)(.*?)(<\/code>)/s", + function ($aMatches) use (&$c, &$aCode) { + $aCode[$c] = $aMatches[2]; + return $aMatches[1] . '___' . $c++ . '___' . $aMatches[3]; + }, + $s); + + $s = preg_replace_callback( + "/{{\~(.*?)\~}}/", + function ($aMatches) { + return BxDolService::callMacro($aMatches[1]); + }, + $s); + + $s = preg_replace_callback( + "/()___(.*?)___(<\/code>)/s", + function ($aMatches) use (&$aCode) { + $sCode = isset($aCode[$aMatches[2]]) ? $aCode[$aMatches[2]] : 'n/a'; + return $aMatches[1] . $sCode . $aMatches[3]; + }, + $s); + + return $s; +} + +/* + * This function apply bx_process_input and then bx_process_output. + * Use this function to output data immediately after receiving, without saving to database. + * Patams are the same as bx_process_input function - @see bx_process_input + */ +function bx_process_pass ($mixedData, $iDataType = BX_DATA_TEXT, $mixedParams = false, $isCheckMagicQuotes = true) +{ + return bx_process_output(bx_process_input ($mixedData, $iDataType, $mixedParams, $isCheckMagicQuotes), $iDataType, $mixedParams); +} + +/** + * DEPRECATED + * use bx_process_input + bx_process_output instead + * -------- + * function for processing pass data + * + * This function cleans the GET/POST/COOKIE data if magic_quotes_gpc() is on + * for data which should be outputed immediately after submit + */ +/* +function process_pass_data( $text, $strip_tags = 0 ) +{ + if ( $strip_tags ) + $text = strip_tags($text); + if ( !get_magic_quotes_gpc() ) + return $text; + else + return stripslashes($text); +} +*/ + +/* + * function for output data from database into html + */ +function htmlspecialchars_adv( $string ) +{ + return htmlspecialchars($string, ENT_COMPAT, 'UTF-8', false); +} + +/** + * Send mail to user by parsing email template + */ +function sendMailTemplate($sTemplateName, $iAccountId = 0, $iProfileId = 0, $aReplaceVars = array(), $iEmailType = BX_EMAIL_NOTIFY, $bAddToQueue = false) +{ + $oProfile = $iProfileId ? BxDolProfile::getInstance($iProfileId) : null; + + $oAccount = $iAccountId ? BxDolAccount::getInstance($iAccountId) : ($oProfile ? $oProfile->getAccountObject() : null); + + $oEmailTemplates = BxDolEmailTemplates::getInstance(); + + if (!($oAccount || $oProfile) || !$oEmailTemplates) + return false; + + $aTemplate = $oEmailTemplates->parseTemplate($sTemplateName, $aReplaceVars, $oAccount ? $oAccount->id() : 0, (int)$iProfileId); + if (!$aTemplate) + return false; + + return sendMail($oAccount->getEmail(), $aTemplate['Subject'], $aTemplate['Body'], 0, array(), $iEmailType, 'html', false, array(), $bAddToQueue); +} + +/** + * Send system email + */ +function sendMailTemplateSystem($sTemplateName, $aReplaceVars = array(), $iEmailType = BX_EMAIL_SYSTEM, $bAddToQueue = false) +{ + $oEmailTemplates = BxDolEmailTemplates::getInstance(); + + if (!$oEmailTemplates) + return false; + + $aTemplate = $oEmailTemplates->parseTemplate($sTemplateName, $aReplaceVars); + if (!$aTemplate) + return false; + + return sendMail(getParam('site_email'), $aTemplate['Subject'], $aTemplate['Body'], 0, array(), $iEmailType, 'html', false, array(), $bAddToQueue); +} +/** + * Send email function + * + * @param $mRecipientEmails - Email where email should be send, can be array, string with one email or comma separated + * @param $sMailSubject - subject of the message + * @param $sMailBody - Body of the message + * @param $iRecipientID - ID of recipient profile + * @param $aPlus - Array of additional information + * @param $iEmailType - email message type: BX_EMAIL_SYSTEM, BX_EMAIL_NOTIFY or BX_EMAIL_MASS + * @param $sEmailFlag - use 'html' for HTML email message + * @param $isDisableAlert - disable alert + * @param $aCustomHeaders - custom email headers + * @param $bAddToQueue - add message to email queue + * @return true if message was send or false otherwise + */ +function sendMail($mRecipientEmails, $sMailSubject, $sMailBody, $iRecipientID = 0, $aPlus = array(), $iEmailType = BX_EMAIL_NOTIFY, $sEmailFlag = 'html', $isDisableAlert = false, $aCustomHeaders = array(), $bAddToQueue = false) +{ + if (is_string($mRecipientEmails)){ + if(strpos($mRecipientEmails, ',') !== false){ + $mRecipientEmails = explode(',', $mRecipientEmails); + } + else{ + return _sendMail($mRecipientEmails, $sMailSubject, $sMailBody, $iRecipientID, $aPlus, $iEmailType, $sEmailFlag, $isDisableAlert, $aCustomHeaders, $bAddToQueue); + } + } + + if (is_array($mRecipientEmails)) { + $bReturn = false; + foreach($mRecipientEmails as $sRecipientEmail) { + $sRecipientEmail = trim($sRecipientEmail); + if (_sendMail($sRecipientEmail, $sMailSubject, $sMailBody, $iRecipientID, $aPlus, $iEmailType, $sEmailFlag, $isDisableAlert, $aCustomHeaders, $bAddToQueue)) + $bReturn = true; + } + return $bReturn; + } +} + +function _sendMail($sRecipientEmail, $sMailSubject, $sMailBody, $iRecipientID = 0, $aPlus = array(), $iEmailType = BX_EMAIL_NOTIFY, $sEmailFlag = 'html', $isDisableAlert = false, $aCustomHeaders = array(), $bAddToQueue = false) +{ + // make sure that recipient's email is valid and message isn't empty + if (!$sMailBody || !$sRecipientEmail || preg_match('/\(2\)$/', $sRecipientEmail)) + return false; + + // get recipient account + $oAccount = !$isDisableAlert ? BxDolAccount::getInstance($sRecipientEmail) : null; + $aAccountInfo = $oAccount ? $oAccount->getInfo() : false; + + // don't send bulk emails if user didn't subscribed to site news or email is unconfirmed + if ($aAccountInfo && BX_EMAIL_MASS == $iEmailType && (!$aAccountInfo['email_confirmed'] || !$aAccountInfo['receive_news'])) + return false; + + // don't send email notifications if user didn't subscribed to notifications or email is unconfirmed + if ($aAccountInfo && BX_EMAIL_NOTIFY == $iEmailType && (!$aAccountInfo['email_confirmed'] || !$aAccountInfo['receive_updates'])) + return false; + + // decode HTML entities in the subj + $sMailSubject = html_entity_decode($sMailSubject, ENT_QUOTES | ENT_SUBSTITUTE | ENT_HTML401, 'UTF-8'); + + if($bAddToQueue && BxDolQueueEmail::getInstance()->add($sRecipientEmail, $sMailSubject, $sMailBody, $iRecipientID, $aPlus, $iEmailType, $sEmailFlag, $isDisableAlert, $aCustomHeaders)) + return true; + + // if profile id is provided - get profile's info + $aRecipientInfo = false; + if ($iRecipientID) { + $oProfile = BxDolProfile::getInstance($iRecipientID); + if ($oProfile) + $aRecipientInfo = $oProfile->getInfo(); + } + + // get site vars + $sEmailNotify = !$isDisableAlert ? getParam('site_email_notify') : $sRecipientEmail; + $sSiteTitle = !$isDisableAlert ? getParam('site_title') : 'UNA ' . BX_DOL_VERSION; + + // add unsubscribe link + if (!$isDisableAlert && empty($aPlus['unsubscribe'])) { + $aPlus['unsubscribe'] = ''; + if ($oAccount && (BX_EMAIL_MASS == $iEmailType || BX_EMAIL_NOTIFY == $iEmailType)) + $aPlus['unsubscribe'] = ($sLink = $oAccount->getUnsubscribeLink($iEmailType)) ? '' . _t('_sys_et_txt_unsubscribe') . '' : ''; + } + + // parse template + if ($aPlus || $iRecipientID || $oAccount) { + if(!is_array($aPlus)) + $aPlus = []; + + $oEmailTemplates = BxDolEmailTemplates::getInstance(); + $sMailSubject = $oEmailTemplates->parseContent($sMailSubject, $aPlus, !$iRecipientID && $oAccount ? $oAccount->id() : 0, $iRecipientID); + $sMailBody = $oEmailTemplates->parseContent($sMailBody, $aPlus, !$iRecipientID && $oAccount ? $oAccount->id() : 0, $iRecipientID); + } + + if(($sRootUrl = getParam('sys_api_url_root_email')) !== '') { + if(substr(BX_DOL_URL_ROOT, -1) == '/' && substr($sRootUrl, -1) != '/') + $sRootUrl .= '/'; + + $sMailBody = str_replace(BX_DOL_URL_ROOT, $sRootUrl, $sMailBody); + + // restore URLs in images + $sMailBody = str_replace([ + 'src="' . $sRootUrl, + "src='" . $sRootUrl + ], [ + 'src="' . BX_DOL_URL_ROOT, + "src='" . BX_DOL_URL_ROOT + ], $sMailBody); + } + + // email message headers + $sMailHeader = ''; + foreach ($aCustomHeaders as $sHeaderName => $sHeaderValue) + $sMailHeader = "$sHeaderName: $sHeaderValue\r\n" . $sMailHeader; + + if (!isset($aCustomHeaders['From'])) + $sMailHeader = "From: =?UTF-8?B?" . base64_encode( $sSiteTitle ) . "?= <{$sEmailNotify}>"; + + if (!isset($aCustomHeaders['MIME-Version'])) + $sMailHeader = "MIME-Version: 1.0\r\n" . $sMailHeader; + + $sMailParameters = isset($aCustomHeaders['Sender']) ? "-f{$aCustomHeaders['Sender']}" : "-f{$sEmailNotify}"; + + if (isset($aCustomHeaders['Subject'])) + $sMailSubject = $aCustomHeaders['Subject']; + + // build data for alert handler + $bResult = null; + $aAlert = array( + 'email' => $sRecipientEmail, + 'subject' => $sMailSubject, + 'body' => $sMailBody, + 'header' => $sMailHeader, + 'params' => $sMailParameters, + 'recipient' => $aRecipientInfo, + 'email_type' => $iEmailType, + 'html' => 'html' == $sEmailFlag ? true : false, + 'custom_headers' => $aCustomHeaders, + 'override_result' => &$bResult, + ); + + /** + * @hooks + * @hookdef hook-system-check_send_mail 'system', 'check_send_mail' - hook for disabling mail sending + * - $unit_name - equals `system` + * - $action - equals `check_send_mail` + * - $object_id - recipient profile id + * - $sender_id - not used + * - $extra_params - array of additional params with the following array keys: + * - `email` - [string] recipient email + * - `subject` - [string] email subject + * - `body` - [string] email body + * - `header` - [string] email headers, headers are separated with double new line character + * - `params` - [string] parameters for php mail function + * - `recipient` - [array] recipient info array + * - `email_type` - [int] email type, one of the following BX_EMAIL_SYSTEM, BX_EMAIL_NOTIFY, BX_EMAIL_MASS + * - `html` - [boolean] `true` if email content is HTML, if `false` then email content is text + * - `custom_headers` - [array] custom email headers array as key&value pairs + * - `override_result` - [boolean] override result of `sendMail` function, if `true` then mail sending should continue as usual, if `false` then mail sending should stop + * @hook @ref hook-system-check_send_mail + */ + bx_alert('system', 'check_send_mail', (isset($aRecipientInfo['ID']) ? $aRecipientInfo['ID'] : 0), '', $aAlert); + + if ($bResult !== null) + return $bResult; + + // system alert + if (!$isDisableAlert) { + /** + * @hooks + * @hookdef hook-system-before_send_mail 'system', 'before_send_mail' - hook before mail sending + * It's equivalent to @ref hook-system-check_send_mail + * @hook @ref hook-system-before_send_mail + */ + bx_alert('system', 'before_send_mail', (isset($aRecipientInfo['ID']) ? $aRecipientInfo['ID'] : 0), '', $aAlert); + if ($bResult !== null) + return $bResult; + unset($aAlert['override_result']); + } + + // prepare HTML/Plain message + if($sEmailFlag == 'html') + $sMailHeader = "Content-type: text/html; charset=UTF-8\r\n" . $sMailHeader; + else { + $sMailHeader = "Content-type: text/plain; charset=UTF-8\r\n" . $sMailHeader; + $sMailBody = html2txt($sMailBody); + } + + // encode subject + if (0 !== strncasecmp($sMailSubject, '=?UTF-8?B?', 10)) + $sMailSubject = '=?UTF-8?B?' . base64_encode($sMailSubject) . '?='; + + // send mail or put it into queue + $bResult = mail($sRecipientEmail, $sMailSubject, $sMailBody, $sMailHeader, $sMailParameters); + + // system alert + if (!$isDisableAlert) { + /** + * @hooks + * @hookdef hook-system-send_mail 'system', 'send_mail' - hook when mail was sent + * It's equivalent to @ref hook-system-check_send_mail + * except `override_result` parameter in $extra_params is missing + * @hook @ref hook-system-send_mail + */ + bx_alert('system', 'send_mail', (isset($aRecipientInfo['ID']) ? $aRecipientInfo['ID'] : 0), '', $aAlert); + } + + return $bResult; +} + +/* + * Getting an array with Templates' Names + */ +function get_templates_array($bEnabledOnly = true, $bShortInfo = true) +{ + $oDb = BxDolDb::getInstance(); + + $sWhereAddon = $bEnabledOnly ? " AND `enabled`='1'" : ""; + + if($bShortInfo) + return $oDb->getPairs("SELECT `uri`, `title` FROM `sys_modules` WHERE 1 AND `type`='" . BX_DOL_MODULE_TYPE_TEMPLATE . "'" . $sWhereAddon, "uri", "title"); + else + return $oDb->getAllWithKey("SELECT * FROM `sys_modules` WHERE 1 AND `type`='" . BX_DOL_MODULE_TYPE_TEMPLATE . "'" . $sWhereAddon, "uri"); +} + +function bx_get_image_exif_and_size($oStorage, $oTranscoder, $iContentId){ + $sData = ''; + $sExif = ''; + $aExif = false; + $aPhoto = $oStorage->getFile($iContentId); + if ($oTranscoder->isMimeTypeSupported($aPhoto['mime_type'])) { + $oImageReize = BxDolImageResize::getInstance(); + + $a = $oImageReize->getImageSize($oTranscoder->getFileUrl($iContentId)); + $sData = isset($a['w']) && isset($a['h']) ? $a['w'] . 'x' . $a['h'] : ''; + + if ($aExif = $oImageReize->getExifInfo($oStorage->getFileUrlById($iContentId))) { + $a = array('Make', 'Model', 'FocalLength', 'ShutterSpeedValue', 'ExposureTime', 'ISOSpeedRatings', 'Orientation', 'Artist', 'Copyright', 'Flash', 'WhiteBalance', 'DateTimeOriginal', 'DateTimeDigitized', 'ExifVersion', 'COMPUTED', 'GPSLatitudeRef', 'GPSLatitude', 'GPSLongitudeRef', 'GPSLongitude', 'GPSAltitudeRef', 'GPSAltitude', 'GPSTimeStamp', 'GPSImgDirectionRef', 'GPSImgDirection', 'GPSDateStamp'); + $aExifFiltered = array(); + foreach ($a as $sIndex) + if (isset($aExif[$sIndex])) + $aExifFiltered[$sIndex] = $aExif[$sIndex]; + $sExif = serialize($aExifFiltered); + } + } + return array('exif' => $sExif, 'size' => $sData); +} + +function bx_get_svg_image_size($sUrl) +{ + $iWidth = $iHeight = 0; + + $sContent = bx_file_get_contents($sUrl); + if(empty($sContent)) + return [$iWidth, $iHeight]; + + $aAttributes = BxDolXmlParser::getInstance()->getAttributes($sContent, 'SVG', 0); + if(isset($aAttributes['VIEWBOX'])) { + $aViewBox = explode(' ', $aAttributes['VIEWBOX']); + if(!empty($aViewBox) && is_array($aViewBox) && count($aViewBox) == 4) { + $iWidth = (float)$aViewBox[2]; + $iHeight = (float)$aViewBox[3]; + } + } + + if(!$iWidth && isset($aAttributes['WIDTH'])) + $iWidth = $this->_str2px($aAttributes['WIDTH']); + + if(!$iHeight && isset($aAttributes['HEIGHT'])) + $iHeight = $this->_str2px($aAttributes['HEIGHT']); + + return [$iWidth, $iHeight]; +} + +function extFileExists( $sFileSrc ) +{ + return (file_exists( $sFileSrc ) && is_file( $sFileSrc )) ? true : false; +} + +function getVisitorIP() +{ + $ip = "0.0.0.0"; + if (isset($_SERVER['HTTP_X_FORWARDED_FOR']) && !empty($_SERVER['HTTP_X_FORWARDED_FOR'])) { + $ip = $_SERVER['HTTP_X_FORWARDED_FOR']; + } elseif (isset( $_SERVER['HTTP_CLIENT_IP']) && !empty($_SERVER['HTTP_CLIENT_IP'])) { + $ip = explode(".",$_SERVER['HTTP_CLIENT_IP']); + $ip = $ip[3].".".$ip[2].".".$ip[1].".".$ip[0]; + } elseif (!isset( $_SERVER['HTTP_X_FORWARDED_FOR']) || empty($_SERVER['HTTP_X_FORWARDED_FOR'])) { + if (!isset( $_SERVER['HTTP_CLIENT_IP']) && empty($_SERVER['HTTP_CLIENT_IP']) && isset($_SERVER['REMOTE_ADDR'])) + $ip = $_SERVER['REMOTE_ADDR']; + } + return $ip; +} + +function genFlag($sLang = '', $oTemplate = null) +{ + if (!$oTemplate) + $oTemplate = BxDolTemplate::getInstance(); + $oTemplate->addCss(BX_DIRECTORY_PATH_PLUGINS_PUBLIC . 'flag-icon-css/css/|flag-icon.min.css'); + $sFlag = BxDolLanguages::getInstance()->getLangFlag($sLang); + return ''; +} + +// print debug information ( e.g. arrays ) +function echoDbg( $what, $desc = '' ) +{ + if ( $desc ) + echo "$desc: "; + echo ""; + print_r( $what ); + echo "\n"; +} + +function echoDbgLog($mWhat, $sDesc = 'unused', $sFileName = 'unused') +{ + bx_log('sys_debug', $mWhat); +} + +function bx_is_dbg() +{ + return (defined('BX_DBG_COOKIE') && !empty($_COOKIE[BX_DBG_COOKIE])) || (defined('BX_DBG_PROFILES') && in_array(bx_get_logged_profile_id(), BX_DBG_PROFILES)); +} + +function dbgTiming($sStartMicrotime) +{ + $i1 = explode(' ', microtime ()); + $i2 = explode(' ', $sStartMicrotime); + $iTime = ($i1[0]+$i1[1]) - ($i2[0]+$i2[1]); + return round($iTime, 6) . ' sec'; +} + +function echoJson($a) +{ + header('Content-Type: application/json; charset=utf-8'); + + echo json_encode($a); +} + +function clear_xss($val) +{ + // HTML Purifier plugin + global $oHtmlPurifier; + if (!isset($oHtmlPurifier) && !$GLOBALS['logged']['admin']) { + HTMLPurifier_Bootstrap::registerAutoload(); + + $oConfig = HTMLPurifier_Config::createDefault(); + + $oConfig->set('Cache.SerializerPath', rtrim(BX_DIRECTORY_PATH_CACHE, '/')); + $oConfig->set('Cache.SerializerPermissions', BX_DOL_DIR_RIGHTS); + + $oConfig->set('HTML.SafeObject', 'true'); + $oConfig->set('Output.FlashCompat', 'true'); + $oConfig->set('HTML.FlashAllowFullScreen', 'true'); + $oConfig->set('Attr.AllowedFrameTargets', array('_blank', '_self', '_parent', '_top')); + + if (getParam('sys_add_nofollow')) { + $sHost = parse_url(BX_DOL_URL_ROOT, PHP_URL_HOST); + $oConfig->set('URI.Host', $sHost); + $oConfig->set('HTML.Nofollow', 'true'); + } + + $oConfig->set('Filter.Custom', array ( + new BxDolHTMLPurifierFilterYouTube(), + new BxDolHTMLPurifierFilterYoutubeIframe(), + new BxDolHTMLPurifierFilterAddBxLinksClass(), + new BxDolHTMLPurifierFilterLocalIframe(), + new BxDolHTMLPurifierFilterEmbed(), + )); + + $oConfig->set('HTML.DefinitionID', 'html5-definitions'); + $oConfig->set('HTML.DefinitionRev', 1); + + if ($def = $oConfig->maybeGetRawHTMLDefinition()) { + $def->addElement('section', 'Block', 'Flow', 'Common'); + $def->addElement('nav', 'Block', 'Flow', 'Common'); + $def->addElement('article', 'Block', 'Flow', 'Common'); + $def->addElement('aside', 'Block', 'Flow', 'Common'); + $def->addElement('header', 'Block', 'Flow', 'Common'); + $def->addElement('footer', 'Block', 'Flow', 'Common'); + $def->addElement('video', 'Block', 'Optional: (source, Flow) | (Flow, source) | Flow', 'Common', array( + 'src' => 'URI', + 'type' => 'Text', + 'width' => 'Length', + 'height' => 'Length', + 'poster' => 'URI', + 'preload' => 'Enum#auto,metadata,none', + 'controls' => 'Bool', + )); + $def->addElement('source', 'Block', 'Flow', 'Common', array( + 'src' => 'URI', + 'type' => 'Text', + )); + $def->addAttribute('a', 'data-profile-id', 'Text'); + $def->addAttribute('a', 'dchar', 'Text'); + $def->addAttribute('div', 'source', 'Text'); + } + + $oHtmlPurifier = new HTMLPurifier($oConfig); + } + + if (!$GLOBALS['logged']['admin']) + $val = $oHtmlPurifier->purify($val); + + $sNewVal = $val; + if (!$GLOBALS['logged']['admin']) + $sNewVal = $oHtmlPurifier->purify($val); + + /** + * @hooks + * @hookdef hook-account-clear_xss 'account', 'clear_xss' - hook after string is checked for xss + * - $unit_name - equals `system` + * - $action - equals `clear_xss` + * - $object_id - not used + * - $sender_id - not used + * - $extra_params - array of additional params with the following array keys: + * - `oHtmlPurifier` - [object] HtmlPurifier object + * - `input_data` - [string] string before check xss + * - `return_data` - [string] by ref, string before check xss, can be overridden in hook processing + * @hook @ref hook-system-clear_xss + */ + bx_alert('system', 'clear_xss', 0, 0, array('oHtmlPurifier' => $oHtmlPurifier, 'input_data' => $val, 'return_data' => &$sNewVal)); + + return $val; +} + +//--------------------------------------- friendly permalinks --------------------------------------// +//------------------------------------------- main functions ---------------------------------------// +function uriGenerate ($sValue, $sTable, $sField, $aParams = []) +{ + $sDivider = isset($aParams['divider']) ? $aParams['divider'] : '-'; + $aCond = isset($aParams['cond']) && is_array($aParams['cond']) ? $aParams['cond'] : []; + + $sValue = uriFilter($sValue, $aParams); + if(uriCheckUniq($sValue, $sTable, $sField, $aCond)) + return $sValue; + + // cut off redundant part + if(get_mb_len($sValue) > 240) + $sValue = get_mb_substr($sValue, 0, 240); + + // try to add number + for($i = 0 ; $i < 999 ; ++$i) { + $iRnd = mt_rand(1000, 9999); + if(uriCheckUniq($sValue . $sDivider . $iRnd, $sTable, $sField, $aCond)) + return ($sValue . $sDivider . $iRnd); + } + + return rand(0, PHP_INT_MAX); +} + +function uriFilter ($s, $aParams = []) +{ + $sEmpty = isset($aParams['empty']) ? $aParams['empty'] : '-'; + $sDivider = isset($aParams['divider']) ? $aParams['divider'] : '-'; + + if(BxTemplConfig::getInstance()->bAllowUnicodeInPreg) + $s = get_mb_replace ('/[^\pL^\pN^_]+/u', $sDivider, $s); // unicode characters + else + $s = get_mb_replace ('/([^\d^\w]+)/u', $sDivider, $s); // latin characters only + + $s = get_mb_replace ('/([' . $sDivider . '^]+)/', $sDivider, $s); + $s = get_mb_replace ('/([' . $sDivider . ']+)$/', '', $s); // remove trailing dash + if(!$s) + $s = $sEmpty; + + return !isset($aParams['lowercase']) || $aParams['lowercase'] === true ? mb_strtolower($s) : $s; +} + +function uriCheckUniq ($sValue, $sTable, $sField, $aCond = []) +{ + $oDb = BxDolDb::getInstance(); + + $sWhere = $aCond ? $oDb->arrayToSQL($aCond, ' AND ') : '1'; + $sSql = $oDb->prepare("SELECT 1 FROM `$sTable` WHERE $sWhere AND `$sField`=? LIMIT 1", $sValue); + return !$oDb->query($sSql); +} + +function get_mb_replace ($sPattern, $sReplace, $s) +{ + return preg_replace ($sPattern, $sReplace, $s); +} + +function get_mb_len ($s) +{ + return (function_exists('mb_strlen')) ? mb_strlen($s) : strlen($s); +} + +function get_mb_substr ($s, $iStart, $iLen) +{ + return (function_exists('mb_substr')) ? mb_substr ($s, $iStart, $iLen) : substr ($s, $iStart, $iLen); +} + +function bx_mb_substr_replace($s, $sReplace, $iPosStart, $iLength) +{ + return mb_substr($s, 0, $iPosStart) . $sReplace . mb_substr($s, $iPosStart + $iLength); +} + +function bx_mb_strpos ($s, $sReplacement, $iStart = 0) +{ + return mb_strpos($s, $sReplacement, $iStart); +} + +/** + * Import class file, it automatically detects class path by its prefix or module array/name + * + * @param $sClassName - full class name or class postfix(withoit prefix) in the case of module class + * @param $mixedModule - module array or module name in the case of module class + */ +function bx_import($sClassName, $mixedModule = array()) +{ + if (class_exists($sClassName, false)) + return; + + $aModule = false; + if ($mixedModule) { + if (is_array($mixedModule)) { + $aModule = $mixedModule; + } elseif (is_string($mixedModule)) { + $o = BxDolModule::getInstance($mixedModule); + $aModule = $o->_aModule; + } elseif (is_bool($mixedModule) && true === $mixedModule) { + $aModule = $GLOBALS['aModule']; + } + } + + if ($aModule) { + if (class_exists($aModule['class_prefix'] . $sClassName, false)) + return; + require_once (BX_DIRECTORY_PATH_MODULES . $aModule['path'] . 'classes/' . $aModule['class_prefix'] . $sClassName . '.php'); + return; + } + + if (0 === strncmp($sClassName, 'BxDol', 5)) { + if (0 === strncmp($sClassName, 'BxDolStudio', 11)) + require_once(BX_DOL_DIR_STUDIO_CLASSES . $sClassName . '.php'); + else + require_once(BX_DIRECTORY_PATH_CLASSES . $sClassName . '.php'); + return; + } + + if (0 === strncmp($sClassName, 'BxBase', 6)) { + if (0 === strncmp($sClassName, 'BxBaseMod', 9)) { + $aMatches = array(); + if (preg_match('/BxBaseMod([A-Z][a-z]+)/', $sClassName, $aMatches)) { + require_once(BX_DIRECTORY_PATH_MODULES . 'base/' . strtolower($aMatches[1]) . '/classes/' . $sClassName . '.php'); + return; + } + } if (0 === strncmp($sClassName, 'BxBaseStudio', 12)) { + require_once(BX_DOL_DIR_STUDIO_BASE . 'scripts/' . $sClassName . '.php'); + return; + } else { + require_once(BX_DIRECTORY_PATH_BASE . 'scripts/' . $sClassName . '.php'); + return; + } + } + + if (0 === strncmp($sClassName, 'BxTempl', 7)) { + if(0 === strncmp($sClassName, 'BxTemplStudio', 13)) { + $sPath = BX_DIRECTORY_PATH_MODULES . BxDolStudioTemplate::getInstance()->getPath() . 'data/template/studio/scripts/' . $sClassName . '.php'; + if (!file_exists($sPath)) + $sPath = BX_DOL_DIR_STUDIO_BASE . 'scripts_templ/' . $sClassName . '.php'; + } else { + $sPath = BX_DIRECTORY_PATH_MODULES . BxDolTemplate::getInstance()->getPath() . 'data/template/system/scripts/' . $sClassName . '.php'; + } + + if (file_exists($sPath)) { + require_once($sPath); + return; + } + else{ + require_once(BX_DIRECTORY_PATH_BASE . 'scripts_templ/' . $sClassName . '.php'); + return; + } + + trigger_error ("bx_import fatal error: class (" . $sClassName . ") wasn't found", E_USER_ERROR); + } +} + +/** + * used in spl_autoload_register() function, so no need to call bx_import for system classes + */ +function bx_autoload($sClassName) +{ + if (0 === strncmp($sClassName, 'BxDol', 5) || 0 === strncmp($sClassName, 'BxBase', 6) || 0 === strncmp($sClassName, 'BxTempl', 7)) + bx_import($sClassName); +} + +/** + * Gets an instance of class pathing necessary parameters if it's necessary. + * + * @param string $sClassName class name. + * @param array $aParams an array of parameters to be pathed to the constructor of the class. + * @param array $mixedModule an array with module description. Is used when the requested class is located in some module. + * @return unknown + */ +function bx_instance($sClassName, $aParams = array(), $mixedModule = array()) +{ + if(isset($GLOBALS['bxDolClasses'][$sClassName])) + return $GLOBALS['bxDolClasses'][$sClassName]; + + if ($mixedModule) { + if (!is_array($mixedModule)) { + $o = BxDolModule::getInstance($mixedModule); + $mixedModule = $o->_aModule; + } + $sClassName = bx_ltrim_str($sClassName, $mixedModule['class_prefix']); + bx_import($sClassName, $mixedModule); + $sClassName = $mixedModule['class_prefix'] . $sClassName; + } + + $oClass = new ReflectionClass($sClassName); + + $GLOBALS['bxDolClasses'][$sClassName] = empty($aParams) ? $oClass->newInstance() : $oClass->newInstanceArgs($aParams); + + return $GLOBALS['bxDolClasses'][$sClassName]; +} + + +/** + * Escapes string/array ready to pass to js script with filtered symbols like ', " etc + * + * @param $mixedInput - string/array which should be filtered + * @param $iQuoteType - string escaping method: BX_ESCAPE_STR_AUTO(default), BX_ESCAPE_STR_APOS or BX_ESCAPE_STR_QUOTE + * @return converted string / array + */ +function bx_js_string ($mixedInput, $iQuoteType = BX_ESCAPE_STR_AUTO) +{ + $aUnits = array( + "\n" => "\\n", + "\r" => "", + ); + if (BX_ESCAPE_STR_APOS == $iQuoteType) { + $aUnits["'"] = "\\'"; + $aUnits[''] = ""; + } elseif (BX_ESCAPE_STR_QUOTE == $iQuoteType) { + $aUnits['"'] = '\\"'; + $aUnits[''] = ''; + } else { + $aUnits['"'] = '"'; + $aUnits["'"] = '''; + $aUnits[""] = '</script>'; + } + return str_replace(array_keys($aUnits), array_values($aUnits), $mixedInput); +} + +/** + * Return input string/array ready to pass to html attribute with filtered symbols like ', " etc + * + * @param $mixedInput - string/array which should be filtered + * @param $iQuoteType - string escaping BX_ESCAPE_STR_AUTO, BX_ESCAPE_STR_APOS or BX_ESCAPE_STR_QUOTE + * @return converted string / array + */ +function bx_html_attribute ($mixedInput, $iQuoteType = BX_ESCAPE_STR_AUTO) +{ + $aUnits = array (); + if (BX_ESCAPE_STR_APOS == $iQuoteType) + $aUnits["'"] = "\\'"; + elseif (BX_ESCAPE_STR_QUOTE == $iQuoteType) + $aUnits['"'] = '"'; + else + $aUnits = array("\"" => """, "'" => "'"); + + return str_replace(array_keys($aUnits), array_values($aUnits), $mixedInput); +} + +/** + * Escapes string/array ready to pass to php script with filtered symbols like ', " etc + * + * @param mixed $mixedInput - string/array which should be filtered + * @return converted string / array + */ +function bx_php_string_apos ($mixedInput) +{ + return str_replace("'", "\\'", $mixedInput); +} +function bx_php_string_quot ($mixedInput) +{ + return str_replace('"', '\\"', $mixedInput); +} + +/** + * Gets file contents by URL. + * + * @param string $sFileUrl - file URL to be read. + * @param array $aParams - an array of parameters to be pathed with URL. + * @param string $sMethod - post or get. + * @param array $aHeaders - custom headers. + * @param string $sHttpCode - HTTP code to return + * @param array $aBasicAuth - array with 'user' and 'password' for Basic HTTP Auth + * @return string the file's contents. + */ +function bx_file_get_contents($sFileUrl, $aParams = array(), $sMethod = 'get', $aHeaders = array(), &$sHttpCode = null, $aBasicAuth = array(), $iTimeout = 0, $aCustomCurlParams = array()) +{ + if(!in_array($sMethod, ['post', 'post-raw', 'post-json', 'post-json-object'])) + $sFileUrl = bx_append_url_params($sFileUrl, $aParams); + + $sResult = ''; + if(function_exists('curl_init')) { + $rConnect = curl_init(); + + curl_setopt($rConnect, CURLOPT_USERAGENT, 'UNA ' . (defined('BX_DOL_VERSION') ? constant('BX_DOL_VERSION') : '')); + curl_setopt($rConnect, CURLOPT_TIMEOUT, BxDolDb::getInstance() ? getParam('sys_default_curl_timeout') : 10); + curl_setopt($rConnect, CURLOPT_URL, $sFileUrl); + curl_setopt($rConnect, CURLOPT_RETURNTRANSFER, 1); + + if (0 !== $iTimeout) { + curl_setopt($rConnect, CURLOPT_CONNECTTIMEOUT, $iTimeout); + curl_setopt($rConnect, CURLOPT_TIMEOUT, $iTimeout); + } + + if(getParam('sys_curl_ssl_allow_untrusted') == 'on'){ + curl_setopt($rConnect, CURLOPT_SSL_VERIFYPEER, false); + curl_setopt($rConnect, CURLOPT_SSL_VERIFYHOST, false); + } + + if (!ini_get('open_basedir')) + curl_setopt($rConnect, CURLOPT_FOLLOWLOCATION, 1); + + if ($aBasicAuth) + curl_setopt($rConnect, CURLOPT_USERPWD, $aBasicAuth['user'] . ':' . $aBasicAuth['password']); + + if ('post' == $sMethod) { + curl_setopt($rConnect, CURLOPT_POST, true); + curl_setopt($rConnect, CURLOPT_POSTFIELDS, http_build_query($aParams)); + } + elseif ('post-raw' == $sMethod) { + curl_setopt($rConnect, CURLOPT_POST, true); + curl_setopt($rConnect, CURLOPT_POSTFIELDS, $aParams); + } + elseif ('post-json' == $sMethod) { + curl_setopt($rConnect, CURLOPT_POST, true); + curl_setopt($rConnect, CURLOPT_POSTFIELDS, json_encode($aParams)); + $aHeaders[] = 'Content-Type: application/json'; + } + elseif ('post-json-object' == $sMethod) { + curl_setopt($rConnect, CURLOPT_POST, true); + curl_setopt($rConnect, CURLOPT_POSTFIELDS, json_encode($aParams, JSON_FORCE_OBJECT)); + $aHeaders[] = 'Content-Type: application/json'; + } + elseif ($sMethod != 'get') { + curl_setopt($rConnect, CURLOPT_CUSTOMREQUEST, $sMethod); + } + + if ($aHeaders) + curl_setopt($rConnect, CURLOPT_HTTPHEADER, $aHeaders); + + if (defined('BX_DOL_URL_ROOT') && 0 === strpos($sFileUrl, BX_DOL_URL_ROOT)) { + $sAllCookies = ''; + foreach($_COOKIE as $sKey => $mValue){ + if(is_array($mValue)){ + foreach ($mValue as $k => $v) + $sAllCookies .= "{$sKey}[{$k}]={$v};"; + } + else{ + $sAllCookies .= $sKey . '=' . $mValue . ';'; + } + } + curl_setopt($rConnect, CURLOPT_COOKIE, $sAllCookies); + } + + if ($aCustomCurlParams) + foreach ($aCustomCurlParams as $sName => $mixedValue) + curl_setopt($rConnect, $sName, $mixedValue); + + $sResult = curl_exec($rConnect); + + if (curl_errno($rConnect) == 60) { // CURLE_SSL_CACERT + curl_setopt($rConnect, CURLOPT_CAINFO, BX_DIRECTORY_PATH_PLUGINS . 'curl/cacert/cacert.pem'); + $sResult = curl_exec($rConnect); + } + + if (NULL !== $sHttpCode) + $sHttpCode = curl_getinfo($rConnect, CURLINFO_HTTP_CODE); + + curl_close($rConnect); + } + else { + + $iSaveTimeout = false; + if (0 !== $iTimeout) { + $iSaveTimeout = ini_get('default_socket_timeout'); + ini_set('default_socket_timeout', $iTimeout); + } + + $sResult = @file_get_contents($sFileUrl); + + if (0 !== $iTimeout && false !== $iSaveTimeout) { + ini_set('default_socket_timeout', $iSaveTimeout); + } + } + + return $sResult; +} + +function bx_make_utf8($s) +{ + // Test it and see if it is UTF-8 or not + if (false !== mb_detect_encoding($s, ["UTF-8"], true)) + return $s; + + $sEncoding = mb_detect_encoding($s, ['ASCII', 'BASE64', 'HTML-ENTITIES', 'Windows-1251', 'KOI8-R'], true); + if ($sEncoding === false) + return $s; + + return mb_convert_encoding($s, "UTF-8", $sEncoding); +} + +function bx_get_site_info($sSourceUrl, $aProcessAdditionalTags = array()) +{ + $aResult = array(); + $sContent = bx_file_get_contents($sSourceUrl); + + if ($sContent) { + $sCharset = ''; + preg_match("//i", $sContent, $aMatch); + if (isset($aMatch[1])) + $sCharset = $aMatch[1]; + + $sContent = preg_replace("/]*>(.*?)<\/script>/i", '', $sContent); + $sContent = preg_replace("/]*>(.*?)<\/style>/i", '', $sContent); + if (preg_match("/]*>(.*?)<\/title>/i", $sContent, $aMatch)) + $aResult['title'] = bx_make_utf8(strip_tags($aMatch[1]), $sCharset); + else + $aResult['title'] = parse_url($sSourceUrl, PHP_URL_HOST); + + $aResult['description'] = bx_make_utf8(bx_parse_html_tag($sContent, 'meta', 'name', 'description', 'content', $sCharset), $sCharset); + $aResult['keywords'] = bx_make_utf8(bx_parse_html_tag($sContent, 'meta', 'name', 'keywords', 'content', $sCharset), $sCharset); + + if ($aProcessAdditionalTags) { + + foreach ($aProcessAdditionalTags as $k => $a) { + $aResult[$k] = bx_parse_html_tag( + $sContent, + isset($a['tag']) ? $a['tag'] : 'meta', + isset($a['name_attr']) ? $a['name_attr'] : 'itemprop', + isset($a['name']) ? $a['name'] : $k, + isset($a['content_attr']) ? $a['content_attr'] : 'content', + $sCharset, + isset($a['specialchars_decode']) ? $a['specialchars_decode'] : true); + + if ((isset($a['name']) && 'og:image' == $a['name']) || (isset($a['tag']) && 'link' == $a['tag'])) { + $aResult[$k] = bx_get_site_info_fix_relative_url ($sSourceUrl, $aResult[$k]); + } + } + + } + } + + return $aResult; +} + +/** + * Fix relative URL to make it absolute + * @param $sSourceUrl main URL + * @param $s URL to fix + * @return absolute URL or URL wothout changes + */ +function bx_get_site_info_fix_relative_url ($sSourceUrl, $s) +{ + if (0 === stripos($s, 'http://') || 0 === stripos($s, 'https://') || 0 === stripos($s, 'ftp://') || !$s) + return $s; + + if ('/' == $s[0]) { + $a = parse_url($sSourceUrl); + return $a['scheme'] . '://' . $a['host'] . (empty($a['port']) || 80 == $a['port'] || 443 == $a['port'] ? '' : ':' . $a['port']) . $s; + } + + return $sSourceUrl . ('/' === substr($sSourceUrl, -1) ? $s : '/' . $s); +} + +function bx_parse_html_tag ($sContent, $sTag, $sAttrNameName, $sAttrNameValue, $sAttrContentName, $sCharset = false, $bSpecialCharsDecode = true) +{ + // This regex is designed to be more flexible with attribute orders and spacing + $regex = "/<{$sTag}\s+(?:[^>]*?\s+)?{$sAttrNameName}\s*=\s*['\"]?{$sAttrNameValue}['\"]?\s+[^>]*{$sAttrContentName}\s*=\s*['\"]([^'\"]*)['\"][^>]*>/i"; + if (!preg_match($regex, $sContent, $aMatch)) { + // Try reversing the attribute order in case the first regex fails + $regex = "/<{$sTag}\s+(?:[^>]*?\s+)?{$sAttrContentName}\s*=\s*['\"]([^'\"]*)['\"]\s+[^>]*{$sAttrNameName}\s*=\s*['\"]?{$sAttrNameValue}['\"]?[^>]*>/i"; + preg_match($regex, $sContent, $aMatch); + } + + // Extract the attribute content if available + $s = isset($aMatch[1]) ? $aMatch[1] : ''; + + // Optionally convert character encoding + if ($s && $sCharset) { + $s = mb_convert_encoding($s, 'UTF-8', $sCharset); + } + + // Optionally decode special HTML characters + if ($bSpecialCharsDecode) { + $s = htmlspecialchars_decode($s); + } + + return $s; +} + +// calculation ini_get('upload_max_filesize') in bytes as example +function return_bytes($val) +{ + $val = trim($val); + $last = strtolower($val[strlen($val)-1]); + $val = (int)$val; + switch($last) { + // The 'G' modifier is available since PHP 5.1.0 + case 'k': + $val *= 1024; + break; + case 'm': + $val *= 1024 * 1024; + break; + case 'g': + $val *= 1024 * 1024 * 1024; + break; + } + return $val; +} + +// Generate Random Password +function genRndPwd($iLength = 8, $bSpecialCharacters = true) +{ + $sPassword = ''; + $sChars = "abcdefghijkmnpqrstuvwxyzABCDEFGHJKLMNPQRSTUVWXYZ23456789"; + + if($bSpecialCharacters === true) + $sChars .= "!?=/&+,."; + + for($i = 0; $i < $iLength; $i++) { + $x = mt_rand(0, strlen($sChars) -1); + $sPassword .= $sChars[$x]; + } + + return $sPassword; +} + +// Generate Random Salt for Password encryption +function genRndSalt() +{ + return genRndPwd(8, true); +} + +/** + * Encrypt user password. + * When BX_PWD_ALGO is 'custom', then bx_custom_pwd_encrypt function with custom algorythm must be defined in inc/header.inc.php file. + * @param $sPwd clear password + * @param $sSalt salt + * @return password hash + */ +function encryptUserPwd($sPwd, $sSalt) +{ + $sAlgo = defined('BX_PWD_ALGO') ? BX_PWD_ALGO : ''; + + switch ($sAlgo) { + + case 'custom': + return bx_custom_pwd_encrypt($sPwd, $sSalt); + + case 'crypt': + return crypt($sPwd, BX_PWD_ALGO_SALT); + + case 'sha1_crypt_salt': + return sha1(crypt($sPwd, BX_PWD_ALGO_SALT) . $sSalt); + + case 'sha1_md5_salt': + default: + return sha1(md5($sPwd) . $sSalt); + } +} + +/** + * Hash profile ID + */ +function encryptUserId($sId) +{ + if (!($oProfile = BxDolProfile::getInstance($sId))) + return false; + + if (!($oAccount = $oProfile->getAccountObject())) + return false; + + $aAccountInfo = $oAccount->getInfo(); + return sha1(md5($sId) . md5($aAccountInfo['salt']) . BX_DOL_SECRET); +} + +function bx_get_reset_password_key($sValue, $sField = 'email', $iLifetime = 0) +{ + if(empty($iLifetime)) { + $iLifetime = (int)getParam('sys_account_reset_password_key_lifetime'); + if(empty($iLifetime)) + $iLifetime = 86400; + } + + $oKey = BxDolKey::getInstance(); + if(!$oKey) + return false; + + return $oKey->getNewKey(array($sField => $sValue), $iLifetime); +} + +function bx_get_reset_password_link($sValue, $sField = 'email', $iLifetime = 0) +{ + $sKey = bx_get_reset_password_key($sValue, $sField, $iLifetime); + if(!$sKey) + return false; + + return bx_get_reset_password_link_by_key($sKey); +} + +function bx_get_reset_password_link_by_key($sKey) +{ + return bx_absolute_url(BxDolPermalinks::getInstance()->permalink('page.php?i=forgot-password', array('key' => $sKey))); +} + +function bx_get_reset_password_redirect($iAccountId) +{ + $sResult = ''; + $sRedirect = getParam('sys_account_reset_password_redirect'); + switch($sRedirect) { + case 'home': + $sResult = BxDolPermalinks::getInstance()->permalink('page.php?i=home'); + break; + + case 'profile': + case 'profile_edit': + if(empty($iAccountId)) + break; + + $oAccount = BxDolAccount::getInstance($iAccountId); + if(!$oAccount) + break; + + $aAccountInfo = $oAccount->getInfo(); + if(empty($aAccountInfo) || !is_array($aAccountInfo) || empty($aAccountInfo['profile_id'])) + break; + + $oProfile = BxDolProfile::getInstance((int)$aAccountInfo['profile_id']); + if(!$oProfile) + break; + + $sResult = $oProfile->{'get' . ($sRedirect == 'profile_edit' ? 'Edit' : '') . 'Url'}(); + break; + + case 'custom': + $sResult = getParam('sys_account_reset_password_redirect_custom'); + break; + } + + if(!empty($sResult)) + $sResult = bx_absolute_url($sResult); + + return $sResult; +} + +function bx_get ($sName, $sMethod = false) +{ + if (isset($_GET[$sName]) && ('get' == $sMethod || !$sMethod)) + return $_GET[$sName]; + elseif (isset($_POST[$sName]) && ('post' == $sMethod || !$sMethod)) + return $_POST[$sName]; + else + return false; +} + +function bx_set ($sName, $sValue, $sMethod = false) +{ + if(!$sMethod) + $sMethod = 'get'; + + $bResult = true; + switch($sMethod) { + case 'get': + $_GET[$sName] = $sValue; + break; + + case 'post': + $_POST[$sName] = $sValue; + break; + + default: + $bResult = false; + } + + return $bResult; +} + +function bx_get_with_prefix ($sPrefix, $sMethod = false) +{ + $aSources = array('get' => &$_GET, 'post' => &$_POST); + + $aFiltered = array(); + foreach($aSources as $sName => $aSource) + if($sMethod == $sName || !$sMethod) + $aFiltered = array_merge($aFiltered, array_filter($aSource, function($sKey) use ($sPrefix) { + return strpos($sKey, $sPrefix) === 0; + }, ARRAY_FILTER_USE_KEY)); + + $aUpdated = array(); + array_walk($aFiltered, function($sValue, $sKey) use ($sPrefix, &$aUpdated) { + $aUpdated[trim(str_replace($sPrefix, '', $sKey), '_-')] = $sValue; + }); + + return $aUpdated; +} + +function bx_get_base_url_inline($aParams = array()) +{ + $aBaseLink = parse_url(BX_DOL_URL_ROOT); + $sPageLink = (!empty($aBaseLink['scheme']) ? $aBaseLink['scheme'] : 'http') . '://' . $aBaseLink['host'] . (!empty($aBaseLink['port']) ? ':' . $aBaseLink['port'] : ''); + if(!empty($_SERVER['REQUEST_URI'])) + $sPageLink .= $_SERVER['REQUEST_URI']; + + list($sPageLink, $aPageParams) = bx_get_base_url($sPageLink); + + if(!empty($_SERVER['QUERY_STRING'])) { + $aPageParamsAdd = array(); + parse_str($_SERVER['QUERY_STRING'], $aPageParamsAdd); + if(!empty($aPageParamsAdd) && is_array($aPageParamsAdd)) + $aPageParams = array_merge($aPageParams, $aPageParamsAdd); + } + + if(!empty($aParams) && is_array($aParams)) + $aPageParams = array_merge($aPageParams, $aParams); + + return array($sPageLink, $aPageParams); +} + +function bx_get_base_url_popup($aParams = array()) +{ + list($sPageLink, $aPageParams) = bx_get_base_url($_SERVER['HTTP_REFERER']); + + if(!empty($aParams) && is_array($aParams)) + $aPageParams = array_merge($aPageParams, $aParams); + + return array($sPageLink, $aPageParams); +} + +function bx_get_base_url($sPageLink) +{ + $sPageLink = BxDolPermalinks::getInstance()->unpermalink($sPageLink, false); + + $sPageParams = ''; + if(strpos($sPageLink, '?') !== false) + list($sPageLink, $sPageParams) = explode('?', $sPageLink); + + $aPageParams = array(); + if(!empty($sPageParams)) + parse_str($sPageParams, $aPageParams); + + return array($sPageLink, $aPageParams); +} + +function bx_get_page_info() +{ + list($sPageLink, $aPageParams) = bx_get_base_url_inline(); + + if(isset($aPageParams['i'], $aPageParams['id']) && ($oPage = BxDolPage::getObjectInstanceByURI($aPageParams['i'])) !== false) { + $sPageModule = $oPage->getModule(); + if(bx_srv('system', 'is_module_context', [$sPageModule]) && ($oProfile = BxDolProfile::getInstanceByContentAndType($aPageParams['id'], $sPageModule)) !== false) + return [ + 'context_module' => $sPageModule, + 'context_id' => $aPageParams['id'], + 'context_profile_id' => $oProfile->id() + ]; + } + + if(isset($aPageParams['profile_id']) && ($oProfile = BxDolProfile::getInstance($aPageParams['profile_id'])) !== false) { + $sProfileModule = $oProfile->getModule(); + if(bx_srv('system', 'is_module_context', [$sProfileModule])) + return [ + 'context_module' => $sProfileModule, + 'context_id' => $oProfile->getContentId(), + 'context_profile_id' => $aPageParams['profile_id'] + ]; + } + + return false; +} + +function bx_get_location_bounds_latlng($fLatitude, $fLongitude, $iRadiusInKm) +{ + $fEquatorLatInKm = 111.321; + $aRv = array(); + $aRv['max_lat'] = $fLatitude + $iRadiusInKm / $fEquatorLatInKm; + $aRv['min_lat'] = $fLatitude - ($aRv['max_lat'] - $fLatitude); + $aRv['max_lng'] = $fLongitude + $iRadiusInKm / (cos($aRv['min_lat'] * M_PI / 180) * $fEquatorLatInKm); + $aRv['min_lng'] = $fLongitude - ($aRv['max_lng'] - $fLongitude); + return $aRv; + +} + +function bx_encode_url_params ($a, $aExcludeKeys = array (), $aOnlyKeys = false) +{ + $s = ''; + foreach ($a as $sKey => $sVal) { + if (in_array($sKey, $aExcludeKeys)) + continue; + if (false !== $aOnlyKeys && !in_array($sKey, $aOnlyKeys)) + continue; + if (is_array($sVal)) { + foreach ($sVal as $sSubVal) { + $s .= rawurlencode($sKey) . '[]=' . rawurlencode(is_array($sSubVal) ? 'array' : $sSubVal) . '&'; + } + } else { + $s .= rawurlencode($sKey) . '=' . rawurlencode($sVal) . '&'; + } + } + return $s; +} + +/** + * It works similar to `parse_str` php function, but it doesn't decode URL params + */ +function bx_parse_str($s) +{ + $a = []; + $aPairs = explode('&', $s); + + foreach ($aPairs as $i) { + list($sName, $mixedValue) = explode('=', $i, 2); + $sName = rtrim($sName, '[]'); + + if (isset($a[$sName])) { + if (is_array($a[$sName])) + $a[$sName][] = $mixedValue; + else + $a[$sName] = [$a[$sName], $mixedValue]; + } + else { + $a[$sName] = $mixedValue; + } + } + + return $a; +} + +function bx_append_url_params ($sUrl, $mixedParams, $bEncodeParams = true, $aIgnoreParams = []) +{ + if (!$mixedParams) + return $sUrl; + + $sParams = false === strpos($sUrl, '?') ? '?' : '&'; + + if (is_array($mixedParams)) { + foreach($mixedParams as $sKey => $sValue) { + if (!is_array($sValue)) { + if ($bEncodeParams) { + if (!in_array($sKey, $aIgnoreParams)) + $sKey = rawurlencode($sKey); + if (!in_array($sValue, $aIgnoreParams)) + $sValue = rawurlencode($sValue); + } + $sParams .= $sKey . '=' . $sValue . '&'; + } + else { + foreach($sValue as $sSubValue) { + if ($bEncodeParams) { + if (!in_array($sKey, $aIgnoreParams)) + $sKey = rawurlencode($sKey); + if (!in_array($sSubValue, $aIgnoreParams)) + $sSubValue = rawurlencode($sSubValue); + } + $sParams .= $sKey . '[]=' . $sSubValue . '&'; + } + } + } + $sParams = substr($sParams, 0, -1); + } else { + $sParams .= $mixedParams; + } + return $sUrl . $sParams; +} + +function bx_process_url_param($sValue, $sPattern = "/^[\d\w_-]+$/") +{ + $mixedValue = bx_process_input($sValue); + return $mixedValue !== false && preg_match($sPattern, $mixedValue) ? $mixedValue : ''; +} + +function bx_rrmdir($directory) +{ + if (substr($directory,-1) == "/") + $directory = substr($directory,0,-1); + + if (!file_exists($directory) || !is_dir($directory)) + return false; + elseif (!is_readable($directory)) + return false; + + if (!($directoryHandle = opendir($directory))) + return false; + + while ($contents = readdir($directoryHandle)) { + if ($contents != '.' && $contents != '..') { + $path = $directory . "/" . $contents; + + if (is_dir($path)) + bx_rrmdir($path); + else + unlink($path); + } + } + + closedir($directoryHandle); + + if (!rmdir($directory)) + return false; + + return true; +} + +function bx_clear_folder ($sPath, $aExts = array ()) +{ + if (substr($$sPath,-1) == "/") + $sPath = substr($sPath,0,-1); + + if (!file_exists($sPath) || !is_dir($sPath)) + return false; + elseif (!is_readable($sPath)) + return false; + + if (!($h = opendir($sPath))) + return false; + + while ($sFile = readdir($h)) { + if ('.' == $sFile || '..' == $sFile) + continue; + + $sFullPath = $sPath . '/' . $sFile; + + if (is_dir($sFullPath)) + continue; + + if (!$aExts || (($sExt = pathinfo($sFullPath, PATHINFO_EXTENSION)) && in_array($sExt, $aExts))) + @unlink($sFullPath); + } + + closedir($h); + + return true; +} + +function bx_ltrim_str ($sString, $sPrefix, $sReplace = '') +{ + if ($sReplace && substr($sString, 0, strlen($sReplace)) == $sReplace) + return $sString; + if (substr($sString, 0, strlen($sPrefix)) == $sPrefix) + return $sReplace . substr($sString, strlen($sPrefix)); + return $sString; +} + +function bx_rtrim_str ($sString, $sPrefix, $sReplace = '') +{ + if ($sReplace && substr($sString, -strlen($sReplace)) == $sReplace) + return $sString; + if (substr($sString, -strlen($sPrefix)) == $sPrefix) + return substr($sString, 0, -strlen($sPrefix)) . $sReplace; + return $sString; +} + +/** + * Strip all lines with no information for example: , + */ +function bx_trim_nl_duplicates($s) +{ + $sStrip = implode('', array_keys(get_html_translation_table(HTML_ENTITIES))); + return implode('', array_filter(mb_split("[\n\r]", $s), function($s) use ($sStrip) { + return trim(strip_tags($s, '<img><input><object><select><svg><video>'), $sStrip) !== ''; + })); +} + +/** + * Convert array to attributes string + * + * Example: + * @code + * $a = array('name' => 'test', 'value' => 5); + * $s = bx_convert_array2attrs($a); + * echo $s; // outputs: name="test" value="5" + * @endcode + * + * @param $a - array of attributes + * @param $sClasses - classes to merge with 'class' attribute + * @param $sStyles - styles to merge with 'style' attribute + * @return string + */ +function bx_convert_array2attrs ($a, $sClasses = false, $sStyles = false) +{ + $sRet = ''; + + if (!$a || !is_array($a)) + $a = array(); + + if ($sClasses) { + $sClasses = trim($sClasses); + $a['class'] = $sClasses . (!empty($a['class']) ? ' ' . $a['class'] : ''); + } + + if ($sStyles) { + $sStyles = trim($sStyles); + if (';' != $sStyles[strlen($sStyles)-1]) + $sStyles .= ';'; + $a['style'] = $sStyles . (!empty($a['style']) ? ' ' . $a['style'] : ''); + } + + foreach ($a as $sKey => $sValue) { + if(is_null($sValue)) // pass NULL values + continue; + + $sValueC = bx_html_attribute($sValue, BX_ESCAPE_STR_QUOTE); + + $sRet .= " $sKey=\"$sValueC\""; + } + + return $sRet; +} + +function bx_unicode_urldecode($s) +{ + preg_match_all('/%u([[:alnum:]]{4})/', $s, $a); + + foreach ($a[1] as $uniord) { + $dec = hexdec($uniord); + $utf = ''; + + if ($dec < 128) { + $utf = chr($dec); + } else if ($dec < 2048) { + $utf = chr(192 + (($dec - ($dec % 64)) / 64)); + $utf .= chr(128 + ($dec % 64)); + } else { + $utf = chr(224 + (($dec - ($dec % 4096)) / 4096)); + $utf .= chr(128 + ((($dec % 4096) - ($dec % 64)) / 64)); + $utf .= chr(128 + ($dec % 64)); + } + + $s = str_replace('%u'.$uniord, $utf, $s); + } + + return urldecode($s); +} + +/** + * Raise an audit event + * @param int $iContentId - content id + * @param string $sContentModule - module name + * @param string $sAction - system action key + * @param array $aParams - array of parameters + */ +function bx_audit($iContentId, $sContentModule, $sAction, $aParams, $iProfileId = 0) +{ + if (!getParam('sys_audit_enable') || getParam('sys_audit_acl_levels') == '') + return; + + if ($iProfileId == 0) + $iProfileId = bx_get_logged_profile_id(); + + if (!BxDolAcl::getInstance()->isMemberLevelInSet(explode(',', getParam('sys_audit_acl_levels')), $iProfileId)) + return; + + $sContentTitle = $sContentInfoObject = $sContextProfileTitle = $sData = $sActionParams = ''; + $iContextProfileId = 0; + + if (isset($aParams['profile_id'])) + $iProfileId = (int)$aParams['profile_id']; + + if (isset($aParams['content_title'])) + $sContentTitle = $aParams['content_title']; + + if (isset($aParams['context_profile_id'])) + $iContextProfileId = (int)$aParams['context_profile_id']; + + if (isset($aParams['context_profile_title'])) + $sContextProfileTitle = $aParams['context_profile_title']; + + if (isset($aParams['action_params']) && is_array($aParams['action_params']) && count($aParams['action_params'])) + $sActionParams = serialize($aParams['action_params']); + + if (isset($aParams['content_info_object'])) + $sContentInfoObject = $aParams['content_info_object']; + + if (isset($aParams['data']) && is_array($aParams['data']) && count($aParams['data'])) + $sData = serialize($aParams['data']); + + $sProfileTitle = BxDolProfile::getInstance($iProfileId)->getDisplayName(); + + $oDb = BxDolDb::getInstance(); + $sSql = $oDb->prepare("INSERT INTO `sys_audit`(`added`, `profile_id`, `profile_title`, `content_id`, `content_title`, `content_module`, `context_profile_id`, `context_profile_title`, `action_lang_key`, `action_lang_key_params`, `content_info_object`, `extras`) VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)" + ,time(), $iProfileId, $sProfileTitle, $iContentId, $sContentTitle, $sContentModule, $iContextProfileId, $sContextProfileTitle, $sAction, $sActionParams ,$sContentInfoObject, $sData); + return !$oDb->query($sSql); +} + +/** + * Raise an alert + * @param string $sUnit - system type + * @param string $sAction - system action + * @param int $iObjectId - object id + * @param int $iSender - sender (action's author) profile id, if it is false - then currectly logged in profile id is used + * @param array $aExtras - extra parameters + */ +function bx_alert($sUnit, $sAction, $iObjectId, $iSender = false, $aExtras = array()) +{ + $o = new BxDolAlerts($sUnit, $sAction, $iObjectId, $iSender, $aExtras); + $o->alert(); +} + +/** + * Check whether serice method exists or not + * @param $mixed module name or module id + * @param $sMethod service method name in format 'method_name', corresponding class metod is serviceMethodName + * @param $sClass class to search for service method, by default it is main module class + * @return boolean check result + */ +function bx_is_srv($mixedModule, $sMethod, $sClass = "Module", $bIgnoreInactive = false) +{ + return BxDolRequest::serviceExists($mixedModule, $sMethod, $sClass, $bIgnoreInactive); +} + +/** + * Check whether serice method exists or not in 'Ignore Inactive' mode. + */ +function bx_is_srv_ii($mixedModule, $sMethod, $sClass = "Module") +{ + return BxDolRequest::serviceExists($mixedModule, $sMethod, $sClass, true); +} + +/** + * Perform serice call + * @param $mixed module name or module id + * @param $sMethod service method name in format 'method_name', corresponding class metod is serviceMethodName + * @param $aParams params to pass to service method + * @param $sClass class to search for service method, by default it is main module class + * @return service call result + */ +function bx_srv($mixed, $sMethod, $aParams = array(), $sClass = 'Module', $bIgnoreCache = false, $bIgnoreInactive = false) +{ + return BxDolService::call($mixed, $sMethod, $aParams, $sClass, $bIgnoreCache, $bIgnoreInactive); +} + +/** + * Perform serice call in 'Ignore Inactive' mode. + */ +function bx_srv_ii($mixed, $sMethod, $aParams = array(), $sClass = 'Module', $bIgnoreCache = false) +{ + return BxDolService::call($mixed, $sMethod, $aParams, $sClass, $bIgnoreCache, true); +} + +/** + * Perform serice call in 'Ignore Cache' mode. + */ +function bx_srv_ic($mixed, $sMethod, $aParams = array(), $sClass = 'Module', $bIgnoreInactive = false) +{ + return BxDolService::call($mixed, $sMethod, $aParams, $sClass, true, $bIgnoreInactive); +} + +function bx_replace_markers($mixed, $aMarkers) +{ + if (empty($aMarkers)) + return $mixed; + + if (is_array($mixed)) { + foreach ($mixed as $sKey => $sValue) + $mixed[$sKey] = bx_replace_markers ($sValue, $aMarkers); + } else { + foreach ($aMarkers as $sKey => $sValue) + $mixed = str_replace('{' . $sKey . '}', is_null($sValue) ? '' : $sValue, $mixed); + } + + return $mixed; +} + +function bx_site_hash($sSalt = '', $isSkipVersion = false) +{ + return md5($sSalt . ($isSkipVersion ? '' : bx_get_ver() . getParam('sys_revision')) . BX_DOL_SECRET . BX_DOL_URL_ROOT); +} + +/** + * Transform string to method name string, for example it changes 'some_method' string to 'SomeMethod' string + * @param $s string where words are separated with underscore + * @param $aWordsDelimiter word delimeters + * @return string where every word begins with capital letter + */ +function bx_gen_method_name ($s, $aWordsDelimiter = array('_')) +{ + return str_replace(' ', '', ucwords(str_replace($aWordsDelimiter, ' ', $s))); +} + +/** + * Trigger user error + * @param $sMsg message to display + * @param $iNumLevelsBack add additional debug backtracing N levels back + */ +function bx_trigger_error ($sMsg, $iNumLevelsBack = 0) +{ + $a = debug_backtrace(); + $sMsgAdd = "<br />\n related code in <b>{$a[$iNumLevelsBack]['file']}</b> on line <b>{$a[$iNumLevelsBack]['line']}</b> <br />\n"; + trigger_error ($sMsg . $sMsgAdd, E_USER_ERROR); +} + +/** + * Get system DB version, for files version @see BX_DOL_VERSION, these versions must match + */ +function bx_get_ver ($bInvalidateCache = false) +{ + $oDb = BxDolDb::getInstance(); + + if ($bInvalidateCache) + $oDb->cleanMemory('sys_version'); + + $sQuery = $oDb->prepare("SELECT `version` FROM `sys_modules` WHERE `name` = 'system'"); + return $oDb->fromMemory('sys_version', 'getOne', $sQuery); +} + +function bx_check_debug_mode() +{ + if(!bx_is_dbg()) + return; + + ini_set('display_errors', 'On'); + error_reporting(E_ALL); +} + +/** + * Check if site maintetance mode is enabled. + * Maintetance mode is enabled when '.bx_maintenance' file exists in the script root folder, + * please note that this is hidden file and some file managers don't show it. + * @param $bShowHttpError show 503 HTTP error if site is in mainenance mode + * @return true if site is in maintenance mode, or false otherwise + */ +function bx_check_maintenance_mode ($bShowHttpError = false) +{ + $bMaintetance = file_exists(BX_DIRECTORY_PATH_ROOT . BX_MAINTENANCE_FILE) && !defined('BX_DOL_UPGRADING'); + + if ($bMaintetance && $bShowHttpError) + bx_show_service_unavailable_error_and_exit ('Site is temporarily unavailable due to scheduled maintenance, please try again in a minute.', 600); + + return $bMaintetance; +} + +/** + * Check for minimal requirements. + * if BX_DISABLE_REQUIREMENTS_CHECK is defined then this requirements checking is skipped. + * @param $bShowHttpError show 503 HTTP error if site doesn't meet minimal requirements + * @return false if requirements are met, or array of errors of requirements aren't met + */ +function bx_check_minimal_requirements ($bShowHttpError = false) +{ + if (defined('BX_DISABLE_REQUIREMENTS_CHECK')) + return false; + + $aErrors = array(); + + $aErrors[] = (ini_get('register_globals') == 0) ? '' : '<b>register_globals</b> is on (you need to disable it, or your site will be unsafe)'; + $aErrors[] = (ini_get('safe_mode') == 0) ? '' : '<b>safe_mode</b> is on (you need to disable it)'; + $aErrors[] = (version_compare(PHP_VERSION, '5.3.0', '<')) ? 'PHP version is too old (please update to <b>PHP 5.3.0</b> at least)' : ''; + $aErrors[] = (!extension_loaded( 'mbstring')) ? '<b>mbstring</b> extension not installed (the script cannot work without it)' : ''; + $aErrors[] = (ini_get('allow_url_include') == 0 || version_compare(PHP_VERSION, '8.0.0', '>=')) ? '' : '<b>allow_url_include</b> is on (you need to disable it, or your site will be unsafe)'; + + $aErrors = array_diff($aErrors, array('')); // delete empty + + $bFailedMinimalRequirements = !empty($aErrors); + + if ($bFailedMinimalRequirements && $bShowHttpError) { + $sErrors = implode(" <br /> ", $aErrors); + bx_show_service_unavailable_error_and_exit($sErrors); + } + + return $bFailedMinimalRequirements ? $aErrors : false; +} + +/** + * Check if redirect to the correct hostname is required, for example redirect from site.com to www.site.com + * @param $bProcessRedirect process redirect and exit if needed + */ +function bx_check_redirect_to_correct_hostname ($bProcessRedirect = false) +{ + $aUrl = parse_url(BX_DOL_URL_ROOT); + $iPortDefault = 'https' == $aUrl['scheme'] ? '443' : '80'; + + $bRedirectRequired = isset($_SERVER['HTTP_HOST']) && 0 !== strcasecmp($_SERVER['HTTP_HOST'], $aUrl['host']) && 0 !== strcasecmp($_SERVER['HTTP_HOST'], $aUrl['host'] . ':' . (!empty($aUrl['port']) ? $aUrl['port'] : $iPortDefault)); + + if ($bRedirectRequired && $bProcessRedirect) { + header("Location:" . bx_get_self_url(), true, 301); + exit; + } + + return $bRedirectRequired; +} + +/** + * Get URL of current page + */ +function bx_get_self_url () +{ + $aUrl = parse_url(BX_DOL_URL_ROOT); + $sPort = empty($aUrl['port']) || 80 == $aUrl['port'] || 443 == $aUrl['port'] ? '' : ':' . $aUrl['port']; + return "{$aUrl['scheme']}://{$aUrl['host']}{$sPort}{$_SERVER['REQUEST_URI']}"; +} + +/** + * Check if redirect to remove install folder. + * If BX_SKIP_INSTALL_CHECK is defined then this redirect checking is skipped. + * @param $bProcessRedirect process redirect and exit if needed + */ +function bx_check_redirect_to_remove_install_folder ($bProcessRedirect = false) +{ + $bRemoveInstallFolder = !defined ('BX_SKIP_INSTALL_CHECK') && file_exists(BX_DIRECTORY_PATH_ROOT . 'install'); + + if ($bRemoveInstallFolder && $bProcessRedirect) { + header('Location:' . BX_DOL_URL_ROOT . 'install/index.php?action=remove_install'); + exit; + } + + return $bRemoveInstallFolder; +} + +/** + * Show HTTP 503 service unavailable error and exit + */ +function bx_show_service_unavailable_error_and_exit ($sMsg = false, $iRetryAfter = 86400) +{ + header('HTTP/1.0 503 Service Unavailable', true, 503); + header('Retry-After: 600'); + echo $sMsg ? $sMsg : 'Service temporarily unavailable'; + exit; +} + +/** + * The function is sumilar to php readfile, but it send all required headers and can send file by chunks and suports file seek + * @param $sPath path to file to output to the browser + * @param $sFilename filename without path, ig file is saved from browser, then this name is used, not used(empty) by default + * @param $sMimeType file mime type, by default 'application/octet-stream' + * @param $iCacheAge file cache age, by default 0 + * @param $sCachePrivacy cache privacy 'public' (default value) or 'private' + * @param $sContentDisposition content disposition header ('inline' or 'attachment' usually + * @return true on success or false on error + */ +function bx_smart_readfile($sPath, $sFilename = '', $sMimeType = 'application/octet-stream', $iCacheAge = 0, $sCachePrivacy = 'public', $sContentDisposition = 'inline') +{ + if (!file_exists($sPath)) + return false; + + $fp = @fopen($sPath, 'rb'); + + $size = filesize($sPath); + $length = $size; + $start = 0; + $end = $size - 1; + + header('Content-Type: ' . $sMimeType); + header('Cache-Control: ' . $sCachePrivacy . ', must-revalidate, max-age=' . $iCacheAge); + header("Expires: " . gmdate('D, d M Y H:i:s', time() + $iCacheAge) . ' GMT'); + header("Last-Modified: " . gmdate('D, d M Y H:i:s', @filemtime($sPath)) . ' GMT'); + header("Accept-Ranges: bytes"); + if ($sFilename) + header('Content-Disposition: ' . $sContentDisposition . '; filename="' . $sFilename . '"'); + + if (isset($_SERVER['HTTP_RANGE'])) { + + $c_start = $start; + $c_end = $end; + + list(, $range) = explode('=', $_SERVER['HTTP_RANGE'], 2); + if (strpos($range, ',') !== false) { + header('HTTP/1.1 416 Requested Range Not Satisfiable'); + header("Content-Range: bytes $start-$end/$size"); + return false; + } + if ($range == '-') { + $c_start = $size - substr($range, 1); + }else{ + $range = explode('-', $range); + $c_start = $range[0]; + $c_end = (isset($range[1]) && is_numeric($range[1])) ? $range[1] : $size; + } + $c_end = ($c_end > $end) ? $end : $c_end; + if ($c_start > $c_end || $c_start > $size - 1 || $c_end >= $size) { + header('HTTP/1.1 416 Requested Range Not Satisfiable'); + header("Content-Range: bytes $start-$end/$size"); + return false; + } + $start = $c_start; + $end = $c_end; + $length = $end - $start + 1; + fseek($fp, $start); + header('HTTP/1.1 206 Partial Content'); + } + header("Content-Range: bytes $start-$end/$size"); + header("Content-Length: ".$length); + + set_time_limit(0); + $buffer = 1024 * 8; + while(!feof($fp) && ($p = ftell($fp)) <= $end) { + + if ($p + $buffer > $end) { + $buffer = $end - $p + 1; + } + echo fread($fp, $buffer); + flush(); + } + + fclose($fp); + + return true; +} + +/** + * Wrap in A tag links in TEXT string + * @param $text - text string without tags + * @param $sAttrs - attributes string to add to the added A tag + * @param $bHtmlSpecialChars - apply htmlspecialchars before processing + * @return string where all links are wrapped in A tag + */ +function bx_linkify($text, $sAttrs = '', $bHtmlSpecialChars = false) +{ + if ($bHtmlSpecialChars) + $text = htmlspecialchars($text, ENT_NOQUOTES, 'UTF-8'); + + $re = "@\b((https?://)|(www\.))(([0-9a-zA-Z_!~*'().&=+$%-]+:)?[0-9a-zA-Z_!~*'().&=+$%-]+\@)?(([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-zA-Z_!~*'()-]+\.)*([0-9a-zA-Z][0-9a-zA-Z-]{0,61})?[0-9a-zA-Z]\.[a-zA-Z]{2,16})(:[0-9]{1,4})?((/[0-9a-zA-Z_!~*'().;?:\@&=+$,%#-]+)*/?)@"; + preg_match_all($re, $text, $matches, PREG_OFFSET_CAPTURE); + + $matches = $matches[0]; + + if ($i = count($matches)) + $bAddNofollow = getParam('sys_add_nofollow') == 'on'; + + while ($i--) + { + $sAttrsLocal = $sAttrs; + $url = $matches[$i][0]; + if (!preg_match('@^https?://@', $url)) + $url = 'http://'.$url; + + if (strncmp(BX_DOL_URL_ROOT, $url, strlen(BX_DOL_URL_ROOT)) !== 0) { + $sAttrsLocal .= ' target="_blank" '; + if ($bAddNofollow) + $sAttrsLocal .= ' rel="nofollow" '; + } + + $text = substr_replace($text, '<a ' . $sAttrsLocal . ' href="'.$url.'">'.$matches[$i][0].'</a>', $matches[$i][1], strlen($matches[$i][0])); + } + + // email pattern + $mail_pattern = "/([A-z0-9\._-]+\@[A-z0-9_-]+\.)([A-z0-9\_\-\.]{1,}[A-z])/"; + $text = preg_replace($mail_pattern, '<a href="mailto:$1$2">$1$2</a>', $text); + + return $text; +} + +function bx_linkify_embeded($sText) +{ + $sRegex = '/\b((https?:\/\/)|(www\.))((([0-9a-zA-Z_!~*\'().&=+$%-]+:)?[0-9a-zA-Z_!~*\'().&=+$%-]+@)?(([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-zA-Z_!~*\'()-]+\.)*([0-9a-zA-Z][0-9a-zA-Z-]{0,61})?[0-9a-zA-Z]\.[a-zA-Z]{2,16})(:[0-9]{1,4})?((\/[0-9a-zA-Z_!~*\'().;?:@&=+$,%#-]*)*))/'; + $aMatches = []; + preg_match_all($sRegex, $sText, $aMatches, PREG_SET_ORDER); + + // Reverse the matches to mimic JavaScript's reverse order processing + $aMatches = array_reverse($aMatches); + + $sUrlRoot = BX_DOL_URL_ROOT; + $sUrlRootApi = bx_api_get_base_url(); + + $sLink = ''; + foreach($aMatches as $aMatch) { + if(!strstr($aMatch[0], $sUrlRoot) && ($sUrlRootApi === false || !strstr($aMatch[0], $sUrlRootApi))) { + $sLink = $aMatch[0]; // Returns the first URL that doesn't include the restricted domains + } + } + + $sResult = ''; + if($sLink) { + bx_import('BxDolEmbed'); + if(($oEmbed = BxDolEmbed::getObjectInstance('sys_system')) !== false) + $sResult = $oEmbed->getLinkHTML($sLink); + } + + return $sResult; +} + +/** + * Wrap in A tag links in HTML string, which aren't wrapped in A tag yet + * @param $sHtmlOrig - HTML string + * @param $sAttrs - attributes string to add to the added A tag + * @return modified HTML string, in case of errror original string is returned + */ +function bx_linkify_html($sHtmlOrig, $sAttrs = '') +{ + if (!trim($sHtmlOrig)) + return $sHtmlOrig; + + $sId = 'bx-linkify-' . md5(microtime()); + $dom = new DOMDocument(); + @$dom->loadHTML('<?xml encoding="UTF-8"><div id="' . $sId . '">' . $sHtmlOrig . '</div>'); + $xpath = new DOMXpath($dom); + + foreach ($xpath->query('//text()') as $text) { + if (!empty($text->parentNode) && !empty($text->parentNode->tagName) && 'a' == $text->parentNode->tagName) + continue; + $frag = $dom->createDocumentFragment(); + @$frag->appendXML(bx_linkify($text->nodeValue, $sAttrs, true)); + $text->parentNode->replaceChild($frag, $text); + } + + if (version_compare(PHP_VERSION, '5.3.6') >= 0) + $s = $dom->saveHTML($dom->getElementById($sId)); + else + $s = $dom->saveXML($dom->getElementById($sId), LIBXML_NOEMPTYTAG); + + if (false === $s) // in case of error return original string + return $sHtmlOrig; + + if (false !== ($iPos = mb_strpos($s, '<html><body>')) && $iPos < mb_strpos($s, $sId)) + $s = mb_substr($s, $iPos + 12, -15); // strip <html><body> tags and everything before them + + return mb_substr($s, 54, -6); // strip added tags +} + +/** + * Returns current site protocol http:// or https:// + */ +function bx_proto() +{ + return 0 === strncmp('https', BX_DOL_URL_ROOT, 5) ? 'https' : 'http'; +} + +/** + * Checks protocol in the link + */ +function bx_has_proto($sLink) +{ + return preg_match('@^https?://@', $sLink); +} + +function bx_is_empty_array ($a) +{ + if (!is_array($a)) + return true; + if (empty($a)) + return true; + foreach ($a as $k => $v) + if ($v) + return false; + return true; +} + +function bx_is_full_array ($a) +{ + if (!is_array($a)) + return false; + if (empty($a)) + return false; + foreach ($a as $k => $v) + if (empty($v)) + return false; + return true; +} + +function bx_is_url_in_content ($sContent, $bSkipLocalUrls = false) +{ + if ($bSkipLocalUrls) + $sContent = str_replace(BX_DOL_URL_ROOT, '', $sContent); + + $a = array( + 'http://', + 'https://', + 'https/', + 'http/', + 'www.', + '.com' + ); + foreach ($a as $s) + if (false !== strpos($sContent, $s)) + return true; + + return false; +} + +function bx_is_dynamic_request () +{ + return bx_get('dynamic') || (isset($_SERVER['HTTP_X_REQUESTED_WITH']) && 'XMLHttpRequest' == $_SERVER['HTTP_X_REQUESTED_WITH']); +} + +function bx_is_htmx_request () +{ + return !empty($_SERVER['HTTP_HX_REQUEST']); +} + +function bx_get_htmx_target () +{ + if(!bx_is_htmx_request()) + return false; + + return isset($_SERVER['HTTP_HX_TARGET']) ? $_SERVER['HTTP_HX_TARGET'] : false; +} + +function bx_get_htmx_attrs ($aAttrs, $mPreload = false) +{ + if(!$aAttrs) + return ''; + + if($mPreload === true) + $mPreload = 'mousedown'; + + $aHxAttrs = []; + array_walk($aAttrs, function($mixedValue, $sIndex) use (&$aHxAttrs) { + $aHxAttrs['hx-' . $sIndex] = $mixedValue; + }); + + return bx_convert_array2attrs($aHxAttrs) . ($mPreload ? ' preload="' . $mPreload . '"' : ''); +} + +function bx_idn_to_utf8($sUrl, $bReturnDomain = false) +{ + return bx_idn_to('idn_to_utf8', $sUrl, $bReturnDomain); +} + +function bx_idn_to_ascii($sUrl, $bReturnDomain = false) +{ + return bx_idn_to('idn_to_ascii', $sUrl, $bReturnDomain); +} + +function bx_idn_to($sMethod, $sUrl, $bReturnDomain = false) +{ + $aUrl = parse_url($sUrl); + if($aUrl === false) + return $sUrl; + + $sResult = $aUrl['host']; + if(function_exists($sMethod)) + $sResult = $sMethod($sResult, IDNA_DEFAULT, (defined('INTL_IDNA_VARIANT_UTS46') ? INTL_IDNA_VARIANT_UTS46 : INTL_IDNA_VARIANT_2003)); + + if($bReturnDomain) + return $sResult; + + $sResult = (!empty($aUrl['scheme']) ? $aUrl['scheme'] . '://' : '' ) . $sResult; + $sResult = $sResult . (!empty($aUrl['path']) ? $aUrl['path'] : ''); + $sResult = $sResult . (!empty($aUrl['query']) ? '?' . $aUrl['query'] : ''); + + return $sResult; +} + +function bx_is_mobile() +{ + if(!isset($_SERVER['HTTP_USER_AGENT'])) + return false; + + $s = $_SERVER['HTTP_USER_AGENT']; + return preg_match('/(android|bb\d+|meego|una).+mobile|avantgo|bada\/|blackberry|blazer|compal|elaine|fennec|hiptop|iemobile|ip(hone|od)|iris|kindle|lge |maemo|midp|mmp|mobile.+firefox|netfront|opera m(ob|in)i|palm( os)?|phone|p(ixi|re)\/|plucker|pocket|psp|series(4|6)0|symbian|treo|up\.(browser|link)|vodafone|wap|windows ce|xda|xiino/i', $s) || preg_match('/1207|6310|6590|3gso|4thp|50[1-6]i|770s|802s|a wa|abac|ac(er|oo|s\-)|ai(ko|rn)|al(av|ca|co)|amoi|an(ex|ny|yw)|aptu|ar(ch|go)|as(te|us)|attw|au(di|\-m|r |s )|avan|be(ck|ll|nq)|bi(lb|rd)|bl(ac|az)|br(e|v)w|bumb|bw\-(n|u)|c55\/|capi|ccwa|cdm\-|cell|chtm|cldc|cmd\-|co(mp|nd)|craw|da(it|ll|ng)|dbte|dc\-s|devi|dica|dmob|do(c|p)o|ds(12|\-d)|el(49|ai)|em(l2|ul)|er(ic|k0)|esl8|ez([4-7]0|os|wa|ze)|fetc|fly(\-|_)|g1 u|g560|gene|gf\-5|g\-mo|go(\.w|od)|gr(ad|un)|haie|hcit|hd\-(m|p|t)|hei\-|hi(pt|ta)|hp( i|ip)|hs\-c|ht(c(\-| |_|a|g|p|s|t)|tp)|hu(aw|tc)|i\-(20|go|ma)|i230|iac( |\-|\/)|ibro|idea|ig01|ikom|im1k|inno|ipaq|iris|ja(t|v)a|jbro|jemu|jigs|kddi|keji|kgt( |\/)|klon|kpt |kwc\-|kyo(c|k)|le(no|xi)|lg( g|\/(k|l|u)|50|54|\-[a-w])|libw|lynx|m1\-w|m3ga|m50\/|ma(te|ui|xo)|mc(01|21|ca)|m\-cr|me(rc|ri)|mi(o8|oa|ts)|mmef|mo(01|02|bi|de|do|t(\-| |o|v)|zz)|mt(50|p1|v )|mwbp|mywa|n10[0-2]|n20[2-3]|n30(0|2)|n50(0|2|5)|n7(0(0|1)|10)|ne((c|m)\-|on|tf|wf|wg|wt)|nok(6|i)|nzph|o2im|op(ti|wv)|oran|owg1|p800|pan(a|d|t)|pdxg|pg(13|\-([1-8]|c))|phil|pire|pl(ay|uc)|pn\-2|po(ck|rt|se)|prox|psio|pt\-g|qa\-a|qc(07|12|21|32|60|\-[2-7]|i\-)|qtek|r380|r600|raks|rim9|ro(ve|zo)|s55\/|sa(ge|ma|mm|ms|ny|va)|sc(01|h\-|oo|p\-)|sdk\/|se(c(\-|0|1)|47|mc|nd|ri)|sgh\-|shar|sie(\-|m)|sk\-0|sl(45|id)|sm(al|ar|b3|it|t5)|so(ft|ny)|sp(01|h\-|v\-|v )|sy(01|mb)|t2(18|50)|t6(00|10|18)|ta(gt|lk)|tcl\-|tdg\-|tel(i|m)|tim\-|t\-mo|to(pl|sh)|ts(70|m\-|m3|m5)|tx\-9|up(\.b|g1|si)|utst|v400|v750|veri|vi(rg|te)|vk(40|5[0-3]|\-v)|vm40|voda|vulc|vx(52|53|60|61|70|80|81|83|85|98)|w3c(\-| )|webc|whit|wi(g |nc|nw)|wmlb|wonu|x700|yas\-|your|zeto|zte\-/i', substr($s, 0, 4)); +} + +function bx_get_device_pixel_ratio() +{ + $iRatio = 1; + if(!isset($_COOKIE['devicePixelRatio'])) + return $iRatio; + + $iDevicePixelRatio = intval($_COOKIE['devicePixelRatio']); + if($iDevicePixelRatio >= 2) + $iRatio = 2; + + return $iRatio; +} + +/** + * Log to logs object + * @param $sObject - logs object + * @param $mixed - string or array to log + */ +function bx_log($sObject, $mixed) +{ + if (class_exists('BxDolLogs', true) && $o = BxDolLogs::getObjectInstance($sObject)) + return $o->add($mixed); + else + return false; +} + +function bx_birthday2age($sBirthday) +{ + $iPosSpace = strpos($sBirthday, ' '); + if($iPosSpace !== false) + $sBirthday = trim(substr($sBirthday, 0, $iPosSpace)); + + $aDate = explode('-', $sBirthday); + + $iCdYear = (int)date('Y'); + $iCdMonth = (int)date('n'); + $iCdDay = (int)date('j'); + + $iResult = $iCdYear - (int)$aDate[0]; + if($iCdMonth < (int)$aDate[1] || ($iCdMonth == (int)$aDate[1] && $iCdDay < (int)$aDate[2])) + $iResult -= 1; + + return $iResult; +} + +function bx_setcookie($sName, $sValue = "", $oExpiresOrOptions = 0, $sPath = 'auto', $sDomain = '', $bSecure = 'auto', $bHttpOnly = false) +{ + + $aUrl = 'auto' === $sPath || 'auto' === $bSecure ? parse_url(BX_DOL_URL_ROOT) : []; + + if (defined('BX_MULTISITE_URL_COOKIE')) { + $aUrl = parse_url(BX_MULTISITE_URL_COOKIE); + $sDomain = $aUrl['host']; + } + + if (bx_is_api()) + $sPath = trim(getParam('sys_api_cookie_path')); + elseif ('auto' === $sPath) + $sPath = isset($aUrl['path']) && !empty($aUrl['path']) ? $aUrl['path'] : '/'; + + if (bx_is_api()) + $bSecure = !!getParam('sys_api_cookie_secure'); + elseif ('auto' === $bSecure) + $bSecure = 0 === strcasecmp('https', $aUrl['scheme']); + + if (PHP_VERSION_ID < 70300) { + if (!defined('BX_MULTISITE_URL_COOKIE') && ('memberPassword' == $sName || 'memberSession' == $sName)) + $sPath .= '; SameSite=' . (bx_is_api() ? getParam('sys_api_cookie_samesite') : getParam('sys_samesite_cookies')); + return setcookie($sName, $sValue, $oExpiresOrOptions, $sPath, $sDomain, $bSecure, $bHttpOnly); + } + else { + $aOptions = is_array($oExpiresOrOptions) ? $oExpiresOrOptions : [ + 'expires' => $oExpiresOrOptions, + 'path' => $sPath, + 'domain' => $sDomain, + 'secure' => $bSecure, + 'httponly' => $bHttpOnly, + ]; + if (!defined('BX_MULTISITE_URL_COOKIE') && !isset($aOptions['samesite']) && ('memberPassword' == $sName || 'memberSession' == $sName)) + $aOptions['samesite'] = bx_is_api() ? getParam('sys_api_cookie_samesite') : getParam('sys_samesite_cookies'); + return setcookie($sName, $sValue, $aOptions); + } +} + +function bx_get_ip_hash($sIp) +{ + return sprintf("%u", crc32(crc32($sIp) + crc32(BX_DOL_SECRET))); +} + +function is_private_ip ($sIp) +{ + if (filter_var($sIp, FILTER_VALIDATE_IP, FILTER_FLAG_IPV4 | FILTER_FLAG_IPV6) !== $sIp) + return false; + + return filter_var($sIp, FILTER_VALIDATE_IP, FILTER_FLAG_IPV4 | FILTER_FLAG_IPV6 | FILTER_FLAG_NO_PRIV_RANGE | FILTER_FLAG_NO_RES_RANGE) !== $sIp; +} + +function bx_absolute_url($sUrl, $sPrefix = BX_DOL_URL_ROOT) +{ + if (!preg_match('/^https?:\/\//', $sUrl)) + $sUrl = $sPrefix . $sUrl; + return $sUrl; +} + +function bx_is_api() +{ + return defined('BX_API') || bx_get('api') ? true : false; +} + +function bx_api_get_sql($q) +{ + $sql = false; + $t = false; + if ($q == 'accounts_count'){ + $sql = 'SELECT Count(*) FROM sys_accounts'; + $t = 'One'; + } + + if ($sql){ + $oDb = BxDolDb::getInstance(); + if ($t == 'One') + echo json_encode($oDb->getOne($sql)); + else + echo json_encode($oDb->getAll($sql)); + exit; + } +} + +function bx_api_check_access() +{ + if (!getParam('sys_api_enable')) { + header('HTTP/1.0 403 Forbidden'); + BxDolLanguages::getInstance(); + echo json_encode(['status' => 403, 'error' => _t("_Access denied")]); + exit; + } + + $aHeaders = function_exists('getallheaders') ? getallheaders() : false; + if ($aHeaders) { + $sOriginHeader = isset($aHeaders['Origin']) ? $aHeaders['Origin'] : false; + $sAuthHeader = isset($aHeaders['Authorization']) ? $aHeaders['Authorization'] : false; + } + else { + $sOriginHeader = isset($_SERVER['HTTP_ORIGIN']) ? $_SERVER['HTTP_ORIGIN'] : false; + $sAuthHeader = isset($_SERVER['HTTP_AUTHORIZATION']) ? $_SERVER['HTTP_AUTHORIZATION'] : false; + } + + if ($sAuthHeader && getParam('sys_api_access_by_key')) { + if (!BxDolApiQuery::getInstance()->getKey(str_replace('Bearer ', '', $sAuthHeader))) { + header('HTTP/1.0 403 Forbidden'); + BxDolLanguages::getInstance(); + echo json_encode(['status' => 403, 'error' => _t("_Access denied")]); + exit; + } + if(bx_get('r') == 'q'){ + bx_api_get_sql(bx_get('q')); + } + } + elseif (getParam('sys_api_access_by_origin') && $sOriginHeader) { + + if (parse_url($sOriginHeader, PHP_URL_HOST) != parse_url(BX_DOL_URL_ROOT, PHP_URL_HOST)) { + + if (!BxDolApiQuery::getInstance()->getOrigin($sOriginHeader)) { + header('HTTP/1.0 403 Forbidden'); + BxDolLanguages::getInstance(); + echo json_encode(['status' => 403, 'error' => _t("_Access denied")]); + exit; + } + + header('Access-Control-Allow-Origin: ' . $sOriginHeader); + header('Access-Control-Allow-Credentials: true'); + + if(bx_get('r') == 'q'){ + bx_api_get_sql(bx_get('q')); + } + + if ('OPTIONS' == $_SERVER['REQUEST_METHOD']) { + header('Access-Control-Allow-Methods: POST, GET'); + header('Access-Control-Allow-Headers: Accept-Encoding, Authorization, Cache-Control, Connection, Host, Origin, Pragma, Referer, User-Agent, X-Custom-Header, X-Requested-With'); + exit; + } + } + } + else { + header('HTTP/1.0 403 Forbidden'); + BxDolLanguages::getInstance(); + echo json_encode(['status' => 403, 'error' => _t("_Access denied")]); + exit; + } + + // TODO: Temporarily to use logged state + // bx_login(1); + // check_logged(); +} + +function bx_api_get_base_url() +{ + if(($sResult = getParam('sys_api_url_root_email')) != '') + return $sResult; + + if(($sResult = getParam('sys_api_url_root_push')) != '') + return $sResult; + + return false; +} + +function bx_api_get_relative_url($sUrl, $sPrefix = BX_DOL_URL_ROOT) +{ + return '/' . bx_ltrim_str($sUrl, $sPrefix); +} + +function bx_api_get_block($sType, $sData, $aParams = []) +{ $aData = ['id' => isset($aParams['id']) ? $aParams['id'] : 1 , 'type' => $sType, 'data' => $sData]; + if (isset($aParams['ext'])) + $aData = array_merge($aData, $aParams['ext']); + return $aData; +} + +function bx_api_get_msg($sMessage, $aParams = []) +{ + return bx_api_get_block('msg', $sMessage != '' ? _t($sMessage) : '', $aParams); +} + +function bx_api_get_image($sStorage, $iId) +{ + $oS = BxDolStorage::getObjectInstance($sStorage); + $aFile = $oS->getFile($iId); + $sUrl = $oS->getFileUrlById($iId); + $iWidth = 500; + $iHeight = 500; + + if(!empty($aFile['dimensions'])){ + $aTmp = explode('x', $aFile['dimensions']); + $iWidth = (int) $aTmp[0]; + $iHeight = (int) $aTmp[1]; + } + if (!empty($sUrl)){ + return [ + 'storage' => $sStorage, + 'src' => $sUrl, + 'width' => $iWidth, + 'height' => $iHeight, + ]; + } + return false; +} + +function bx_api_get_browse_params($sParams, $bParamsOnly = false) +{ + if(!$sParams || !is_string($sParams)) + return []; + + $aParams = json_decode($sParams, true); + if(isset($aParams['params']['validate']) && !is_array($aParams['params']['validate'])) + $aParams['params']['validate'] = !empty($aParams['params']['validate']) ? explode(',', $aParams['params']['validate']) : []; + + if(!$bParamsOnly) + return $aParams; + + if(!isset($aParams['params'])) + return []; + + return $aParams['params']; +} +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/inc/version.inc.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/inc/version.inc.php new file mode 100644 index 0000000000..17209ebdb3 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/inc/version.inc.php @@ -0,0 +1,12 @@ +<?php defined('BX_DOL') or defined('BX_DOL_INSTALL') or die('hack attempt'); +/** + * Copyright (c) UNA, Inc - https://una.io + * MIT License - https://opensource.org/licenses/MIT + * + * @defgroup UnaCore UNA Core + * @{ + */ + +define('BX_DOL_VERSION', '14.0.0-RC1'); ///< system files version, for DB version @see bx_get_ver, DB and files version must match + +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/general/classes/BxBaseModGeneralFormEntry.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/general/classes/BxBaseModGeneralFormEntry.php new file mode 100644 index 0000000000..1d17356e14 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/general/classes/BxBaseModGeneralFormEntry.php @@ -0,0 +1,1160 @@ +<?php defined('BX_DOL') or die('hack attempt'); +/** + * Copyright (c) UNA, Inc - https://una.io + * MIT License - https://opensource.org/licenses/MIT + * + * @defgroup BaseGeneral Base classes for modules + * @ingroup UnaModules + * + * @{ + */ + +/** + * Create/edit entry form + */ +class BxBaseModGeneralFormEntry extends BxTemplFormView +{ + protected static $_isCssJsGeneralModuleAdded = false; + + protected $MODULE; + + protected $_oModule; + + protected $_aMetatagsFieldsWithKeywords = array(); + protected $_oMetatagsObject = null; + protected $_oMetatagsContentId = 0; + + protected $_sGhostTemplate = 'form_ghost_template.html'; + + protected $_aTrackFieldsChanges; + + protected $_iContentId; + + protected $_bAllowChangeUserForAdmins; + + public function __construct($aInfo, $oTemplate = false) + { + if (!isset($this->_bAllowChangeUserForAdmins)) + $this->_bAllowChangeUserForAdmins = true; + + parent::__construct($aInfo, $oTemplate); + + $this->_oModule = BxDolModule::getInstance($this->MODULE); + + $this->_aTrackFieldsChanges = array(); + + $CNF = &$this->_oModule->_oConfig->CNF; + + if (isset($CNF['FIELD_ADDED']) && isset($this->aInputs[$CNF['FIELD_ADDED']])) { + $this->aInputs[$CNF['FIELD_ADDED']]['date_filter'] = BX_DATA_INT; + $this->aInputs[$CNF['FIELD_ADDED']]['date_format'] = BX_FORMAT_DATE; + } + + if (isset($CNF['FIELD_CHANGED']) && isset($this->aInputs[$CNF['FIELD_CHANGED']])) { + $this->aInputs[$CNF['FIELD_CHANGED']]['date_filter'] = BX_DATA_INT; + $this->aInputs[$CNF['FIELD_CHANGED']]['date_format'] = BX_FORMAT_DATE; + } + + if (isset($CNF['FIELD_TEXT']) && isset($this->aInputs[$CNF['FIELD_TEXT']]) && isset($CNF['FIELD_TEXT_ID'])) { + $this->aInputs[$CNF['FIELD_TEXT']]['attrs'] = array_merge ( + array ('id' => $CNF['FIELD_TEXT_ID']), + is_array($this->aInputs[$CNF['FIELD_TEXT']]['attrs']) ? $this->aInputs[$CNF['FIELD_TEXT']]['attrs'] : array () + ); + } + + if (isset($CNF['FIELD_LABELS']) && isset($this->aInputs[$CNF['FIELD_LABELS']]) && !empty($CNF['OBJECT_METATAGS']) && ($oMetatags = BxDolMetatags::getObjectInstance($CNF['OBJECT_METATAGS'])) && $oMetatags->keywordsIsEnabled()) { + $this->aInputs[$CNF['FIELD_LABELS']]['meta_object'] = $CNF['OBJECT_METATAGS']; + } + + if (isset($CNF['FIELD_LOCATION_PREFIX']) && isset($this->aInputs[$CNF['FIELD_LOCATION_PREFIX']])) { + $this->aInputs[$CNF['FIELD_LOCATION_PREFIX']]['manual_input'] = true; + } + + // add ability to change author by admins in some apps + if (!empty($CNF['FIELD_AUTHOR']) && ($this->_oModule->_isModerator() || $this->_oModule->_isAdministrator()) && $this->_isChangeUserForAdmins($this->aParams['display'])) + $this->aInputs = array_merge([ + $CNF['FIELD_AUTHOR'] => [ + 'type' => 'custom', + 'name' => $CNF['FIELD_AUTHOR'], + 'db' => ['pass' => 'Xss'], + 'caption' => _t('_sys_form_input_caption_author') + ], + ], $this->aInputs); + + if (isset($CNF['FIELD_PHOTO']) && isset($this->aInputs[$CNF['FIELD_PHOTO']])) { + $this->aInputs[$CNF['FIELD_PHOTO']]['storage_object'] = $CNF['OBJECT_STORAGE']; + $this->aInputs[$CNF['FIELD_PHOTO']]['uploaders'] = !empty($this->aInputs[$CNF['FIELD_PHOTO']]['value']) ? unserialize($this->aInputs[$CNF['FIELD_PHOTO']]['value']) : $CNF['OBJECT_UPLOADERS']; + $this->aInputs[$CNF['FIELD_PHOTO']]['images_transcoder'] = $CNF['OBJECT_IMAGES_TRANSCODER_PREVIEW']; + $this->aInputs[$CNF['FIELD_PHOTO']]['storage_private'] = 0; + $this->aInputs[$CNF['FIELD_PHOTO']]['multiple'] = true; + $this->aInputs[$CNF['FIELD_PHOTO']]['content_id'] = 0; + $this->aInputs[$CNF['FIELD_PHOTO']]['ghost_template'] = ''; + } + + $aPrivacyFields = $this->_getPrivacyFields(); + foreach($aPrivacyFields as $sField => $sObject) + $this->_preparePrivacyField($sField, $sObject); + + foreach($this->aInputs as $sKey => $aInput) { + if ($aInput['type'] == 'nested_form'){ + $this->genGhostTemplateForInputNestedForm ($this->aInputs[$sKey]); + } + } + } + + protected function _isChangeUserForAdmins($sDisplay) + { + $CNF = &$this->_oModule->_oConfig->CNF; + + if(!$this->_bAllowChangeUserForAdmins) + return false; + + if(isset($CNF['OBJECT_FORM_ENTRY_DISPLAY_ADD']) && $sDisplay == $CNF['OBJECT_FORM_ENTRY_DISPLAY_ADD']) + return true; + + if(isset($CNF['OBJECT_FORM_ENTRY_DISPLAY_EDIT']) && $sDisplay == $CNF['OBJECT_FORM_ENTRY_DISPLAY_EDIT']) + return true; + + return false; + } + + function getCode($bDynamicMode = false) + { + $CNF = &$this->_oModule->_oConfig->CNF; + + if(!$bDynamicMode && bx_is_dynamic_request()) + $bDynamicMode = true; + + $sResult = parent::getCode($bDynamicMode); + + $aPrivacyFields = $this->_getPrivacyFields(); + foreach($aPrivacyFields as $sField => $sObject) + $this->_addCssJsPrivacyField($sField, $sObject, $bDynamicMode); + + if(isset($CNF['PARAM_MULTICAT_ENABLED']) && $CNF['PARAM_MULTICAT_ENABLED'] === true) { + $sInclude2 = ''; + $sInclude2 .= $this->_oModule->_oTemplate->addJs(array('BxDolCategories.js'), $bDynamicMode); + $sInclude2 .= $this->_oModule->_oTemplate->addCss(array('categories.css'), $bDynamicMode); + + $sResult .= ($bDynamicMode ? $sInclude2 : '') . $this->_oModule->_oTemplate->getJsCode('categories'); + } + + return $sResult; + } + + /** + * Nested forms processing + */ + function genInputNestedForm (&$aInput, $sInfo = '', $sError = '') + { + $sUniqId = genRndPwd (8, false); + $aNestedForms = array(); + if (!$this->isSubmitted()){ + $aGhostTemplateParams = is_object($aInput['ghost_template']) ? $aInput['ghost_template']->aParams : $aInput['ghost_template']['params']; + + $aNestedValues = $this->_oModule->_oDb->getNestedBy(array( + 'type' => 'content_id', + 'id' => $this->_iContentId, + 'key_name' => $aGhostTemplateParams['db']['key'] + ), $aGhostTemplateParams['db']['table']); + + foreach($aNestedValues as $aNestedValue) { + $aNestedValuesRv = array(); + $oForm = $this->getNestedFormObject($aInput); + + foreach($aNestedValue as $aNestedKey => $aNestedItem) { + if ($oForm->aParams['db']['key'] == $aNestedKey) + $aNestedValuesRv[$aNestedKey . '[]'] = $aNestedItem; + else + $aNestedValuesRv[$aNestedKey] = $aNestedItem; + } + + $oForm->initChecker($aNestedValuesRv); + array_push( + $aNestedForms, + array( + 'key_value' => $aNestedValuesRv[$oForm->aParams['db']['key'] . '[]'], + 'key_name' => $aInput['name'], + 'form_code' => $oForm->genRows(), + 'js_instance_name' => 'oBxNestedForm_' . $sUniqId, + 'nested_type' => $aInput['name'], + ) + ); + } + } + else{ + $aInput['ghost_templates'] = $aInput['ghost_template']; + $this->genGhostTemplateForInputNestedForm ($aInput); + foreach($aInput['ghost_templates'] as $oForm) { + if (isset($oForm->aInputs)){ + array_push( + $aNestedForms, + array( + 'key_value' => $oForm->aInputs[$aInput['name']]['value'], + 'key_name' => $aInput['name'], + 'form_code' => $oForm->genRows(), + 'js_instance_name' => 'oBxNestedForm_' . $sUniqId, + 'nested_type' => $aInput['name'], + ) + ); + } + } + } + + return $this->oTemplate->parseHtmlByName('form_field_nested_form.html', array( + 'bx_repeat:items' => $aNestedForms, + 'info' => $sInfo, + 'error' => $sError, + 'uniq_id' => $sUniqId, + 'js_instance_name' => 'oBxNestedForm_' . $sUniqId, + 'options' => json_encode(array( + 'uniq_id' => $sUniqId, + 'js_instance_name' => 'oBxNestedForm_' . $sUniqId, + 'template_ghost' => $this->genGhostTemplate($aInput), + 'form_name' => $aInput['value'], + 'action_uri' => $this->_oModule->_oConfig->getBaseUri(), + 'nested_type' => $aInput['name'], + )), + )); + } + + function genNestedForm (&$aInput) + { + $sResult = ''; + $aGhostTemplateParams = is_object($aInput['ghost_template']) ? $aInput['ghost_template']->aParams : $aInput['ghost_template']['params']; + + $aNestedValues = $this->_oModule->_oDb->getNestedBy([ + 'type' => 'content_id', + 'id' => $this->_iContentId, + 'key_name' => $aGhostTemplateParams['db']['key'] + ], $aGhostTemplateParams['db']['table']); + + foreach($aNestedValues as $aNestedValue) { + $oForm = $this->getNestedFormObject($aInput, true); + + $aNestedValuesRv = []; + foreach($aNestedValue as $aNestedKey => $aNestedItem) { + if ($oForm->aParams['db']['key'] == $aNestedKey) + $aNestedValuesRv[$aNestedKey . '[]'] = $aNestedItem; + else + $aNestedValuesRv[$aNestedKey] = $aNestedItem; + } + + $oForm->initChecker($aNestedValuesRv); + + $sValue = ''; + if($aInput['rateable']) { + $iId = BxDolFormQuery::getFormField($this->id, $aInput['name'], $this->_iContentId, $aNestedValuesRv[$oForm->aParams['db']['key'] . '[]']); + + $sVoteElement = ''; + $sVoteCounter = ''; + if(($oVote = BxDolVote::getObjectInstance($aInput['rateable'], $iId)) !== null) { + $sVoteElement = $oVote->getElementInline(['show_counter_empty' => true, 'show_counter' => false, 'show_counter_style' => 'simple', 'dynamic_mode' => $this->_bDynamicMode]); + $sVoteCounter = $oVote->getCounter(['show_counter_empty' => true, 'show_counter' => true, 'show_counter_style' => 'simple', 'dynamic_mode' => $this->_bDynamicMode]); + } + + $sValue = $this->oTemplate->parseHtmlByName('form_view_rateable_row.html', [ + 'value' => $oForm->getCode(), + 'rate_btn' => $sVoteElement, + 'rate' => $sVoteCounter, + ]); + } + else + $sValue = $oForm->getCode(); + + $sResult .= $this->oTemplate->parseHtmlByName('form_view_nested_row.html', [ + 'value' => $sValue + ]); + } + + if(!$sResult) + return ''; + + $aTmplVarsIcon = []; + if(!empty($aInput['icon'])) { + list($sIcon, $sIconUrl, $sIconA, $sIconHtml) = BxTemplFunctions::getInstanceWithTemplate($this->oTemplate)->getIcon($aInput['icon']); + + $aTmplVarsIcon = [ + 'bx_if:icon' => [ + 'condition' => (bool)$sIcon, + 'content' => ['icon' => $sIcon], + ], + 'bx_if:icon-html' => [ + 'condition' => (bool)$sIconHtml, + 'content' => ['icon' => $sIconHtml], + ], + 'bx_if:image_inline' => [ + 'condition' => false, + 'content' => ['image' => ''], + ] + ]; + } + + return $this->oTemplate->parseHtmlByName('form_view_row.html', [ + 'type' => $aInput['type'], + 'class' => '', + 'bx_if:show_icon' => [ + 'condition' => !empty($aTmplVarsIcon), + 'content' => $aTmplVarsIcon + ], + 'caption' => isset($aInput['caption']) ? bx_process_output($aInput['caption']) : '', + 'class_value' => '', + 'value' => $sResult + ]); + } + + protected function genGhostTemplateForInputNestedForm (&$aInput) + { + $oForm = $this->getNestedFormObject($aInput); + $aInput['ghost_template'] = array ( + 'params' => array( + 'nested_form_template' => 'form_field_nested_form_wrapper.html', + 'db' => array( + 'table' => $oForm->aParams['db']['table'], + 'key' => $oForm->aParams['db']['key'], + 'submit_name' => $oForm->aParams['db']['key'], + ), + ), + 'inputs' => $oForm->aInputs + ); + } + + function getNestedFormObject (&$aInput, $bViewMode = false) + { + $oForm = BxDolForm::getObjectInstance($aInput['value'], $aInput['value'] . ($bViewMode ? '_view' : '')); + foreach($oForm->aInputs as $sKey => $aInput2) { + $sName = $oForm->aInputs[$sKey]['name']; + if (strpos($sName,'[]') === false) + $oForm->aInputs[$sKey]['name'] = $sName . '[]'; + } + return $oForm; + } + + /** + * Add field(s) which will be tracked during content update. + */ + public function addTrackFields($mixedFields, $mixedContent) + { + if(empty($mixedContent) || empty($mixedFields)) + return; + + if(!is_array($mixedContent)) { + $mixedContent = $this->_oModule->_oDb->getContentInfoById((int)$mixedContent); + if(empty($mixedContent) || !is_array($mixedContent)) + return; + } + + if(!is_array($mixedFields)) + $mixedFields = array($mixedFields); + + foreach($mixedFields as $sField) { + if(!isset($mixedContent[$sField])) + continue; + + $this->_aTrackFieldsChanges[$sField] = array( + 'old' => $mixedContent[$sField], + ); + } + } + + /** + * Checks if the field was changed. + */ + public function isTrackFieldChanged($sField, $bReturnValues = false) + { + if(!isset($this->_aTrackFieldsChanges[$sField]) || $this->_aTrackFieldsChanges[$sField] === false) + return false; + + return $bReturnValues ? $this->_aTrackFieldsChanges[$sField] : true; + } + + function initChecker ($aValues = array (), $aSpecificValues = array()) + { + $CNF = &$this->_oModule->_oConfig->CNF; + + $bValues = $aValues && !empty($aValues['id']); + + $this->_iContentId = isset($aValues['id']) ? $aValues['id'] : false; + + if (!empty($CNF['FIELD_LOCATION_PREFIX']) && isset($this->aInputs[$CNF['FIELD_LOCATION_PREFIX']]) && isset($aValues[$CNF['FIELD_ID']]) && !empty($CNF['OBJECT_METATAGS']) && ($oMetatags = BxDolMetatags::getObjectInstance($CNF['OBJECT_METATAGS'])) && $oMetatags->locationsIsEnabled()) + $this->aInputs[$CNF['FIELD_LOCATION_PREFIX']]['value'] = $oMetatags->locationsString($aValues[$CNF['FIELD_ID']], false); + + if (isset($CNF['FIELD_PHOTO']) && isset($this->aInputs[$CNF['FIELD_PHOTO']])) { + + $aContentInfo = false; + if ($aValues && !empty($aValues['id'])) { + $aContentInfo = $this->_oModule->_oDb->getContentInfoById ($aValues['id']); + $this->aInputs[$CNF['FIELD_PHOTO']]['content_id'] = $aValues['id']; + } + + $this->aInputs[$CNF['FIELD_PHOTO']]['ghost_template'] = $this->_oModule->_oTemplate->parseHtmlByName($this->_sGhostTemplate, $this->_getPhotoGhostTmplVars($aContentInfo)); + } + + if (isset($CNF['FIELD_LABELS']) && isset($this->aInputs[$CNF['FIELD_LABELS']]) && !empty($CNF['OBJECT_METATAGS']) && ($oMetatags = BxDolMetatags::getObjectInstance($CNF['OBJECT_METATAGS'])) && $oMetatags->keywordsIsEnabled() && !empty($aValues['id'])) { + $this->aInputs[$CNF['FIELD_LABELS']]['content_id'] = $aValues['id']; + if(($aLabels = $oMetatags->keywordsGet($aValues['id']))) + $this->aInputs[$CNF['FIELD_LABELS']]['value'] = array_intersect($aLabels, BxDolLabel::getInstance()->getLabels(array('type' => 'values'))); + } + + if (isset($CNF['FIELD_ANONYMOUS'], $this->aInputs[$CNF['FIELD_ANONYMOUS']]) && isset($CNF['FIELD_AUTHOR'], $aValues[$CNF['FIELD_AUTHOR']])) { + $this->aInputs[$CNF['FIELD_ANONYMOUS']]['checked'] = $aValues[$CNF['FIELD_AUTHOR']] < 0; + } + + if (isset($CNF['FIELD_MULTICAT']) && isset($this->aInputs[$CNF['FIELD_MULTICAT']]) && $CNF['PARAM_MULTICAT_ENABLED']) { + if ($bValues) + $this->aInputs[$CNF['FIELD_MULTICAT']]['content_id'] = $aValues['id']; + } + + $aPrivacyFields = $this->_getPrivacyFields(); + foreach($aPrivacyFields as $sField => $sObject) + $this->_preloadPrivacyField($sField, $sObject, $aValues); + + if(isset($CNF['FIELD_AUTHOR'], $this->aInputs[$CNF['FIELD_AUTHOR']])) { + if (isset($aValues[$CNF['FIELD_AUTHOR']]) && $aValues[$CNF['FIELD_AUTHOR']]) + $aValues[$CNF['FIELD_AUTHOR']] = abs($aValues[$CNF['FIELD_AUTHOR']]); + else + $aValues[$CNF['FIELD_AUTHOR']] = bx_get_logged_profile_id(); + } + + parent::initChecker ($aValues, $aSpecificValues); + + foreach($aPrivacyFields as $sField => $sObject) + $this->_validatePrivacyField($sField, $sObject, $aValues); + } + + public function insert ($aValsToAdd = array(), $isIgnore = false) + { + $CNF = &$this->_oModule->_oConfig->CNF; + + $iAuthor = -1; + if(isset($CNF['FIELD_AUTHOR'])) { + $sFa = $CNF['FIELD_AUTHOR']; + + $iAnonymous = isset($CNF['FIELD_ANONYMOUS'], $this->aInputs[$CNF['FIELD_ANONYMOUS']]) && $this->getCleanValue($CNF['FIELD_ANONYMOUS']) ? -1 : 1; + + if(empty($aValsToAdd[$sFa])) { + if(!isset($this->aInputs[$sFa]) || empty($this->getCleanValue($sFa))) + $iAuthor = bx_get_logged_profile_id(); + else + $iAuthor = $this->getCleanValue($sFa); + + $aValsToAdd[$sFa] = $iAnonymous * $iAuthor; + } + else { + $iAuthor = $aValsToAdd[$sFa]; + + $aValsToAdd[$sFa] *= $iAnonymous; + } + } + + if (isset($CNF['FIELD_ADDED']) && empty($aValsToAdd[$CNF['FIELD_ADDED']]) && empty($this->getCleanValue($CNF['FIELD_ADDED']))) + $aValsToAdd[$CNF['FIELD_ADDED']] = time(); + + if (isset($CNF['FIELD_CHANGED']) && empty($aValsToAdd[$CNF['FIELD_CHANGED']]) && empty($this->getCleanValue($CNF['FIELD_CHANGED']))) + $aValsToAdd[$CNF['FIELD_CHANGED']] = time(); + + if (CHECK_ACTION_RESULT_ALLOWED === $this->_oModule->checkAllowedSetThumb() && isset($CNF['FIELD_THUMB'])) { + $aThumb = isset($_POST[$CNF['FIELD_THUMB']]) ? bx_process_input ($_POST[$CNF['FIELD_THUMB']], BX_DATA_INT) : false; + $aValsToAdd[$CNF['FIELD_THUMB']] = 0; + if (!empty($aThumb)){ + if(is_array($aThumb) && ($iFileThumb = array_pop($aThumb))) + $aValsToAdd[$CNF['FIELD_THUMB']] = $iFileThumb; + else + $aValsToAdd[$CNF['FIELD_THUMB']] = $aThumb; + } + } + + if(!empty($CNF['OBJECT_METATAGS'])) + $this->_processMetas($aValsToAdd); + + if(isset($CNF['FIELD_STATUS']) && !empty($CNF['FIELDS_DELAYED_PROCESSING']) && !empty($CNF['OBJECT_VIDEOS_TRANSCODERS']['mp4'])) { + $oTranscoder = BxDolTranscoder::getObjectInstance($CNF['OBJECT_VIDEOS_TRANSCODERS']['mp4']); + + $aFields = $CNF['FIELDS_DELAYED_PROCESSING']; + if(is_string($aFields)) + $aFields = explode(',', $aFields); + + foreach($aFields as $sField) { + $mixedFieldValues = $this->getCleanValue($sField); + if(empty($mixedFieldValues)) + continue; + + $oStorage = BxDolStorage::getObjectInstance($this->aInputs[$sField]['storage_object']); + if(!$oStorage) + continue; + + if(!is_array($mixedFieldValues)) + $mixedFieldValues = array($mixedFieldValues); + + foreach($mixedFieldValues as $mixedFieldValue) { + $aInfo = $oStorage->getFile((int)$mixedFieldValue); + if(empty($aInfo) || !is_array($aInfo)) + continue; + + if(strncmp($aInfo['mime_type'], 'video/', 6) != 0) + continue; + + if($oTranscoder->isFileReady((int)$mixedFieldValue)) + continue; + + $aValsToAdd[$CNF['FIELD_STATUS']] = 'awaiting'; + break 2; + } + } + } + + if(isset($CNF['FIELD_STATUS_ADMIN']) && empty($aValsToAdd[$CNF['FIELD_STATUS_ADMIN']]) && !$this->_oModule->_isModerator() && !$this->_oModule->_oConfig->isAutoApproveEnabled()) + $aValsToAdd[$CNF['FIELD_STATUS_ADMIN']] = BX_BASE_MOD_GENERAL_STATUS_PENDING; + + $bMulticatEnabled = $this->_isMulticatEnabled(); + if ($bMulticatEnabled) + $this->processMulticatBefore($CNF['FIELD_MULTICAT'], $aValsToAdd); + $iContentId = parent::insert ($aValsToAdd, $isIgnore); + + if(!empty($iContentId)) { + foreach($this->aInputs as $aInput) { + if ($aInput['type'] == 'nested_form') { + if (is_array($aInput['ghost_template']) && !isset($aInput['ghost_template']['inputs'])) { + foreach ($aInput['ghost_template'] as $oFormNested) { + $iNestedContentId = $oFormNested->insert(array('content_id' => $iContentId)); + + if ($aInput['rateable']) { + BxDolFormQuery::addFormField($this->id, $aInput['name'], $iContentId, $iAuthor, $this->_oModule->getName(), $iNestedContentId); + } + } + } + } + } + + if ($bMulticatEnabled) + $this->processMulticatAfter($CNF['FIELD_MULTICAT'], $iContentId); + } + + foreach($this->aInputs as $aInput) { + if (isset($aInput['rateable']) && $aInput['rateable'] && $aInput['type'] != 'nested_form'){ + BxDolFormQuery::addFormField($this->id, $aInput['name'], $iContentId, $iAuthor, $this->_oModule->getName()); + } + } + + return $iContentId; + } + + function update ($iContentId, $aValsToAdd = array(), &$aTrackTextFieldsChanges = null) + { + $CNF = &$this->_oModule->_oConfig->CNF; + + $aContentInfo = $this->_oModule->_oDb->getContentInfoById($iContentId); + + $iAuthor = -1; + if(isset($CNF['FIELD_AUTHOR'])) { + $sFa = $CNF['FIELD_AUTHOR']; + + if(!empty($aValsToAdd[$sFa])) + $iAuthor = $aValsToAdd[$sFa]; + else if(isset($this->aInputs[$sFa]) && !empty($this->getCleanValue($sFa))) + $iAuthor = $this->getCleanValue($sFa); + else if(!empty($aContentInfo[$sFa])) + $iAuthor = $aContentInfo[$sFa]; + else + $iAuthor = bx_get_logged_profile_id(); + + $iAuthor = abs($iAuthor); + $iAnonymous = isset($CNF['FIELD_ANONYMOUS'], $this->aInputs[$CNF['FIELD_ANONYMOUS']]) && $this->getCleanValue($CNF['FIELD_ANONYMOUS']) ? -1 : 1; + + $aValsToAdd[$sFa] = $iAnonymous * $iAuthor; + } + + if(isset($CNF['FIELD_CHANGED']) && empty($aValsToAdd[$CNF['FIELD_CHANGED']]) && empty($this->getCleanValue($CNF['FIELD_CHANGED']))) + $aValsToAdd[$CNF['FIELD_CHANGED']] = time(); + + if(CHECK_ACTION_RESULT_ALLOWED === $this->_oModule->checkAllowedSetThumb($iContentId) && isset($CNF['FIELD_THUMB']) && ($aThumb = bx_get($CNF['FIELD_THUMB'])) !== false) { + $aThumb = bx_process_input($aThumb, BX_DATA_INT); + + $aValsToAdd[$CNF['FIELD_THUMB']] = 0; + if(!empty($aThumb)) { + if(is_array($aThumb) && ($iFileThumb = array_pop($aThumb))) + $aValsToAdd[$CNF['FIELD_THUMB']] = $iFileThumb; + else + $aValsToAdd[$CNF['FIELD_THUMB']] = $aThumb; + } + } + + if(!empty($CNF['OBJECT_METATAGS'])) + $this->_processMetas($aValsToAdd); + + if(isset($CNF['FIELD_STATUS']) && isset($aContentInfo[$CNF['FIELD_STATUS']]) && $aContentInfo[$CNF['FIELD_STATUS']] == 'failed') + $aValsToAdd[$CNF['FIELD_STATUS']] = 'active'; + + $bMulticatEnabled = $this->_isMulticatEnabled(); + if ($bMulticatEnabled) + $this->processMulticatBefore($CNF['FIELD_MULTICAT'], $aValsToAdd); + + $mixedResult = parent::update($iContentId, $aValsToAdd, $aTrackTextFieldsChanges); + + foreach($this->aInputs as $aInput) { + if ($aInput['type'] == 'nested_form'){ + if (is_array($aInput['ghost_template']) && !isset($aInput['ghost_template']['inputs'])) { + foreach ($aInput['ghost_template'] as $oFormNested) { + $aSpecificValues = $oFormNested->getSpecificValues(); + $iNestedContentId = $oFormNested->getSubmittedValue($aInput['name'], BX_DOL_FORM_METHOD_SPECIFIC, $aSpecificValues); + + if (empty($iNestedContentId)){ + $iNestedContentId = $oFormNested->insert(array('content_id' => $iContentId)); + if ($aInput['rateable']){ + BxDolFormQuery::addFormField($this->id, $aInput['name'], $iContentId, $iAuthor, $this->_oModule->getName(), $iNestedContentId); + } + } + else{ + $oFormNested->update($iNestedContentId, array('content_id' => $iContentId)); + } + } + } + } + } + + if ($bMulticatEnabled) + $this->processMulticatAfter($CNF['FIELD_MULTICAT'], $iContentId); + + foreach($this->aInputs as $aInput) { + if (isset($aInput['rateable']) && $aInput['rateable'] && $aInput['type'] != 'nested_form'){ + BxDolFormQuery::addFormField($this->id, $aInput['name'], $iContentId, $iAuthor, $this->_oModule->getName()); + } + } + + if($mixedResult !== false) + $this->_processTrackFields($iContentId); + + return $mixedResult; + } + + function getHtmlEditorQueryParams($aInput) + { + $aQueryParams = parent::getHtmlEditorQueryParams($aInput); + if (isset($this->MODULE)){ + $aQueryParams['m'] = $this->MODULE; + } + if (isset($this->_iContentId) && $this->_iContentId){ + $aQueryParams['cid'] = $this->_iContentId; + } + $aQueryParams['fi'] = ''; + + /** + * @hooks + * @hookdef hook-system-editor_query_params 'system', 'editor_query_params' - hook to override http(s) request's query params, which is used in HTML editor + * - $unit_name - equals `system` + * - $action - equals `editor_query_params` + * - $object_id - not used + * - $sender_id - not used + * - $extra_params - array of additional params with the following array keys: + * - `form` - [object] an instance of form, @see BxDolForm + * - `override_result` - [array] by ref, query string params, can be overridden in hook processing + * @hook @ref hook-system-editor_query_params + */ + bx_alert('system', 'editor_query_params', 0, 0, [ + 'form' => $this, + 'override_result' => &$aQueryParams + ]); + + return $aQueryParams; + } + + protected function _associalFileWithContent($oStorage, $iFileId, $iProfileId, $iContentId, $sPictureField = '') + { + $oStorage->updateGhostsContentId ($iFileId, $iProfileId, $iContentId, $this->_isAdmin($iContentId)); + } + + protected function _getPhotoGhostTmplVars($aContentInfo = array()) + { + $CNF = &$this->_oModule->_oConfig->CNF; + + return array ( + 'name' => $this->aInputs[$CNF['FIELD_PHOTO']]['name'], + 'content_id' => (int)$this->aInputs[$CNF['FIELD_PHOTO']]['content_id'], + 'editor_id' => isset($CNF['FIELD_TEXT_ID']) ? $CNF['FIELD_TEXT_ID'] : '', + 'thumb_id' => isset($CNF['FIELD_THUMB']) && isset($aContentInfo[$CNF['FIELD_THUMB']]) ? $aContentInfo[$CNF['FIELD_THUMB']] : 0, + 'name_thumb' => isset($CNF['FIELD_THUMB']) ? $CNF['FIELD_THUMB'] : '', + 'bx_if:set_thumb' => array ( + 'condition' => CHECK_ACTION_RESULT_ALLOWED === $this->_oModule->checkAllowedSetThumb($this->aInputs[$CNF['FIELD_PHOTO']]['content_id']), + 'content' => array ( + 'name_thumb' => isset($CNF['FIELD_THUMB']) ? $CNF['FIELD_THUMB'] : '', + 'txt_pict_use_as_thumb' => _t(!empty($CNF['T']['txt_pict_use_as_thumb']) ? $CNF['T']['txt_pict_use_as_thumb'] : '_sys_txt_form_entry_input_picture_use_as_thumb') + ), + ), + ); + } + + function delete ($iContentId, $aContentInfo = array()) + { + $CNF = &$this->_oModule->_oConfig->CNF; + + // delete associated files + + $a = array('OBJECT_STORAGE', 'OBJECT_STORAGE_FILES', 'OBJECT_STORAGE_PHOTOS', 'OBJECT_STORAGE_VIDEOS', 'OBJECT_STORAGE_SOUNDS'); + foreach ($a as $k) { + if (!empty($CNF[$k])) { + $oStorage = BxDolStorage::getObjectInstance($CNF[$k]); + if ($oStorage) + $oStorage->queueFilesForDeletionFromGhosts($aContentInfo[$CNF['FIELD_AUTHOR']], $iContentId); + } + } + + // delete associated objects data + + if (!empty($CNF['OBJECT_VIEWS'])) { + $o = BxDolView::getObjectInstance($CNF['OBJECT_VIEWS'], $iContentId); + if ($o) $o->onObjectDelete(); + } + + if (!empty($CNF['OBJECT_VOTES'])) { + $o = BxDolVote::getObjectInstance($CNF['OBJECT_VOTES'], $iContentId); + if ($o) $o->onObjectDelete(); + } + + if (!empty($CNF['OBJECT_SCORES'])) { + $o = BxDolScore::getObjectInstance($CNF['OBJECT_SCORES'], $iContentId); + if ($o) $o->onObjectDelete(); + } + + if (!empty($CNF['OBJECT_COMMENTS'])) { + $o = BxDolCmts::getObjectInstance($CNF['OBJECT_COMMENTS'], $iContentId); + if ($o) $o->onObjectDelete(); + } + + if (!empty($CNF['OBJECT_REPORTS'])) { + $o = BxDolReport::getObjectInstance($CNF['OBJECT_REPORTS'], $iContentId); + if ($o) $o->onObjectDelete(); + } + + if (!empty($CNF['OBJECT_METATAGS'])) { + $o = BxDolMetatags::getObjectInstance($CNF['OBJECT_METATAGS']); + if ($o) $o->onDeleteContent($iContentId); + } + + // delete SEO links + + BxDolPage::deleteSeoLink ($this->_oModule->getName(), $this->_oModule->getName(), $iContentId); + + // delete db record + + BxDolFormQuery::removeFormField($this->id, $iContentId); + + return parent::delete($iContentId); + } + + protected function _isAdmin ($iContentId = 0) + { + return $this->_oModule->_isModerator(); + } + + public function processFiles ($sFieldFile, $iContentId = 0, $isAssociateWithContent = false) + { + $CNF = &$this->_oModule->_oConfig->CNF; + + if (!isset($this->aInputs[$sFieldFile])) + return true; + + $mixedFileIds = $this->getCleanValue($sFieldFile); + if(!$mixedFileIds) + return true; + + $oStorage = BxDolStorage::getObjectInstance($this->aInputs[$sFieldFile]['storage_object']); + if (!$oStorage) + return false; + + $iProfileId = $this->getContentOwnerProfileId($iContentId); + + $aGhostFiles = $oStorage->getGhosts ($iProfileId, $isAssociateWithContent ? 0 : $iContentId, true, $this->_isAdmin($iContentId)); + if (!$aGhostFiles) + return true; + + foreach ($aGhostFiles as $aFile) { + if (is_array($mixedFileIds) && !in_array($aFile['id'], $mixedFileIds)) + continue; + + if ($aFile['private']) + $oStorage->setFilePrivate ($aFile['id'], 1); + + if ($iContentId) + $this->_associalFileWithContent($oStorage, $aFile['id'], $iProfileId, $iContentId, $sFieldFile); + } + + return true; + } + + function _deleteFile ($iFileId, $sStorage = '') + { + $CNF = &$this->_oModule->_oConfig->CNF; + + if (!$iFileId) + return true; + + $sStorage = !empty($sStorage) ? $sStorage : $CNF['OBJECT_STORAGE']; + $oStorage = BxDolStorage::getObjectInstance($sStorage); + if (!$oStorage) + return false; + + if (!$oStorage->getFile($iFileId)) + return true; + + $iProfileId = bx_get_logged_profile_id(); + return $oStorage->deleteFile($iFileId, $iProfileId); + } + + function addCssJs () + { + if ((!isset($this->aParams['view_mode']) || !$this->aParams['view_mode']) && !self::$_isCssJsGeneralModuleAdded) { + $this->_oModule->_oTemplate->addCss('forms.css'); + $this->_oModule->_oTemplate->addJs('modules/base/general/js/|forms.js'); + self::$_isCssJsGeneralModuleAdded = true; + } + + return parent::addCssJs (); + } + + function genViewRowValue(&$aInput) + { + $s = parent::genViewRowValue($aInput); + + if ($this->_oMetatagsObject && in_array($aInput['name'], $this->_aMetatagsFieldsWithKeywords) && $s) + $s = $this->_oMetatagsObject->metaParse($this->_oMetatagsContentId, $s); + + return $s; + } + + function genViewRowWrapped(&$aInput) + { + $sResult = parent::genViewRowWrapped($aInput); + if(!$aInput['rateable']) + return $sResult; + + $sValue = $this->genViewRowValue($aInput); + if(null === $sValue) + return ''; + + // process rateable fields + $iId = BxDolFormQuery::getFormField($this->id, $aInput['name'], $this->_iContentId); + if(($oVote = BxDolVote::getObjectInstance($aInput['rateable'], $iId)) !== null) { + $sVoteElement = $oVote->getElementInline(['show_counter_empty' => true, 'show_counter' => false, 'show_counter_style' => 'simple', 'dynamic_mode' => $this->_bDynamicMode]); + $sVoteCounter = $oVote->getCounter(['show_counter_empty' => true, 'show_counter' => true, 'show_counter_style' => 'simple', 'dynamic_mode' => $this->_bDynamicMode]); + + return $this->oTemplate->parseHtmlByName('form_view_rateable_row.html', [ + 'value' => $sResult, + 'rate_btn' => $sVoteElement, + 'rate' => $sVoteCounter, + ]); + } + + return $sResult; + } + + function setMetatagsKeywordsData($iId, $a, $o) + { + $this->_oMetatagsContentId = $iId; + $this->_aMetatagsFieldsWithKeywords = $a; + $this->_oMetatagsObject = $o; + } + + function getContentOwnerProfileId ($iContentId) + { + return $this->_oModule->serviceGetContentOwnerProfileId($iContentId); + } + + protected function _processTrackFields($mixedContent) + { + if(empty($mixedContent) || empty($this->_aTrackFieldsChanges)) + return; + + if(!is_array($mixedContent)) { + $mixedContent = $this->_oModule->_oDb->getContentInfoById((int)$mixedContent); + if(empty($mixedContent) || !is_array($mixedContent)) + return; + } + + foreach($this->_aTrackFieldsChanges as $sField => $aValues) + if($mixedContent[$sField] == $aValues['old']) + $this->_aTrackFieldsChanges[$sField] = false; + else + $this->_aTrackFieldsChanges[$sField]['new'] = $mixedContent[$sField]; + } + + protected function _processMetas(&$aValsToAdd) + { + $CNF = &$this->_oModule->_oConfig->CNF; + + $sKey = 'FIELD_LABELS'; + if(isset($CNF[$sKey]) && isset($this->aInputs[$CNF[$sKey]]) && empty($aValsToAdd[$CNF[$sKey]])) { + $aLabels = $this->getCleanValue($CNF[$sKey]); + if(!empty($aLabels) && is_array($aLabels)) + $aValsToAdd[$CNF[$sKey]] = serialize($aLabels); + else + $aValsToAdd[$CNF[$sKey]] = ''; + } + + $sKey1 = 'FIELD_LOCATION'; + $sKey2 = 'FIELD_LOCATION_PREFIX'; + if(isset($CNF[$sKey1]) && isset($CNF[$sKey2]) && isset($this->aInputs[$CNF[$sKey1]]) && empty($aValsToAdd[$CNF[$sKey1]])) { + $aLocation = BxDolMetatags::locationsRetrieveFromForm($CNF[$sKey2], $this); + if(!empty($aLocation) && is_array($aLocation)) + $aValsToAdd[$CNF[$sKey1]] = serialize(BxDolMetatags::locationsParseComponents($aLocation)); + } + } + + protected function _getPrivacyFields($aKeysF2O = array()) + { + $CNF = &$this->_oModule->_oConfig->CNF; + + if(isset($CNF['PRIVACY_FIELD_TO_OBJECT']) && is_array($CNF['PRIVACY_FIELD_TO_OBJECT'])) + return $CNF['PRIVACY_FIELD_TO_OBJECT']; + + if(empty($aKeysF2O)) + $aKeysF2O = array('FIELD_ALLOW_VIEW_TO' => 'OBJECT_PRIVACY_VIEW'); + + $aResult = array(); + foreach($aKeysF2O as $sKeyField => $sKeyObject) { + if(!isset($CNF[$sKeyField]) || !isset($this->aInputs[$CNF[$sKeyField]]) || !isset($CNF[$sKeyObject])) + continue; + + $aResult[$CNF[$sKeyField]] = $CNF[$sKeyObject]; + } + + return $aResult; + } + + function _addCssJsPrivacyField($sField, $sPrivacyObject, $bDynamicMode = false) + { + $oPrivacy = BxDolPrivacy::getObjectInstance($sPrivacyObject); + if(!$oPrivacy) + return; + + $this->aInputs[$sField]['content'] = $oPrivacy->addCssJs($bDynamicMode) . $this->aInputs[$sField]['content']; + } + + protected function _preparePrivacyField($sField, $sPrivacyObject) + { + $oPrivacy = BxDolPrivacy::getObjectInstance($sPrivacyObject); + if(!$oPrivacy) + return; + + $aSave = array('db' => array('pass' => 'Xss')); + array_walk($this->aInputs[$sField], function ($a, $k, $aSave) { + if (in_array($k, array('info', 'caption', 'value'))) + $aSave[0][$k] = $a; + }, array(&$aSave)); + + $aGroupChooser = $oPrivacy->getGroupChooser($sPrivacyObject, 0, array( + 'object' => $this->aParams['object'], + 'display' => $this->aParams['display'] + )); + + $this->aInputs[$sField] = array_merge($this->aInputs[$sField], $aGroupChooser, $aSave); + } + + protected function _preloadPrivacyField($sField, $sPrivacyObject, $aValues) + { + $CNF = &$this->_oModule->_oConfig->CNF; + + $oPrivacy = BxDolPrivacy::getObjectInstance($sPrivacyObject); + if(!$oPrivacy) + return; + + $iContentId = !empty($aValues[$CNF['FIELD_ID']]) ? (int)$aValues[$CNF['FIELD_ID']] : 0; + $iProfileId = !empty($iContentId) ? (int)$this->getContentOwnerProfileId($iContentId) : bx_get_logged_profile_id(); + $iGroupId = !empty($aValues[$sField]) ? $aValues[$sField] : 0; + + if(!isset($this->aInputs[$sField]['content'])) + $this->aInputs[$sField]['content'] = ''; + + $this->aInputs[$sField]['content'] .= $oPrivacy->initGroupChooser($sPrivacyObject, $iProfileId, array( + 'content_id' => $iContentId, + 'group_id' => $iGroupId, + 'html_ids' => array( + 'form' => $this->getId() + ) + )); + } + + protected function _validatePrivacyField($sField, $sPrivacyObject, $aValues) + { + $mixedValue = $this->aInputs[$sField]['value']; + + $bValue = false; + foreach($this->aInputs[$sField]['values'] as $aValue) + if(isset($aValue['key']) && $aValue['key'] == $mixedValue) { + $bValue = true; + break; + } + + if(!$bValue) { + $sTitle = ''; + if(is_numeric($mixedValue) && (int)$mixedValue < 0 && ($oContext = BxDolProfile::getInstance(abs((int)$mixedValue))) !== false) + $sTitle = $oContext->getDisplayName(); + else + $sTitle = _t('_sys_ps_group_title_unknown'); + + $this->aInputs[$sField]['values'] = array_merge(array( + array('key' => $mixedValue, 'value' => $sTitle), + array('key' => '', 'value' => '----', 'attrs' => array('disabled' => 'disabled')) + ), $this->aInputs[$sField]['values']); + } + } + + /** + * + * MultiCategories related methods. + * + */ + + protected function processMulticatBefore($sFieldName, &$aValsToAdd){ + if (isset($this->aInputs[$sFieldName])){ + $this->aInputs[$sFieldName]['value'] = array_unique(array_filter($this->aInputs[$sFieldName]['value'], function($sTmp){ + return trim($sTmp); + })); + $aValsToAdd[$sFieldName] = implode(',', $this->aInputs[$sFieldName]['value']); + } + } + + protected function processMulticatAfter($sFieldName, $iContentId){ + $CNF = &$this->_oModule->_oConfig->CNF; + $bAutoActivation = (isset($CNF['PARAM_MULTICAT_AUTO_ACTIVATION_FOR_CATEGORIES']) && getParam($CNF['PARAM_MULTICAT_AUTO_ACTIVATION_FOR_CATEGORIES']) == 'on') ? true : false; + $oCategories = BxDolCategories::getInstance(); + if (isset($this->aInputs[$sFieldName])){ + $oCategories->delete($this->_oModule->getName(), $iContentId); + foreach($this->aInputs[$sFieldName]['value'] as $sValue) { + $oCategories->add($this->_oModule->getName(), bx_get_logged_profile_id(), $sValue, $iContentId, $bAutoActivation); + } + } + } + + protected function genCustomViewRowValueMulticat(&$aInput) + { + $oCategories = BxDolCategories::getInstance(); + $aValues = $oCategories->getData(array('type' => 'by_module_and_object', 'module' => $this->_oModule->getName(), 'object_id' => (!empty($aInput['content_id']) ? (int)$aInput['content_id'] : 0 ))); + if (count($aValues) > 0){ + $aVars = array('bx_repeat:cats' => array()); + foreach ($aValues as $sValue) { + $aVars['bx_repeat:cats'][] = array( + 'url' => $oCategories->getUrl($this->_oModule->getName(), $sValue), + 'name' => _t($sValue), + 'bx_if:more' => array( + 'condition' => $sValue === end($aValues) ? false : true, + 'content' => array('1') + ), + ); + } + + if (!$aVars['bx_repeat:cats']) + return ''; + + return $this->_oModule->_oTemplate->parseHtmlByName('category_list_inline.html', $aVars); + } + return ''; + } + + protected function genCustomInputMulticat(&$aInput) + { + $sJsObject = $this->_oModule->_oConfig->getJsObject('categories'); + $aValuesForSelect = BxDolCategories::getInstance()->getData(array('type' => 'by_module_and_author', 'module' => $this->_oModule->getName(), 'author' => bx_get_logged_profile_id())); + + $aSelectedItems = array(); + if (isset($aInput['value']) && is_array($aInput['value'])) + $aInput['value'] = array_filter($aInput['value']); + + if(!empty($aInput['value'])) { + if (!is_array($aInput['value'])) + $aValues = BxDolCategories::getInstance()->getData(array('type' => 'by_module_and_object', 'module' => $this->_oModule->getName(), 'object_id' => (!empty($aInput['content_id']) ? (int)$aInput['content_id'] : 0 ))); + else + $aValues = $aInput['value']; + + $aValues = array_filter($aValues); + foreach($aValues as $sValue) { + if (!array_key_exists($sValue, $aValuesForSelect)){ + $aValuesForSelect[$sValue] = array('key' => $sValue, 'value' => $sValue); + } + } + foreach($aValues as $sValue) { + $sInput = $this->genCustomInputMulticatSelect($aInput, $aValuesForSelect, $sValue); + $aSelectedItems[] = array('js_object' => $sJsObject, 'select_cat' => $sInput); + } + } + else{ + $aSelectedItems = array( + array('js_object' => $sJsObject, 'select_cat' => $this->genCustomInputMulticatSelect($aInput, $aValuesForSelect)) + ); + } + return $this->_oModule->_oTemplate->parseHtmlByName('form_categories.html', array( + 'bx_repeat:items' => $aSelectedItems, + 'js_object' => $sJsObject, + 'select_cat' => $this->genCustomInputMulticatSelect($aInput, $aValuesForSelect, -1), + 'input_cat' => $this->genCustomInputMulticatInput($aInput), + 'js_object' => $sJsObject, + 'btn_add' => $this->genCustomInputMulticatButton($aInput), + 'btn_add_new' => $this->genCustomInputMulticatButtonNew($aInput) + )); + } + + protected function genCustomInputMulticatSelect($aInput, $aValues, $mixedValue = '') + { + foreach($aValues as $sKey => $aValue) { + $aValues[$sKey]['value'] = _t($aValue['key']); + } + $aValues = array_merge(array('1' => array('key' => false, 'value' => _t('_sys_please_select'))), $aValues); + + $aInput['type'] = 'select'; + $aInput['name'] .= '[]'; + $aInput['value'] = $mixedValue; + $aInput['values'] = $aValues; + return $this->genInput($aInput); + } + + protected function genCustomInputMulticatInput($aInput) + { + $aInput['type'] = 'text'; + $aInput['name'] .= '[]'; + $aInput['value'] = ''; + return $this->genInput($aInput); + } + + protected function genCustomInputMulticatButton($aInput) + { + $sName = $aInput['name']; + $aInput['type'] = 'button'; + $aInput['name'] .= '_add'; + $aInput['value'] = _t('_sys_txt_categories_button_caption_add'); + $aInput['attrs']['class'] = 'bx-def-margin-right bx-def-margin-sec-top'; + $aInput['attrs']['onclick'] = $this->_oModule->_oConfig->getJsObject('categories') . ".categoryAdd(this, '" . $sName . "');"; + return $this->genInputButton($aInput); + } + + protected function genCustomInputMulticatButtonNew($aInput) + { + $sName = $aInput['name']; + $aInput['type'] = 'button'; + $aInput['name'] .= '_add'; + $aInput['value'] = _t('_sys_txt_categories_button_caption_addnew'); + $aInput['attrs']['class'] = 'bx-def-margin-sec-top'; + $aInput['attrs']['onclick'] = $this->_oModule->_oConfig->getJsObject('categories') . ".categoryAddNew(this, '" . $sName . "');"; + return $this->genInputButton($aInput); + } + + protected function genCustomInputAuthor ($aInput) + { + if(empty($aInput['custom']) || !is_array($aInput['custom'])) + $aInput['custom'] = array(); + $aInput['custom']['only_once'] = 1; + + $aInput['ajax_get_suggestions'] = BX_DOL_URL_ROOT . "modules/?r=" . $this->_oModule->_oConfig->getUri() . "/ajax_get_profiles"; + if (bx_is_api()){ + $aInput['ajax_get_suggestions'] = $this->_oModule->_oConfig->getName() . "/get_profiles¶ms[]="; + $aProfile = BxDolProfile::getInstance($aInput['value'])->getUnitAPI(0, ['template' => 'unit_wo_info']); + $aInput['value_data'] = [$aProfile['author_data']]; + } + return $this->genCustomInputUsernamesSuggestions($aInput); + } + + protected function _isMulticatEnabled(){ + $CNF = $this->_oModule->_oConfig->CNF; + return isset($CNF['PARAM_MULTICAT_ENABLED']) && $CNF['PARAM_MULTICAT_ENABLED'] === true && isset($CNF['FIELD_MULTICAT']); + } +} + +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/general/classes/BxBaseModGeneralModule.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/general/classes/BxBaseModGeneralModule.php new file mode 100644 index 0000000000..c8a9abccb8 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/general/classes/BxBaseModGeneralModule.php @@ -0,0 +1,4418 @@ +<?php defined('BX_DOL') or die('hack attempt'); +/** + * Copyright (c) UNA, Inc - https://una.io + * MIT License - https://opensource.org/licenses/MIT + * + * @defgroup BaseGeneral Base classes for modules + * @ingroup UnaModules + * + * @{ + */ + +define('BX_BASE_MOD_GENERAL_STATUS_ACTIVE', 'active'); +define('BX_BASE_MOD_GENERAL_STATUS_HIDDEN', 'hidden'); +define('BX_BASE_MOD_GENERAL_STATUS_PENDING', 'pending'); + +bx_import('BxDolAcl'); + +/** + * Base module class. + */ +class BxBaseModGeneralModule extends BxDolModule +{ + protected $_bIsApi; + protected $_iProfileId; + protected $_aSearchableNamesExcept; + protected $_aFormParams; + + protected $_aBrowsingFiltersKeys; + + function __construct(&$aModule) + { + parent::__construct($aModule); + + $this->_bIsApi = bx_is_api(); + $this->_iProfileId = bx_get_logged_profile_id(); + $this->_aSearchableNamesExcept = array( + 'allow_view_to' + ); + + $this->_aFormParams = array( + 'display' => false, + 'dynamic_mode' => false, + 'ajax_mode' => false, + 'absolute_action_url' => false, + 'visibility_autoselect' => false, + 'context_id' => 0, + 'custom' => array() + ); + + $this->_aBrowsingFiltersKeys = ['mode']; + } + + // ====== ACTIONS METHODS + + public function isEntryActive($aContentInfo) + { + $CNF = &$this->_oConfig->CNF; + + $iProfileId = bx_get_logged_profile_id(); + $bModerator = $this->_isModerator(); + + $mixedResult = null; + /** + * @hooks + * @hookdef hook-bx_base_general-is_entry_active '{module_name}', 'is_entry_active' - hook to override whether an entry (content) active or not + * - $unit_name - module name + * - $action - equals `is_entry_active` + * - $object_id - not used + * - $sender_id - not used + * - $extra_params - array of additional params with the following array keys: + * - `viewer_id` - [int] viewer profile id + * - `is_moderator` - [boolean] is viewer has moderator status or not + * - `content_info` - [array] content info array as key&value pairs + * - `override_result` - [boolean] by ref, boolean value which determines whether entry (content) active or not, can be overridden in hook processing + * @hook @ref hook-bx_base_general-is_entry_active + */ + bx_alert($this->getName(), 'is_entry_active', 0, 0, [ + 'viewer_id' => $iProfileId, + 'is_moderator' => $bModerator, + 'content_info' => $aContentInfo, + 'override_result' => &$mixedResult + ]); + if($mixedResult !== null) + return $mixedResult; + + if($this->isEntryAuthor($aContentInfo, $iProfileId) || $bModerator) + return true; + + if(!empty($CNF['FIELD_ALLOW_VIEW_TO']) && (int)$aContentInfo[$CNF['FIELD_ALLOW_VIEW_TO']] < 0) { + $iContextProfileId = abs((int)$aContentInfo[$CNF['FIELD_ALLOW_VIEW_TO']]); + $oContextProfile = BxDolProfile::getInstance($iContextProfileId); + + $aAdmins = bx_srv($oContextProfile->getModule(), 'get_admins_to_manage_content', [$iContextProfileId]); + if(!empty($aAdmins) && in_array($iProfileId, $aAdmins)) + return true; + } + + if(isset($CNF['FIELD_STATUS']) && $aContentInfo[$CNF['FIELD_STATUS']] != 'active') + return false; + + if(isset($CNF['FIELD_STATUS_ADMIN']) && isset($aContentInfo[$CNF['FIELD_STATUS_ADMIN']]) && $aContentInfo[$CNF['FIELD_STATUS_ADMIN']] != 'active') + return false; + + return true; + } + + public function isEntryAuthor($aContentInfo, $iProfileId = 0) + { + $CNF = &$this->_oConfig->CNF; + + if(!$iProfileId) + $iProfileId = bx_get_logged_profile_id(); + + $mixedResult = null; + /** + * @hooks + * @hookdef hook-bx_base_general-is_entry_author '{module_name}', 'is_entry_author' - hook to check if a viewer is an author of viewed entry (content) or not + * - $unit_name - module name + * - $action - equals `is_entry_author` + * - $object_id - not used + * - $sender_id - not used + * - $extra_params - array of additional params with the following array keys: + * - `viewer_id` - [int] viewer profile id + * - `content_info` - [array] content info array as key&value pairs + * - `override_result` - [boolean] by ref, boolean value which determines whether the viewer is an author of viewed entry (content) or not, can be overridden in hook processing + * @hook @ref hook-bx_base_general-is_entry_author + */ + bx_alert($this->getName(), 'is_entry_author', 0, 0, [ + 'viewer_id' => $iProfileId, + 'content_info' => $aContentInfo, + 'override_result' => &$mixedResult + ]); + if($mixedResult !== null) + return $mixedResult; + + return abs($aContentInfo[$CNF['FIELD_AUTHOR']]) == $iProfileId; + } + + public function actionUpdateImage($sFiledName, $iContentId, $sValue) + { + $mixedResult = $this->serviceUpdateImage($sFiledName, $iContentId, $sValue); + if($mixedResult !== false) + echo $mixedResult; + } + + public function actionUpdateImagePosition($iContentId, $sFiledName, $sH, $sV) + { + $this->serviceUpdateImagePosition($iContentId, $sFiledName, $sH, $sV); + } + + public function actionApprove() + { + $CNF = &$this->_oConfig->CNF; + + if(!isset($CNF['FIELD_STATUS_ADMIN'])) + return echoJson([]); + + $iContentId = (int)bx_get('content_id'); + $aContentInfo = $this->_oDb->getContentInfoById($iContentId); + if(empty($aContentInfo) || !is_array($aContentInfo) || $aContentInfo[$CNF['FIELD_STATUS_ADMIN']] != BX_BASE_MOD_GENERAL_STATUS_PENDING) + return echoJson([]); + + if(($mixedCheckResult = $this->checkAllowedApprove($aContentInfo)) !== CHECK_ACTION_RESULT_ALLOWED) + return echoJson(['msg' => $mixedCheckResult]); + + $oForm = $this->_getApproveForm($iContentId, $aContentInfo); + $oForm->initChecker(); + + if(!$oForm->isSubmitted() || !$oForm->isValid()) { + $sPopupId = $this->getName() . '_approve_' . $iContentId; + $sPopupTitle = '_sys_manage_popup_approve_title'; + if(!empty($CNF['T']['txt_approve_popup_title'])) + $sPopupTitle = $CNF['T']['txt_approve_popup_title']; + + return echoJson(['popup' => BxTemplFunctions::getInstance()->popupBox($sPopupId, _t($sPopupTitle), $oForm->getCode(true))]); + } + + if($oForm->getCleanValue('do_send')) { + $aResult = []; + if($this->_sendApproveMessage($iContentId, $aContentInfo, $oForm)) + $aResult = ['msg' => _t('_sys_manage_txt_sent')]; + else + $aResult = ['msg' => _t('_sys_manage_err_cannot_perform_action')]; + + return echoJson($aResult); + } + + if($oForm->getCleanValue('do_submit')) { + $aResult = []; + if($this->_oDb->updateEntriesBy([$CNF['FIELD_STATUS_ADMIN'] => BX_BASE_MOD_GENERAL_STATUS_ACTIVE], [$CNF['FIELD_ID'] => $iContentId])) { + $this->checkAllowedApprove($aContentInfo, true); + + $this->onApprove($aContentInfo); + + /* + * Process metas. + * Note. It's essential to process metas a the very end, + * because all data related to an entry should be already + * processed and are ready to be passed to alert. + */ + $this->processMetasAdd($iContentId); + + $aResult = ['msg' => _t('_sys_manage_txt_approved'), 'reload' => 1]; + } + else + $aResult = ['msg' => _t('_sys_manage_err_cannot_perform_action')]; + + return echoJson($aResult); + } + } + + public function serviceSetStatus($iId, $sValue, $sStatus = '') + { + $CNF = &$this->_oConfig->CNF; + + if(!$sStatus && !empty($CNF['FIELD_STATUS_ADMIN'])) + $sStatus = $CNF['FIELD_STATUS_ADMIN']; + + $aStatuses = []; + if(!empty($CNF['FIELD_STATUS_ADMIN'])) + $aStatuses[] = $CNF['FIELD_STATUS_ADMIN']; + if(!empty($CNF['FIELD_STATUS'])) + $aStatuses[] = $CNF['FIELD_STATUS']; + + if(!in_array($sStatus, $aStatuses)) + return false; + + if((int)$this->_oDb->updateEntriesBy([$sStatus => $sValue], [$CNF['FIELD_ID'] => $iId]) == 0) + return false; + + if($sValue == BX_BASE_MOD_GENERAL_STATUS_ACTIVE) + $this->onPublished($iId); + } + + public function actionRss () + { + $aArgs = func_get_args(); + $this->_rss($aArgs); + } + + public function actionGetAttachLinkForm() + { + $CNF = &$this->_oConfig->CNF; + + $iContentId = ($iContentId = bx_get($CNF['FIELD_ATTACH_LINK_CONTENT_ID'])) !== false ? (int)$iContentId : 0; + + echo $this->_oTemplate->getAttachLinkForm($iContentId); + } + + public function actionSubmitAttachLinkForm() + { + echoJson($this->getFormAttachLink()); + } + + public function actionAddAttachLink() + { + $CNF = &$this->_oConfig->CNF; + + $sUrl = bx_process_input(bx_get($CNF['FIELD_ATTACH_LINK_URL'])); + if(empty($sUrl)) + return echoJson([]); + + $sUrl = htmlspecialchars_decode($sUrl); + $oStreamContext = stream_context_create([ + 'http' => [ + 'timeout' => getParam('sys_default_socket_timeout'), + ] + ]); + + $sHeader = 'Content-Type'; + $aHeaders = @get_headers($sUrl, 1, $oStreamContext); + if(!empty($aHeaders) && is_array($aHeaders) && !empty($aHeaders[$sHeader])) { + $mixedContentType = $aHeaders[$sHeader]; + if(!is_array($mixedContentType)) + $mixedContentType = [$mixedContentType]; + + foreach($mixedContentType as $sContentType) + if(strpos($sContentType, 'image') !== false) + return echoJson([]); + } + + echoJson($this->addAttachLink([ + $CNF['FIELD_ATTACH_LINK_CONTENT_ID'] => ($iContentId = bx_get($CNF['FIELD_ATTACH_LINK_CONTENT_ID'])) !== false ? (int)$iContentId : 0, + $CNF['FIELD_ATTACH_LINK_URL'] => $sUrl + ])); + } + + public function actionDeleteAttachLink() + { + $CNF = &$this->_oConfig->CNF; + + $iUserId = $this->getUserId(); + $iLinkId = bx_process_input(bx_get('id'), BX_DATA_INT); + if(empty($iLinkId)) + return echoJson([]); + + $aLink = $this->_oDb->getLinksBy(['type' => 'id', 'id' => $iLinkId, 'profile_id' => $iUserId]); + if(empty($aLink) || !is_array($aLink)) + return echoJson([]); + + if(!empty($aLink['media_id'])) + BxDolStorage::getObjectInstance($CNF['OBJECT_STORAGE_PHOTOS'])->deleteFile($aLink['media_id']); + + $aResult = []; + if($this->_oDb->deleteLink($iLinkId)) + $aResult = ['code' => 0, 'url' => $aLink['url']]; + else + $aResult = ['code' => 1, 'message' => _t(!empty($CNF['txt_link_form_err_delete']) ? $CNF['txt_link_form_err_delete'] : $this->getName() . '_form_post_input_link_err_delete')]; + + echoJson($aResult); + } + + public function actionGetCreatePostForm() + { + $sName = $this->_oConfig->getName(); + + $aParams = bx_process_input(array_intersect_key($_GET, $this->_aFormParams)); + $aParams = array_merge($this->_aFormParams, $aParams); + $aParams['context_id'] = (bool)$aParams['context_id'] ? (int)$aParams['context_id'] : false; + + $mixedResponse = $this->serviceGetCreatePostForm($aParams); + if(empty($mixedResponse)) + return echoJson(array()); + else if(is_array($mixedResponse)) { + $mixedResponse['module'] = $sName; + return echoJson($mixedResponse); + } + + return echoJson(array( + 'module' => $sName, + 'content' => $mixedResponse + )); + } + + public function actionGetNotes() + { + $CNF = &$this->_oConfig->CNF; + if(empty($CNF['OBJECT_NOTES'])) + return echoJson([]); + + $iContentId = (int)bx_get('content_id'); + + $oCmtsNotes = BxDolCmts::getObjectInstance($CNF['OBJECT_NOTES'], $iContentId, true, $this->_oTemplate); + $aCmtsNotes = $oCmtsNotes->getCommentsBlock([], ['in_designbox' => false]); + if(empty($aCmtsNotes) || !is_array($aCmtsNotes)) + return echoJson([]); + + $sPostfix = $iContentId < 0 ? '_rc' : ''; + + $sPopupId = $this->getName() . '_notes_' . $iContentId; + $sPopupTitle = !empty($CNF['T']['txt_cmts_notes_popup_view_title' . $sPostfix]) ? $CNF['T']['txt_cmts_notes_popup_view_title' . $sPostfix] : '_cmt_nts_popup_view_title' . $sPostfix; + echoJson(['popup' => BxTemplFunctions::getInstance()->popupBox($sPopupId, _t($sPopupTitle), $aCmtsNotes['content'])]); + } + + public function actionNested() + { + $sAction = bx_get('a'); + $sMethodName = 'subaction' . ucfirst($sAction); + if (!method_exists($this, $sMethodName)) { + return; + } + $this->$sMethodName(); + } + + public function actionEmbed($iContentId, $sUnitTemplate = '', $sAddCode = '') + { + $oTemplate = BxDolTemplate::getInstance(); + + $aContentInfo = $this->_oDb->getContentInfoById($iContentId); + if(empty($aContentInfo)) + $oTemplate->getEmbed(false); + + if(empty($sUnitTemplate)) + $sUnitTemplate = 'unit_gallery.html'; + + $CNF = &$this->_oConfig->CNF; + + if(!empty($CNF['OBJECT_VIEWS'])) { + $oView = BxDolView::getObjectInstance($CNF['OBJECT_VIEWS'], $iContentId); + if($oView && $oView->isEnabled()) + $oView->doView(); + } + + $oTemplate->getEmbed($this->_oTemplate->unit($aContentInfo, true, $sUnitTemplate) . $sAddCode); + } + + public function subactionDelete() + { + header('Content-type: text/html; charset=utf-8'); + + $iNestedId = (int)bx_get('id'); + $sNestedForm = bx_get('s'); + + $oForm = BxDolForm::getObjectInstance($sNestedForm, $sNestedForm); + if (!$oForm){ + echo _t('_sys_request_page_not_found_cpt'); + return; + } + + $aNested = $this->_oDb->getNestedBy(array('type' => 'id', 'id' => $iNestedId, 'key_name' => $oForm->aParams['db']['key']), $oForm->aParams['db']['table']); + if (empty($aNested)){ + echo _t('_sys_request_page_not_found_cpt'); + return; + } + + $aContentInfo = $this->_oDb->getContentInfoById ($aNested['content_id']); + if (!$aContentInfo){ + echo _t('_sys_request_page_not_found_cpt'); + return; + } + + elseif (CHECK_ACTION_RESULT_ALLOWED !== ($sMsg = $this->checkAllowedEdit ($aContentInfo))) { + echo $sMsg; + } + elseif (!$this->_oDb->deleteNestedById($iNestedId, $oForm->aParams['db']['key'], $oForm->aParams['db']['table'])) { + echo _t('_sys_txt_error_occured'); + } + else { + echo 'ok'; + } + } + + /** + * Get possible recipients for start conversation form + */ + public function actionAjaxGetProfiles () + { + $sTerm = bx_get('term'); + + $a = BxDolService::call('system', 'profiles_search', array($sTerm), 'TemplServiceProfiles'); + + header('Content-Type:text/javascript; charset=utf-8'); + echo(json_encode($a)); + } + + public function serviceGetProfiles ($sParams) + { + $aOptions = json_decode($sParams, true); + if (!$sParams || !isset($aOptions['term'])) + return []; + + return BxDolService::call('system', 'profiles_search', array($aOptions['term']), 'TemplServiceProfiles'); + } + + public function actionGetBrowsingFilters() + { + $aParams = $this->_prepareBrowsingFiltersParamsGet(); + + $sContent = $this->_oTemplate->getBrowsingFilters($aParams); + if(empty($sContent)) + return echoJson([]); + + echoJson([ + 'code' => 0, + 'popup' => [ + 'html' => $sContent, + 'options' => [ + 'closeOnOuterClick' => false, + 'removeOnClose' => false, + ] + ], + ]); + } + + public function actionApplyBrowsingFilters() + { + $aParams = $this->_prepareBrowsingFiltersParamsGet(); + + $aBrowseParams = ['mode' => $aParams['mode'], 'empty_message' => true]; + unset($aParams['mode']); + $aBrowseParams['params'] = $aParams; + + $mixedResult = $this->serviceBrowse($aBrowseParams); + if(empty($mixedResult)) + return echoJson([]); + + if(is_array($mixedResult) && isset($mixedResult['content'])) + $mixedResult = $mixedResult['content']; + + return echoJson([ + 'code' => 0, + 'content' => $mixedResult, + 'eval' => $this->_oConfig->getJsObject('main') . '.onApplyBrowsingFilter(oData)' + ]); + } + + protected function _prepareBrowsingFiltersParamsGet($mParams = false) + { + $aParams = []; + $bParams = !empty($mParams) && is_array($mParams); + + foreach($this->_aBrowsingFiltersKeys as $sKey) + if($bParams) { + if(isset($mParams[$sKey])) + $aParams[$sKey] = $mParams[$sKey]; + } + else { + if(($sValue = bx_get($sKey)) !== false) + $aParams[$sKey] = $sValue; + } + + return $aParams; + } + + // ====== SERVICE METHODS + + public function serviceIsBadgesAvaliable() + { + if(!isAdmin() && !$this->_isAdministrator()) + return false; + + $aBadges = BxDolBadges::getInstance()->getData([ + 'type' => 'by_module&object', + 'object_id' => 0, + 'module' => $this->getName() + ]); + + return count($aBadges) > 0 ? true : false; + } + + public function serviceGetSafeServices() + { + return array( + // other + 'ModuleIcon' => '', + 'GetLink' => '', + // browse + 'GetSearchResultUnit' => '', + 'Browse' => '', + 'BrowseFeatured' => '', + 'BrowseFavorite' => '', + // forms + 'GetCreatePostForm' => '', + 'EntityCreate' => '', + 'EntityEdit' => '', + 'EntityDelete' => '', + 'UpdateImage' => '', + // page blocks + 'EntityTextBlock' => '', + 'EntityInfo' => '', + 'EntityInfoFull' => '', + 'EntityInfoExtended' => '', + 'EntityLocation' => '', + 'EntityComments' => '', + 'EntityAttachments' => '', + 'CategoriesMultiList' => '', + // menu + 'EntityAllActions' => '', + 'EntityActions' => '', + 'EntitySocialSharing' => '', + 'MyEntriesActions' => '', + + 'GetProfiles' => '', + ); + } + + /** + * @page service Service Calls + * @section bx_base_general Base General + * @subsection bx_base_general-other Other + * @subsubsection bx_base_general-module_icon module_icon + * + * @code bx_srv('bx_posts', 'module_icon', [...]); @endcode + * + * Get module icon as CSS class name with FontAwesome icon name class and color class + * + * @see BxBaseModGeneralModule::serviceModuleIcon + */ + /** + * @ref bx_base_general-module_icon "module_icon" + */ + public function serviceModuleIcon () + { + return isset($this->_oConfig->CNF['ICON']) ? $this->_oConfig->CNF['ICON'] : ''; + } + + public function serviceGetAuthor ($iContentId) + { + $mixedResult = $this->_getFieldValue('FIELD_AUTHOR', $iContentId); + return $mixedResult !== false ? (int)$mixedResult : 0; + } + + public function serviceGetPrivacyView ($iContentId) + { + return $this->_getFieldValue('FIELD_ALLOW_VIEW_TO', $iContentId); + } + + public function serviceGetDateAdded ($iContentId) + { + $mixedResult = $this->_getFieldValue('FIELD_ADDED', $iContentId); + return $mixedResult !== false ? (int)$mixedResult : 0; + } + + public function serviceGetDateChanged ($iContentId) + { + $mixedResult = $this->_getFieldValue('FIELD_CHANGED', $iContentId); + return $mixedResult !== false ? (int)$mixedResult : 0; + } + + /** + * @page service Service Calls + * @section bx_base_general Base General + * @subsection bx_base_general-other Other + * @subsubsection bx_base_general-get_link get_link + * + * @code bx_srv('bx_posts', 'get_link', [...]); @endcode + * + * Get URL for the specified content. + * @param $iContentId content id + * + * @see BxBaseModGeneralModule::serviceGetLink + */ + /** + * @ref bx_base_general-get_link "get_link" + */ + public function serviceGetLink ($iContentId) + { + $CNF = &$this->_oConfig->CNF; + if(empty($CNF['URI_VIEW_ENTRY'])) + return ''; + + $aContentInfo = $this->_oDb->getContentInfoById($iContentId); + if(empty($aContentInfo)) + return ''; + + return bx_absolute_url(BxDolPermalinks::getInstance()->permalink('page.php?i=' . $CNF['URI_VIEW_ENTRY'] . '&id=' . $aContentInfo[$CNF['FIELD_ID']])); + } + + public function serviceGetTitle ($iContentId) + { + $mixedResult = $this->_getFieldValue('FIELD_TITLE', $iContentId); + return $mixedResult !== false ? $mixedResult : ''; + } + + public function serviceGetText ($iContentId) + { + $mixedResult = $this->_getFieldValue('FIELD_TEXT', $iContentId); + if (false === $mixedResult) + return ''; + + $CNF = &$this->_oConfig->CNF; + if (!empty($CNF['OBJECT_METATAGS']) && is_string($mixedResult)) { + $oMetatags = BxDolMetatags::getObjectInstance($CNF['OBJECT_METATAGS']); + $mixedResult = $oMetatags->metaParse($iContentId, $mixedResult); + } + + return $mixedResult; + } + + public function serviceGetLocation ($iContentId) + { + $CNF = &$this->_oConfig->CNF; + + if(empty($CNF['OBJECT_METATAGS'])) + return []; + + $mixedResult = $this->_getFieldValue('FIELD_LOCATION', $iContentId); + if(false === $mixedResult) + return []; + + $oMeta = false; + if(!($oMeta = BxDolMetatags::getObjectInstance($CNF['OBJECT_METATAGS'])) || !$oMeta->locationsIsEnabled()) + return false; + + $aLocation = $oMeta->locationGet($iContentId); + if(empty($aLocation) || !is_array($aLocation)) + return false; + + return array_values(array_slice($aLocation, 1)); + } + + public function serviceGetEmbed ($iContentId) + { + $sTitle = $this->_getFieldValue('FIELD_TITLE', $iContentId); + return $this->_oTemplate->parseHtmlByName('embed.html', [ + 'title' => $sTitle, + 'url' => BX_DOL_URL_ROOT . $this->_oConfig->getBaseUri() . 'embed/' . $iContentId . '/' + ]); + } + + public function serviceGetInfo ($iContentId, $bSearchableFieldsOnly = true) + { + $CNF = &$this->_oConfig->CNF; + + $aContentInfo = $this->_getFields($iContentId); + if(empty($aContentInfo)) + return array(); + + if(!$bSearchableFieldsOnly) + return $aContentInfo; + + if(empty($CNF['PARAM_SEARCHABLE_FIELDS'])) + return array(); + + $aFields = explode(',', getParam($CNF['PARAM_SEARCHABLE_FIELDS'])); + if(empty($aFields)) + return array(); + + $aResult = array(); + foreach($aFields as $sField) + if(isset($aContentInfo[$sField])) + $aResult[$sField] = $aContentInfo[$sField]; + + return $aResult; + } + + public function serviceGetInfoApi ($iContentId, $bExtendedUnits = false) + { + $aData = $this->serviceGetInfo($iContentId, false); + if($aData) + $aData = $this->getDataAPI($aData, ['extended' => $bExtendedUnits]); + + return $aData; + } + + /** + * @page service Service Calls + * @section bx_base_general Base General + * @subsection bx_base_general-browsing Browsing + * @subsubsection bx_base_general-get_search_result_unit get_search_result_unit + * + * @code bx_srv('bx_posts', 'get_search_result_unit', [3,"unit_gallery.html"]); @endcode + * + * Get browsing unit for the specified content + * @param $iContentId content id + * @param $sUnitTemplate unit template, such as: unit_full.html, unit_gallery.html, unit_live_search.html + * + * @see BxBaseModGeneralModule::serviceGetSearchResultUnit + */ + /** + * @ref bx_base_general-get_search_result_unit "get_search_result_unit" + */ + public function serviceGetSearchResultUnit ($iContentId, $sUnitTemplate = '') + { + $aContentInfo = $this->_oDb->getContentInfoById($iContentId); + if($this->_bIsApi) + return $this->getDataAPI($aContentInfo); + + if(empty($aContentInfo)) + return ''; + + if(empty($sUnitTemplate)) + $sUnitTemplate = 'unit.html'; + + return $this->_oTemplate->unit($aContentInfo, true, $sUnitTemplate); + } + + public function serviceGetAll ($aParams = array()) + { + if(empty($aParams) || !is_array($aParams)) + $aParams = array('type' => 'all'); + + return $this->_oDb->getEntriesBy($aParams); + } + + public function serviceGetAllByAuthor ($iProfileId) + { + return $this->_oDb->getEntriesByAuthor((int)$iProfileId); + } + + public function serviceGetSortableFieldsExtended($aInputsAdd = array()) + { + $CNF = &$this->_oConfig->CNF; + if(empty($CNF['OBJECT_FORM_ENTRY'])) + return array(); + + $aResult = array(); + + $aSortableFields = []; + + $aDisplays = []; + if(!empty($CNF['OBJECT_FORM_ENTRY_DISPLAY_ADD'])) { + $aDisplays[] = $CNF['OBJECT_FORM_ENTRY_DISPLAY_ADD']; + } + if(!empty($CNF['OBJECT_FORM_ENTRY_DISPLAY_EDIT'])) { + $aDisplays[] = $CNF['OBJECT_FORM_ENTRY_DISPLAY_EDIT']; + } + + $aInputsAll = BxDolFormQuery::getFormInputs($CNF['OBJECT_FORM_ENTRY']); + foreach($aInputsAll as $aInput){ + $aInputsAll[$aInput['name']] = $aInput; + } + + $aInputs = BxDolFormQuery::getFormInputs($CNF['OBJECT_FORM_ENTRY'], $aDisplays); + foreach($aInputs as $aInput){ + $aInputs[$aInput['name']] = $aInput; + if ($aInput['type'] == 'text'){ + $aSortableFields[] = $aInput['name']; + } + } + + if(!empty($CNF['FIELD_ADDED']) && isset($aInputsAll[$CNF['FIELD_ADDED']])){ + $aSortableFields[] = $CNF['FIELD_ADDED']; + } + + if(!empty($CNF['FIELD_CHANGED']) && isset($aInputsAll[$CNF['FIELD_CHANGED']])){ + $aSortableFields[] = $CNF['FIELD_CHANGED']; + } + + foreach($aSortableFields as $sSortableField){ + $aResult[$sSortableField . '_asc'] = [ + 'name' => $sSortableField, + 'caption' => $aInputsAll[$sSortableField]['caption'], + 'direction' => 'asc' + ]; + + $aResult[$sSortableField . '_desc'] = [ + 'name' => $sSortableField, + 'caption' => $aInputsAll[$sSortableField]['caption'], + 'direction' => 'desc' + ]; + } + + /** + * @hooks + * @hookdef hook-bx_base_general-get_sortable_fields '{module_name}', 'get_sortable_fields' - hook to override a list of sortable fields + * - $unit_name - module name + * - $action - equals `get_sortable_fields` + * - $object_id - not used + * - $sender_id - not used + * - $extra_params - array of additional params with the following array keys: + * - `override_result` - [array] a list of searchable fields, can be overridden in hook processing + * @hook @ref hook-bx_base_general-get_sortable_fields + */ + bx_alert($this->getName(), 'get_sortable_fields', 0, 0, [ + 'extended' => true, + 'override_result' => &$aResult + ]); + + return $aResult; + } + + public function serviceGetSearchableFieldsExtended($aInputsAdd = array()) + { + $CNF = &$this->_oConfig->CNF; + if(empty($CNF['OBJECT_FORM_ENTRY'])) + return array(); + + $aResult = array(); + if(!empty($CNF['FIELD_AUTHOR']) && !in_array($CNF['FIELD_AUTHOR'], $this->_aSearchableNamesExcept)) + $aResult[$CNF['FIELD_AUTHOR']] = array( + 'type' => 'text_auto', + 'caption' => $CNF['T']['form_field_author'], + 'info' => '', + 'value' => '', + 'values' => '', + 'pass' => '' + ); + + if(!empty($CNF['FIELD_LABELS']) && !in_array($CNF['FIELD_LABELS'], $this->_aSearchableNamesExcept)) + $aResult[$CNF['FIELD_LABELS']] = array( + 'type' => 'checkbox_set', + 'caption' => isset($CNF['T']['form_field_labels']) ? $CNF['T']['form_field_author'] : '_sys_form_input_labels', + 'info' => '', + 'value' => '', + 'values' => '', + 'pass' => '', + 'search_operator' => 'like' + ); + + + $aInputs = array(); + if(!empty($CNF['OBJECT_FORM_ENTRY_DISPLAY_ADD'])) { + $oForm = BxDolForm::getObjectInstance($CNF['OBJECT_FORM_ENTRY'], $CNF['OBJECT_FORM_ENTRY_DISPLAY_ADD'], $this->_oTemplate); + + $aInputs = array_merge($aInputs, $oForm->aInputs); + } + if(!empty($CNF['OBJECT_FORM_ENTRY_DISPLAY_EDIT'])) { + $oForm = BxDolForm::getObjectInstance($CNF['OBJECT_FORM_ENTRY'], $CNF['OBJECT_FORM_ENTRY_DISPLAY_EDIT'], $this->_oTemplate); + + $aInputs = array_merge($aInputs, $oForm->aInputs); + } + + if(!empty($aInputsAdd) && is_array($aInputsAdd)) + $aInputs = array_merge($aInputs, $aInputsAdd); + + foreach($aInputs as $aInput){ + if(in_array($aInput['type'], BxDolSearchExtended::$SEARCHABLE_TYPES) && !in_array($aInput['name'], $this->_aSearchableNamesExcept)) { + $aField = array( + 'type' => $aInput['type'], + 'caption_system' => $aInput['caption_system_src'], + 'caption' => $aInput['caption_src'], + 'info' => $aInput['info_src'], + 'value' => !empty($aInput['value']) ? $aInput['value'] : '', + 'values' => !empty($aInput['values_src']) ? $aInput['values_src'] : '', + 'pass' => !empty($aInput['db']['pass']) ? $aInput['db']['pass'] : '', + ); + + if(isset($aInput['search_type'])) + $aField['search_type'] = $aInput['search_type']; + + if(isset($aInput['search_operator'])) + $aField['search_operator'] = $aInput['search_operator']; + + $aResult[$aInput['name']] = $aField; + } + } + + /** + * @hooks + * @hookdef hook-bx_base_general-get_searchable_fields '{module_name}', 'get_searchable_fields' - hook to override a list of searchable fields + * - $unit_name - module name + * - $action - equals `get_searchable_fields` + * - $object_id - not used + * - $sender_id - not used + * - $extra_params - array of additional params with the following array keys: + * - `override_result` - [array] a list of searchable fields, can be overridden in hook processing + * @hook @ref hook-bx_base_general-get_searchable_fields + */ + bx_alert($this->getName(), 'get_searchable_fields', 0, 0, [ + 'extended' => true, + 'override_result' => &$aResult + ]); + + return $aResult; + } + + public function serviceGetSearchResultExtended($aParams, $iStart = 0, $iPerPage = 0, $bFilterMode = false) + { + if((empty($aParams) || !is_array($aParams)) && !$bFilterMode) + return array(); + + return $this->_oDb->getEntriesBy(array('type' => 'search_ids', 'search_params' => $aParams, 'start' => $iStart, 'per_page' => $iPerPage)); + } + + public function serviceGetSearchableFields ($aInputsAdd = array()) + { + $CNF = $this->_oConfig->CNF; + + if(!isset($CNF['PARAM_SEARCHABLE_FIELDS']) || !isset($CNF['OBJECT_FORM_ENTRY']) || !isset($CNF['OBJECT_FORM_ENTRY_DISPLAY_ADD'])) + return array(); + + $oForm = BxDolForm::getObjectInstance($CNF['OBJECT_FORM_ENTRY'], $CNF['OBJECT_FORM_ENTRY_DISPLAY_ADD'], $this->_oTemplate); + if(!$oForm) + return array(); + + $aInputs = $oForm->aInputs; + if(!empty($aInputsAdd) && is_array($aInputsAdd)) + $aInputs = array_merge($aInputs, $aInputsAdd); + + $aTextTypes = array('text', 'textarea'); + $aTextFields = array(); + foreach($aInputs as $r) + if(in_array($r['type'], $aTextTypes)) + $aTextFields[$r['name']] = $r['caption']; + + return $aTextFields; + } + + public function serviceUpdateImage($sFiledName, $iContentId, $sValue) + { + $CNF = &$this->_oConfig->CNF; + + $aData = $this->_oDb->getContentInfoById($iContentId); + if(empty($aData) || !is_array($aData)) + return false; + + if($this->checkAllowedEdit($aData) !== CHECK_ACTION_RESULT_ALLOWED) + return false; + + //TODO add transcoder settings + $oImgStorage = BxDolStorage::getObjectInstance($CNF['OBJECT_STORAGE']); + if(!$oImgStorage) + return false; + + $this->_oDb->updateEntriesBy([$sFiledName => $sValue], [$CNF['FIELD_ID'] => $iContentId]); + + $this->serviceUpdateImagePosition($iContentId, $sFiledName, '', ''); + + $this->onUpdateImage($iContentId, $sFiledName, $sValue); + + return $oImgStorage->getFileUrlById($sValue); + } + + public function serviceUpdateImagePosition($iContentId, $sFiledName, $sH, $sV) + { + $CNF = &$this->_oConfig->CNF; + + $sFieldNamePos = 'FIELD_' . strtoupper($sFiledName) . '_POSITION'; + if(!isset($CNF[$sFieldNamePos])) + return false; + + $sValue = ''; + if($sH != '' || $sV != '') + $sValue = json_encode(['x' => $sH, 'y' => $sV]); + + $this->_oDb->updateEntriesBy([$CNF[$sFieldNamePos] => $sValue], [$CNF['FIELD_ID'] => $iContentId]); + + return true; + } + + public function serviceManageTools($sType = 'common') + { + if(!isLogged()) + return ''; + + $oGrid = BxDolGrid::getObjectInstance($this->_oConfig->getGridObject($sType)); + if(!$oGrid) + return ''; + + if($this->_bIsApi) + return [ + bx_api_get_block('grid', $oGrid->getCodeAPI()) + ]; + + $CNF = &$this->_oConfig->CNF; + + $mixedMenu = ''; + if(BxDolAcl::getInstance()->isMemberLevelInSet(192)) { + $oPermalink = BxDolPermalinks::getInstance(); + + $aMenuItems = array(); + if(!empty($CNF['OBJECT_GRID_COMMON']) && !empty($CNF['T']['menu_item_manage_my'])) + $aMenuItems[] = array('id' => 'manage-common', 'name' => 'manage-common', 'class' => '', 'link' => $oPermalink->permalink($CNF['URL_MANAGE_COMMON']), 'target' => '_self', 'title' => _t($CNF['T']['menu_item_manage_my']), 'active' => 1); + if(!empty($CNF['OBJECT_GRID_ADMINISTRATION']) && !empty($CNF['T']['menu_item_manage_all'])) + $aMenuItems[] = array('id' => 'manage-administration', 'name' => 'manage-administration', 'class' => '', 'link' => $oPermalink->permalink($CNF['URL_MANAGE_ADMINISTRATION']), 'target' => '_self', 'title' => _t($CNF['T']['menu_item_manage_all']), 'active' => 1); + + if(count($aMenuItems) > 1) { + $mixedMenu = new BxTemplMenu(array( + 'template' => 'menu_block_submenu_ver.html', + 'menu_items' => $aMenuItems + ), $this->_oTemplate); + $mixedMenu->setSelected($this->_aModule['name'], 'manage-' . $sType); + } + } + + if(!empty($CNF['OBJECT_MENU_SUBMENU']) && isset($CNF['URI_MANAGE_COMMON']) && ($oSubmenu = BxDolMenu::getObjectInstance($CNF['OBJECT_MENU_SUBMENU'])) !== false) + $oSubmenu->setSelected($this->_aModule['name'], $CNF['URI_MANAGE_COMMON']); + + $this->_oTemplate->addCss(array('manage_tools.css')); + $this->_oTemplate->addJs(array('manage_tools.js')); + $this->_oTemplate->addJsTranslation(array('_sys_grid_search')); + return array( + 'content' => $this->_oTemplate->getJsCode('manage_tools', array('sObjNameGrid' => $this->_oConfig->getGridObject($sType))) . $oGrid->getCode(), + 'menu' => $mixedMenu + ); + } + + public function serviceGetMenuAddonManageTools() + { + return 0; + } + + public function serviceGetMenuAddonManageToolsProfileStats($iProfileId = 0) + { + return 0; + } + + /** + * @page service Service Calls + * @section bx_base_general Base General + * @subsection bx_base_general-browsing Browsing + * @subsubsection bx_base_general-browse browse + * + * @code bx_srv('bx_posts', 'browse', [...]); @endcode + * @code {{~bx_posts:browse[{"mode":"author", "params":{"author":"10"}}]~}} @endcode + * + * Universal browse method. + * @param $aParams custom browse params, possible params are the following: + * - mode - browse mode, such as 'recent', 'featured', etc + * - params - custom params to browse method, for example 'unit_view' can be passed here + * - design_box - design box style, @see BxBaseFunctions::DesignBoxContent + * - empty_message - display or not "empty" message when there is no content + * - ajax_paginate - use AJAX paginate or not + * + * @see BxBaseModGeneralModule::serviceBrowse + */ + /** + * @ref bx_base_general-browse "browse" + */ + public function serviceBrowse ($aParams = array()) + { + if($this->_bIsApi && is_string($aParams)){ + $aParams = json_decode($aParams, true); + if (isset($aParams['params'])) { + if(isset($aParams['params']['type'])) + $aParams['mode'] = $aParams['params']['type']; + + if(isset($aParams['params']['filters'])) { + foreach($aParams['params']['filters'] as $sKey => $sValue) + $aParams['params'][$sKey] = $sValue; + + $aParams['params']['filters'] = [ + 'values' => $aParams['params']['filters'] + ]; + } + + if(isset($aParams['params']['validate']) && !is_array($aParams['params']['validate'])) + $aParams['params']['validate'] = !empty($aParams['params']['validate']) ? explode(',', $aParams['params']['validate']) : []; + } + } + + if (isset($aParams['params']['condition'])) + unset($aParams['params']['condition']); + + return $this->serviceBrowseWithCondition ($aParams); + } + + public function serviceBrowseWithCondition ($aParams = array()) + { + $aDefaults = array ( + 'mode' => 'recent', + 'params' => false, + 'design_box' => BX_DB_PADDING_DEF, + 'empty_message' => false, + 'ajax_paginate' => true, + 'class_search_result' => 'SearchResult' + ); + + $aParams = array_merge($aDefaults, $aParams); + + return $this->_serviceBrowse ($aParams['mode'], $aParams['params'], $aParams['design_box'], $aParams['empty_message'], $aParams['ajax_paginate'], $aParams['class_search_result']); + } + + /** + * @page service Service Calls + * @section bx_base_general Base General + * @subsection bx_base_general-browsing Browsing + * @subsubsection bx_base_general-browse_featured browse_featured + * + * @code bx_srv('bx_posts', 'browse_featured', [...]); @endcode + * + * Display featured entries + * @param $sUnitView browsing unity view, + * such as: full, extended, gallery, showcase + * @param $bEmptyMessage display or not "empty" message when there is no content + * @param $bAjaxPaginate use AJAX paginate or not + * + * @see BxBaseModGeneralModule::serviceBrowseFeatured + */ + /** + * @ref bx_base_general-browse_featured "browse_featured" + */ + public function serviceBrowseFeatured ($sUnitView = false, $bEmptyMessage = false, $bAjaxPaginate = true) + { + return $this->_serviceBrowse ('featured', $sUnitView ? array('unit_view' => $sUnitView) : false, BX_DB_PADDING_DEF, $bEmptyMessage, $bAjaxPaginate); + } + + /** + * @page service Service Calls + * @section bx_base_general Base General + * @subsection bx_base_general-browsing Browsing + * @subsubsection bx_base_general-browse_favorite browse_favorite + * + * @code bx_srv('bx_posts', 'browse_favorite', [...]); @endcode + * + * Display entries which were added to favorite list by some member + * @param $iProfileId profile ID + * @param $aParams additional browse params, see BxBaseModGeneralModule::serviceBrowse + * + * @see BxBaseModGeneralModule::serviceBrowseFavorite BxBaseModGeneralModule::serviceBrowse + */ + /** + * @ref bx_base_general-browse_favorite "browse_favorite" + */ + public function serviceBrowseFavorite ($iProfileId = 0, $aParams = array()) + { + $CNF = &$this->_oConfig->CNF; + + $oProfile = null; + if((int)$iProfileId) + $oProfile = BxDolProfile::getInstance($iProfileId); + if(!$oProfile && bx_get('profile_id') !== false) + $oProfile = BxDolProfile:: getInstance(bx_process_input(bx_get('profile_id'), BX_DATA_INT)); + if(!$oProfile) + $oProfile = BxDolProfile::getInstance(); + if(!$oProfile) + return ''; + + $bEmptyMessage = true; + if(isset($aParams['empty_message'])) { + $bEmptyMessage = (bool)$aParams['empty_message']; + unset($aParams['empty_message']); + } + + if(bx_get('list_id') !== false && !isset($aParams['list_id'])) + $aParams['list_id'] = (int) bx_get('list_id'); + + $aBlock = $this->_serviceBrowse ('favorite', array_merge(array('user' => $oProfile->id()), $aParams), BX_DB_PADDING_DEF, $bEmptyMessage); + if(!$aBlock) + return $aBlock; + + $sTitle = _t('_sys_txt_default_favorite_list'); + if(!empty($aParams['list_id']) && ($oFavorite = BxDolFavorite::getObjectInstance($CNF['OBJECT_FAVORITES'], 0, true))) { + $aList = $oFavorite->getQueryObject()->getList(['type' => 'id', 'list_id' => $aParams['list_id']]); + if(!empty($aList) && is_array($aList)) + $sTitle = $aList['title']; + } + + return array_merge($aBlock, ['markers' => [ + 'title' => $sTitle + ]]); + } + + /** + * @page service Service Calls + * @section bx_base_general Base General + * @subsection bx_base_general-browsing Browsing + * @subsubsection bx_base_general-browse_favorite_lists browse_favorite_lists + * + * @code bx_srv('bx_posts', 'browse_favorite_lists', [...]); @endcode + * + * Display entries which were added to favorite lists grouped by lists by some member + * @param $iProfileId profile ID + * @param $aParams additional browse params, see BxBaseModGeneralModule::serviceBrowse + * + * @see BxBaseModGeneralModule::serviceBrowseFavoriteLists BxBaseModGeneralModule::serviceBrowse + */ + /** + * @ref bx_base_general-browse_favorite_lists "browse_favorite_lists" + */ + public function serviceBrowseFavoriteLists ($iProfileId = 0, $aParams = array()) + { + $CNF = &$this->_oConfig->CNF; + + $oProfile = null; + if((int)$iProfileId) + $oProfile = BxDolProfile::getInstance($iProfileId); + if(!$oProfile && bx_get('profile_id') !== false) + $oProfile = BxDolProfile:: getInstance(bx_process_input(bx_get('profile_id'), BX_DATA_INT)); + if(!$oProfile) + $oProfile = BxDolProfile::getInstance(); + if(!$oProfile) + return ''; + + $iStart = (bx_get('list_start') !== false ? (int)bx_get('list_start') : 0); + $iPerPage = (int)getParam($CNF['PARAM_PER_PAGE_FOR_FAVORITES_LISTS']); + + return $this->_oTemplate->getFavoriteList($oProfile, $iStart, $iPerPage, $aParams); + } + + /** + * @page service Service Calls + * @section bx_base_general Base General + * @subsection bx_base_general-browsing Browsing + * @subsubsection bx_base_general-browse_by_category category + * + * @code bx_srv('bx_posts', 'browse_by_category', [...]); @endcode + * + * Display entries in category + * @param $sUnitView browsing unity view, + * such as: full, extended, gallery, showcase + * @param $bEmptyMessage display or not "empty" message when there is no content + * @param $bAjaxPaginate use AJAX paginate or not + * + * @see BxBaseModGeneralModule::serviceBrowseByCategory BxBaseModGeneralModule::serviceBrowse + */ + /** + * @ref bx_base_general-browse_by_category "browse_by_category" + */ + public function serviceBrowseCategory($sUnitView = false, $bEmptyMessage = true, $bAjaxPaginate = true, $aParams = []) + { + $sType = 'category'; + + $aParams = array_merge(['category' => bx_process_input(bx_get('category'), BX_DATA_INT)], $aParams); + if($sUnitView) + $aParams['unit_view'] = $sUnitView; + + return $this->_serviceBrowse($sType, $aParams, BX_DB_PADDING_DEF, $bEmptyMessage, $bAjaxPaginate); + } + + /** + * @page service Service Calls + * @section bx_base_general Base General + * @subsection bx_base_general-browsing Browsing + * @subsubsection bx_base_general-browse_favorite_list_actions browse_favorite_list_actions + * + * @code bx_srv('bx_posts', 'browse_favorite_list_actions', [...]); @endcode + * + * Display menu actions for favorite lists + * + * @see BxBaseModGeneralModule::serviceFavoritesListActions + */ + /** + * @ref bx_base_general-browse_favorite_list_actions "browse_favorite_list_actions" + */ + public function serviceFavoritesListActions() + { + $iListId = 0; + if(bx_get('list_id') !== false) + $iListId = (int) bx_get('list_id'); + + $oProfile = null; + if(bx_get('profile_id') !== false) + $oProfile = BxDolProfile:: getInstance(bx_process_input(bx_get('profile_id'), BX_DATA_INT)); + if(!$oProfile) + return false; + + $CNF = &$this->_oConfig->CNF; + $oFavorite = BxDolFavorite::getObjectInstance($CNF['OBJECT_FAVORITES'], 0, true); + + $aList = $oFavorite->getQueryObject()->getList(array('type' => 'id', 'list_id' => $iListId)); + if($iListId != 0 && (empty($aList) || !is_array($aList))) + return false; + + $sRv = ''; + if (!empty($aList) && $oFavorite->isAllowedEditList($aList['author_id'])){ + $aMarkers = array( + 'js_object' => $oFavorite->getJsObjectName(), + 'list_id' => $iListId, + ); + + $oMenu = BxDolMenu::getObjectInstance('sys_favorite_list'); + + $oMenu->addMarkers($aMarkers); + $sMenu = $oMenu->getCode(); + + $sRv .= $sMenu . $oFavorite->getJsScript(); + } + + $aMarkers = array( + 'id' => $iListId, + 'module' => $this->_aModule['name'], + 'url' => $this->_getFavoriteListUrl($iListId, $oProfile->id()), + 'title' => $iListId > 0 ? $aList['title'] : _t('_sys_txt_default_favorite_list') + ); + + $oMenu = BxDolMenu::getObjectInstance('sys_social_sharing'); + $oMenu->addMarkers($aMarkers); + $sRv .= $sMenu = $oMenu->getCode(); + return $sRv; + } + + /** + * @page service Service Calls + * @section bx_base_general Base General + * @subsection bx_base_general-menu Menu + * @subsubsection bx_base_general-favorites_list_info favorites_list_info + * + * @code bx_srv('bx_posts', 'favorites_list_info', [...]); @endcode + * + * Favorites list info + * @param $aParams array with additional custom params + * which may overwrite some default values + * + * @see BxBaseModGeneralModule::serviceFavoritesListInfo + */ + /** + * @ref bx_base_general-favorites_list_info "favorites_list_info" + */ + public function serviceFavoritesListInfo($aParams = array()) + { + $CNF = &$this->_oConfig->CNF; + + $iListId = 0; + if(bx_get('list_id') !== false) + $iListId = (int) bx_get('list_id'); + + $oFavorite = BxDolFavorite::getObjectInstance($CNF['OBJECT_FAVORITES'], 0, true); + $aList = $oFavorite->getQueryObject()->getList(array('type' => 'id', 'list_id' => $iListId)); + if($iListId != 0 && (empty($aList) || !is_array($aList))) + return false; + + $oProfile = null; + if(bx_get('profile_id') !== false) + $oProfile = BxDolProfile:: getInstance(bx_process_input(bx_get('profile_id'), BX_DATA_INT)); + + if(!$oProfile) + return false; + + return $this->_oTemplate->getFavoritesListInfo($aList, $oProfile); + } + + /** + * Display entries posted into particular context + * @return HTML string + */ + public function serviceBrowseContext ($iProfileId = 0, $aParams = array()) + { + return $this->_serviceBrowseWithParam ('context', 'profile_id', $iProfileId, $aParams); + } + + public function _serviceBrowseWithParam ($sParamName, $sParamGet, $sParamVal, $aParams = array()) + { + if(!$sParamVal) + $sParamVal = bx_process_input(bx_get($sParamGet), BX_DATA_INT); + if(!$sParamVal) + return ''; + + $bEmptyMessage = true; + if(isset($aParams['empty_message'])) { + $bEmptyMessage = (bool)$aParams['empty_message']; + unset($aParams['empty_message']); + } + + $bAjaxPaginate = true; + if(isset($aParams['ajax_paginate'])) { + $bAjaxPaginate = (bool)$aParams['ajax_paginate']; + unset($aParams['ajax_paginate']); + } + + return $this->_serviceBrowse ($sParamName, array_merge(array($sParamName => $sParamVal), $aParams), BX_DB_PADDING_DEF, $bEmptyMessage, $bAjaxPaginate); + } + + public function getFormsHelper () + { + $sClass = 'FormsEntryHelper'; + $oObject = null; + + bx_alert('system', 'get_forms_helper', 0, 0, [ + 'class' => &$sClass, + 'object' => &$oObject + ]); + + if($oObject !== null) + return $oObject; + + bx_import($sClass, $this->_aModule); + $sClass = $this->_aModule['class_prefix'] . $sClass; + return new $sClass($this); + } + + public function serviceFormsHelper () + { + return $this->getFormsHelper(); + } + + /** + * Add entry using provided fields' values. + * @return array with result: 'code' is 0 on success or non-zero on error, 'message' is error message in case of error, 'content' is content info array in case of success + */ + public function serviceEntityAdd ($iProfile, $aValues, $sDisplay = false) + { + $oFormsHelper = $this->getFormsHelper(); + return $oFormsHelper->addData($iProfile, $aValues, $sDisplay); + } + + /** + * Perform redirect after content creation + * @return nothing, rediret header is sent + */ + public function serviceRedirectAfterAdd($aContentInfo) + { + $oFormsHelper = $this->getFormsHelper(); + $oFormsHelper->redirectAfterAdd($aContentInfo); + } + + /** + * Get form object for add, edit, view or delete the content + * @param $sType 'add', 'edit', 'view' or 'delete' + * @param $aParams optional array with parameters(display name, etc) + * @return form object or false on error + */ + public function serviceGetObjectForm ($sType, $aParams = array()) + { + if(!in_array($sType, array('add', 'edit', 'view', 'delete'))) + return false; + + $iLoggedId = (int)bx_get_logged_profile_id(); + $mixedContextId = isset($aParams['context_id']) ? $aParams['context_id'] : false; + + $oContextProfile = false; + $bContext = $mixedContextId !== false; + if($bContext) { + $oContextProfile = BxDolProfile::getInstance(abs($mixedContextId)); + $bContext = $oContextProfile !== false; + + if($bContext && $oContextProfile->checkAllowedPostInProfile() !== CHECK_ACTION_RESULT_ALLOWED) + return false; + } + + $CNF = &$this->_oConfig->CNF; + $oFormsHelper = $this->getFormsHelper(); + + $sParamsKey = 'ajax_mode'; + if(isset($aParams[$sParamsKey]) && (bool)$aParams[$sParamsKey] === true) + $oFormsHelper->setAjaxMode((bool)$aParams[$sParamsKey]); + + $sParamsKey = 'absolute_action_url'; + if(isset($aParams[$sParamsKey]) && (bool)$aParams[$sParamsKey] === true) + $oFormsHelper->setAbsoluteActionUrl((bool)$aParams[$sParamsKey]); + + if($bContext) + $oFormsHelper->setContextId($mixedContextId); + + $sDisplay = !empty($aParams['display']) ? $aParams['display'] : false; + + $sFunc = 'getObjectForm' . ucfirst($sType); + $oForm = $oFormsHelper->$sFunc($sDisplay); + + $sKey = 'FIELD_ALLOW_VIEW_TO'; + if(!empty($CNF[$sKey]) && !empty($oForm->aInputs[$CNF[$sKey]]) && (!$bContext || $mixedContextId < 0)) { + $bContextOwner = $bContext && abs($mixedContextId) == $iLoggedId; + + if(!$bContext || $bContextOwner) { + $iGc = 0; + $iKeyGh = false; + foreach($oForm->aInputs[$CNF[$sKey]]['values'] as $iKey => $aValue) { + if(isset($aValue['type']) && in_array($aValue['type'], array('group_header', 'group_end'))) { + if($iKeyGh !== false && $iGc == 0) { + unset($oForm->aInputs[$CNF[$sKey]]['values'][$iKeyGh]); + $iKeyGh = false; + + if($aValue['type'] == 'group_end') + unset($oForm->aInputs[$CNF[$sKey]]['values'][$iKey]); + } + + if($aValue['type'] == 'group_header') { + $iGc = 0; + $iKeyGh = $iKey; + } + + continue; + } + + //--- Show 'Public' privacy group only in Public post form. + if(!$bContext && $aValue['key'] == BX_DOL_PG_ALL) { + $iGc += 1; + continue; + } + + //--- Show a default privacy groups in Profile (for Owner) post form. + if($bContextOwner && ((int)$aValue['key'] >= 0 || $mixedContextId == $aValue['key'])) { + $iGc += 1; + continue; + } + + unset($oForm->aInputs[$CNF[$sKey]]['values'][$iKey]); + } + } + else { + $oForm->aInputs[$CNF[$sKey]]['value'] = $mixedContextId; + $oForm->aInputs[$CNF[$sKey]]['type'] = 'hidden'; + } + } + + $sKey = 'FIELD_LABELS'; + if(!empty($CNF[$sKey]) && !empty($oForm->aInputs[$CNF[$sKey]]) && empty($oForm->aInputs[$CNF[$sKey]]['value']) && $bContext) { + $iContextProfileId = $oContextProfile->id(); + $sContextModule = $oContextProfile->getModule(); + + if(bx_srv($sContextModule, 'is_fan', [$iContextProfileId, $iLoggedId])) { + $aContextInfo = bx_srv($sContextModule, 'get_content_info_by_profile_id', [$iContextProfileId]); + if(!empty($aContextInfo['hashtag'])) + $oForm->aInputs[$CNF[$sKey]]['value'] = [$aContextInfo['hashtag']]; + } + } + + /** + * @hooks + * @hookdef hook-system-get_object_form 'system', 'get_object_form' - hook to override an object of create content form, @see BxDolForm + * - $unit_name - equals `system` + * - $action - equals `get_object_form` + * - $object_id - not used + * - $sender_id - not used + * - $extra_params - array of additional params with the following array keys: + * - `module` - [string] module name + * - `type` - [string] 'add', 'edit', 'view' or 'delete' form display type + * - `params` - [array] form params array as key&value pairs + * - `form` - [object] by ref, an object of create content form, @see BxDolForm, can be overridden in hook processing + * @hook @ref hook-system-get_object_form + */ + bx_alert('system', 'get_object_form', 0, 0, [ + 'module' => $this->_oConfig->getName(), + 'type' => $sType, + 'params' => $aParams, + 'form' => &$oForm + ]); + + return $oForm; + } + + /** + * + * + * Create entry form + * @return HTML string + */ + public function serviceEntityCreate ($sParams = false) + { + $bParamsArray = is_array($sParams); + + $sDisplay = is_string($sParams) ? $sParams : false; + if($bParamsArray && !empty($sParams['display'])) + $sDisplay = $sParams['display']; + + $oFormsHelper = $this->getFormsHelper(); + if($bParamsArray && isset($sParams['dynamic_mode'])) + $oFormsHelper->setDynamicMode($sParams['dynamic_mode']); + + $mixedResult = $oFormsHelper->addDataForm($sDisplay); + + if (bx_is_api()){ + return $mixedResult; + } + + if(isset($mixedResult['_dt']) && $mixedResult['_dt'] == 'json') { + echoJson($mixedResult); + exit; + } + + return $mixedResult; + } + + /** + * @page service Service Calls + * @section bx_base_general Base General + * @subsection bx_base_general-forms Forms + * @subsubsection bx_base_general-get_create_post_form get_create_post_form + * + * @code bx_srv('bx_posts', 'get_create_post_form'); @endcode + * + * Get content creation form + * @param $aParams additional parameters array: + * context_id, ajax_mode, absolute_action_url, displays + * + * @see BxBaseModGeneralModule::serviceGetCreatePostForm + */ + /** + * @ref bx_base_general-get_create_post_form "get_create_post_form" + */ + public function serviceGetCreatePostForm($aParams = []) + { + $aParams = array_merge($this->_aFormParams, $aParams); + + if($aParams['context_id'] !== false && ($aContextInfo = BxDolProfileQuery::getInstance()->getInfoById(abs($aParams['context_id'])))) + if(bx_srv($aContextInfo['type'], 'check_allowed_post_in_profile', [$aContextInfo['content_id'], $this->getName()]) !== CHECK_ACTION_RESULT_ALLOWED) + return ''; + + $oForm = $this->serviceGetObjectForm('add', $aParams); + if(!$oForm) + return ''; + + return $this->serviceEntityCreate($aParams); + } + + /** + * @page service Service Calls + * @section bx_base_general Base General + * @subsection bx_base_general-forms Forms + * @subsubsection bx_base_general-entity_edit entity_edit + * + * @code bx_srv('bx_posts', 'entity_edit', [...]); @endcode + * + * Get content edit form + * @param $iContentId content ID + * @param $sDisplay optional form display name + * + * @see BxBaseModGeneralModule::serviceEntityEdit + */ + /** + * @ref bx_base_general-entity_edit "entity_edit" + */ + public function serviceEntityEdit ($iContentId = 0, $sDisplay = false) + { + $mixedResult = $this->_serviceEntityForm ('editDataForm', $iContentId, $sDisplay); + if(!bx_is_api()) + return $mixedResult; + + $aResult = []; + if(is_a($mixedResult, 'BxTemplFormView')){ + $iContentId = $this->_getContent($iContentId, false); + $aResult = bx_api_get_block('form', $mixedResult->getCodeAPI(), ['ext' => ['name' => $this->getName(), 'request' => ['url' => '/api.php?r=' . $this->_aModule['name'] . '/entity_edit¶ms[]=' . $iContentId . '¶ms[]=' . $mixedResult->aParams['display'], 'immutable' => true]]]); + } + else + $aResult = $mixedResult; + + return [ + $aResult + ]; + } + + /** + * @page service Service Calls + * @section bx_base_general Base General + * @subsection bx_base_general-forms Forms + * @subsubsection bx_base_general-entity_delete entity_delete + * + * @code bx_srv('bx_posts', 'entity_delete', [...]); @endcode + * + * Get content delete form + * @param $iContentId content ID + * + * @see BxBaseModGeneralModule::serviceEntityDelete + */ + /** + * @ref bx_base_general-entity_delete "entity_delete" + */ + public function serviceEntityDelete ($iContentId = 0) + { + $mixedResult = $this->_serviceEntityForm ('deleteDataForm', $iContentId); + if(!bx_is_api()) + return $mixedResult; + + $aResult = []; + if(is_a($mixedResult, 'BxTemplFormView')){ + $iContentId = $this->_getContent($iContentId, false); + $aResult = bx_api_get_block('form', $mixedResult->getCodeAPI(), ['ext' => ['name' => $this->getName(), 'request' => ['url' => '/api.php?r=' . $this->_aModule['name'] . '/entity_delete¶ms[]=' . $iContentId . '¶ms[]=' . $mixedResult->aParams['display'], 'immutable' => true]]]); + } + else + $aResult = $mixedResult; + + return [ + $aResult + ]; + } + + /** + * @page service Service Calls + * @section bx_base_general Base General + * @subsection bx_base_general-page_blocks Page Blocks + * @subsubsection bx_base_general-entity_text_block entity_text_block + * + * @code bx_srv('bx_posts', 'entity_text_block', [...]); @endcode + * + * Get content text/description + * @param $iContentId content ID + * + * @see BxBaseModGeneralModule::serviceEntityTextBlock + */ + /** + * @ref bx_base_general-entity_text_block "entity_text_block" + */ + public function serviceEntityTextBlock ($iContentId = 0) + { + return $this->_serviceEntityForm ('viewDataEntry', $iContentId); + } + + /** + * @page service Service Calls + * @section bx_base_general Base General + * @subsection bx_base_general-page_blocks Page Blocks + * @subsubsection bx_base_general-entity_info entity_info + * + * @code bx_srv('bx_posts', 'entity_info', [...]); @endcode + * + * Get content info + * @param $iContentId content ID + * + * @see BxBaseModGeneralModule::serviceEntityInfo + */ + /** + * @ref bx_base_general-entity_info "entity_info" + */ + public function serviceEntityInfo ($iContentId = 0, $sDisplay = false) + { + return $this->_serviceEntityForm ('viewDataForm', $iContentId, $sDisplay); + } + + /** + * @page service Service Calls + * @section bx_base_general Base General + * @subsection bx_base_general-page_blocks Page Blocks + * @subsubsection bx_base_general-entity_info_full entity_info_full + * + * @code bx_srv('bx_posts', 'entity_info_full', [...]); @endcode + * + * Get full content info + * @param $iContentId content ID + * + * @see BxBaseModGeneralModule::serviceEntityInfoFull + */ + /** + * @ref bx_base_general-entity_info_full "entity_info_full" + */ + public function serviceEntityInfoFull ($iContentId = 0) + { + $CNF = &$this->_oConfig->CNF; + + $sDisplayName = 'OBJECT_FORM_ENTRY_DISPLAY_VIEW_FULL'; + return $this->_serviceEntityForm ('viewDataForm', $iContentId, !empty($CNF[$sDisplayName]) ? $CNF[$sDisplayName] : false); + } + + /** + * @page service Service Calls + * @section bx_base_general Base General + * @subsection bx_base_general-page_blocks Page Blocks + * @subsubsection bx_base_general-entity_info_extended entity_info_extended + * + * @code bx_srv('bx_posts', 'entity_info_extended', [...]); @endcode + * + * Get extended content info + * @param $iContentId content ID + * + * @see BxBaseModGeneralModule::serviceEntityInfoExtended + */ + /** + * @ref bx_base_general-entity_info_extended "entity_info_extended" + */ + public function serviceEntityInfoExtended ($iContentId = 0) + { + return $this->_serviceTemplateFunc ('entryInfo', $iContentId); + } + + /** + * @page service Service Calls + * @section bx_base_general Base General + * @subsection bx_base_general-page_blocks Page Blocks + * @subsubsection bx_base_general-entity_location entity_location + * + * @code bx_srv('bx_posts', 'entity_location', [...]); @endcode + * + * Get content location + * @param $iContentId content ID + * + * @see BxBaseModGeneralModule::serviceEntityLocation + */ + /** + * @ref bx_base_general-entity_location "entity_location" + */ + public function serviceEntityLocation ($iContentId = 0) + { + $CNF = &$this->_oConfig->CNF; + + $mixedContent = $this->_getContent($iContentId); + if($mixedContent === false) + return false; + + list($iContentId, $aContentInfo) = $mixedContent; + + $oFormsHelper = $this->getFormsHelper(); + $oFormView = $oFormsHelper->getObjectFormView(); + if(!$oFormView) + return false; + + $oFormView->initChecker($aContentInfo); + if(empty($CNF['FIELD_LOCATION']) || !$oFormView->isInputVisible($CNF['FIELD_LOCATION'])) + return false; + + return $this->_oTemplate->entryLocation ($iContentId); + } + + /** + * @page service Service Calls + * @section bx_base_general Base General + * @subsection bx_base_general-page_blocks Page Blocks + * @subsubsection bx_base_general-entity_comments entity_comments + * + * @code bx_srv('bx_posts', 'entity_comments', [...]); @endcode + * + * Get content comments + * @param $iContentId content ID + * + * @see BxBaseModGeneralModule::serviceEntityComments + */ + /** + * @ref bx_base_general-entity_comments "entity_comments" + */ + public function serviceEntityComments ($iContentId = 0) + { + $CNF = &$this->_oConfig->CNF; + if(empty($CNF['OBJECT_COMMENTS'])) + return ''; + + return $this->_entityComments($CNF['OBJECT_COMMENTS'], $iContentId); + } + + /** + * @page service Service Calls + * @section bx_base_general Base General + * @subsection bx_base_general-page_blocks Page Blocks + * @subsubsection bx_base_general-entity_attachments entity_attachments + * + * @code bx_srv('bx_posts', 'entity_attachments', [...]); @endcode + * + * Get content attachments + * @param $iContentId content ID + * + * @see BxBaseModGeneralModule::serviceEntityAttachments + */ + /** + * @ref bx_base_general-entity_attachments "entity_attachments" + */ + public function serviceEntityAttachments ($iContentId = 0) + { + return $this->_serviceTemplateFunc ('entryAttachments', $iContentId); + } + + /** + * Delete content entry + * @param $iContentId content id + * @return error message or empty string on success + */ + public function serviceDeleteEntity ($iContentId, $sFuncDelete = 'deleteData') + { + $oFormsHelper = $this->getFormsHelper(); + return $oFormsHelper->$sFuncDelete($iContentId); + } + + /** + * @page service Service Calls + * @section bx_base_general Base General + * @subsection bx_base_general-menu Menu + * @subsubsection bx_base_general-my_entries_actions my_entries_actions + * + * @code bx_srv('bx_posts', 'my_entries_actions', [...]); @endcode + * + * My entries actions menu + * @param $iProfileId profiles ID, + * if omitted it try to get it from 'profile_id' GET param + * + * @see BxBaseModGeneralModule::serviceMyEntriesActions + */ + /** + * @ref bx_base_general-my_entries_actions "my_entries_actions" + */ + public function serviceMyEntriesActions ($iProfileId = 0) + { + $CNF = &$this->_oConfig->CNF; + if(empty($CNF['OBJECT_MENU_ACTIONS_MY_ENTRIES'])) + return false; + + if (!$iProfileId) + $iProfileId = bx_process_input(bx_get('profile_id'), BX_DATA_INT); + if (!$iProfileId || !($oProfile = BxDolProfile::getInstance($iProfileId))) + return false; + + if ($iProfileId != $this->_iProfileId) + return false; + + $oMenu = BxTemplMenu::getObjectInstance($CNF['OBJECT_MENU_ACTIONS_MY_ENTRIES']); + return $oMenu ? $oMenu->getCode() : false; + } + + /** + * @page service Service Calls + * @section bx_base_general Base General + * @subsection bx_base_general-menu Menu + * @subsubsection bx_base_general-entity_all_actions entity_all_actions + * + * @code bx_srv('bx_posts', 'entity_all_actions', [...]); @endcode + * + * Entry actions and social sharing actions + * @param $mixedContent content ID + * @param $aParams additional params + * + * @see BxBaseModGeneralModule::serviceEntityAllActions + */ + /** + * @ref bx_base_general-entity_all_actions "entity_all_actions" + */ + public function serviceEntityAllActions ($mixedContent = false, $aParams = array()) + { + $mixedResult = $this->getEntryAllActions($mixedContent, $aParams); + + if(bx_is_api()) + return [bx_api_get_block('entity_actions', $mixedResult)]; + else + return $this->_oTemplate->entryAllActions($mixedResult); + } + + /** + * @page service Service Calls + * @section bx_base_general Base General + * @subsection bx_base_general-menu Menu + * @subsubsection bx_base_general-entity_actions entity_actions + * + * @code bx_srv('bx_posts', 'entity_actions', [...]); @endcode + * + * Entry actions, without social sharing actions + * @param $iContentId content ID + * + * @see BxBaseModGeneralModule::serviceEntityActions + */ + /** + * @ref bx_base_general-entity_actions "entity_actions" + */ + public function serviceEntityActions ($iContentId = 0) + { + $iContentId = $this->_getContent($iContentId, false); + if($iContentId === false) + return false; + + $oMenu = BxTemplMenu::getObjectInstance($this->_oConfig->CNF['OBJECT_MENU_ACTIONS_VIEW_ENTRY']); + return $oMenu ? $oMenu->getCode() : false; + } + + /** + * @page service Service Calls + * @section bx_base_general Base General + * @subsection bx_base_general-page_blocks Page Blocks + * @subsubsection bx_base_general-entity_reports entity_reports + * + * @code bx_srv('bx_posts', 'entity_reports', [...]); @endcode + * + * Get content reports + * @param $iContentId content ID + * + * @see BxBaseModGeneralModule::serviceEntityReports + */ + /** + * @ref bx_base_general-entity_reports "entity_reports" + */ + public function serviceEntityReports ($iContentId = 0) + { + $mixedContent = $this->_getContent($iContentId); + list($iContentId, $aContentInfo) = $mixedContent; + + if($iContentId === false) + return false; + + $CNF = &$this->_oConfig->CNF; + + if (!isset($CNF['OBJECT_REPORTS']) || !isset($CNF['OBJECT_NOTES'])) + return false; + + if(!$aContentInfo || !(BxDolAcl::getInstance()->isMemberLevelInSet(192) || (isset($CNF['FIELD_AUTHOR']) && bx_get_logged_profile_id() == $aContentInfo[$CNF['FIELD_AUTHOR']]))) + return false; + + $oReport = BxDolReport::getObjectInstance($CNF['OBJECT_REPORTS'], $iContentId, true); + if(!$oReport) + return false; + + return $oReport->getReportedByWithComments($CNF['OBJECT_NOTES']); + } + + /** + * @page service Service Calls + * @section bx_base_general Base General + * @subsection bx_base_general-page_blocks Page Blocks + * @subsubsection bx_base_general-reports_count_by_status reports_count_by_status + * + * @code bx_srv('bx_posts', 'reports_count_by_status', [...]); @endcode + * + * Get number of reports with specified status + * @param $iStatus status ID + * + * @see BxBaseModGeneralModule::serviceReportsCountByStatus + */ + /** + * @ref bx_base_general-entity_reports "entity_reports" + */ + public function serviceReportsCountByStatus ($iStatus) + { + $CNF = &$this->_oConfig->CNF; + + if (!isset($CNF['OBJECT_REPORTS']) || !isset($CNF['OBJECT_NOTES'])) + return false; + + $oReport = BxDolReport::getObjectInstance($CNF['OBJECT_REPORTS'], 0, false); + return $oReport->getCountByStatus($iStatus); + } + + /** + * @page service Service Calls + * @section bx_base_general Base General + * @subsection bx_base_general-menu Menu + * @subsubsection bx_base_general-entity_social_sharing entity_social_sharing + * + * @code bx_srv('bx_posts', 'entity_social_sharing', [...]); @endcode + * + * Entry social sharing actions + * @param $mixedContent content ID or array with integer content ID and + * array with content info, or false + * @param $aParams array with additional custom params + * which may overwrite some default values + * + * @see BxBaseModGeneralModule::serviceEntitySocialSharing + */ + /** + * @ref bx_base_general-entity_social_sharing "entity_social_sharing" + */ + public function serviceEntitySocialSharing($mixedContent = false, $aParams = array()) + { + if(!empty($mixedContent)) { + if(!is_array($mixedContent)) + $mixedContent = array((int)$mixedContent, array()); + } + else { + $mixedContent = $this->_getContent(); + if($mixedContent === false) + return false; + } + + list($iContentId, $aContentInfo) = $mixedContent; + + $CNF = &$this->_oConfig->CNF; + + $sUri = !empty($aParams['uri']) ? $aParams['uri'] : ''; + if(empty($sUri) && !empty($CNF['URI_VIEW_ENTRY'])) + $sUri = $CNF['URI_VIEW_ENTRY']; + + $sUrl = !empty($sUri) ? BxDolPermalinks::getInstance()->permalink('page.php?i=' . $sUri . '&id=' . $iContentId) : ''; + + $sTitle = !empty($aParams['title']) ? $aParams['title'] : ''; + if(empty($sTitle) && !empty($aContentInfo[$CNF['FIELD_TITLE']])) + $sTitle = $aContentInfo[$CNF['FIELD_TITLE']]; + + $aMarkers = array( + 'id' => $iContentId, + 'module' => $this->_aModule['name'], + 'url' => bx_absolute_url($sUrl), + 'title' => $sTitle, + ); + + $iIdThumb = !empty($aParams['id_thumb']) ? (int)$aParams['id_thumb'] : 0; + if(empty($iIdThumb) && !empty($CNF['FIELD_THUMB']) && !empty($aContentInfo[$CNF['FIELD_THUMB']])) + $iIdThumb = (int)$aContentInfo[$CNF['FIELD_THUMB']]; + + if ($iIdThumb) { + $sTranscoder = !empty($aParams['object_transcoder']) ? $aParams['object_transcoder'] : ''; + $sStorage = !empty($aParams['object_storage']) ? $aParams['object_storage'] : ''; + if(empty($sStorage) && !empty($CNF['OBJECT_STORAGE'])) + $sStorage = $CNF['OBJECT_STORAGE']; + + if(!empty($sTranscoder)) + $o = BxDolTranscoder::getObjectInstance($sTranscoder); + else if(!empty($sStorage)) + $o = BxDolStorage::getObjectInstance($sStorage); + + $sImgUrl = $o ? $o->getFileUrlById($iIdThumb) : ''; + if($sImgUrl) + $aMarkers['img_url'] = $sImgUrl; + } + + $oMenu = BxDolMenu::getObjectInstance('sys_social_sharing'); + $oMenu->addMarkers($aMarkers); + $sMenu = $oMenu->getCode(); + + if(empty($sMenu)) + return ''; + + return $this->_oTemplate->parseHtmlByName('entry-share.html', array( + 'menu' => $sMenu + )); + } + + /** + * Entry context block + */ + public function serviceEntityContext ($iContentId = 0) + { + return $this->_serviceTemplateFunc ('entryContext', $iContentId); + } + + /** + * Blocks for lables tree browsing + */ + public function serviceGetLablesTree() + { + $aBreadcrumbs = array(); + $this->_getLablesBreadcrumbsArray(bx_get('label'), $aBreadcrumbs); + return $this->_getLablesTreeLevel($aBreadcrumbs); + } + + public function serviceGetLablesBreadcrumbs() + { + if (bx_get('label')){ + $aBreadcrumbs = array(); + $this->_getLablesBreadcrumbsArray(bx_process_input(bx_get('label'), BX_DATA_INT), $aBreadcrumbs); + $aLabels = array(); + foreach (array_reverse($aBreadcrumbs) as $aLabel){ + $aLabels[] = array( + 'value' => $aLabel['value'], + 'url' => $this->_getLablesBrowseUrl($aLabel['id']) + ); + } + + return $this->_oTemplate->parseHtmlByName('labels_breadcrumbs.html', array('bx_repeat:items' => $aLabels)); + } + return ''; + } + + public function serviceBrowseByLabel() + { + $CNF = &$this->_oConfig->CNF; + if (empty($CNF['OBJECT_METATAGS'])) + return ''; + + $sMode = 'recent'; + if(bx_srv('system', 'is_module_content', [$this->_aModule['name']])) + $sMode = 'public'; + + $sClassSearchResult ='SearchResult'; + + bx_import($sClassSearchResult, $this->_aModule['name']); + $sClass = $this->_aModule['class_prefix'] . $sClassSearchResult; + + $o = new $sClass($sMode, false); + $o->setDesignBoxTemplateId(BX_DB_PADDING_DEF); + $o->setDisplayEmptyMsg(true); + $o->setAjaxPaginate(false); + $o->setUnitParams(array('context' => $sMode)); + + if (bx_get('label')){ + $iLabelId = (int)bx_get('label'); + $oLabel = BxDolLabel::getInstance(); + $aLabel = $oLabel->getLabels(array('type' => 'id', 'id' => $iLabelId)); + $oMetatags = BxDolMetatags::getObjectInstance($CNF['OBJECT_METATAGS']); + $sTmp =$oMetatags->keywordsSetSearchCondition($o, $aLabel['value']); + } + + if ($o->isError) + return ''; + + if ($s = $o->processing()) + return $s; + else + return ''; + } + + public function serviceBrowseByCategories($sUnitView, $bEmptyMessage, $bAjaxPaginate, $sMode, $iPerPage) + { + $CNF = &$this->_oConfig->CNF; + $sClassSearchResult ='SearchResult'; + + bx_import($sClassSearchResult, $this->_aModule['name']); + $sClass = $this->_aModule['class_prefix'] . $sClassSearchResult; + $o = new $sClass($sMode, array('unit_view' => $sUnitView, 'paginate' => array('perPage' => 10, 'start' => 0, 'num' => 11))); + $o->setDesignBoxTemplateId(BX_DB_PADDING_DEF); + $o->setAjaxPaginate($bAjaxPaginate); + $o->setCategoryObject('multi'); + + $aCategoriesOutput = array(); + $aCategories = BxDolCategories::getInstance()->getData(array('type' => 'by_module_with_num', 'module' => $this->_aModule['name'])); + + foreach($aCategories as $aCategory){ + if ($aCategory['num'] > 0){ + $o->setCustomSearchCondition(array('keyword' => $aCategory['value'])); + $o->setPaginatePerPage(2); + if (!$o->isError){ + $aResult = $o->processing(); + if ($aResult && $aResult['content'] != '') + $aCategoriesOutput[] = array('name' => _t($aCategory['value']), 'url' => '', 'content' => $aResult['content']); + } + } + } + + return $this->_oTemplate->parseHtmlByName('browse_by_categories.html', array( + 'bx_repeat:categories' => $aCategoriesOutput, + )); + + } + + /** + * Data for Notifications module + */ + public function serviceGetNotificationsData() + { + $sModule = $this->_aModule['name']; + + $sEventPrivacy = $sModule . '_allow_view_event_to'; + if(BxDolPrivacy::getObjectInstance($sEventPrivacy) === false) + $sEventPrivacy = ''; + + $aResult = [ + 'handlers' => [ + ['group' => $sModule . '_object', 'type' => 'insert', 'alert_unit' => $sModule, 'alert_action' => 'added', 'module_name' => $sModule, 'module_method' => 'get_notifications_post', 'module_class' => 'Module', 'module_event_privacy' => $sEventPrivacy], + ['group' => $sModule . '_object', 'type' => 'update', 'alert_unit' => $sModule, 'alert_action' => 'edited'], + ['group' => $sModule . '_object', 'type' => 'delete', 'alert_unit' => $sModule, 'alert_action' => 'deleted'], + + ['group' => $sModule . '_object_approved', 'type' => 'insert', 'alert_unit' => $sModule, 'alert_action' => 'approved', 'module_name' => $sModule, 'module_method' => 'get_notifications_post_approved', 'module_class' => 'Module', 'module_event_privacy' => $sEventPrivacy], + + ['group' => $sModule . '_comment', 'type' => 'insert', 'alert_unit' => $sModule, 'alert_action' => 'commentPost', 'module_name' => $sModule, 'module_method' => 'get_notifications_comment', 'module_class' => 'Module', 'module_event_privacy' => $sEventPrivacy], + ['group' => $sModule . '_comment', 'type' => 'delete', 'alert_unit' => $sModule, 'alert_action' => 'commentRemoved'], + + ['group' => $sModule . '_reply', 'type' => 'insert', 'alert_unit' => $sModule, 'alert_action' => 'replyPost', 'module_name' => $sModule, 'module_method' => 'get_notifications_reply', 'module_class' => 'Module', 'module_event_privacy' => $sEventPrivacy], + ['group' => $sModule . '_reply', 'type' => 'delete', 'alert_unit' => $sModule, 'alert_action' => 'replyRemoved'], + + ['group' => $sModule . '_vote', 'type' => 'insert', 'alert_unit' => $sModule, 'alert_action' => 'doVote', 'module_name' => $sModule, 'module_method' => 'get_notifications_vote', 'module_class' => 'Module', 'module_event_privacy' => $sEventPrivacy], + ['group' => $sModule . '_vote', 'type' => 'delete', 'alert_unit' => $sModule, 'alert_action' => 'undoVote'], + + ['group' => $sModule . '_reaction', 'type' => 'insert', 'alert_unit' => $sModule . '_reactions', 'alert_action' => 'doVote', 'module_name' => $sModule, 'module_method' => 'get_notifications_reaction', 'module_class' => 'Module', 'module_event_privacy' => $sEventPrivacy], + ['group' => $sModule . '_reaction', 'type' => 'delete', 'alert_unit' => $sModule . '_reactions', 'alert_action' => 'undoVote'], + + ['group' => $sModule . '_score_up', 'type' => 'insert', 'alert_unit' => $sModule, 'alert_action' => 'doVoteUp', 'module_name' => $sModule, 'module_method' => 'get_notifications_score_up', 'module_class' => 'Module', 'module_event_privacy' => $sEventPrivacy], + + ['group' => $sModule . '_score_down', 'type' => 'insert', 'alert_unit' => $sModule, 'alert_action' => 'doVoteDown', 'module_name' => $sModule, 'module_method' => 'get_notifications_score_down', 'module_class' => 'Module', 'module_event_privacy' => $sEventPrivacy], + + //--- Moderation related: For 'admins'. + ['group' => $sModule . '_object_pending_approval', 'type' => 'insert', 'alert_unit' => $sModule, 'alert_action' => 'pending_approval', 'module_name' => $sModule, 'module_method' => 'get_notifications_post_pending_approval', 'module_class' => 'Module', 'module_event_privacy' => $sEventPrivacy], + ], + 'settings' => [ + ['group' => 'content', 'unit' => $sModule, 'action' => 'added', 'types' => ['follow_member', 'follow_context']], + ['group' => 'content_updated', 'unit' => $sModule, 'action' => 'approved', 'types' => ['personal']], + ['group' => 'comment', 'unit' => $sModule, 'action' => 'commentPost', 'types' => ['personal', 'follow_member', 'follow_context']], + ['group' => 'reply', 'unit' => $sModule, 'action' => 'replyPost', 'types' => ['personal']], + ['group' => 'vote', 'unit' => $sModule, 'action' => 'doVote', 'types' => ['personal', 'follow_member', 'follow_context']], + ['group' => 'vote', 'unit' => $sModule . '_reactions', 'action' => 'doVote', 'types' => ['personal', 'follow_member', 'follow_context']], + ['group' => 'score_up', 'unit' => $sModule, 'action' => 'doVoteUp', 'types' => ['personal', 'follow_member', 'follow_context']], + ['group' => 'score_down', 'unit' => $sModule, 'action' => 'doVoteDown', 'types' => ['personal', 'follow_member', 'follow_context']], + + //--- Moderation related: For 'admins'. + ['group' => 'action_required', 'unit' => $sModule, 'action' => 'pending_approval', 'types' => ['personal']], + ], + 'alerts' => [ + ['unit' => $sModule, 'action' => 'added'], + ['unit' => $sModule, 'action' => 'edited'], + ['unit' => $sModule, 'action' => 'deleted'], + + ['unit' => $sModule, 'action' => 'approved'], + + ['unit' => $sModule, 'action' => 'commentPost'], + ['unit' => $sModule, 'action' => 'commentRemoved'], + + ['unit' => $sModule, 'action' => 'replyPost'], + ['unit' => $sModule, 'action' => 'replyRemoved'], + + ['unit' => $sModule, 'action' => 'doVote'], + ['unit' => $sModule, 'action' => 'undoVote'], + + ['unit' => $sModule . '_reactions', 'action' => 'doVote'], + ['unit' => $sModule . '_reactions', 'action' => 'undoVote'], + + ['unit' => $sModule, 'action' => 'doVoteUp'], + ['unit' => $sModule, 'action' => 'doVoteDown'], + + //--- Moderation related: For 'admins'. + ['unit' => $sModule, 'action' => 'pending_approval'], + ] + ]; + + if(!empty($this->_oConfig->CNF['FIELDS_DELAYED_PROCESSING'])) { + $aResult['handlers'] = array_merge($aResult['handlers'], [ + ['group' => $sModule . '_object_publish_failed', 'type' => 'insert', 'alert_unit' => $sModule, 'alert_action' => 'publish_failed', 'module_name' => $sModule, 'module_method' => 'get_notifications_post_publish_failed', 'module_class' => 'Module', 'module_event_privacy' => ''], + ['group' => $sModule . '_object_publish_succeeded', 'type' => 'insert', 'alert_unit' => $sModule, 'alert_action' => 'publish_succeeded', 'module_name' => $sModule, 'module_method' => 'get_notifications_post_publish_succeeded', 'module_class' => 'Module', 'module_event_privacy' => ''], + ]); + + $aResult['settings'] = array_merge($aResult['settings'], [ + ['group' => 'content_updated', 'unit' => $sModule, 'action' => 'publish_failed', 'types' => ['personal']], + ['group' => 'content_updated', 'unit' => $sModule, 'action' => 'publish_succeeded', 'types' => ['personal']], + ]); + + $aResult['alerts'] = array_merge($aResult['alerts'], [ + ['unit' => $sModule, 'action' => 'publish_failed'], + ['unit' => $sModule, 'action' => 'publish_succeeded'], + ]); + } + + return $aResult; + } + + /** + * Entry post for Notifications module + */ + public function serviceGetNotificationsPost($aEvent) + { + $CNF = &$this->_oConfig->CNF; + + $aContentInfo = $this->_oDb->getContentInfoById($aEvent['object_id']); + if(empty($aContentInfo) || !is_array($aContentInfo)) + return []; + + $sEntryUrl = bx_absolute_url(BxDolPermalinks::getInstance()->permalink('page.php?i=' . $CNF['URI_VIEW_ENTRY'] . '&id=' . $aContentInfo[$CNF['FIELD_ID']]), '{bx_url_root}'); + $sEntryCaption = isset($aContentInfo[$CNF['FIELD_TITLE']]) ? $aContentInfo[$CNF['FIELD_TITLE']] : strmaxtextlen($aContentInfo[$CNF['FIELD_TEXT']], 20, '...'); + $sEntrySummary = isset($aContentInfo[$CNF['FIELD_TEXT']]) ? $aContentInfo[$CNF['FIELD_TEXT']] : ''; + + return [ + 'entry_sample' => $CNF['T']['txt_sample_single'], + 'entry_url' => $sEntryUrl, + 'entry_caption' => $sEntryCaption, + 'entry_summary' => $sEntrySummary, + 'entry_author' => $aContentInfo[$CNF['FIELD_AUTHOR']], + 'entry_privacy' => '', //may be empty or not specified. In this case Public privacy will be used. + 'lang_key' => '', //may be empty or not specified, or a string, or an array('site' => '...', 'email' => '...', 'push' => '...'). In this case of empty/not specified the default one from Notification module will be used. + /* + * Custom settings for email and/or push notifications can be provided here. + * Only necessary parts of 'settings' array can be used. + * + 'settings' => array( + 'email' => array( + 'template' => '', //--- custom email template + 'markers' => '', //--- markers to parse email parts (subject, body) with + 'subject' => '' //--- custom email subject + ), + 'push' => array( + 'subject' => '' //--- custom push notification subject + ) + ) + */ + ]; + } + + public function serviceGetNotificationsPostPendingApproval($aEvent) + { + $aResult = $this->serviceGetNotificationsPost($aEvent); + + /** + * Unset Entry Author because the notification is addressed to 'admins'. + */ + if(isset($aResult['entry_author'])) + unset($aResult['entry_author']); + + return $aResult; + } + + public function serviceGetNotificationsPostApproved($aEvent) + { + return $this->serviceGetNotificationsPost($aEvent); + } + + public function serviceGetNotificationsPostPublishFailed($aEvent) + { + return $this->serviceGetNotificationsPost($aEvent); + } + + public function serviceGetNotificationsPostPublishSucceeded($aEvent) + { + return $this->serviceGetNotificationsPost($aEvent); + } + + + /** + * Entry post comment for Notifications module + */ + public function serviceGetNotificationsComment($aEvent) + { + $CNF = &$this->_oConfig->CNF; + + $iContentId = (int)$aEvent['object_id']; + $aContentInfo = $this->_oDb->getContentInfoById($iContentId); + if(empty($aContentInfo) || !is_array($aContentInfo)) + return []; + + $oComment = BxDolCmts::getObjectInstance($CNF['OBJECT_COMMENTS'], $iContentId); + if(!$oComment || !$oComment->isEnabled()) + return []; + + $sEntryUrl = bx_absolute_url(BxDolPermalinks::getInstance()->permalink('page.php?i=' . $CNF['URI_VIEW_ENTRY'] . '&id=' . $aContentInfo[$CNF['FIELD_ID']]), '{bx_url_root}'); + $sEntryCaption = isset($aContentInfo[$CNF['FIELD_TITLE']]) ? $aContentInfo[$CNF['FIELD_TITLE']] : strmaxtextlen($aContentInfo[$CNF['FIELD_TEXT']], 20, '...'); + $sEntrySummary = isset($aContentInfo[$CNF['FIELD_TEXT']]) ? $aContentInfo[$CNF['FIELD_TEXT']] : ''; + + $iCommentId = (int)$aEvent['subobject_id']; + + return [ + 'entry_sample' => $CNF['T']['txt_sample_single'], + 'entry_url' => $sEntryUrl, + 'entry_caption' => $sEntryCaption, + 'entry_summary' => $sEntrySummary, + 'entry_author' => $aContentInfo[$CNF['FIELD_AUTHOR']], + 'subentry_sample' => $CNF['T']['txt_sample_comment_single'], + 'subentry_url' => bx_absolute_url($oComment->getViewUrl($iCommentId, false), '{bx_url_root}'), + 'subentry_summary' => $oComment->getViewText($iCommentId), + 'lang_key' => '', //may be empty or not specified. In this case the default one from Notification module will be used. + ]; + } + + /** + * Entry post reply for Notifications module + */ + public function serviceGetNotificationsReply($aEvent) + { + $CNF = &$this->_oConfig->CNF; + + $oComment = BxDolCmts::getObjectInstance($CNF['OBJECT_COMMENTS'], 0, false); + if(!$oComment || !$oComment->isEnabled()) + return []; + + $iParentId = (int)$aEvent['object_id']; + $aParentInfo = $oComment->getQueryObject()->getCommentsBy(array('type' => 'id', 'id' => $iParentId)); + if(empty($aParentInfo) || !is_array($aParentInfo)) + return []; + + $iObjectId = (int)$aParentInfo['cmt_object_id']; + $oComment->init($iObjectId); + + $iCommentId = (int)$aEvent['subobject_id']; + + return [ + 'object_id' => $iObjectId, + 'entry_sample' => '_cmt_txt_sample_comment_single', + 'entry_url' => bx_absolute_url($oComment->getViewUrl($iParentId, false), '{bx_url_root}'), + 'entry_caption' => strmaxtextlen($aParentInfo['cmt_text'], 20, '...'), + 'entry_summary' => $oComment->getViewText($iParentId), + 'entry_author' => (int)$aParentInfo['cmt_author_id'], + 'subentry_sample' => '_cmt_txt_sample_reply_to', + 'subentry_url' => bx_absolute_url($oComment->getViewUrl($iCommentId, false), '{bx_url_root}'), + 'subentry_summary' => $oComment->getViewText($iCommentId), + 'lang_key' => '', //may be empty or not specified. In this case the default one from Notification module will be used. + ]; + } + + /** + * Entry post vote for Notifications module + */ + public function serviceGetNotificationsVote($aEvent) + { + $CNF = &$this->_oConfig->CNF; + + $iContentId = (int)$aEvent['object_id']; + $aContentInfo = $this->_oDb->getContentInfoById($iContentId); + if(empty($aContentInfo) || !is_array($aContentInfo)) + return []; + + $oVote = BxDolVote::getObjectInstance($CNF['OBJECT_VOTES'], $iContentId); + if(!$oVote || !$oVote->isEnabled()) + return []; + + $sEntryUrl = bx_absolute_url(BxDolPermalinks::getInstance()->permalink('page.php?i=' . $CNF['URI_VIEW_ENTRY'] . '&id=' . $aContentInfo[$CNF['FIELD_ID']]), '{bx_url_root}'); + $sEntryCaption = isset($aContentInfo[$CNF['FIELD_TITLE']]) ? $aContentInfo[$CNF['FIELD_TITLE']] : strmaxtextlen($aContentInfo[$CNF['FIELD_TEXT']], 20, '...'); + $sEntrySummary = isset($aContentInfo[$CNF['FIELD_TEXT']]) ? $aContentInfo[$CNF['FIELD_TEXT']] : ''; + + return [ + 'entry_sample' => $CNF['T']['txt_sample_single'], + 'entry_url' => $sEntryUrl, + 'entry_caption' => $sEntryCaption, + 'entry_summary' => $sEntrySummary, + 'entry_author' => $aContentInfo[$CNF['FIELD_AUTHOR']], + 'subentry_sample' => $CNF['T']['txt_sample_vote_single'], + 'lang_key' => '', //may be empty or not specified. In this case the default one from Notification module will be used. + ]; + } + + /** + * Entry post vote for Notifications module + */ + public function serviceGetNotificationsReaction($aEvent) + { + $CNF = &$this->_oConfig->CNF; + + $iContentId = (int)$aEvent['object_id']; + $aContentInfo = $this->_oDb->getContentInfoById($iContentId); + if(empty($aContentInfo) || !is_array($aContentInfo)) + return []; + + $oReaction = BxDolVote::getObjectInstance($CNF['OBJECT_REACTIONS'], $iContentId); + if(!$oReaction || !$oReaction->isEnabled()) + return []; + + $aSubentry = $oReaction->getTrackBy(array('type' => 'id', 'id' => (int)$aEvent['subobject_id'])); + if(empty($aSubentry) || !is_array($aSubentry)) + return []; + + $aSubentrySampleParams = array(); + $aReaction = $oReaction->getReaction($aSubentry['reaction']); + if(!empty($aReaction['title'])) + $aSubentrySampleParams[] = $aReaction['title']; + else + $aSubentrySampleParams[] = '_undefined'; + + $sEntryUrl = bx_absolute_url(BxDolPermalinks::getInstance()->permalink('page.php?i=' . $CNF['URI_VIEW_ENTRY'] . '&id=' . $aContentInfo[$CNF['FIELD_ID']]), '{bx_url_root}'); + $sEntryCaption = isset($aContentInfo[$CNF['FIELD_TITLE']]) ? $aContentInfo[$CNF['FIELD_TITLE']] : strmaxtextlen($aContentInfo[$CNF['FIELD_TEXT']], 20, '...'); + $sEntrySummary = isset($aContentInfo[$CNF['FIELD_TEXT']]) ? $aContentInfo[$CNF['FIELD_TEXT']] : ''; + + return [ + 'entry_sample' => $CNF['T']['txt_sample_single'], + 'entry_url' => $sEntryUrl, + 'entry_caption' => $sEntryCaption, + 'entry_summary' => $sEntrySummary, + 'entry_author' => $aContentInfo[$CNF['FIELD_AUTHOR']], + 'subentry_sample' => $CNF['T']['txt_sample_reaction_single'], + 'subentry_sample_params' => $aSubentrySampleParams, + 'lang_key' => '', //may be empty or not specified. In this case the default one from Notification module will be used. + ]; + } + + /** + * Entry post score -> vote up for Notifications module + */ + public function serviceGetNotificationsScoreUp($aEvent) + { + return $this->_serviceGetNotificationsScore('up', $aEvent); + } + + /** + * Entry post score -> vote up for Notifications module + */ + public function serviceGetNotificationsScoreDown($aEvent) + { + return $this->_serviceGetNotificationsScore('down', $aEvent); + } + + protected function _serviceGetNotificationsScore($sType, $aEvent) + { + $CNF = &$this->_oConfig->CNF; + + $iContentId = (int)$aEvent['object_id']; + $aContentInfo = $this->_oDb->getContentInfoById($iContentId); + if(empty($aContentInfo) || !is_array($aContentInfo)) + return array(); + + $oScore = BxDolScore::getObjectInstance($CNF['OBJECT_SCORES'], $iContentId); + if(!$oScore || !$oScore->isEnabled()) + return array(); + + $sEntryUrl = bx_absolute_url(BxDolPermalinks::getInstance()->permalink('page.php?i=' . $CNF['URI_VIEW_ENTRY'] . '&id=' . $aContentInfo[$CNF['FIELD_ID']]), '{bx_url_root}'); + $sEntryCaption = isset($aContentInfo[$CNF['FIELD_TITLE']]) ? $aContentInfo[$CNF['FIELD_TITLE']] : strmaxtextlen($aContentInfo[$CNF['FIELD_TEXT']], 20, '...'); + $sEntrySummary = isset($aContentInfo[$CNF['FIELD_TEXT']]) ? $aContentInfo[$CNF['FIELD_TEXT']] : ''; + + return [ + 'entry_sample' => $CNF['T']['txt_sample_single'], + 'entry_url' => $sEntryUrl, + 'entry_caption' => $sEntryCaption, + 'entry_summary' => $sEntrySummary, + 'entry_author' => $aContentInfo[$CNF['FIELD_AUTHOR']], + 'subentry_sample' => $CNF['T']['txt_sample_score_' . $sType . '_single'], + 'lang_key' => '', //may be empty or not specified. In this case the default one from Notification module will be used. + ]; + } + + /** + * Data for Timeline module + */ + public function serviceGetTimelineData() + { + $sModule = $this->_aModule['name']; + + return array( + 'handlers' => array( + array('group' => $sModule . '_object', 'type' => 'insert', 'alert_unit' => $sModule, 'alert_action' => 'added', 'module_name' => $sModule, 'module_method' => 'get_timeline_post', 'module_class' => 'Module', 'groupable' => 0, 'group_by' => ''), + array('group' => $sModule . '_object', 'type' => 'update', 'alert_unit' => $sModule, 'alert_action' => 'edited'), + array('group' => $sModule . '_object', 'type' => 'delete', 'alert_unit' => $sModule, 'alert_action' => 'deleted') + ), + 'alerts' => array( + array('unit' => $sModule, 'action' => 'added'), + array('unit' => $sModule, 'action' => 'edited'), + array('unit' => $sModule, 'action' => 'deleted'), + ) + ); + } + + /** + * Entry post for Timeline module + */ + public function serviceGetTimelinePost($aEvent, $aBrowseParams = array()) + { + $aContentInfo = $this->_oDb->getContentInfoById($aEvent['object_id']); + if(empty($aContentInfo) || !is_array($aContentInfo)) + return false; + + $CNF = &$this->_oConfig->CNF; + + if((!empty($CNF['FIELD_STATUS']) && $aContentInfo[$CNF['FIELD_STATUS']] != 'active') || (!empty($CNF['FIELD_STATUS_ADMIN']) && $aContentInfo[$CNF['FIELD_STATUS_ADMIN']] != 'active')) + return false; + + $iUserId = $this->getUserId(); + $iAuthorId = (int)$aContentInfo[$CNF['FIELD_AUTHOR']]; + $iAuthorIdAbs = abs($iAuthorId); + + /** + * Don't show anonymous posts on the post's owner timeline. + */ + if($iAuthorId < 0 && $iAuthorIdAbs != $iUserId && ((is_numeric($aEvent['owner_id']) && $iAuthorIdAbs == (int)$aEvent['owner_id']) || (is_array($aEvent['owner_id']) && in_array($iAuthorIdAbs, $aEvent['owner_id'])))) + return false; + + //--- Views + $oViews = isset($CNF['OBJECT_VIEWS']) ? BxDolView::getObjectInstance($CNF['OBJECT_VIEWS'], $aContentInfo[$CNF['FIELD_ID']]) : null; + + $aViews = array(); + if ($oViews && $oViews->isEnabled()) + $aViews = array( + 'system' => $CNF['OBJECT_VIEWS'], + 'object_id' => $aContentInfo[$CNF['FIELD_ID']], + 'count' => $aContentInfo['views'] + ); + + //--- Votes + $oVotes = isset($CNF['OBJECT_VOTES']) ? BxDolVote::getObjectInstance($CNF['OBJECT_VOTES'], $aContentInfo[$CNF['FIELD_ID']]) : null; + + $aVotes = array(); + if ($oVotes && $oVotes->isEnabled()) + $aVotes = array( + 'system' => $CNF['OBJECT_VOTES'], + 'object_id' => $aContentInfo[$CNF['FIELD_ID']], + 'count' => $aContentInfo['votes'] + ); + + //--- Reactions + $oReactions = isset($CNF['OBJECT_REACTIONS']) ? BxDolVote::getObjectInstance($CNF['OBJECT_REACTIONS'], $aContentInfo[$CNF['FIELD_ID']]) : null; + + $aReactions = array(); + if ($oReactions && $oReactions->isEnabled()) + $aReactions = array( + 'system' => $CNF['OBJECT_REACTIONS'], + 'object_id' => $aContentInfo[$CNF['FIELD_ID']], + 'count' => $aContentInfo['rvotes'] + ); + + //--- Scores + $oScores = isset($CNF['OBJECT_SCORES']) ? BxDolScore::getObjectInstance($CNF['OBJECT_SCORES'], $aContentInfo[$CNF['FIELD_ID']]) : null; + + $aScores = array(); + if ($oScores && $oScores->isEnabled()) + $aScores = array( + 'system' => $CNF['OBJECT_SCORES'], + 'object_id' => $aContentInfo[$CNF['FIELD_ID']], + 'score' => $aContentInfo['score'] + ); + + //--- Reports + $oReports = isset($CNF['OBJECT_REPORTS']) ? BxDolReport::getObjectInstance($CNF['OBJECT_REPORTS'], $aContentInfo[$CNF['FIELD_ID']]) : null; + + $aReports = array(); + if ($oReports && $oReports->isEnabled()) + $aReports = array( + 'system' => $CNF['OBJECT_REPORTS'], + 'object_id' => $aContentInfo[$CNF['FIELD_ID']], + 'count' => $aContentInfo['reports'] + ); + + //--- Comments + $oCmts = isset($CNF['OBJECT_COMMENTS']) ? BxDolCmts::getObjectInstance($CNF['OBJECT_COMMENTS'], $aContentInfo[$CNF['FIELD_ID']]) : null; + + $aComments = array(); + if($oCmts && $oCmts->isEnabled()) + $aComments = array( + 'system' => $CNF['OBJECT_COMMENTS'], + 'object_id' => $aContentInfo[$CNF['FIELD_ID']], + 'count' => $aContentInfo['comments'] + ); + + //--- Title & Description + $sTitle = !empty($aContentInfo[$CNF['FIELD_TITLE']]) ? $aContentInfo[$CNF['FIELD_TITLE']] : ''; + if(empty($sTitle) && !empty($aContentInfo[$CNF['FIELD_TEXT']])) + $sTitle = $aContentInfo[$CNF['FIELD_TEXT']]; + + $iOwnerId = $iAuthorIdAbs; + if(isset($aEvent['object_privacy_view']) && (int)$aEvent['object_privacy_view'] < 0) + $iOwnerId = abs($aEvent['object_privacy_view']); + + $bCache = true; + $aContent = $this->_getContentForTimelinePost($aEvent, $aContentInfo, $aBrowseParams); + if(isset($aContent['_cache'])) { + $bCache = (bool)$aContent['_cache']; + + unset($aContent['_cache']); + } + + return array( + '_cache' => $bCache, + 'owner_id' => $iOwnerId, + 'object_owner_id' => $iAuthorId, + 'icon' => !empty($CNF['ICON']) ? $CNF['ICON'] : '', + 'sample' => isset($CNF['T']['txt_sample_single_with_article']) ? $CNF['T']['txt_sample_single_with_article'] : $CNF['T']['txt_sample_single'], + 'sample_wo_article' => $CNF['T']['txt_sample_single'], + 'sample_action' => isset($CNF['T']['txt_sample_action']) ? $CNF['T']['txt_sample_action'] : '', + 'url' => bx_absolute_url(BxDolPermalinks::getInstance()->permalink('page.php?i=' . $CNF['URI_VIEW_ENTRY'] . '&id=' . $aContentInfo[$CNF['FIELD_ID']])), + 'content' => $aContent, //a string to display or array to parse default template before displaying. + 'date' => $aContentInfo[$CNF['FIELD_ADDED']], + 'views' => $aViews, + 'votes' => $aVotes, + 'reactions' => $aReactions, + 'scores' => $aScores, + 'reports' => $aReports, + 'comments' => $aComments, + 'title' => $sTitle, //may be empty. + 'description' => '' //may be empty. + ); + } + + public function serviceGetTimelinePostAllowedView($aEvent) + { + $iContentId = (int)$aEvent['object_id']; + $aContentInfo = $this->_oDb->getContentInfoById($iContentId); + if(empty($aContentInfo) || !is_array($aContentInfo)) + return _t('_sys_txt_access_denied'); + + return $this->serviceCheckAllowedViewForProfile($aContentInfo); + } + + /** + * Check particular action permission without content + * @param $sAction action to check, for example: Browse, Add + * @param $iContentId content ID + * @return message on error, or CHECK_ACTION_RESULT_ALLOWED when allowed + */ + public function serviceCheckAllowed($sAction, $isPerformAction = false) + { + $sMethod = 'checkAllowed' . bx_gen_method_name($sAction); + if (!method_exists($this, $sMethod)) + return _t('_sys_request_method_not_found_cpt'); + + return $this->$sMethod($isPerformAction); + } + + /** + * Check particular action permission with content + * @param $sAction action to check, for example: View, Edit + * @param $iContentId content ID + * @return message on error, or CHECK_ACTION_RESULT_ALLOWED when allowed + */ + public function serviceCheckAllowedWithContent($sAction, $iContentId, $isPerformAction = false) + { + if (!$iContentId || !($aContentInfo = $this->_oDb->getContentInfoById($iContentId))) + return _t('_sys_request_page_not_found_cpt'); + + $sMethod = 'checkAllowed' . bx_gen_method_name($sAction); + if (!method_exists($this, $sMethod)) + return _t('_sys_request_method_not_found_cpt'); + + return $this->$sMethod($aContentInfo, $isPerformAction); + } + + /** + * Check particular action permission with content for specified profile + * @param $sAction action to check, for example: View, Edit + * @param $iContentId content ID + * @param $iProfileId profile ID which the permissions to be cheked for + * @return message on error, or CHECK_ACTION_RESULT_ALLOWED when allowed + */ + public function serviceCheckAllowedWithContentForProfile($sAction, $iContentId, $iProfileId, $isPerformAction = false) + { + if (!$iContentId || !($aContentInfo = $this->_oDb->getContentInfoById($iContentId))) + return _t('_sys_request_page_not_found_cpt'); + + $sMethod = 'checkAllowed' . bx_gen_method_name($sAction) . 'ForProfile'; + if (!method_exists($this, $sMethod)) + return _t('_sys_request_method_not_found_cpt'); + + return $this->$sMethod($aContentInfo, $iProfileId, $isPerformAction); + } + + public function serviceCheckAllowedCommentsView($iContentId, $sObjectComments) + { + //negative id used in comments for reports + if ($iContentId < 0) + return CHECK_ACTION_RESULT_ALLOWED; + + return $this->serviceCheckAllowedWithContent('comments_view', $iContentId); + } + + public function serviceCheckAllowedCommentsPost($iContentId, $sObjectComments) + { + //negative id used in comments for reports + if ($iContentId < 0) + return CHECK_ACTION_RESULT_ALLOWED; + + return $this->serviceCheckAllowedWithContent('comments_post', $iContentId); + } + + public function serviceGetContentOwnerProfileId ($iContentId) + { + $CNF = &$this->_oConfig->CNF; + + // file owner must be author of the content or profile itself in case of profile based module + if ($iContentId) { + $sModule = $this->getName(); + if ($this instanceof iBxDolProfileService && BxDolService::call($sModule, 'act_as_profile')) { + $oProfile = BxDolProfile::getInstanceByContentAndType($iContentId, $sModule); + } + else { + $aContentInfo = $this->_oDb->getContentInfoById($iContentId); + $iContentAuthor = (int)$aContentInfo[$CNF['FIELD_AUTHOR']]; + if($iContentAuthor < 0) + $iContentAuthor = abs($iContentAuthor); + + $oProfile = $aContentInfo ? BxDolProfile::getInstance($iContentAuthor) : null; + } + + $iProfileId = $oProfile ? $oProfile->id() : bx_get_logged_profile_id(); + } + else + $iProfileId = bx_get_logged_profile_id(); + + return $iProfileId; + } + + public function serviceGetBadges($iContentId, $bIsSingle = false, $bIsCompact = false) + { + $sModule = $this->getName(); + + $oBadges = BxDolBadges::getInstance(); + $aBadges = $oBadges->getData(array( + 'type' => ($bIsSingle ? 'by_module&object2_single' : 'by_module&object2'), + 'module' => $sModule, + 'object_id' => $iContentId + )); + + $sResult = false; + /** + * @hooks + * @hookdef hook-system-get_badges 'system', 'get_badges' - hook to override bages assigned to an entry (content) + * - $unit_name - equals `system` + * - $action - equals `get_badges` + * - $object_id - not used + * - $sender_id - not used + * - $extra_params - array of additional params with the following array keys: + * - `module` - [string] module name + * - `content_id` - [int] content id + * - `is_single` - [boolean] only one badge can be used or not + * - `is_compact` - [boolean] badge in compact mode or not + * - `badges` - [array] a list of all badges assigned to the content + * - `override_result` - [string] or [boolean] by ref, if string is returned then it will be used as resulting badges code, can be overridden in hook processing + * @hook @ref hook-system-get_badges + */ + bx_alert('system', 'get_badges', 0, 0, [ + 'module' => $sModule, + 'content_id' => $iContentId, + 'is_single' => $bIsSingle, + 'is_compact' => $bIsCompact, + 'badges' => $aBadges, + 'override_result' => &$sResult + ]); + if($sResult !== false) + return $sResult; + + if(empty($aBadges) || !is_array($aBadges)) + return ''; + + if (bx_is_api()){ + return $aBadges; + } + + if($bIsSingle) + return BxDolService::call('system', 'get_badge', array($aBadges[0], $bIsCompact), 'TemplServices'); + + $aBadgesOutput = array(); + foreach($aBadges as $aBadge) + $aBadgesOutput[] = array('badge' => BxDolService::call('system', 'get_badge', array($aBadge, $bIsCompact), 'TemplServices')); + + return $this->_oTemplate->parseHtmlByName('badges.html', array( + 'bx_repeat:items' => $aBadgesOutput, + )); + } + + /** + * @page service Service Calls + * @section bx_base_general Base General + * @subsection bx_base_general-page_blocks Page Blocks + * @subsubsection bx_base_general-categories_multi_list categories_multi_list + * + * @code bx_srv('bx_posts', 'categories_multi_list', [...]); @endcode + * + * Display multi-categorories block with number of posts in each category + * @param $bDisplayEmptyCats display empty categories + * + * @see BxBaseModGeneralModule::serviceCategoriesMultiList + */ + /** + * @ref bx_base_general-categories_multi_list "categories_multi_list" + */ + public function serviceCategoriesMultiList($bDisplayEmptyCats = true) + { + $aContextInfo = bx_get_page_info(); + + $mProfileContextId = false; + if ($aContextInfo !== false) + $mProfileContextId = $aContextInfo['context_profile_id']; + + $oCategories = BxDolCategories::getInstance(); + if ($mProfileContextId) + $aCats = $oCategories->getData([ + 'type' => 'by_module&context_with_num', + 'module' => $this->getName(), + 'context_id' => $mProfileContextId + ]); + else{ + $aCats = $oCategories->getData([ + 'type' => 'by_module_with_num', + 'module' => $this->getName() + ]); + } + $aVars = array('bx_repeat:cats' => array()); + foreach ($aCats as $oCat) { + $sValue = $oCat['value']; + $iNum = $oCat['num']; + + $aVars['bx_repeat:cats'][] = array( + 'url' => $oCategories->getUrl($this->getName(), $sValue, $mProfileContextId ? '&context_id=' . $mProfileContextId : ''), + 'name' => _t($sValue), + 'value' => $sValue, + 'num' => $iNum, + ); + } + + if (!$aVars['bx_repeat:cats']) + return ''; + + return $this->_oTemplate->parseHtmlByName('category_list_multi.html', $aVars); + } + + /** + * ====== + * PERMISSION METHODS + * ====== + */ + public function serviceCheckAllowedViewForProfile ($aDataEntry, $isPerformAction = false, $iProfileId = false) + { + $mixedResult = $this->_serviceCheckAllowedViewForProfile ($aDataEntry, $isPerformAction, $iProfileId); + + /** + * @hooks + * @hookdef hook-system-check_allowed_view 'system', 'check_allowed_view' - hook to override the result of checking whether 'view' action is allowed or not to specified profile + * - $unit_name - equals `system` + * - $action - equals `check_allowed_view` + * - $object_id - not used + * - $sender_id - not used + * - $extra_params - array of additional params with the following array keys: + * - `module` - [string] module name + * - `content_info` - [array] content info array as key&value pairs + * - `profile_id` - [boolean] or [int] profile id to be checked the availability of the action to + * - `override_result` - [string] or [int] by ref, check action result, can be overridden in hook processing. Return string with an error if action isn't allowed or CHECK_ACTION_RESULT_ALLOWED, @see BxDolAcl + * @hook @ref hook-system-check_allowed_view + */ + bx_alert('system', 'check_allowed_view', 0, 0, [ + 'module' => $this->getName(), + 'content_info' => $aDataEntry, + 'profile_id' => $iProfileId, + 'override_result' => &$mixedResult + ]); + + return $mixedResult; + } + + public function checkAllowedSetThumb ($iContentId = 0) + { + return CHECK_ACTION_RESULT_ALLOWED; + } + + /** + * @return CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. So make sure to make "true === " checking. + */ + public function checkAllowedBrowse () + { + $mixedResult = null; + /** + * @hooks + * @hookdef hook-system-check_allowed_browse 'system', 'check_allowed_browse' - hook to override the result of checking whether 'browse' action is allowed or not to currently logged in profile + * It's equivalent to @ref hook-system-check_allowed_view + * except `content_info` parameter in $extra_params is missing + * @hook @ref hook-system-check_allowed_browse + */ + bx_alert('system', 'check_allowed_browse', 0, 0, [ + 'module' => $this->getName(), + 'profile_id' => $this->_iProfileId, + 'override_result' => &$mixedResult + ]); + if($mixedResult !== null) + return $mixedResult; + + return CHECK_ACTION_RESULT_ALLOWED; + } + + /** + * @return CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. So make sure to make strict(===) checking. + */ + public function checkAllowedView ($aDataEntry, $isPerformAction = false) + { + return $this->serviceCheckAllowedViewForProfile ($aDataEntry, $isPerformAction); + } + + /** + * @return CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. So make sure to make strict(===) checking. + */ + public function checkAllowedViewForProfile ($aDataEntry, $iProfileId, $isPerformAction = false) + { + return $this->serviceCheckAllowedViewForProfile ($aDataEntry, $isPerformAction, $iProfileId); + } + + /** + * @return CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. So make sure to make strict(===) checking. + */ + public function checkAllowedAdd ($isPerformAction = false) + { + // check ACL + $aCheck = checkActionModule($this->_iProfileId, 'create entry', $this->getName(), $isPerformAction); + if ($aCheck[CHECK_ACTION_RESULT] !== CHECK_ACTION_RESULT_ALLOWED) + return $aCheck[CHECK_ACTION_MESSAGE]; + return CHECK_ACTION_RESULT_ALLOWED; + } + + /** + * @return CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. So make sure to make strict(===) checking. + */ + public function checkAllowedApprove ($aDataEntry, $isPerformAction = false) + { + $CNF = &$this->_oConfig->CNF; + $sError = '_sys_txt_access_denied'; + + if($this->_oConfig->isAutoApproveEnabled()) + return _t($sError); + + if($aDataEntry[$CNF['FIELD_STATUS_ADMIN']] != BX_BASE_MOD_GENERAL_STATUS_PENDING) + return _t($sError); + + // moderator always have access + if ($this->_isModerator($isPerformAction)) + return CHECK_ACTION_RESULT_ALLOWED; + + // check for context's admins + if (!empty($CNF['FIELD_ALLOW_VIEW_TO']) && (int)$aDataEntry[$CNF['FIELD_ALLOW_VIEW_TO']] < 0) { + $oProfile = BxDolProfile::getInstance(-(int)$aDataEntry[$CNF['FIELD_ALLOW_VIEW_TO']]); + if ($oProfile){ + $sModule = $oProfile->getModule(); + $aEntity = BxDolRequest::serviceExists($sModule, 'get_all') ? BxDolService::call($sModule, 'get_all', array(array('type' => 'id', 'id' => $oProfile->getContentId()))) : array(); + + $oModule = BxDolModule::getInstance($sModule); + + // check for context's extra roles with rights + if (method_exists($oModule, 'isAllowedModuleActionByProfile')) { + $bResult = $oModule->isAllowedModuleActionByProfile($oProfile->getContentId(), $this->getName(), 'edit_any'); + if ($bResult !== NULL) return $bResult; + } + + // if allowed edit a group then allowed to edit anything inside its context + if(isset($aEntity) && $oModule->checkAllowedEdit($aEntity) === CHECK_ACTION_RESULT_ALLOWED){ + return CHECK_ACTION_RESULT_ALLOWED; + } + } + } + + return _t($sError); + } + + /** + * @return CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. So make sure to make strict(===) checking. + */ + public function checkAllowedEdit ($aDataEntry, $isPerformAction = false) + { + // moderator and owner always have access + if ($this->isEntryAuthor($aDataEntry, $this->_iProfileId) || $this->_isModerator($isPerformAction)) + return CHECK_ACTION_RESULT_ALLOWED; + + // check for context's admins + if (!empty($this->_oConfig->CNF['FIELD_ALLOW_VIEW_TO']) && (int)$aDataEntry[$this->_oConfig->CNF['FIELD_ALLOW_VIEW_TO']] < 0) { + $oProfile = BxDolProfile::getInstance(-(int)$aDataEntry[$this->_oConfig->CNF['FIELD_ALLOW_VIEW_TO']]); + if ($oProfile){ + $sModule = $oProfile->getModule(); + $aEntity = BxDolRequest::serviceExists($sModule, 'get_all') ? BxDolService::call($sModule, 'get_all', array(array('type' => 'id', 'id' => $oProfile->getContentId()))) : array(); + + $oModule = BxDolModule::getInstance($sModule); + + // check for context's extra roles with rights + if (method_exists($oModule, 'isAllowedModuleActionByProfile')) { + $bResult = $oModule->isAllowedModuleActionByProfile($oProfile->getContentId(), $this->getName(), 'edit_any'); + if ($bResult !== NULL) return $bResult; + } + + // if allowed edit a group then allowed to edit anything inside its context + if(isset($aEntity) && $oModule->checkAllowedEdit($aEntity) === CHECK_ACTION_RESULT_ALLOWED){ + return CHECK_ACTION_RESULT_ALLOWED; + } + } + } + + return _t('_sys_txt_access_denied'); + } + + /** + * @return CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. So make sure to make strict(===) checking. + */ + public function checkAllowedDelete (&$aDataEntry, $isPerformAction = false) + { + // moderator always has access + if ($this->_isAdministrator($isPerformAction)) + return CHECK_ACTION_RESULT_ALLOWED; + + // check ACL + $aCheck = checkActionModule($this->_iProfileId, 'delete entry', $this->getName(), $isPerformAction); + if ($this->isEntryAuthor($aDataEntry, $this->_iProfileId) && $aCheck[CHECK_ACTION_RESULT] === CHECK_ACTION_RESULT_ALLOWED) + return CHECK_ACTION_RESULT_ALLOWED; + + // check for context's admins + if (isset($this->_oConfig->CNF['FIELD_ALLOW_VIEW_TO']) && (int)$aDataEntry[$this->_oConfig->CNF['FIELD_ALLOW_VIEW_TO']] < 0){ + $oProfile = BxDolProfile::getInstance(-(int)$aDataEntry[$this->_oConfig->CNF['FIELD_ALLOW_VIEW_TO']]); + if ($oProfile){ + $sModule = $oProfile->getModule(); + $aEntity = BxDolRequest::serviceExists($sModule, 'get_all') ? BxDolService::call($sModule, 'get_all', array(array('type' => 'id', 'id' => $oProfile->getContentId()))) : array(); + + $oModule = BxDolModule::getInstance($sModule); + + // check for context's extra roles with rights + if (method_exists($oModule, 'isAllowedModuleActionByProfile')) { + $bResult = $oModule->isAllowedModuleActionByProfile($oProfile->getContentId(), $this->getName(), 'delete_any'); + if ($bResult !== NULL) return $bResult; + } + + // if allowed delete a group then allowed to delete anything inside its context + if(isset($aEntity) && $oModule->checkAllowedDelete($aEntity) === CHECK_ACTION_RESULT_ALLOWED){ + return CHECK_ACTION_RESULT_ALLOWED; + } + } + } + + return _t('_sys_txt_access_denied'); + } + + /** + * @return CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. So make sure to make strict(===) checking. + */ + public function checkAllowedSetMembership (&$aDataEntry, $isPerformAction = false) + { + // admin always has access + if (isAdmin()) + return CHECK_ACTION_RESULT_ALLOWED; + + // check ACL + $aCheck = checkActionModule($this->_iProfileId, 'set acl level', 'system', $isPerformAction); + if ($aCheck[CHECK_ACTION_RESULT] !== CHECK_ACTION_RESULT_ALLOWED) + return $aCheck[CHECK_ACTION_MESSAGE]; + + return CHECK_ACTION_RESULT_ALLOWED; + } + + /** + * @return CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. So make sure to make strict(===) checking. + */ + public function checkAllowedEditAnyEntry ($isPerformAction = false) + { + return $this->checkAllowedEditAnyEntryForProfile($isPerformAction, $this->_iProfileId); + } + + /** + * @return CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. So make sure to make strict(===) checking. + */ + public function checkAllowedDeleteAnyEntry ($isPerformAction = false) + { + return $this->checkAllowedDeleteAnyEntryForProfile($isPerformAction, $this->_iProfileId); + } + + /** + * @return CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. So make sure to make strict(===) checking. + */ + public function checkAllowedEditAnyEntryForProfile ($isPerformAction = false, $iProfileId = false) + { + if(!$iProfileId) + $iProfileId = $this->_iProfileId; + + $aCheck = checkActionModule($iProfileId, MEMBERSHIP_ACTION_EDIT_ANY_ENTRY, $this->getName(), $isPerformAction); + if($aCheck[CHECK_ACTION_RESULT] === CHECK_ACTION_RESULT_ALLOWED) + return CHECK_ACTION_RESULT_ALLOWED; + + return _t('_sys_txt_access_denied'); + } + + /** + * @return CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. So make sure to make strict(===) checking. + */ + public function checkAllowedDeleteAnyEntryForProfile ($isPerformAction = false, $iProfileId = false) + { + if(!$iProfileId) + $iProfileId = $this->_iProfileId; + + $aCheck = checkActionModule($iProfileId, MEMBERSHIP_ACTION_DELETE_ANY_ENTRY, $this->getName(), $isPerformAction); + if($aCheck[CHECK_ACTION_RESULT] === CHECK_ACTION_RESULT_ALLOWED) + return CHECK_ACTION_RESULT_ALLOWED; + + return _t('_sys_txt_access_denied'); + } + + /** + * @return CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. So make sure to make "true === " checking. + */ + public function checkAllowedCommentsView ($aContentInfo, $isPerformAction = false) + { + return $this->checkAllowedView ($aContentInfo, $isPerformAction); + } + + /** + * @return CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. So make sure to make "true === " checking. + */ + public function checkAllowedCommentsPost ($aContentInfo, $isPerformAction = false) + { + return $this->checkAllowedView ($aContentInfo, $isPerformAction); + } + + protected function _serviceCheckAllowedViewForProfile ($aDataEntry, $isPerformAction, $iProfileId) + { + $CNF = &$this->_oConfig->CNF; + + if(!$iProfileId) + $iProfileId = $this->_iProfileId; + + if(empty($aDataEntry) || !is_array($aDataEntry)) + return _t('_sys_txt_not_found'); + + // moderator and owner always have access + if(!empty($iProfileId) && (abs($aDataEntry[$CNF['FIELD_AUTHOR']]) == (int)$iProfileId || $this->_isModeratorForProfile($isPerformAction, $iProfileId))) + return CHECK_ACTION_RESULT_ALLOWED; + + // check ACL + $aCheck = checkActionModule($iProfileId, 'view entry', $this->getName(), $isPerformAction); + if($aCheck[CHECK_ACTION_RESULT] !== CHECK_ACTION_RESULT_ALLOWED) + return $aCheck[CHECK_ACTION_MESSAGE]; + + // check privacy + if(!empty($CNF['OBJECT_PRIVACY_VIEW'])) { + $oPrivacy = BxDolPrivacy::getObjectInstance($CNF['OBJECT_PRIVACY_VIEW']); + if ($oPrivacy && !$oPrivacy->check($aDataEntry[$CNF['FIELD_ID']], $iProfileId)) + return _t('_sys_access_denied_to_private_content'); + } + + return CHECK_ACTION_RESULT_ALLOWED; + } + + public function _serviceBrowse ($sMode, $aParams = false, $iDesignBox = BX_DB_PADDING_DEF, $bDisplayEmptyMsg = false, $bAjaxPaginate = true, $sClassSearchResult = 'SearchResult') + { + if (CHECK_ACTION_RESULT_ALLOWED !== ($sMsg = $this->checkAllowedBrowse())) + return bx_is_api() ? [bx_api_get_msg($sMsg)] : MsgBox($sMsg); + + bx_import($sClassSearchResult, $this->_aModule); + $sClass = $this->_aModule['class_prefix'] . $sClassSearchResult; + $o = new $sClass($sMode, $aParams); + + $o->setDesignBoxTemplateId($iDesignBox); + $o->setDisplayEmptyMsg($bDisplayEmptyMsg); + $o->setAjaxPaginate($bAjaxPaginate); + $o->setUnitParams(array('context' => $sMode)); + if (isset($aParams['condition']) && is_array($aParams['condition'])) + $o->setCustomCurrentCondition($aParams['condition']); + + if ($o->isError) + return ''; + + if ($s = $o->processing()) + return bx_is_api() ? [bx_api_get_block('browse', $s)] : $s; + else + return ''; + } + + /** + * Shows a list of profiles. + */ + protected function _serviceBrowseQuick($aProfiles, $iStart = 0, $iLimit = 4, $aAdditionalParams = array()) + { + // get paginate object + $oPaginate = new BxTemplPaginate(array( + 'on_change_page' => "return !loadDynamicBlockAutoPaginate(this, '{start}', '{per_page}', " . bx_js_string(json_encode($aAdditionalParams)) . ");", + 'num' => count($aProfiles), + 'per_page' => $iLimit, + 'start' => $iStart, + )); + + // remove last item from connection array, because we've got one more item for pagination calculations only + if (count($aProfiles) > $iLimit) + array_pop($aProfiles); + + // get profiles HTML + $s = ''; + foreach ($aProfiles as $mixedProfile) { + $bProfile = is_array($mixedProfile); + + $oProfile = BxDolProfile::getInstance($bProfile ? (int)$mixedProfile['id'] : (int)$mixedProfile); + if(!$oProfile) + continue; + + $aUnitParams = array('template' => array('name' => 'unit', 'size' => 'thumb')); + if(BxDolModule::getInstance($oProfile->getModule()) instanceof BxBaseModGroupsModule) + $aUnitParams['template']['name'] = 'unit_wo_cover'; + + if($bProfile && is_array($mixedProfile['info'])) + $aUnitParams['template']['vars'] = $mixedProfile['info']; + + $s .= $oProfile->getUnit(0, $aUnitParams); + } + + $aTmplVarsPaginate = []; + if($iStart || $oPaginate->getNum() > $iLimit) + $aTmplVarsPaginate = ['paginate' => $oPaginate->getSimplePaginate()]; + + return $this->_oTemplate->parseHtmlByName('browse_quick.html', array( + 'code' => $s, + 'bx_if:show_paginate' => [ + 'condition' => !empty($aTmplVarsPaginate), + 'content' => $aTmplVarsPaginate + ] + )); + } + + // ====== COMMON METHODS + public function onPublished($iContentId) + { + $CNF = &$this->_oConfig->CNF; + + $aContentInfo = $this->_oDb->getContentInfoById($iContentId); + if(!$aContentInfo) + return; + + /* + * Process metas. + * Note. It's essential to process metas a the very end, + * because all data related to an entry should be already + * processed and are ready to be passed to alert. + */ + $this->processMetasAdd($iContentId); + + $this->alertAfterAdd($aContentInfo); + } + + public function onFailed($iContentId) + { + $CNF = &$this->_oConfig->CNF; + + $aContentInfo = $this->_oDb->getContentInfoById($iContentId); + if(!$aContentInfo) + return; + + /** + * @hooks + * @hookdef hook-bx_base_general-failed '{module_name}', 'failed' - hook after content creation when publishing was failed + * - $unit_name - module name + * - $action - equals `failed` + * - $object_id - content id + * - $sender_id - content author profile id + * - $extra_params - array of additional params with the following array keys: + * - `object_author_id` - [int] content author profile id + * @hook @ref hook-bx_base_general-failed + */ + bx_alert($this->getName(), 'failed', $iContentId, $aContentInfo[$CNF['FIELD_AUTHOR']], [ + 'object_author_id' => $aContentInfo[$CNF['FIELD_AUTHOR']] + ]); + } + + public function onApprove($mixedContent) + { + $CNF = &$this->_oConfig->CNF; + + if(!is_array($mixedContent)) + $mixedContent = $this->_oDb->getContentInfoById((int)$mixedContent); + + $this->alertAfterApprove($mixedContent); + + $this->onPublished($mixedContent[$CNF['FIELD_ID']]); + } + + public function onUpdateImage($iContentId, $sFiledName, $sFiledValue, $iProfileId = 0) {} + + public function alertAfterAdd($aContentInfo) {} + + public function alertAfterEdit($aContentInfo) {} + + public function alertAfterApprove($aContentInfo) + { + $CNF = &$this->_oConfig->CNF; + + $iId = (int)$aContentInfo[$CNF['FIELD_ID']]; + + $sModule = $this->getName(); + $aParams = $this->_alertParams($aContentInfo); + + /** + * @hooks + * @hookdef hook-bx_base_general-approved '{module_name}', 'approved' - hook when module content has been approved + * - $unit_name - module name + * - $action - equals `approved` + * - $object_id - content id + * - $sender_id - not used, always `false` + * - $extra_params - array of additional params with the following array keys: + * - `source` - [string] uniq string for particular content in the following format `{module}_{content}` + * - `object_author_id` - [int] content author profile id + * @hook @ref hook-bx_base_general-approved + */ + bx_alert($sModule, 'approved', $iId, false, $aParams); + } + + /** + * Get array of params to be passed in Add/Edit Alert. + */ + protected function _alertParams($aContentInfo) + { + $CNF = &$this->_oConfig->CNF; + + return [ + 'source' => $this->_oConfig->getName() . '_' . (int)$aContentInfo[$CNF['FIELD_ID']], + + 'object_author_id' => (int)$aContentInfo[$CNF['FIELD_AUTHOR']] + ]; + } + + public function processMetasAdd($iContentId) + { + $CNF = &$this->_oConfig->CNF; + + if(empty($CNF['OBJECT_METATAGS'])) + return false; + + $aContentInfo = $this->_oDb->getContentInfoById($iContentId); + + $bFldStatus = !empty($CNF['FIELD_STATUS']); + $bFldStatusAdmin = !empty($CNF['FIELD_STATUS_ADMIN']); + $bContentInfo = $aContentInfo && (!$bFldStatus || ($bFldStatus && $aContentInfo[$CNF['FIELD_STATUS']] == 'active')) && (!$bFldStatusAdmin || ($bFldStatusAdmin && $aContentInfo[$CNF['FIELD_STATUS_ADMIN']] == 'active')); + if(!$bContentInfo) + return false; + + $oMetatags = BxDolMetatags::getObjectInstance($CNF['OBJECT_METATAGS']); + $oMetatags->metaAddAuto($iContentId, $aContentInfo, $CNF, $CNF['OBJECT_FORM_ENTRY_DISPLAY_ADD']); + + $sKey = 'FIELD_LOCATION'; + if($oMetatags->locationsIsEnabled() && !empty($CNF[$sKey]) && !empty($aContentInfo[$CNF[$sKey]])) { + $aLocation = unserialize($aContentInfo[$CNF[$sKey]]); + if(!empty($aLocation) && is_array($aLocation)) + call_user_func_array(array($oMetatags, 'locationsAdd'), array_merge(array($iContentId), array_values($aLocation))); + } + + $sKey = 'FIELD_LABELS'; + if($oMetatags->keywordsIsEnabled() && !empty($CNF[$sKey]) && !empty($aContentInfo[$CNF[$sKey]])) { + $aLabels = unserialize($aContentInfo[$CNF[$sKey]]); + if(!empty($aLabels) && is_array($aLabels)) + foreach ($aLabels as $sLabel) { + if(!preg_match("/(\pL[\pL\pN_]+)/u", $sLabel)) + continue; + + $oMetatags->keywordsAddOne($iContentId, $sLabel, false); + } + } + + return true; + } + + public function processMetasEdit($iContentId, $oForm) + { + $CNF = &$this->_oConfig->CNF; + + if(empty($CNF['OBJECT_METATAGS'])) + return false; + + $aContentInfo = $this->_oDb->getContentInfoById($iContentId); + + $bFldStatus = isset($CNF['FIELD_STATUS']); + $bFldStatusAdmin = isset($CNF['FIELD_STATUS_ADMIN']); + $bContentInfo = $aContentInfo && (!$bFldStatus || ($bFldStatus && $aContentInfo[$CNF['FIELD_STATUS']] == 'active')) && (!$bFldStatusAdmin || ($bFldStatusAdmin && $aContentInfo[$CNF['FIELD_STATUS_ADMIN']] == 'active')); + if(!$bContentInfo) + return false; + + $oMetatags = BxDolMetatags::getObjectInstance($CNF['OBJECT_METATAGS']); + $oMetatags->metaAddAuto($iContentId, $aContentInfo, $CNF, $CNF['OBJECT_FORM_ENTRY_DISPLAY_EDIT']); + + $sKey = 'FIELD_LOCATION'; + if($oMetatags->locationsIsEnabled() && !empty($CNF[$sKey]) && !empty($aContentInfo[$CNF[$sKey]])) { + $aLocation = unserialize($aContentInfo[$CNF[$sKey]]); + if(!empty($aLocation) && is_array($aLocation)) + call_user_func_array(array($oMetatags, 'locationsAdd'), array_merge(array($iContentId), array_values($aLocation))); + } + + $sKey = 'FIELD_LABELS'; + if($oMetatags->keywordsIsEnabled() && !empty($CNF[$sKey]) && !empty($aContentInfo[$CNF[$sKey]])) { + $aLabels = unserialize($aContentInfo[$CNF[$sKey]]); + if(!empty($aLabels) && is_array($aLabels)) + foreach ($aLabels as $sLabel) { + if(!preg_match("/(\pL[\pL\pN_]+)/u", $sLabel)) + continue; + + $oMetatags->keywordsAddOne($iContentId, $sLabel, false); + } + } + + return true; + } + + public function addAttachLink($aValues, $sDisplay = false) + { + $CNF = &$this->_oConfig->CNF; + + if(!$sDisplay) + $sDisplay = $CNF['OBJECT_FORM_ATTACH_LINK_DISPLAY_ADD']; + + $oForm = BxDolForm::getObjectInstance($CNF['OBJECT_FORM_ATTACH_LINK'], $sDisplay, $this->_oTemplate); + if(!$oForm) + return array('message' => '_sys_txt_error_occured'); + + $oForm->aFormAttrs['method'] = BX_DOL_FORM_METHOD_SPECIFIC; + $oForm->aParams['csrf']['disable'] = true; + if(!empty($oForm->aParams['db']['submit_name'])) { + $sSubmitName = $oForm->aParams['db']['submit_name']; + if(!isset($oForm->aInputs[$sSubmitName])) { + if(isset($oForm->aInputs[$CNF['FIELD_ATTACH_LINK_CONTROLS']])) + foreach($oForm->aInputs[$CNF['FIELD_ATTACH_LINK_CONTROLS']] as $mixedIndex => $aInput) { + if(!is_numeric($mixedIndex) || empty($aInput['name']) || $aInput['name'] != $sSubmitName) + continue; + + $aValues[$sSubmitName] = $aInput['value']; + } + } + else + $aValues[$sSubmitName] = $oForm->aInputs[$sSubmitName]['value']; + } + + $oForm->aInputs['url']['checker']['params']['preg'] = $this->_oConfig->getPregPattern('url'); + + $oForm->initChecker(array(), $aValues); + if(!$oForm->isSubmittedAndValid()) + return array('message' => '_sys_txt_error_occured'); + + return $this->_addLink($oForm); + } + + public function getFormAttachLink($iContentId = 0) + { + $CNF = &$this->_oConfig->CNF; + + $oForm = BxDolForm::getObjectInstance($CNF['OBJECT_FORM_ATTACH_LINK'], $CNF['OBJECT_FORM_ATTACH_LINK_DISPLAY_ADD'], $this->_oTemplate); + $oForm->aFormAttrs['action'] = BX_DOL_URL_ROOT . $this->_oConfig->getBaseUri() . 'submit_attach_link_form/'; + $oForm->aInputs[$CNF['FIELD_ATTACH_LINK_CONTENT_ID']]['value'] = $iContentId; + $oForm->aInputs[$CNF['FIELD_ATTACH_LINK_URL']]['checker']['params']['preg'] = $this->_oConfig->getPregPattern('url'); + + $oForm->initChecker(); + if($oForm->isSubmittedAndValid()) + return $this->_addLink($oForm); + + return ['form' => $oForm->getCode(), 'form_id' => $oForm->id]; + } + + protected function _addLink(&$oForm) + { + $CNF = &$this->_oConfig->CNF; + + $iUserId = $this->getUserId(); + + $iContentId = (int)$oForm->getCleanValue($CNF['FIELD_ATTACH_LINK_CONTENT_ID']); + $sLink = rtrim($oForm->getCleanValue('url'), '/'); + $sHost = parse_url($sLink, PHP_URL_HOST); + if($sHost && is_private_ip(gethostbyname($sHost))) + return ['message' => _t('_sys_txt_error_occured')]; + + $aMatches = []; + preg_match($this->_oConfig->getPregPattern('url'), $sLink, $aMatches); + $sLink = (empty($aMatches[2]) ? 'http://' : '') . $aMatches[0]; + + $aSiteInfo = bx_get_site_info($sLink, [ + 'thumbnailUrl' => ['tag' => 'link', 'content_attr' => 'href'], + 'OGImage' => ['name_attr' => 'property', 'name' => 'og:image'], + ]); + + $sTitle = !empty($aSiteInfo['title']) ? $aSiteInfo['title'] : $sHost; + $sDescription = !empty($aSiteInfo['description']) ? $aSiteInfo['description'] : ''; + + $sMediaUrl = ''; + if(!empty($aSiteInfo['thumbnailUrl'])) + $sMediaUrl = $aSiteInfo['thumbnailUrl']; + else if(!empty($aSiteInfo['OGImage'])) + $sMediaUrl = $aSiteInfo['OGImage']; + + $iMediaId = 0; + $oStorage = null; + if(!empty($sMediaUrl)) { + $oStorage = BxDolStorage::getObjectInstance($CNF['OBJECT_STORAGE_PHOTOS']); + + $iMediaId = $oStorage->storeFileFromUrl($sMediaUrl, true, $iUserId); + } + + $iId = (int)$oForm->insert(['profile_id' => $iUserId, 'media_id' => $iMediaId, 'url' => $sLink, 'title' => $sTitle, 'text' => $sDescription, 'added' => time()]); + if(!empty($iId)) { + if(!empty($oStorage) && !empty($iMediaId)) + $oStorage->afterUploadCleanup($iMediaId, $iUserId); + + return [ + 'id' => $iId, + $CNF['FIELD_ATTACH_LINK_CONTENT_ID'] => $iContentId, + 'url' => $sLink, + 'item' => $this->_oTemplate->getAttachLinkItem($iUserId, $iId) + ]; + } + + return ['message' => _t('_bx_timeline_txt_err_cannot_perform_action')]; + } + + public function getEntryImageData($aContentInfo, $sField = 'FIELD_THUMB', $aTranscoders = array()) + { + if(empty($aTranscoders)) + $aTranscoders = array('OBJECT_TRANSCODER_COVER', 'OBJECT_IMAGES_TRANSCODER_COVER', 'OBJECT_IMAGES_TRANSCODER_GALLERY'); + + $CNF = &$this->_oConfig->CNF; + if(empty($CNF[$sField]) || empty($aContentInfo[$CNF[$sField]]) || empty($CNF['OBJECT_STORAGE'])) + return false; + + $iId = (int)$aContentInfo[$CNF[$sField]]; + $aFile = BxDolStorage::getObjectInstance($CNF['OBJECT_STORAGE'])->getFile($iId); + if(!empty($aFile) && is_array($aFile) && strpos($aFile['mime_type'], 'svg') !== false) + return array('id' => $iId, 'object' => $CNF['OBJECT_STORAGE']); + + foreach($aTranscoders as $sTranscoder) + if(!empty($CNF[$sTranscoder])) + return array('id' => $iId, 'transcoder' => $CNF[$sTranscoder]); + + return array('id' => $iId, 'object' => $CNF['OBJECT_STORAGE']); + } + + public function getEntryAllActions ($mixedContent = false, $aParams = []) + { + $CNF = &$this->_oConfig->CNF; + + if(!empty($mixedContent)) { + if(!is_array($mixedContent)) + $mixedContent = array((int)$mixedContent, (method_exists($this->_oDb, 'getContentInfoById')) ? $this->_oDb->getContentInfoById((int)$mixedContent) : array()); + } + else { + $mixedContent = $this->_getContent(); + if($mixedContent === false) + return false; + } + + list($iContentId, $aContentInfo) = $mixedContent; + + $sObjectMenu = !empty($aParams['object_menu']) ? $aParams['object_menu'] : ''; + if(empty($sObjectMenu) && !empty($CNF['OBJECT_MENU_ACTIONS_VIEW_ENTRY_ALL'])) + $sObjectMenu = $CNF['OBJECT_MENU_ACTIONS_VIEW_ENTRY_ALL']; + + if(empty($sObjectMenu)) + return false; + + $sEntryTitle = !empty($aParams['entry_title']) ? $aParams['entry_title'] : ''; + if(empty($sEntryTitle) && !empty($CNF['FIELD_TITLE']) && !empty($aContentInfo[$CNF['FIELD_TITLE']])) + $sEntryTitle = $aContentInfo[$CNF['FIELD_TITLE']]; + + $sEntryUrl = !empty($aParams['entry_url']) ? $aParams['entry_url'] : ''; + if(empty($sEntryUrl) && !empty($CNF['URI_VIEW_ENTRY'])) + $sEntryUrl = bx_absolute_url(BxDolPermalinks::getInstance()->permalink('page.php?i=' . $CNF['URI_VIEW_ENTRY'] . '&id=' . $iContentId)); + + $iEntryThumb = !empty($aParams['entry_thumb']) ? (int)$aParams['entry_thumb'] : 0; + if(empty($iEntryThumb) && !empty($CNF['FIELD_THUMB']) && !empty($aContentInfo[$CNF['FIELD_THUMB']])) + $iEntryThumb = (int)$aContentInfo[$CNF['FIELD_THUMB']]; + + $sObjectStorage = !empty($aParams['object_storage']) ? $aParams['object_storage'] : false; + if(empty($sObjectStorage) && !empty($CNF['OBJECT_STORAGE'])) + $sObjectStorage = $CNF['OBJECT_STORAGE']; + + $sObjectTranscoder = !empty($aParams['object_transcoder']) ? $aParams['object_transcoder'] : false; + + $aMarkers = [ + 'id' => $iContentId, + 'module' => $this->_oConfig->getName(), + 'title' => !empty($sEntryTitle) ? $sEntryTitle : '', + 'url' => !empty($sEntryUrl) ? $sEntryUrl : '', + 'img_url' => '' + ]; + + if(!empty($iEntryThumb)) { + if(!empty($sObjectTranscoder)) + $o = BxDolTranscoder::getObjectInstance($sObjectTranscoder); + else if(!empty($sObjectStorage)) + $o = BxDolStorage::getObjectInstance($sObjectStorage); + + $sImageUrl = $o ? $o->getFileUrlById($iEntryThumb) : ''; + if(!empty($sImageUrl)) + $aMarkers['img_url'] = $sImageUrl; + } + + $oActions = BxDolMenu::getObjectInstance($sObjectMenu, $this->_oTemplate); + if(!$oActions) + return false; + + $oActions->setContentId($iContentId); + $oActions->addMarkers($aMarkers); + + return $oActions->{bx_is_api() ? 'getCodeAPI' : 'getCode'}(); + } + + public function getProfileId() + { + return bx_get_logged_profile_id(); + } + + public function getProfileInfo($iUserId = false) + { + $oProfile = $this->getObjectUser($iUserId); + + $oAccount = null; + if($oProfile && !($oProfile instanceof BxDolProfileUndefined) && !($oProfile instanceof BxDolProfileAnonymous)) + $oAccount = $oProfile->getAccountObject(); + $bAccount = !empty($oAccount); + + if(!$bAccount) + $oProfile = BxDolProfileUndefined::getInstance(); + + return array( + 'id' => $oProfile->id(), + 'name' => $oProfile->getDisplayName(), + 'email' => $bAccount ? $oAccount->getEmail() : '', + 'link' => $oProfile->getUrl(), + 'icon' => $oProfile->getIcon(), + 'thumb' => $oProfile->getThumb(), + 'avatar' => $oProfile->getAvatar(), + 'active' => $oProfile->isActive(), + ); + } + + public function getObjectUser($iUserId = false) + { + bx_import('BxDolProfile'); + return BxDolProfile::getInstanceMagic($iUserId); + } + + public function getObjectFavorite($sSystem = '', $iId = 0) + { + $CNF = &$this->_oConfig->CNF; + if(empty($sSystem) && !empty($CNF['OBJECT_FAVORITES'])) + $sSystem = $CNF['OBJECT_FAVORITES']; + + if(empty($sSystem)) + return false; + + $oFavorite = BxDolFavorite::getObjectInstance($sSystem, $iId, true, $this->_oTemplate); + if(!$oFavorite || !$oFavorite->isEnabled()) + return false; + + return $oFavorite; + } + + public function getUserId() + { + return isLogged() ? bx_get_logged_profile_id() : 0; + } + + public function getUserIp() + { + return getVisitorIP(); + } + + public function getUserInfo($iUserId = 0) + { + $oProfile = BxDolProfile::getInstanceMagic($iUserId); + + return array( + $oProfile->getDisplayName(), + $oProfile->getUrl(), + $oProfile->getThumb(), + $oProfile->getUnit(), + $oProfile->getUnit(0, array('template' => 'unit_wo_info')) + ); + } + + public function getUserInfoWithBadges($iUserId = 0) + { + $oProfile = BxDolProfile::getInstanceMagic($iUserId); + + return array( + $oProfile->getDisplayName(), + $oProfile->getUrl(), + $oProfile->getThumb(), + $oProfile->getUnit(), + $oProfile->getUnit(0, array('template' => 'unit_wo_info')), + $oProfile->getBadges() + ); + } + + public function isMenuItemVisible($sObject, &$aItem, &$aContentInfo) + { + $CNF = &$this->_oConfig->CNF; + + // default visible settings + if(!BxDolAcl::getInstance()->isMemberLevelInSet($aItem['visible_for_levels'])) + return false; + + if (!empty($aItem['visibility_custom'])) { + $oMenu = BxDolMenu::getObjectInstance($sObject); + if ($oMenu && !BxDolService::callSerialized($aItem['visibility_custom'], $oMenu->getMarkers())) + return false; + } + + // get custom function name to check menu item visibility + $sFuncCheckAccess = false; + if(isset($CNF['MENU_ITEM_TO_METHOD'][$sObject][$aItem['name']])) + $sFuncCheckAccess = $CNF['MENU_ITEM_TO_METHOD'][$sObject][$aItem['name']]; + + // check custom visibility settings defined in module config class + if(!isset($aContentInfo)) + $aContentInfo = array(); + + if($sFuncCheckAccess && CHECK_ACTION_RESULT_ALLOWED !== call_user_func_array(array($this, $sFuncCheckAccess), array(&$aContentInfo))) + return false; + + return true; + } + + public function _isModerator ($isPerformAction = false) + { + return $this->_isModeratorForProfile($isPerformAction, $this->_iProfileId); + } + + public function _isModeratorForProfile($isPerformAction = false, $iProfileId = false) + { + return CHECK_ACTION_RESULT_ALLOWED === $this->checkAllowedEditAnyEntryForProfile ($isPerformAction, $iProfileId); + } + + public function _isAdministrator ($isPerformAction = false) + { + return $this->_isAdministratorForProfile($isPerformAction, $this->_iProfileId); + } + + public function _isAdministratorForProfile($isPerformAction = false, $iProfileId = false) + { + return CHECK_ACTION_RESULT_ALLOWED === $this->checkAllowedDeleteAnyEntryForProfile ($isPerformAction, $iProfileId); + } + + public function _prepareAuditParams($aContentInfo, $bIsSaveData = true, $aOverrideAuditParams = array()) + { + $CNF = &$this->_oConfig->CNF; + + $iContextId = isset($CNF['FIELD_ALLOW_VIEW_TO']) && (!empty($aContentInfo[$CNF['FIELD_ALLOW_VIEW_TO']]) && (int)$aContentInfo[$CNF['FIELD_ALLOW_VIEW_TO']] < 0) ? - $aContentInfo[$CNF['FIELD_ALLOW_VIEW_TO']] : 0; + + $AuditParams = array( + 'content_title' => (isset($CNF['FIELD_TITLE']) && isset($aContentInfo[$CNF['FIELD_TITLE']])) ? $aContentInfo[$CNF['FIELD_TITLE']] : '', + 'context_profile_id' => $iContextId, + 'content_info_object' => isset($CNF['OBJECT_CONTENT_INFO']) ? $CNF['OBJECT_CONTENT_INFO'] : '', + 'data' => ($bIsSaveData ? $aContentInfo : array()) + ); + if ($iContextId > 0) + $AuditParams['context_profile_title'] = BxDolProfile::getInstance($iContextId)->getDisplayName(); + + $AuditParams = array_merge($AuditParams, $aOverrideAuditParams); + + return $AuditParams; + } + + public function _getFavoriteListUrl ($iListId, $iProfileId) + { + $CNF = &$this->_oConfig->CNF; + return bx_absolute_url(BxDolPermalinks::getInstance()->permalink('page.php?i=' . $CNF['URI_FAVORITES_LIST'] . '&profile_id=' . $iProfileId . '&list_id=' . $iListId)); + } + + public function getDataAPI($aData, $aParams = []) + { + $aDataApi = $this->decodeDataAPI($aData, $aParams); + + $sModule = $this->getName(); + $aExtras = [ + 'module' => $sModule, + 'data' => $aData, + 'params' => $aParams, + 'data_api' => &$aDataApi, + ]; + + /** + * @hooks + * @hookdef hook-system-decode_data_api 'system', 'decode_data_api' - hook to override content data prepared for sending in API response + * - $unit_name - equals `system` + * - $action - equals `decode_data_api` + * - $object_id - not used + * - $sender_id - not used + * - $extra_params - array of additional params with the following array keys: + * - `module` - [string] module name + * - `data` - [array] content info array as key&value pairs + * - `params` - [array] params array as key&value pairs + * - `data_api` - [array] by ref, content data prepared for sending in API response, can be overridden in hook processing + * @hook @ref hook-system-decode_data_api + */ + bx_alert('system', 'decode_data_api', 0, 0, $aExtras); + + /** + * @hooks + * @hookdef hook-bx_base_general-decode_data_api '{module_name}', 'decode_data_api' - hook to override content data prepared for sending in API response + * It's equivalent to @ref hook-system-decode_data_api + * @hook @ref hook-bx_base_general-decode_data_api + */ + bx_alert($sModule, 'decode_data_api', 0, 0, $aExtras); + + return $aDataApi; + } + + public function decodeDataAPI($aData, $aParams = []) + { + return $aData; + } + + // ====== PROTECTED METHODS + + protected function _serviceEntityForm ($sFormMethod, $iContentId = 0, $sDisplay = false, $sCheckFunction = false, $bErrorMsg = true) + { + $iContentId = $this->_getContent($iContentId, false); + if($iContentId === false) + return false; + + $oFormsHelper = $this->getFormsHelper(); + return $oFormsHelper->$sFormMethod((int)$iContentId, $sDisplay, $sCheckFunction, $bErrorMsg); + } + + protected function _serviceTemplateFunc ($sFunc, $iContentId, $sFuncGetContent = 'getContentInfoById') + { + return $this->_serviceTemplateFuncEx($sFunc, $iContentId, array('function_get_content' => $sFuncGetContent)); + } + + protected function _serviceTemplateFuncEx ($sFunc, $iContentId, $aParams = array()) + { + if (!isset($aParams['function_get_content'])) + $aParams['function_get_content'] = 'getContentInfoById'; + + $mixedContent = $this->_getContent($iContentId, $aParams['function_get_content']); + if($mixedContent === false) + return false; + + list($iContentId, $aContentInfo) = $mixedContent; + + unset($aParams['function_get_content']); + + if (!empty($aParams)) + return $this->_oTemplate->$sFunc($aContentInfo, $aParams); + else + return $this->_oTemplate->$sFunc($aContentInfo); + } + + protected function _getApproveForm($iContentId, $aContentInfo) + { + $CNF = &$this->_oConfig->CNF; + + $sForm = 'sys_manage'; + if(!empty($CNF['OBJECT_FORM_MANAGE'])) + $sForm = $CNF['OBJECT_FORM_MANAGE']; + + $sFormDisplay = 'sys_manage_approve'; + if(!empty($CNF['OBJECT_FORM_MANAGE_APPROVE'])) + $sFormDisplay = $CNF['OBJECT_FORM_MANAGE_APPROVE']; + + $oForm = BxTemplFormView::getObjectInstance($sForm, $sFormDisplay); + $oForm->aFormAttrs['action'] = BX_DOL_URL_ROOT . $this->_oConfig->getBaseUri() . 'approve'; + $oForm->aInputs['content_id']['value'] = $iContentId; + foreach($oForm->aInputs['controls'] as $iKey => $mixedValue) + if(is_numeric($iKey) && isset($mixedValue['name']) && $mixedValue['name'] == 'do_submit') + $oForm->aInputs['controls'][$iKey]['value'] = _t('_sys_form_manage_input_do_submit_approve'); + + /** + * @hooks + * @hookdef hook-bx_base_general-get_approve_form '{module_name}', 'get_approve_form' - hook to override approve content form + * - $unit_name - module name + * - $action - equals `get_approve_form` + * - $object_id - not used + * - $sender_id - not used + * - $extra_params - array of additional params with the following array keys: + * - `content_id` - [int] content id + * - `content_info` - [array] content info array as key&value pairs + * - `override_result` - [object] by ref, an instance of approve content form, @see BxDolForm, can be overridden in hook processing + * @hook @ref hook-bx_base_general-get_approve_form + */ + bx_alert($this->_oConfig->getName(), 'get_approve_form', 0, 0, [ + 'content_id' => $iContentId, + 'content_info' => $aContentInfo, + 'override_result' => &$oForm + ]); + + return $oForm; + } + + protected function _sendApproveMessage($iContentId, $aContentInfo, &$oForm) + { + $CNF = &$this->_oConfig->CNF; + + $sETemplate = 't_ManageApprove'; + if(!empty($CNF['ETEMPLATE_MANAGE_APPROVE'])) + $sETemplate = $CNF['ETEMPLATE_MANAGE_APPROVE']; + + $aEParams = array( + 'content_title' => !empty($CNF['FIELD_TITLE']) && !empty($aContentInfo[$CNF['FIELD_TITLE']]) ? $aContentInfo[$CNF['FIELD_TITLE']] : '', + 'notes' => $oForm->getCleanValue('notes'), + ); + + /** + * @hooks + * @hookdef hook-bx_base_general-get_approve_message '{module_name}', 'get_approve_form' - hook to override approve content message + * - $unit_name - module name + * - $action - equals `get_approve_message` + * - $object_id - not used + * - $sender_id - not used + * - $extra_params - array of additional params with the following array keys: + * - `content_id` - [int] content id + * - `content_info` - [array] content info array as key&value pairs + * - `form` - [object] an instance of approve content form + * - `email_template` - [string] by ref, email template name, @see BxDolEmailTemplates, can be overridden in hook processing + * - `email_params` - [array] by ref, email template params, can be overridden in hook processing + * @hook @ref hook-bx_base_general-get_approve_message + */ + bx_alert($this->_oConfig->getName(), 'get_approve_message', 0, 0, [ + 'content_id' => $iContentId, + 'content_info' => $aContentInfo, + 'form' => $oForm, + 'email_template' => &$sETemplate, + 'email_params' => &$aEParams + ]); + + return sendMailTemplate($sETemplate, 0, $aContentInfo[$CNF['FIELD_AUTHOR']], $aEParams); + } + + protected function _processModerationNotifications($aContentInfo) + { + $CNF = &$this->_oConfig->CNF; + + if(empty($CNF['PARAM_AUTO_APPROVE']) || getParam($CNF['PARAM_AUTO_APPROVE']) == 'on') + return; + + $aRecipients = []; + if(getParam('sys_notify_to_approve_by_role') == 'on' && bx_srv('system', 'is_module_content', [$this->_oConfig->getName()]) && !empty($CNF['FIELD_ALLOW_VIEW_TO']) && (int)$aContentInfo[$CNF['FIELD_ALLOW_VIEW_TO']] < 0) { + $iContextProfileId = abs((int)$aContentInfo[$CNF['FIELD_ALLOW_VIEW_TO']]); + $oContextProfile = BxDolProfile::getInstance($iContextProfileId); + + $aRecipients = bx_srv($oContextProfile->getModule(), 'get_admins_to_manage_content', [$iContextProfileId]); + } + + $sModule = $this->getName(); + + if(empty($aRecipients)) + $aRecipients = BxDolAclQuery::getInstance()->getProfilesByAction([ + MEMBERSHIP_ACTION_EDIT_ANY_ENTRY, + MEMBERSHIP_ACTION_DELETE_ANY_ENTRY + ], [ + 'module' => $sModule, + 'ids_only' => true + ]); + + if(empty($aRecipients)) + return; + + foreach($aRecipients as $iRecipientId) + /** + * @hooks + * @hookdef hook-bx_base_general-pending_approval '{module_name}', 'pending_approval' - hook to notify admins/moderators about new pending approval content + * - $unit_name - module name + * - $action - equals `pending_approval` + * - $object_id - content id + * - $sender_id - content author profile id + * - $extra_params - array of additional params with the following array keys: + * - `object_author_id` - [int] admin/moderator profile id + * @hook @ref hook-bx_base_general-pending_approval + */ + bx_alert($sModule, 'pending_approval', $aContentInfo[$CNF['FIELD_ID']], $aContentInfo[$CNF['FIELD_AUTHOR']], [ + 'object_author_id' => (int)$iRecipientId + ]); + } + + protected function _rss ($aArgs, $sClass = 'SearchResult') + { + $sMode = array_shift($aArgs); + + if (CHECK_ACTION_RESULT_ALLOWED !== ($sMsg = $this->checkAllowedBrowse())) { + $this->_oTemplate->displayAccessDenied ($sMsg); + exit; + } + + $aParams = $this->_buildRssParams($sMode, $aArgs); + + bx_import ($sClass, $this->_aModule); + $sClass = $this->_aModule['class_prefix'] . $sClass; + $o = new $sClass($sMode, $aParams); + + if ($o->isError) + $this->_oTemplate->displayPageNotFound (); + else + $o->outputRSS(); + + exit; + } + + protected function _getContent($iContentId = 0, $sFuncGetContent = true) + { + if(!$iContentId) + $iContentId = bx_process_input(bx_get('id'), BX_DATA_INT); + + if(!$iContentId) + return false; + + if($sFuncGetContent === true) + $sFuncGetContent = 'getContentInfoById'; + + if(empty($sFuncGetContent) || !method_exists($this->_oDb, $sFuncGetContent)) + return $iContentId; + + $aContentInfo = $this->_oDb->$sFuncGetContent($iContentId); + if(!$aContentInfo) + return false; + + return array($iContentId, $aContentInfo); + } + + protected function _getContentForTimelinePost($aEvent, $aContentInfo, $aBrowseParams = array()) + { + $CNF = &$this->_oConfig->CNF; + + $sUrl = bx_absolute_url(BxDolPermalinks::getInstance()->permalink('page.php?i=' . $CNF['URI_VIEW_ENTRY'] . '&id=' . $aContentInfo[$CNF['FIELD_ID']])); + + //--- Image(s) + $aImages = $this->_getImagesForTimelinePost($aEvent, $aContentInfo, $sUrl, $aBrowseParams); + $aImagesAttach = $this->_getImagesForTimelinePostAttach($aEvent, $aContentInfo, $sUrl, $aBrowseParams); + + if(bx_is_api() && getParam('sys_api_extended_units') != 'on') { + $sTitle = ''; + if(isset($CNF['FIELD_TITLE']) && isset($aContentInfo[$CNF['FIELD_TITLE']])) + $sTitle = $aContentInfo[$CNF['FIELD_TITLE']]; + else if(isset($CNF['FIELD_TEXT']) && isset($aContentInfo[$CNF['FIELD_TEXT']])) + $sTitle = strmaxtextlen($aContentInfo[$CNF['FIELD_TEXT']], 20, '...'); + + $sAbstract = isset($CNF['FIELD_ABSTRACT']) && isset($aContentInfo[$CNF['FIELD_ABSTRACT']]) ? $aContentInfo[$CNF['FIELD_ABSTRACT']] : ''; + + $sText = isset($CNF['FIELD_TEXT']) && isset($aContentInfo[$CNF['FIELD_TEXT']]) ? $aContentInfo[$CNF['FIELD_TEXT']] : ''; + $sText = BxTemplFunctions::getInstance()->getStringWithLimitedLength(strip_tags($sText), 240); + + return [ + 'url' => $sUrl, + 'title' => $sTitle, + 'abstract' => $sAbstract, + 'text' => $sText, + 'images' => $aImages + ]; + } + + //--- Video(s) + $aVideos = $this->_getVideosForTimelinePost($aEvent, $aContentInfo, $sUrl, $aBrowseParams); + $aVideosAttach = $this->_getVideosForTimelinePostAttach($aEvent, $aContentInfo, $sUrl, $aBrowseParams); + + //--- Files(s) + $aFiles = $this->_getFilesForTimelinePost($aEvent, $aContentInfo, $sUrl, $aBrowseParams); + $aFilesAttach = $this->_getFilesForTimelinePostAttach($aEvent, $aContentInfo, $sUrl, $aBrowseParams); + + //--- Title + $sTitle = ''; + if(isset($CNF['FIELD_TITLE']) && isset($aContentInfo[$CNF['FIELD_TITLE']])) + $sTitle = $aContentInfo[$CNF['FIELD_TITLE']]; + else if(isset($CNF['FIELD_TEXT']) && isset($aContentInfo[$CNF['FIELD_TEXT']])) + $sTitle = strmaxtextlen($aContentInfo[$CNF['FIELD_TEXT']], 20, '...'); + + //--- Text + $sText = ''; + if(isset($CNF['FIELD_ABSTRACT']) && isset($aContentInfo[$CNF['FIELD_ABSTRACT']])) + $sText = $aContentInfo[$CNF['FIELD_ABSTRACT']]; + if(empty($sText) && isset($CNF['FIELD_TEXT']) && isset($aContentInfo[$CNF['FIELD_TEXT']])) + $sText = $aContentInfo[$CNF['FIELD_TEXT']]; + + if(!empty($CNF['OBJECT_METATAGS']) && is_string($sText)) { + $oMetatags = BxDolMetatags::getObjectInstance($CNF['OBJECT_METATAGS']); + $sText = $oMetatags->metaParse($aContentInfo[$CNF['FIELD_ID']], $sText); + } + + $sCategory = ''; + if (isset($CNF['OBJECT_CATEGORY']) && isset($CNF['OBJECT_CATEGORY']) && isset($aContentInfo[$CNF['FIELD_CATEGORY']])){ + $oCategory = BxDolCategory::getObjectInstance($CNF['OBJECT_CATEGORY']); + if ($oCategory) + $sCategory = $oCategory->getCategoryTitle($aContentInfo[$CNF['FIELD_CATEGORY']]); + } + + return array( + 'sample' => isset($CNF['T']['txt_sample_single_with_article']) ? $CNF['T']['txt_sample_single_with_article'] : $CNF['T']['txt_sample_single'], + 'sample_wo_article' => $CNF['T']['txt_sample_single'], + 'sample_action' => isset($CNF['T']['txt_sample_action']) ? $CNF['T']['txt_sample_action'] : '', + 'url' => $sUrl, + 'title' => $sTitle, + 'category' => $sCategory, + 'text' => $sText, + 'images' => $aImages, + 'images_attach' => $aImagesAttach, + 'videos' => $aVideos, + 'videos_attach' => $aVideosAttach, + 'files' => $aFiles, + 'files_attach' => $aFilesAttach + ); + } + + protected function _getImagesForTimelinePost($aEvent, $aContentInfo, $sUrl, $aBrowseParams = array()) + { + $CNF = &$this->_oConfig->CNF; + if (bx_is_api()){ + $aResult = []; + if(isset($CNF['FIELD_COVER']) && !empty($aContentInfo[$CNF['FIELD_COVER']])) { + $aResult[] = bx_api_get_image($CNF['OBJECT_STORAGE'], (int)$aContentInfo[$CNF['FIELD_COVER']]); + } + if(isset($CNF['FIELD_THUMB']) && !empty($aContentInfo[$CNF['FIELD_THUMB']])) { + $aResult[] = bx_api_get_image($CNF['OBJECT_STORAGE'], (int)$aContentInfo[$CNF['FIELD_THUMB']]); + } + return $aResult; + } + else{ + $iImageId = 0; + $sImageSm = $sImageMd = $sImageXl = ''; + if(isset($CNF['FIELD_COVER']) && !empty($aContentInfo[$CNF['FIELD_COVER']])) { + $iImageId = (int)$aContentInfo[$CNF['FIELD_COVER']]; + $sImageSm = $this->_oConfig->getImageUrl($iImageId, ['OBJECT_IMAGES_TRANSCODER_MINIATURE', 'OBJECT_IMAGES_TRANSCODER_THUMB']); + $sImageMd = $this->_oConfig->getImageUrl($iImageId, ['OBJECT_IMAGES_TRANSCODER_GALLERY', 'OBJECT_IMAGES_TRANSCODER_THUMB']); + $sImageXl = $this->_oConfig->getImageUrl($iImageId, ['OBJECT_IMAGES_TRANSCODER_COVER']); + } + + if($sImageMd == '' && isset($CNF['FIELD_THUMB']) && !empty($aContentInfo[$CNF['FIELD_THUMB']])) { + $iImageId = (int)$aContentInfo[$CNF['FIELD_THUMB']]; + $sImageSm = $this->_oConfig->getImageUrl($iImageId, ['OBJECT_IMAGES_TRANSCODER_MINIATURE', 'OBJECT_IMAGES_TRANSCODER_THUMB']); + $sImageMd = $this->_oConfig->getImageUrl($iImageId, ['OBJECT_IMAGES_TRANSCODER_GALLERY', 'OBJECT_IMAGES_TRANSCODER_THUMB']); + $sImageXl = $this->_oConfig->getImageUrl($iImageId, ['OBJECT_IMAGES_TRANSCODER_COVER']); + } + + if(empty($sImageMd)) + return []; + + if($sImageSm == '') + $sImageSm = $sImageMd; + + if($sImageXl == '') + $sImageXl = $sImageMd; + + return [[ + 'id' => $iImageId, + 'url' => $sUrl, + 'src' => $sImageMd, + 'src_small' => $sImageSm, + 'src_medium' => $sImageMd, + 'src_orig' => $sImageXl + ]]; + } + } + + protected function _getImagesForTimelinePostAttach($aEvent, $aContentInfo, $sUrl, $aBrowseParams = array()) + { + return array(); + } + + protected function _getVideosForTimelinePost($aEvent, $aContentInfo, $sUrl, $aBrowseParams = array()) + { + return array(); + } + + protected function _getVideosForTimelinePostAttach($aEvent, $aContentInfo, $sUrl, $aBrowseParams = array()) + { + return array(); + } + + protected function _getFilesForTimelinePost($aEvent, $aContentInfo, $sUrl, $aBrowseParams = array()) + { + return array(); + } + + protected function _getFilesForTimelinePostAttach($aEvent, $aContentInfo, $sUrl, $aBrowseParams = array()) + { + return array(); + } + + protected function _entityComments ($sObject, $iId = 0) + { + if (!$iId) + $iId = bx_process_input(bx_get('id'), BX_DATA_INT); + + if (!$iId) + return false; + + $oCmts = BxDolCmts::getObjectInstance($sObject, $iId); + if (!$oCmts || !$oCmts->isEnabled()) + return false; + + if (bx_is_api()){ + return [bx_srv('system', 'get_data_api', [['module' => $sObject, 'object_id' => $iId]], 'TemplCmtsServices')]; + } + return $oCmts->getCommentsBlock([], ['in_designbox' => false, 'show_empty' => false]); + } + + protected function _getFields($iContentId) + { + $aContentInfo = $this->_oDb->getContentInfoById($iContentId); + if(empty($aContentInfo)) + return array(); + + return BxDolContentInfo::formatFields($aContentInfo); + } + + protected function _getFieldValue($sField, $iContentId) + { + $CNF = &$this->_oConfig->CNF; + if(empty($CNF[$sField])) + return false; + + $aContentInfo = $this->_oDb->getContentInfoById($iContentId); + if(empty($aContentInfo) || empty($aContentInfo[$CNF[$sField]])) + return false; + + return $aContentInfo[$CNF[$sField]]; + } + + protected function _getFieldValueThumb($sField, $iContentId, $sTranscoder = '') + { + $CNF = &$this->_oConfig->CNF; + + if(empty($sTranscoder) || empty($CNF[$sField])) + return false; + + $aContentInfo = $this->_oDb->getContentInfoById($iContentId); + if(empty($aContentInfo) || empty($aContentInfo[$CNF[$sField]])) + return false; + + $oImagesTranscoder = BxDolTranscoderImage::getObjectInstance($sTranscoder); + if(!$oImagesTranscoder) + return false; + + return $oImagesTranscoder->getFileUrl($aContentInfo[$CNF[$sField]]); + } + + protected function _prepareResponse($aResponse, $bAsJson = false, $aAdditional = array()) + { + if(!$bAsJson) + return $aResponse; + + if(!empty($aAdditional) && is_array($aAdditional)) + $aResponse = array_merge($aResponse, $aAdditional); + + echoJson($aResponse); + exit; + } + + /** + * Blocks for lables tree browsing private functions + */ + + private function _getLablesBreadcrumbsArray($iLabelId, &$aBreadcrumbs) + { + $oLabel = BxDolLabel::getInstance(); + $aLabel = $oLabel->getLabels(array('type' => 'id', 'id' => $iLabelId)); + if ($aLabel){ + $aBreadcrumbs[$aLabel['id']] = array('id' => $aLabel['id'], 'value' => $aLabel['value']); + $this->_getLablesBreadcrumbsArray($aLabel['parent'], $aBreadcrumbs); + } + } + + private function _getLablesBrowseUrl($iLabelId) + { + list($sPageLink, $aPageParams) = bx_get_base_url_inline(); + return BxDolPermalinks::getInstance()->permalink(bx_append_url_params($sPageLink, array_merge($aPageParams, array('label' => $iLabelId)))); + } + + private function _getLablesTreeLevel($aBreadcrumbs, $iParent = 0) + { + $oLabel = BxDolLabel::getInstance(); + $aLabelsOutput = array(); + $aLabels = $oLabel->getLabels(array('type' => 'parent', 'parent' => $iParent)); + if (count($aLabels) > 0){ + foreach($aLabels as $aLabel) { + $sChild = $this->_getLablesTreeLevel($aBreadcrumbs, $aLabel['id']); + $bChildPresent = $sChild != '' ? true : false; + $bIsOpen = array_key_exists($aLabel['id'], $aBreadcrumbs) ? true : false; + if (!$bIsOpen){ + $sChild = ''; + } + $aLabelsOutput[] = array( + 'value' => $aLabel['value'], + 'url' => $this->_getLablesBrowseUrl($aLabel['id']), + 'child' => $sChild, + + 'selected' => bx_process_input(bx_get('label'), BX_DATA_INT) == $aLabel['id'] ? 'selected' : ''.$aLabel['id'], + 'bx_if:open' => array( + 'condition' => $bChildPresent && $bIsOpen, + 'content' => array() + ), + 'bx_if:can_open' => array( + 'condition' => $bChildPresent && !$bIsOpen, + 'content' => array() + ) + ); + } + return $this->_oTemplate->parseHtmlByName('labels_tree.html', + array( + 'bx_repeat:items' => $aLabelsOutput, + 'parent' => $iParent, + ) + ); + } + return ''; + } +} + +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/general/classes/BxBaseModGeneralSearchResult.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/general/classes/BxBaseModGeneralSearchResult.php new file mode 100644 index 0000000000..6683c12c0c --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/general/classes/BxBaseModGeneralSearchResult.php @@ -0,0 +1,310 @@ +<?php defined('BX_DOL') or die('hack attempt'); +/** + * Copyright (c) UNA, Inc - https://una.io + * MIT License - https://opensource.org/licenses/MIT + * + * @defgroup BaseGeneral Base classes for modules + * @ingroup UnaModules + * + * @{ + */ + +define('BX_SYS_PER_PAGE_BROWSE_SHOWCASE', 32); + +class BxBaseModGeneralSearchResult extends BxTemplSearchResult +{ + protected $oModule; + protected $sFilterName; + protected $bShowcaseView = false; + protected $aUnitViews = array(); + protected $sUnitViewDefault = 'gallery'; + + function __construct($sMode = '', $aParams = array()) + { + $this->_sMode = $sMode; + $this->_aParams = $aParams; + + $this->_bValidate = isset($this->_aParams['validate']) && is_array($this->_aParams['validate']); + + parent::__construct(); + } + + function getMain() + { + if(!$this->oModule) + $this->oModule = BxDolModule::getInstance($this->getModuleName()); + + return $this->oModule; + } + + function getContentInfoObject() + { + return BxDolContentInfo::getObjectInstance($this->getContentInfoName()); + } + + function getFieldsOwn() + { + $mixedFields = getParam($this->getModuleName() . '_browse_fields_own'); + if(empty($mixedFields)) + return false; + + if(($aFields = json_decode($mixedFields, true)) !== null) + return $aFields; + + $sDelimiter = ','; + if(strpos($mixedFields, $sDelimiter) !== false) + return explode($sDelimiter, $mixedFields); + + return false; + } + + function getFieldsJoin($sJoin) + { + $mixedFields = getParam($this->getModuleName() . '_browse_fields_join'); + if(empty($mixedFields)) + return false; + + return ($aJoins = json_decode($mixedFields, true)) !== null && !empty($aJoins[$sJoin]) ? $aJoins[$sJoin] : false; + } + + function getRssUnitLink (&$a) + { + $CNF = &$this->oModule->_oConfig->CNF; + + return bx_absolute_url(BxDolPermalinks::getInstance()->permalink('page.php?i=' . $CNF['URI_VIEW_ENTRY'] . '&id=' . $a[$CNF['FIELD_ID']])); + } + + function getRssPageUrl () + { + if (false === parent::getRssPageUrl()) + return false; + + $oPermalinks = BxDolPermalinks::getInstance(); + return bx_absolute_url($oPermalinks->permalink($this->aCurrent['rss']['link'])); + } + + function rss () + { + if (!isset($this->aCurrent['rss'])) + return ''; + + $this->aCurrent['paginate']['perPage'] = empty($this->oModule->_oConfig->CNF['PARAM_NUM_RSS']) ? 10 : getParam($this->oModule->_oConfig->CNF['PARAM_NUM_RSS']); + + return parent::rss(); + } + + function processingAPI () + { + $aResult = parent::processingAPI(); + + if(isset($this->_aParams['filters']) && is_array($this->_aParams['filters'])) { + $oModule = $this->getMain(); + + if(!empty($this->_aParams['filters']['values']) && is_array($this->_aParams['filters']['values'])) + $aResult['params']['filters'] = $this->_aParams['filters']['values']; + + $aResult['filters'] = $oModule->_oTemplate->getBrowsingFilters(['mode' => $this->_sMode]); + } + + return $aResult; + } + + protected function addCustomConditions($CNF, $oProfile, $sMode, $aParams) + { + $this->addConditionsForAuthorStatus($CNF); + + $this->addConditionsForCf($CNF); + + if(!empty($aParams['filter']) && is_array($aParams['filter'])) + $this->addConditionsForFilter($CNF, $sMode, $aParams); + } + + protected function addConditionsForAuthorStatus($CNF) + { + if (empty($CNF['FIELD_AUTHOR'])) + return; + + $this->aCurrent['restriction']['statusAuthor'] = [ + 'value' => 'active', + 'field' => 'status', + 'operator' => '=', + 'table' => 'sys_profiles', + ]; + + $this->aCurrent['join']['statusAuthor'] = [ + 'type' => 'INNER', + 'table' => 'sys_profiles', + 'mainField' => $CNF['FIELD_AUTHOR'], + 'mainFieldFunc' => 'ABS', + 'onField' => 'id', + 'joinFields' => array(), + ]; + } + + protected function addConditionsForCf($CNF) + { + if(empty($CNF['FIELD_CF'])) + return; + + $oCf = BxDolContentFilter::getInstance(); + if(!$oCf->isEnabled()) + return; + + $aConditions = $oCf->getConditions($this->aCurrent['table'], $CNF['FIELD_CF']); + if(!empty($aConditions) && is_array($aConditions)) + $this->aCurrent['restriction'] = array_merge($this->aCurrent['restriction'], $aConditions); + } + + protected function addConditionsForFilter($CNF, $sMode, $aParams) + { + $aFilter = $aParams['filter']; + + if(empty($aFilter['field']) || empty($aFilter['value'])) + return; + + $aRestriction = [ + 'value' => $aFilter['value'], + 'field' => $aFilter['field'], + 'operator' => '=', + ]; + + if(isset($aFilter['operator'])) + $aRestriction['operator'] = $aFilter['operator']; + + if(isset($aFilter['table'])) + switch($aFilter['table']) { + case 'table': + $aRestriction['table'] = $this->aCurrent['table']; + break; + + case 'tableSearch': + $aRestriction['table'] = $this->aCurrent['tableSearch']; + break; + + default: + $aRestriction['table'] = $aFilter['table']; + } + + $this->aCurrent['restriction']['filter'] = $aRestriction; + } + + /** + * Add conditions for private content + */ + protected function addConditionsForPrivateContent($CNF, $oProfile, $aCustomGroup = array()) + { + // default is bProcessPrivateContent = 1, + // so private items are shown as empty boxes with "Private" title + + // we can show public content when privacy object is available + + if(empty($CNF['OBJECT_PRIVACY_VIEW'])) + return; + + $oPrivacy = BxDolPrivacy::getObjectInstance($CNF['OBJECT_PRIVACY_VIEW']); + if(!$oPrivacy) + return; + + // for posts in some context we need to show all items, not only public content + if (!empty($this->aCurrent['restriction']['context']['value']) || !empty($this->aCurrent['restriction']['author']['value'])) { + $this->setProcessPrivateContent(true); + return; + } + + // build condition to show only public content + $aCondition = $oPrivacy->getContentPublicAsCondition($oProfile ? $oProfile->id() : 0, $aCustomGroup); + if(empty($aCondition) || !is_array($aCondition)) + return; + + if(isset($aCondition['restriction'])) { + $this->aCurrent['restriction'] = array_merge($this->aCurrent['restriction'], $aCondition['restriction']); + $this->aPrivateConditionsIndexes['restriction'] = array_keys($aCondition['restriction']); + } + if(isset($aCondition['join'])) { + $this->aCurrent['join'] = array_merge($this->aCurrent['join'], $aCondition['join']); + $this->aPrivateConditionsIndexes['join'] = array_keys($aCondition['join']); + } + + $this->setProcessPrivateContent(false); + } + + function showPagination($bAdmin = false, $bChangePage = true, $bPageReload = true) + { + if($this->bShowcaseView) + return ''; + + $sPagination = parent::showPagination ($bAdmin, $bChangePage, $bPageReload); + if(empty($sPagination)) + return ''; + + return $sPagination; + } + + protected function getItemPerPageInShowCase () + { + $iPerPageInShowCase = BX_SYS_PER_PAGE_BROWSE_SHOWCASE; + $CNF = &$this->oModule->_oConfig->CNF; + if (isset($CNF['PARAM_PER_PAGE_BROWSE_SHOWCASE'])) + $iPerPageInShowCase = getParam($CNF['PARAM_PER_PAGE_BROWSE_SHOWCASE']); + return $iPerPageInShowCase; + } + + function displayResultBlock() + { + if ($this->bShowcaseView) { + $this->addContainerClass(array('bx-base-unit-showcase-wrapper')); + $this->aCurrent['paginate']['perPage'] = $this->getItemPerPageInShowCase(); + $this->oModule->_oTemplate->addCss(array(BX_DIRECTORY_PATH_PLUGINS_PUBLIC . 'flickity/|flickity.css')); + $this->oModule->_oTemplate->addJs(array('flickity/flickity.pkgd.min.js','modules/base/general/js/|showcase.js')); + } + + return parent::displayResultBlock(); + } + + function displaySearchBox ($sContent, $sPaginate = '') + { + $aResult = parent::displaySearchBox($sContent, $sPaginate); + + if(isset($this->_aParams['filters']) && is_array($this->_aParams['filters'])) + $aResult['buttons'] = [ + ['title' => _t('_Filters'), 'href' => 'javascript:void(0)', 'onclick' => 'javascript:' . $this->_aParams['filters']['onclick']] + ]; + + return $aResult; + } + + function applyContainerId() + { + if(empty($this->aCurrent['name']) || empty($this->_sMode)) + return parent::applyContainerId(); + + return str_replace('_', '-', $this->aCurrent['name'] . '-search-result-block-' . $this->_sMode); + } + + function decodeDataAPI($a) + { + if(!is_array($a)) + return $a; + + $bExtendedUnits = getParam('sys_api_extended_units') == 'on'; + + foreach($a as $i => $r) + $a[$i] = $this->oModule->getDataAPI($r, ['extended' => $bExtendedUnits]); + + return $a; + } + + function _getPseudFromParam () + { + $mixedPseud = getParam($this->getModuleName() . '_browse_pseud'); + if(empty($mixedPseud)) + return false; + + if(($aPseud = json_decode($mixedPseud, true)) !== null) + return $aPseud; + + return false; + } +} + +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/general/classes/BxBaseModGeneralTemplate.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/general/classes/BxBaseModGeneralTemplate.php new file mode 100644 index 0000000000..2d5c3521d4 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/general/classes/BxBaseModGeneralTemplate.php @@ -0,0 +1,840 @@ +<?php defined('BX_DOL') or die('hack attempt'); +/** + * Copyright (c) UNA, Inc - https://una.io + * MIT License - https://opensource.org/licenses/MIT + * + * @defgroup BaseGeneral Base classes for modules + * @ingroup UnaModules + * + * @{ + */ + +/** + * Module representation. + */ +class BxBaseModGeneralTemplate extends BxDolModuleTemplate +{ + protected $MODULE; + + protected $_bIsApi; + + public $aMethodsToCallAddJsCss = array('entry', 'unit'); + + public function __construct(&$oConfig, &$oDb) + { + parent::__construct($oConfig, $oDb); + + $this->_bIsApi = bx_is_api(); + } + + public function addLocationBase() + { + parent::addLocationBase(); + + $this->addLocation('mod_general', BX_DIRECTORY_PATH_MODULES . 'base' . DIRECTORY_SEPARATOR . 'general' . DIRECTORY_SEPARATOR, BX_DOL_URL_MODULES . 'base/general/'); + } + + public function getJsCode($sType, $aParams = array(), $mixedWrap = true) + { + $sMask = "{var} {object} = new {class}({params});"; + $aMaskMarkers = array(); + if(is_array($mixedWrap)) { + if(!empty($mixedWrap['mask'])) + $sMask = $mixedWrap['mask']; + + if(!empty($mixedWrap['mask_markers']) && is_array($mixedWrap['mask_markers'])) + $aMaskMarkers = $mixedWrap['mask_markers']; + } + + $sJsClass = $this->_oConfig->getJsClass($sType); + if(!empty($aParams['js_class'])) { + $sJsClass = $aParams['js_class']; + unset($aParams['js_class']); + } + + $sJsObject = $this->_oConfig->getJsObject($sType); + if(!empty($aParams['js_object'])) { + $sJsObject = $aParams['js_object']; + unset($aParams['js_object']); + } + + $sBaseUri = $this->_oConfig->getBaseUri(); + $aParams = array_merge([ + 'sActionUri' => $sBaseUri, + 'sActionUrl' => BX_DOL_URL_ROOT . $sBaseUri, + 'sObjName' => $sJsObject, + 'aHtmlIds' => [], + 'oRequestParams' => [] + ], $aParams); + + $sContent = false; + /** + * @hooks + * @hookdef hook-system-get_js_code 'system', 'get_js_code' - hook to override an instance of JavaScript class associate with the page + * - $unit_name - equals `system` + * - $action - equals `get_js_code` + * - $object_id - not used + * - $sender_id - not used + * - $extra_params - array of additional params with the following array keys: + * - `mask` - [string] by ref, a mask to generate JS code, can be overridden in hook processing + * - `mask_markers` - [array] by ref, an array of markers to be parsed in the mask, can be overridden in hook processing + * - `object` - [string] by ref, a string with JS object name, can be overridden in hook processing + * - `class` - [string] by ref, a string with JS class name, can be overridden in hook processing + * - `params` - [array] by ref, an array of parameters as key&value pairs which will be passed to constructor, can be overridden in hook processing + * - `override_result` - [string] or [boolean] by ref, if string is returned then it will be used as resulting JS code, can be overridden in hook processing + * @hook @ref hook-system-get_js_code + */ + bx_alert('system', 'get_js_code', 0, 0, [ + 'mask' => &$sMask, + 'mask_markers' => &$aMaskMarkers, + 'object' => &$sJsObject, + 'class' => &$sJsClass, + 'params' => &$aParams, + 'override_result' => &$sContent, + ]); + + if($sContent === false) + $sContent = bx_replace_markers($sMask, array_merge([ + 'var' => 'var', + 'object' => $sJsObject, + 'class' => $sJsClass, + 'params' => json_encode($aParams) + ], $aMaskMarkers)); + + return ($mixedWrap === true || (is_array($mixedWrap) && isset($mixedWrap['wrap']) && $mixedWrap['wrap'] === true)) ? $this->_wrapInTagJsCode($sContent) : $sContent; + } + + public function getTitleAuto($aData, $iMaxLen = 20, $sEllipsisSign = '...') + { + $CNF = &$this->getModule()->_oConfig->CNF; + + if(isset($aData[$CNF['FIELD_TITLE']])) + return $this->getTitle($aData); + + $sResult = $this->getText($aData); + if(strlen($sResult) > 0 && $iMaxLen > 0) + $sResult = strmaxtextlen($sResult, $iMaxLen, $sEllipsisSign); + + return $sResult; + } + + public function getTitle($aData, $mixedProcessOutput = BX_DATA_TEXT) + { + $CNF = &$this->getModule()->_oConfig->CNF; + + if(!isset($aData[$CNF['FIELD_TITLE']])) + return ''; + + $sResult = $aData[$CNF['FIELD_TITLE']]; + if($mixedProcessOutput !== false && !empty($sResult)) + $sResult = bx_process_output($sResult, (int)$mixedProcessOutput); + + return $sResult; + } + + public function getAbstract($aData, $mixedProcessOutput = BX_DATA_TEXT) + { + $CNF = &$this->getModule()->_oConfig->CNF; + + if(!isset($CNF['FIELD_ABSTRACT']) || !isset($aData[$CNF['FIELD_ABSTRACT']])) + return ''; + + $sResult = $aData[$CNF['FIELD_ABSTRACT']]; + if($mixedProcessOutput !== false && !empty($sResult)) + $sResult = bx_process_output($sResult, (int)$mixedProcessOutput); + + return $sResult; + } + + public function getText($aData, $mixedProcessOutput = BX_DATA_HTML) + { + $CNF = &$this->getModule()->_oConfig->CNF; + + if(!isset($CNF['FIELD_TEXT']) || !isset($aData[$CNF['FIELD_TEXT']])) + return ''; + + $sResult = $aData[$CNF['FIELD_TEXT']]; + if($mixedProcessOutput !== false && !empty($sResult)) + $sResult = bx_process_output($sResult, (int)$mixedProcessOutput); + + return $sResult; + } + + protected function getSummary($aData, $sTitle = '', $sText = '', $sUrl = '') + { + $sAbstract = $this->getAbstract($aData); + if(!empty($sAbstract)) + return $sAbstract; + + $CNF = &$this->getModule()->_oConfig->CNF; + if(empty($CNF['PARAM_CHARS_SUMMARY'])) + return ''; + + // get summary + $sLinkMore = ' <a title="' . bx_html_attribute(_t('_sys_read_more', $sTitle)) . '" href="' . $sUrl . '"><i class="sys-icon ellipsis-h"></i></a>'; + return strmaxtextlen($sText, (int)getParam($CNF['PARAM_CHARS_SUMMARY']), $sLinkMore); + } + + public function getProfileLink($mixedProfile) + { + if(!is_array($mixedProfile)) + $mixedProfile = $this->getModule()->getProfileInfo((int)$mixedProfile); + + return $this->getLink('link', array( + 'href' => $mixedProfile['link'], + 'title' => bx_html_attribute(!empty($mixedProfile['title']) ? $mixedProfile['title'] : $mixedProfile['name']), + 'content' => $mixedProfile['name'] + )); + } + + public function getLink($sTemplate, $aParams) + { + return $this->parseHtmlByName($sTemplate . '.html', array( + 'href' => $aParams['href'], + 'title' => $aParams['title'], + 'content' => $aParams['content'] + )); + } + + function getContextAddon ($aData, $oProfile) + { + $CNF = &$this->getModule()->_oConfig->CNF; + $sUrl = 'page.php?i=' . $CNF['URI_ENTRIES_BY_CONTEXT'] . '&profile_id=' . $oProfile->id(); + $bActAsProfile = BxDolService::call($oProfile->getModule(), 'act_as_profile'); + if ($bActAsProfile) + $sUrl = 'page.php?i=' . $CNF['URI_AUTHOR_ENTRIES'] . '&profile_id=' . $oProfile->id(); + $sUrl = BxDolPermalinks::getInstance()->permalink($sUrl); + return _t($CNF['T']['txt_all_entries_in'], $sUrl, $oProfile->getDisplayName(), $this->getModule()->_oDb->getEntriesNumByContext($oProfile->id())); + } + + function getContextDesc ($aData) + { + return ''; + } + + public function getTmplVarsText($aData) + { + $CNF = &$this->getModule()->_oConfig->CNF; + + $aVars = $aData; + $aVars['entry_title'] = $this->getTitle($aData); + $aVars['entry_abstract'] = $this->getAbstract($aData); + $aVars['bx_if:show_entry_abstract'] = [ + 'condition' => !empty($aVars['entry_abstract']), + 'content' => [ + 'entry_abstract' => $aVars['entry_abstract'] + ] + ]; + $aVars['entry_text'] = $this->getText($aData); + $aVars['badges'] = $this->getModule()->serviceGetBadges($aData[$CNF['FIELD_ID']]); + if (!empty($CNF['OBJECT_METATAGS'])) { + $oMetatags = BxDolMetatags::getObjectInstance($CNF['OBJECT_METATAGS']); + + // keywords + if ($oMetatags->keywordsIsEnabled()) { + $aFields = array_merge($oMetatags->metaFields($aData, $CNF, $CNF['OBJECT_FORM_ENTRY_DISPLAY_VIEW']), array('entry_title', 'entry_text')); + foreach ($aFields as $sField) + $aVars[$sField] = $oMetatags->keywordsParse($aData[$CNF['FIELD_ID']], $aVars[$sField]); + } + + // mentions + if ($oMetatags->mentionsIsEnabled()) { + $aFields = array_merge($oMetatags->metaFields($aData, $CNF, $CNF['OBJECT_FORM_ENTRY_DISPLAY_VIEW'], true), array('entry_text')); + foreach ($aFields as $sField) + $aVars[$sField] = $oMetatags->mentionsParse($aData[$CNF['FIELD_ID']], $aVars[$sField]); + } + + // location + $aVars['location'] = $oMetatags->locationsIsEnabled() ? $oMetatags->locationsString($aData[$CNF['FIELD_ID']]) : ''; + } + + unset($aVars['recipients']); + + return $aVars; + } + + public function entryBreadcrumb($aContentInfo, $aTmplVarsItems = array()) + { + $CNF = &BxDolModule::getInstance($this->MODULE)->_oConfig->CNF; + return bx_is_api() ? ['id' => 2, 'type' => 'breadcrumb', 'data' => ['name' => BxDolModule::getInstance($this->MODULE)->_aModule['title'], 'url' => BxDolPermalinks::getInstance()->permalink($CNF['URL_HOME'])]] : $this->parseHtmlByName('breadcrumb.html', [ + 'url_home' => bx_absolute_url(BxDolPermalinks::getInstance()->permalink($CNF['URL_HOME'])), + 'icon_home' => $CNF['ICON'], + 'bx_repeat:items' => $aTmplVarsItems + ]); + } + + public function entryText ($aData, $sTemplateName = 'entry-text.html') + { + $aVars = $this->getTmplVarsText($aData); + + if (empty($aVars['entry_text'])) + return false; + + return bx_is_api() ? $aVars : $this->parseHtmlByName($sTemplateName, $aVars); + } + + public function entryLocation ($iContentId) + { + $CNF = &$this->getModule()->_oConfig->CNF; + + if (empty($CNF['OBJECT_METATAGS'])) + return ''; + + $oMetatags = BxDolMetatags::getObjectInstance($CNF['OBJECT_METATAGS']); + + if (!($sLocationString = $oMetatags->locationsString($iContentId))) + return ''; + + $aVars = array ( + 'location' => $sLocationString + ); + return $this->parseHtmlByName('entry-location.html', $aVars); + } + + public function entryInfo($aData, $aValues = array()) + { + $CNF = $this->_oConfig->CNF; + $aValuesDefault = array(); + + if (isset($aData[$CNF['FIELD_ADDED']])) + $aValuesDefault[] = array( + 'title' => _t('_sys_txt_field_created'), + 'value' => bx_time_js($aData[$CNF['FIELD_ADDED']]), + ); + + if (isset($aData[$CNF['FIELD_CHANGED']])) + $aValuesDefault[] = array( + 'title' => _t('_sys_txt_field_updated'), + 'value' => bx_time_js($aData[$CNF['FIELD_CHANGED']]), + ); + + $aValues = array_merge($aValuesDefault, $aValues); + + return $this->parseHtmlByName('entry-info.html', array( + 'bx_repeat:info' => $aValues, + )); + } + + public function getFavoriteList($oProfile, $iStart, $iPerPage, $aParams) + { + $CNF = $this->_oConfig->CNF; + + $bEmptyMessage = false; + if(isset($aParams['empty_message'])) { + $bEmptyMessage = (bool)$aParams['empty_message']; + unset($aParams['empty_message']); + } + + $oFavorite = BxDolFavorite::getObjectInstance($CNF['OBJECT_FAVORITES'], 0, true); + $aListsData = $oFavorite->getQueryObject()->getList(array('type' => 'active', 'author_id' => $oProfile->id(), 'need_default' => true, 'start' => $iStart, 'limit' => $iPerPage + 1)); + $iNum = count($aListsData); + if ($iNum > $iPerPage) + $aListsData = array_slice($aListsData, 0, $iPerPage); + + $oPrivacy = BxDolPrivacy::getObjectInstance($CNF['OBJECT_PRIVACY_LIST_VIEW']); + $aListsTmpl = array(); + foreach($aListsData as $iListId => $sName) { + $aParams['list_id'] = $iListId; + if ($oPrivacy->check($iListId) || $iListId == 0){ + $aTmp = $this->getModule()->_serviceBrowse ('favorite', array_merge(array('user' => $oProfile->id()), $aParams), BX_DB_PADDING_DEF, $bEmptyMessage, false); + if ($aTmp && $aTmp['content']){ + $aListsTmpl[] = array( + 'title' => $sName, + 'content_url' => $this->getModule()->_getFavoriteListUrl($iListId, $oProfile->id()), + 'content' => $aTmp['content'] + ); + } + } + else{ + $aListsTmpl[] = array( + 'title' => 'private list', + 'content_url' => 'javascript:', + 'content' => '' + ); + } + } + + $oPaginate = new BxTemplPaginate(array( + 'on_change_page' => "return !loadDynamicBlockAutoPaginate(this, '{start}', '{per_page}', " . bx_js_string(json_encode($aParams)) . ", 'list_start', 'list_per_page');", + 'num' => $iNum, + 'per_page' => $iPerPage, + 'start' => $iStart, + )); + if (count($aListsTmpl) > 0) + return $this->parseHtmlByName('favorite-lists.html', array('bx_repeat:items' => $aListsTmpl)) . $oPaginate->getSimplePaginate() . $oFavorite->getJsScript(); + + return false; + } + + public function getFavoritesListInfo($aList, $oProfile) + { + $CNF = $this->_oConfig->CNF; + + $iListId = !empty($aList['id']) ? (int)$aList['id'] : 0; + + $oFavorite = BxDolFavorite::getObjectInstance($CNF['OBJECT_FAVORITES'], 0, true); + $aListInfo = $oFavorite->getQueryObject()->getList(array('type' => 'info', 'list_id' => $iListId, 'author_id' => $oProfile->id())); + + $oPrivacy = BxDolPrivacy::getObjectInstance($CNF['OBJECT_PRIVACY_LIST_VIEW']); + $sTitle = ""; + if ($aListInfo['allow_view_favorite_list_to'] < 0){ + $oProfileContext = BxDolProfile::getInstance(abs($aListInfo['allow_view_favorite_list_to'])); + $sTitle = $oProfileContext->getDisplayName(); + } + else{ + if (empty($aListInfo['allow_view_favorite_list_to'])) + $aListInfo['allow_view_favorite_list_to'] = 3; + $aPrivaciInfo = $oPrivacy->getGroupsBy(array('type'=>'id' , 'id'=> $aListInfo['allow_view_favorite_list_to'])); + $sTitle = _t($aPrivaciInfo['title']); + } + + $aListsTmpl = array(); + + if (!empty($aListInfo['created'])){ + $aListsTmpl[] = array('title' => _t('_sys_form_favorite_list_title_created'), 'value' => bx_time_js($aListInfo['created'])); + } + + $aListsTmpl = array_merge($aListsTmpl, + array( + array('title' => _t('_sys_form_favorite_list_title_updated'), 'value' => bx_time_js($aListInfo['updated'])), + array('title' => _t('_sys_form_favorite_list_title_count'), 'value' => $aListInfo['count']), + array('title' => _t('_sys_form_favorite_list_title_visibility'), 'value' => $sTitle) + ) + ); + + return $this->parseHtmlByName('favorite-list-info.html', array('bx_repeat:items' => $aListsTmpl, 'author' => $oProfile->getUnit())); + } + + public function getBrowsingFilters($aParams) + { + if(empty($aParams['mode'])) + return ''; + + $mixedContent = $this->_getBrowsingFiltersContent($aParams); + if($this->_bIsApi) + return $mixedContent; + + if(empty($mixedContent)) + return ''; + + $sPopupId = $this->_oConfig->getHtmlIds('popup_bfilters_' . $aParams['mode']); + $sPopupContent = $this->parseHtmlByName('browsing_filters.html', [ + 'content' => $mixedContent + ]); + + return BxTemplFunctions::getInstance()->transBox($sPopupId, $sPopupContent, true); + } + + function entryAllActions($sActions) + { + if(empty($sActions)) + return ''; + + return $this->parseHtmlByName('entry-all-actions.html', array ( + 'actions' => $sActions + )); + } + + function entryAttachments ($aData, $aParams = array()) + { + return $this->entryAttachmentsByStorage($this->getModule()->_oConfig->CNF['OBJECT_STORAGE'], $aData, $aParams); + } + + function entryAttachmentsByStorage ($mixedStorage, $aData, $aParams = array()) + { + if(!is_array($mixedStorage)) + $mixedStorage = array($mixedStorage); + + $aResult = array(); + + if (bx_is_api()){ + foreach($mixedStorage as $sStorage) { + $aAttachments = $this->getAttachments($sStorage, $aData, $aParams); + if ($aAttachments){ + foreach($aAttachments as $aAttachment) { + $aItem = [ + 'file_name' => $aAttachment['file_name'], + 'mime_type' => $aAttachment['mime_type'], + 'ext' => $aAttachment['ext'], + 'type' => 'other', + 'size' => $aAttachment['size'], + 'url' => $aAttachment['bx_if:not_image']['content']['url_original'] + ]; + if ($aAttachment['bx_if:image']['condition'] == 1){ + $aItem['type'] = 'image'; + $aItem['data'] = bx_api_get_image($sStorage, $aAttachment['id']); + } + if ($aAttachment['bx_if:video']['condition'] == 1){ + $aItem['type'] = 'video'; + $aItem['data'] = bx_api_get_image($sStorage, $aAttachment['id']); + } + if ($aAttachment['bx_if:sound']['condition'] == 1){ + $aItem['type'] = 'sound'; + $aItem['data'] = bx_api_get_image($sStorage, $aAttachment['id']); + } + + $aResult[] = $aItem; + } + } + } + return [bx_api_get_block('entity_attachments', $aResult)]; + } + + foreach($mixedStorage as $sStorage) { + $aAttachments = $this->getAttachments($sStorage, $aData, $aParams); + if(empty($aAttachments) || !is_array($aAttachments)) + continue; + + $aResult = array_merge($aResult, $aAttachments); + } + + + + if(empty($aResult) || !is_array($aResult)) + return ''; + + $this->addCss(BX_DIRECTORY_PATH_PLUGINS_PUBLIC . 'flickity/|flickity.css'); + $this->addJs(array( + 'flickity/flickity.pkgd.min.js', + 'pdfjs/build/pdf.min.js', + )); + + return $this->parseHtmlByName('attachments.html', array( + 'bx_repeat:attachments' => $aResult, + 'pdfjs_worker_url' => $this->getJsUrl('pdfjs/build/pdf.worker.min.js'), + )); + } + + function entryContext ($aData, $iProfileId = false, $sFuncContextDesc = 'getContextDesc', $sTemplateName = 'context.html', $sFuncContextAddon = 'getContextAddon') + { + $CNF = &$this->getModule()->_oConfig->CNF; + + $iContextId = $aData[$CNF['FIELD_ALLOW_VIEW_TO']]; + if ($iContextId >= 0) + return ''; + + $iProfileId = - $iContextId; + + $oProfile = BxDolProfile::getInstance($iProfileId); + if (!$oProfile) + $oProfile = BxDolProfileUndefined::getInstance(); + + if (!$oProfile) + return ''; + + $sName = $oProfile->getDisplayName(); + $sAddon = $sFuncContextAddon ? $this->$sFuncContextAddon($aData, $oProfile) : ''; + $aVars = array ( + 'author_url' => $oProfile->getUrl(), + 'author_thumb_url' => $oProfile->getThumb(), + 'author_unit' => $oProfile->getUnit(0, array('template' => 'unit_wo_info')), + 'author_title' => $sName, + 'author_title_attr' => bx_html_attribute($sName), + 'author_desc' => $sFuncContextDesc ? $this->$sFuncContextDesc($aData) : '', + 'bx_if:addon' => array ( + 'condition' => (bool)$sAddon, + 'content' => array ( + 'content' => $sAddon, + ), + ), + ); + return $this->parseHtmlByName($sTemplateName, $aVars); + } + + protected function getAttachmentsImagesTranscoders ($sStorage = '') + { + $CNF = &$this->getModule()->_oConfig->CNF; + + $oTranscoder = BxDolTranscoderImage::getObjectInstance($CNF['OBJECT_IMAGES_TRANSCODER_PREVIEW']); + $oTranscoderView = !empty($CNF['OBJECT_IMAGES_TRANSCODER_PICTURE']) ? BxDolTranscoderImage::getObjectInstance($CNF['OBJECT_IMAGES_TRANSCODER_PICTURE']) : null; + + return array($oTranscoder, $oTranscoderView); + } + + protected function getAttachmentsVideoTranscoders ($sStorage = '') + { + $CNF = &$this->getModule()->_oConfig->CNF; + + if (isset($CNF['OBJECT_VIDEOS_TRANSCODERS']) && $CNF['OBJECT_VIDEOS_TRANSCODERS']) + return array ( + 'poster' => BxDolTranscoderImage::getObjectInstance($CNF['OBJECT_VIDEOS_TRANSCODERS']['poster']), + 'mp4' => BxDolTranscoderImage::getObjectInstance($CNF['OBJECT_VIDEOS_TRANSCODERS']['mp4']), + 'mp4_hd' => BxDolTranscoderImage::getObjectInstance($CNF['OBJECT_VIDEOS_TRANSCODERS']['mp4_hd']), + ); + + return false; + } + + public function getAttachmentsData ($sStorage, $aData, $aParams = array()) + { + return $this->getAttachments($sStorage, $aData, $aParams ); + } + + protected function getAttachments ($sStorage, $aData, $aParams = array()) + { + $CNF = &$this->getModule()->_oConfig->CNF; + + $oStorage = BxDolStorage::getObjectInstance($sStorage); + + list($oTranscoder, $oTranscoderPreview) = $this->getAttachmentsImagesTranscoders($sStorage); + $oTranscoderSound = isset($CNF['OBJECT_SOUNDS_TRANSCODER']) && $CNF['OBJECT_SOUNDS_TRANSCODER'] ? BxDolTranscoderImage::getObjectInstance($CNF['OBJECT_SOUNDS_TRANSCODER']) : null; + $aTranscodersVideo = $this->getAttachmentsVideoTranscoders($sStorage); + + $aGhostFiles = $oStorage->getGhosts ($this->getModule()->serviceGetContentOwnerProfileId($aData[$CNF['FIELD_ID']]), $aData[$CNF['FIELD_ID']]); + if (!$aGhostFiles) + return false; + + $sFilterField = isset($aParams['filter_field']) ? $aParams['filter_field'] : $CNF['FIELD_THUMB']; + if(!empty($sFilterField) && isset($aData[$sFilterField])) + foreach ($aGhostFiles as $k => $a) { + // don't show thumbnail in attachments + if ($a['id'] == $aData[$sFilterField]) + unset($aGhostFiles[$k]); + } + + if(!$aGhostFiles) + return false; + + $aAttachmnts = array(); + foreach ($aGhostFiles as $k => $a) { + $isImage = !empty($CNF['OBJECT_STORAGE_PHOTOS']) && $sStorage == $CNF['OBJECT_STORAGE_PHOTOS'] && $oTranscoder && (0 === strncmp('image/', $a['mime_type'], 6)) && $oTranscoder->isMimeTypeSupported($a['mime_type']); // preview for images, transcoder object for preview must be defined + $isVideo = !empty($CNF['OBJECT_STORAGE_VIDEOS']) && $sStorage == $CNF['OBJECT_STORAGE_VIDEOS'] && $aTranscodersVideo && (0 === strncmp('video/', $a['mime_type'], 6)) && $aTranscodersVideo['poster']->isMimeTypeSupported($a['mime_type']); // preview for videos, transcoder object for video must be defined + $isSound = !empty($CNF['OBJECT_STORAGE_SOUNDS']) && $sStorage == $CNF['OBJECT_STORAGE_SOUNDS'] && $oTranscoderSound && (0 === strncmp('audio/', $a['mime_type'], 6)) && $oTranscoderSound->isMimeTypeSupported($a['mime_type']); // preview for sounds, transcoder object for sounds must be defined + $sUrlOriginal = $oStorage->getFileUrlById($a['id']); + $sImgPopupId = 'bx-messages-atachment-popup-' . $a['id']; + + // images are displayed with preview and popup upon clicking + $a['bx_if:image'] = array ( + 'condition' => $isImage, + 'content' => array ( + 'url_original' => $isImage && $oTranscoderPreview ? $oTranscoderPreview->getFileUrl($a['id']) : $sUrlOriginal, + 'attr_file_name' => bx_html_attribute($a['file_name']), + 'popup_id' => $sImgPopupId, + 'url_preview' => $isImage ? $oTranscoder->getFileUrl($a['id']) : '', + 'popup' => BxTemplFunctions::getInstance()->transBox($sImgPopupId, '<img src="' . $sUrlOriginal . '" />', true, true), + ), + ); + + $sVideoUrlHd = ''; + if($isVideo) { + $sVideoUrl = $oStorage->getFileUrlById($a['id']); + $aVideoFile = $oStorage->getFile($a['id']); + + if (!empty($aVideoFile['dimensions']) && $aTranscodersVideo['mp4_hd']->isProcessHD($aVideoFile['dimensions'])) + $sVideoUrlHd = $aTranscodersVideo['mp4_hd']->getFileUrl($a['id']); + } + + // videos are displayed inline + $a['bx_if:video'] = array ( + 'condition' => $isVideo, + 'content' => array ( + 'video' => $isVideo && $aTranscodersVideo ? BxTemplFunctions::getInstance()->videoPlayer( + $aTranscodersVideo['poster']->getFileUrl($a['id']), + $aTranscodersVideo['mp4']->getFileUrl($a['id']), + $sVideoUrlHd, + false, '' + ) : '', + ), + ); + + // sounds are displayed inline + $a['bx_if:sound'] = array ( + 'condition' => $isSound, + 'content' => array ( + 'sound' => $isSound && $oTranscoderSound && ($oPlayer = BxDolPlayer::getObjectInstance()) ? $this->parseHtmlByName('attachment_sound.html', array( + 'file_name' => $a['file_name'], + 'file_url' => $oTranscoderSound ? $oTranscoderSound->getFileUrl($a['id']) : '', + 'player' => $oTranscoderSound && $oTranscoderSound->isFileReady($a['id']) ? + $oPlayer->getCodeAudio (BX_PLAYER_STANDARD, array( + 'mp3' => $oTranscoderSound->getFileUrl($a['id']), + )) : _t('_sys_txt_err_sound_not_transcoded_yet'), + )) : '', + ), + ); + + // non-images are displayed as text links to original file + $a['bx_if:not_image'] = array ( + 'condition' => !$isImage && !$isVideo && !$isSound, + 'content' => array ( + 'url_original' => $sUrlOriginal, + 'attr_file_name' => bx_html_attribute($a['file_name']), + 'file_name' => bx_process_output($a['file_name']), + ), + ); + + $aAttachmnts[] = $a; + } + + return $aAttachmnts; + } + + public function embedVideo($iFileId) + { + $CNF = $this->getModule()->_oConfig->CNF; + list($oPlayer, $oStorage, $aContentInfo, $a) = $this->_embedChecks('OBJECT_STORAGE_VIDEOS', $iFileId); + + // check if file is really video + $aTranscodersVideo = $this->getAttachmentsVideoTranscoders(); + if (!$aTranscodersVideo || (0 !== strncmp('video/', $a['mime_type'], 6)) || !$aTranscodersVideo['poster']->isMimeTypeSupported($a['mime_type'])) { + $this->displayErrorOccured('', BX_PAGE_EMBED); + exit; + } + + // check HD video version + $sVideoUrlHd = ''; + $sVideoUrl = $oStorage->getFileUrlById($a['id']); + $aVideoFile = $oStorage->getFile($a['id']); + + if (!empty($aVideoFile['dimensions']) && $aTranscodersVideo['mp4_hd']->isProcessHD($aVideoFile['dimensions'])) + $sVideoUrlHd = $aTranscodersVideo['mp4_hd']->getFileUrl($a['id']); + + // generate player code + $sCode = $oPlayer->getCodeVideo (BX_PLAYER_EMBED, array( + 'poster' => $aTranscodersVideo['poster']->getFileUrl($a['id']), + 'mp4' => array( + 'sd' => $aTranscodersVideo['mp4']->getFileUrl($a['id']), + 'hd' => $sVideoUrlHd + ), + )); + + // display page + $oTemplate = BxDolTemplate::getInstance(); + $oTemplate->setPageNameIndex (BX_PAGE_EMBED); + $oTemplate->setPageHeader ($a['file_name']); + $oTemplate->setPageContent ('page_main_code', $sCode); + $oTemplate->getPageCode(); + exit; + } + + public function embedSound($iFileId) + { + $CNF = $this->getModule()->_oConfig->CNF; + list($oPlayer, $oStorage, $aContentInfo, $a) = $this->_embedChecks('OBJECT_STORAGE_SOUNDS', $iFileId); + + // check if file is really audio + $oTranscoderSound = isset($CNF['OBJECT_SOUNDS_TRANSCODER']) ? BxDolTranscoderImage::getObjectInstance($CNF['OBJECT_SOUNDS_TRANSCODER']) : null; + if (!$oTranscoderSound || (0 !== strncmp('audio/', $a['mime_type'], 6)) || !$oTranscoderSound->isMimeTypeSupported($a['mime_type'])) { + $this->displayErrorOccured('', BX_PAGE_EMBED); + exit; + } + + if (!$oTranscoderSound->isFileReady($a['id'])) { + $oTranscoderSound->getFileUrl($a['id']); // queue for encoding + $this->displayMsg('_sys_txt_err_sound_not_transcoded_yet', true, BX_PAGE_EMBED); + exit; + } + + // generate player code + $sCode = $oPlayer->getCodeAudio (BX_PLAYER_EMBED, array( + 'mp3' => $oTranscoderSound->getFileUrl($a['id']), + )); + + // display page + $oTemplate = BxDolTemplate::getInstance(); + $oTemplate->setPageNameIndex (BX_PAGE_EMBED); + $oTemplate->setPageHeader ($a['file_name']); + $oTemplate->setPageContent ('page_main_code', $sCode); + $oTemplate->getPageCode(); + exit; + } + + protected function _embedChecks($sStorageKey, $iFileId) + { + // general checks + $oPlayer = BxDolPlayer::getObjectInstance(); + $CNF = $this->getModule()->_oConfig->CNF; + $sStorage = isset($CNF[$sStorageKey]) ? $CNF[$sStorageKey] : false; + if (!$oPlayer || !$sStorage || !($oStorage = BxDolStorage::getObjectInstance($sStorage))) { + $this->displayErrorOccured('', BX_PAGE_EMBED); + exit; + } + + // privacy check + $aGhost = $oStorage->getGhost($iFileId); + $aContentInfo = $aGhost && $aGhost['content_id'] ? $this->getModule()->_oDb->getContentInfoById($aGhost['content_id']) : false; + if (!$aGhost || ($aGhost['content_id'] && !$aContentInfo)) { + $this->displayPageNotFound('', BX_PAGE_EMBED); + exit; + } + + if (!$aGhost['content_id']) { + // if file is not associated with content yet, then only admin and owner can view it + if (!isAdmin() && CHECK_ACTION_RESULT_ALLOWED !== $this->getModule()->checkAllowedEditAnyEntry() && $aGhost['profile_id'] != bx_get_logged_profile_id()) { + $this->displayAccessDenied('', BX_PAGE_EMBED); + exit; + } + } + else { + // if file is associated with content, then check entry privacy + if (CHECK_ACTION_RESULT_ALLOWED !== $this->getModule()->checkAllowedView($aContentInfo)) { + $this->displayAccessDenied('', BX_PAGE_EMBED); + exit; + } + } + + // get file info + if (!($a = $oStorage->getFile($iFileId))) { + $this->displayPageNotFound('', BX_PAGE_EMBED); + exit; + } + + return array($oPlayer, $oStorage, $aContentInfo, $a); + } + + function _getImageSettings($sSettings) + { + $sCoverSettings = ''; + $aCoverData = json_decode($sSettings, true); + if (!empty($aCoverData)){ + $sCoverSettings = 'background-position: ' . $aCoverData['x'] . '% ' . $aCoverData['y'] . '%'; + } + return $sCoverSettings; + } + + function _prepareImage($aData, $sUniqId, $aUploaders, $sStorage, $sField, $bAllowTweak, $bAllowMultiple = false) + { + $oUploader = null; + $sJsName = $sJsCode = ''; + foreach ($aUploaders as $sUploaderObject) { + $oUploader = BxDolUploader::getObjectInstance($sUploaderObject, $sStorage, $sUniqId, $this); + $sGhostTemplate = '{file_id}'; + + $sJsCode .= $oUploader->getUploaderJs($sGhostTemplate, $bAllowMultiple, array_merge($oUploader->getUploaderJsParams(), [ + 'latest' => 1, + 'content_id' => $aData['id'], + 'storage_private' => '0', + 'is_init_ghosts' => 0, + 'is_init_reordering' => 0 + ])); + $sJsName = $oUploader->getNameJsInstanceUploader(); + } + + $this->addJs(['BxDolUploader.js']); + $this->addJsTranslation(['_sys_uploader_image_reposition_info']); + return $this->parseHtmlByName('image_tweak.html', [ + 'id' => $aData['id'], + 'js_object' => $sJsName, + 'unique_id' => $sUniqId, + 'id' => $aData['id'], + 'allow_tweak' => $bAllowTweak, + 'image_exists' => $aData[$sField] == 0 ? 'bx-image-edit-buttons-no-image' : '', + 'field' => $sField, + 'action_url' => BX_DOL_URL_ROOT . $this->_oConfig->getBaseUri(), + 'uploader' => $oUploader->getUploaderButton([ + 'content_id' => $aData['id'], + 'storage_private' => '0', + 'btn_class' => '', + 'button_title' => '', + 'attrs' => "class='hidden'" + ]), + 'uploader_js' => $sJsCode, + ]); + } + + public function addCssJs() + { + $this->addCss('main.css'); + } +} + +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/groups/classes/BxBaseModGroupsFormEntry.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/groups/classes/BxBaseModGroupsFormEntry.php new file mode 100644 index 0000000000..55b09e0595 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/groups/classes/BxBaseModGroupsFormEntry.php @@ -0,0 +1,137 @@ +<?php defined('BX_DOL') or die('hack attempt'); +/** + * Copyright (c) UNA, Inc - https://una.io + * MIT License - https://opensource.org/licenses/MIT + * + * @defgroup BaseGroups Base classes for groups modules + * @ingroup UnaModules + * + * @{ + */ + +/** + * Create/Edit Group Form. + */ +class BxBaseModGroupsFormEntry extends BxBaseModProfileFormEntry +{ + protected $_bDisplayInvite; + + public function __construct($aInfo, $oTemplate = false) + { + if (!isset($this->_bAllowChangeUserForAdmins)) + $this->_bAllowChangeUserForAdmins = true; + + parent::__construct($aInfo, $oTemplate); + + $CNF = &$this->_oModule->_oConfig->CNF; + + $this->_bDisplayInvite = isset($CNF['OBJECT_FORM_ENTRY_DISPLAY_INVITE']) && $CNF['OBJECT_FORM_ENTRY_DISPLAY_INVITE'] == $this->aParams['display']; + + if (isset($this->aInputs['initial_members'])) { + if(!isset($this->aInputs['initial_members']['value'])) + $this->aInputs['initial_members']['value'] = $this->_bDisplayInvite ? [] : [bx_get_logged_profile_id()]; + + if($this->_bDisplayInvite) + $this->aInputs['initial_members'] = array_merge($this->aInputs['initial_members'], [ + 'required' => 1, + 'checker' => [ + 'func' => 'Avail', + 'params' => [], + 'error' => _t('_Enter_value_here'), + ] + ]); + } + } + + function initChecker ($aValues = array (), $aSpecificValues = array()) + { + $CNF = &$this->_oModule->_oConfig->CNF; + + $bValues = $aValues && !empty($aValues['id']); + $aContentInfo = $bValues ? $this->_oModule->_oDb->getContentInfoById($aValues['id']) : false; + + if(isset($CNF['FIELD_PUBLISHED']) && $this->aParams['display'] == $CNF['OBJECT_FORM_ENTRY_DISPLAY_EDIT'] && isset($this->aInputs[$CNF['FIELD_PUBLISHED']])) + if($bValues && in_array($aValues[$CNF['FIELD_STATUS']], array('active', 'hidden'))) + unset($this->aInputs[$CNF['FIELD_PUBLISHED']]); + + parent::initChecker ($aValues, $aSpecificValues); + } + + public function insert ($aValsToAdd = array(), $isIgnore = false) + { + $CNF = &$this->_oModule->_oConfig->CNF; + + if(isset($CNF['FIELD_ADDED']) && empty($aValsToAdd[$CNF['FIELD_ADDED']])) { + $iAdded = 0; + if(isset($this->aInputs[$CNF['FIELD_ADDED']])) + $iAdded = $this->getCleanValue($CNF['FIELD_ADDED']); + + if(empty($iAdded)) + $iAdded = time(); + + $aValsToAdd[$CNF['FIELD_ADDED']] = $iAdded; + } + + if(isset($CNF['FIELD_PUBLISHED']) && empty($aValsToAdd[$CNF['FIELD_PUBLISHED']])) { + $iPublished = 0; + if(isset($this->aInputs[$CNF['FIELD_PUBLISHED']])) + $iPublished = $this->getCleanValue($CNF['FIELD_PUBLISHED']); + + if(empty($iPublished)) + $iPublished = time(); + + $aValsToAdd[$CNF['FIELD_PUBLISHED']] = $iPublished; + } + + $aValsToAdd[$CNF['FIELD_STATUS']] = (isset($CNF['FIELD_PUBLISHED']) && ($aValsToAdd[$CNF['FIELD_PUBLISHED']] > $aValsToAdd[$CNF['FIELD_ADDED']])) ? 'awaiting' : 'active'; + + return parent::insert ($aValsToAdd, $isIgnore); + } + + function update ($iContentId, $aValsToAdd = array(), &$aTrackTextFieldsChanges = null) + { + $CNF = &$this->_oModule->_oConfig->CNF; + + if(isset($CNF['FIELD_PUBLISHED'])) { + if(empty($aValsToAdd[$CNF['FIELD_PUBLISHED']]) && isset($this->aInputs[$CNF['FIELD_PUBLISHED']])) { + $iPublished = $this->getCleanValue($CNF['FIELD_PUBLISHED']); + if(empty($iPublished)) + $iPublished = time(); + + $aValsToAdd[$CNF['FIELD_PUBLISHED']] = $iPublished; + } + } + + $aContentInfo = $this->_oModule->_oDb->getContentInfoById($iContentId); + + $mixedResult = parent::update($iContentId, $aValsToAdd, $aTrackTextFieldsChanges); + if($mixedResult && ($iAuthorId = (int)$this->getCleanValue($CNF['FIELD_AUTHOR'])) && (int)$aContentInfo[$CNF['FIELD_AUTHOR']] != $iAuthorId) { + $oProfileAuthor = BxDolProfile::getInstance($iAuthorId); + $oProfileContent = BxDolProfile::getInstanceByContentAndType($iContentId, $this->MODULE); + if($oProfileAuthor !== false && $oProfileContent !== false) + $oProfileContent->move($oProfileAuthor->getAccountId()); + } + + return $mixedResult; + } + + protected function genCustomInputInitialMembers ($aInput) + { + $aInput['ajax_get_suggestions'] = BX_DOL_URL_ROOT . "modules/?r=" . $this->_oModule->_oConfig->getUri() . "/ajax_get_initial_members"; + if(bx_is_api()) { + $aInput['ajax_get_suggestions'] = $this->_oModule->_oConfig->getName() . "/get_initial_members¶ms[]="; + + $aInput['value_data'] = []; + if(!empty($aInput['value']) && is_array($aInput['value'])) + foreach($aInput['value'] as $iProfileId) + if(($oProfile = BxDolProfile::getInstance($iProfileId)) !== false) { + $aProfile = $oProfile->getUnitAPI(); + $aInput['value_data'][] = $aProfile['author_data']; + } + } + + return $this->genCustomInputUsernamesSuggestions($aInput); + } +} + +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/groups/classes/BxBaseModGroupsFormsEntryHelper.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/groups/classes/BxBaseModGroupsFormsEntryHelper.php new file mode 100644 index 0000000000..38e7bf8917 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/groups/classes/BxBaseModGroupsFormsEntryHelper.php @@ -0,0 +1,288 @@ +<?php defined('BX_DOL') or die('hack attempt'); +/** + * Copyright (c) UNA, Inc - https://una.io + * MIT License - https://opensource.org/licenses/MIT + * + * @defgroup BaseGroups Base classes for groups modules + * @ingroup UnaModules + * + * @{ + */ + +/** + * Group profile forms functions + */ +class BxBaseModGroupsFormsEntryHelper extends BxBaseModProfileFormsEntryHelper +{ + public function __construct($oModule) + { + parent::__construct($oModule); + } + + public function getObjectFormInvite ($sDisplay = false) + { + $CNF = &$this->_oModule->_oConfig->CNF; + + if($sDisplay === false) + $sDisplay = $CNF['OBJECT_FORM_ENTRY_DISPLAY_INVITE']; + + $oForm = BxDolForm::getObjectInstance($CNF['OBJECT_FORM_ENTRY'], $sDisplay, $this->_oModule->_oTemplate); + if($this->_bAjaxMode) + $oForm->setAjaxMode($this->_bAjaxMode); + + if($this->_bAbsoluteActionUrl) + $this->_setAbsoluteActionUrl('edit', $oForm); + + return $oForm; + } + + public function inviteForm ($iContentId, $sDisplay = false, $sCheckFunction = false, $bErrorMsg = true) + { + if (!$sCheckFunction) + $sCheckFunction = 'checkAllowedInvite'; + + $CNF = &$this->_oModule->_oConfig->CNF; + + // get content data and profile info + list($oProfile, $aContentInfo) = $this->_getProfileAndContentData($iContentId); + + if(!$aContentInfo) + return $bErrorMsg ? ($this->_bIsApi ? [bx_api_get_msg('_sys_txt_error_entry_is_not_defined')] : MsgBox('_sys_txt_error_entry_is_not_defined')) : ''; + + // check access + if(($sMsg = $this->_oModule->$sCheckFunction($aContentInfo)) !== CHECK_ACTION_RESULT_ALLOWED) + return $bErrorMsg ? ($this->_bIsApi ? [bx_api_get_msg($sMsg)] : MsgBox($sMsg)) : ''; + + // check and display form + $oForm = $this->getObjectFormInvite($sDisplay); + + if(!$oForm) + return $bErrorMsg ? ($this->_bIsApi ? [bx_api_get_msg('_sys_txt_error_occured')] : MsgBox(_t('_sys_txt_error_occured'))) : ''; + + $oForm->initChecker($aContentInfo); + if (!$oForm->isSubmittedAndValid()) + return $this->_bIsApi ? [bx_api_get_block('form', $oForm->getCodeAPI(), ['ext' => ['name' => $this->_oModule->getName(), 'request' => ['url' => '/api.php?r=' . $this->_oModule->getName() . '/entity_invite¶ms[]=' . $iContentId . '¶ms[]=' . $sDisplay, 'immutable' => true]]])] : $oForm->getCode(); + + $this->onDataInviteBefore($aContentInfo[$CNF['FIELD_ID']], $aContentInfo); + + if (!$oForm->update($aContentInfo[$CNF['FIELD_ID']])) { + if (!$oForm->isValid()) + return $this->_bIsApi ? [bx_api_get_block('form', $oForm->getCodeAPI(), ['ext' => ['name' => $this->_oModule->getName(), 'request' => ['url' => '/api.php?r=' . $this->_oModule->getName() . '/entity_invit¶ms[]=' . $iContentId . '¶ms[]=' . $sDisplay, 'immutable' => true]]])] : $oForm->getCode(); + else + return $this->_bIsApi ? [bx_api_get_msg('_sys_txt_error_entry_update')] : MsgBox(_t('_sys_txt_error_entry_update')); + } + + list($oProfile, $aContentInfo) = $this->_getProfileAndContentData($iContentId); + + $sResult = $this->onDataInviteAfter($aContentInfo[$CNF['FIELD_ID']], $aContentInfo); + if($sResult) + return $sResult; + + // Perform ACL action + $this->_oModule->$sCheckFunction($aContentInfo, true); + + // Redirect + if (bx_is_api()) + return [$this->redirectAfterEdit($aContentInfo)]; + else + $this->redirectAfterEdit($aContentInfo); + } + + protected function _getProfileAndContentData ($iContentId) + { + $CNF = &$this->_oModule->_oConfig->CNF; + + $aContentInfo = $this->_oModule->_oDb->getContentInfoById($iContentId); + if(!$aContentInfo) + return array(false, false); + + $oProfile = BxDolProfile::getInstanceMagic($aContentInfo[$CNF['FIELD_AUTHOR']]); + return array($oProfile, $aContentInfo); + } + + protected function _processPermissionsCheckForViewDataForm ($aContentInfo, $oProfile) + { + $sMsg = parent::_processPermissionsCheckForViewDataForm ($aContentInfo, $oProfile); + + $oPrivacy = BxDolPrivacy::getObjectInstance($this->_oModule->_oConfig->CNF['OBJECT_PRIVACY_VIEW']); + if ($sMsg && $oPrivacy->isPartiallyVisible($aContentInfo[$this->_oModule->_oConfig->CNF['FIELD_ALLOW_VIEW_TO']])) + return ''; + + return $sMsg; + } + + public function onDataAddAfter ($iAccountId, $iContentId) + { + if($s = parent::onDataAddAfter($iAccountId, $iContentId)) + return $s; + + $oGroupProfile = BxDolProfile::getInstanceByContentAndType($iContentId, $this->_oModule->_oConfig->getName()); + if(!$oGroupProfile) + return ''; + + $mInitialMembers = bx_get('initial_members'); + if($this->_bIsApi && $mInitialMembers && is_string($mInitialMembers)) + $mInitialMembers = explode(',', $mInitialMembers); + + $this->makeAuthorAdmin($oGroupProfile, $mInitialMembers); + + $this->inviteMembers($oGroupProfile, $mInitialMembers); + + return ''; + } + + public function onDataEditAfter ($iContentId, $aContentInfo, $aTrackTextFieldsChanges, $oProfile, $oForm) + { + if($s = parent::onDataEditAfter($iContentId, $aContentInfo, $aTrackTextFieldsChanges, $oProfile, $oForm)) + return $s; + + $oGroupProfile = BxDolProfile::getInstanceByContentAndType($iContentId, $this->_oModule->_oConfig->getName()); + if(!$oGroupProfile) + return ''; + + $this->inviteMembers ($oGroupProfile, bx_get('initial_members')); + + return ''; + } + + public function onDataInviteBefore ($iContentId, $aContentInfo) + { + return ''; + } + + public function onDataInviteAfter ($iContentId, $aContentInfo) + { + $oGroupProfile = BxDolProfile::getInstanceByContentAndType($iContentId, $this->_oModule->_oConfig->getName()); + if(!$oGroupProfile) + return ''; + + $this->inviteMembers($oGroupProfile, bx_get('initial_members')); + + return ''; + } + + protected function redirectAfterEdit($aContentInfo, $sUrl = '') + { + $CNF = &$this->_oModule->_oConfig->CNF; + + $sUrl = ''; + if(bx_get('initial_members')) { + if(isset($CNF['URL_ENTRY_MANAGE'])) + $sUrl = $CNF['URL_ENTRY_MANAGE']; + else if(isset($CNF['URL_ENTRY_FANS'])) + $sUrl = $CNF['URL_ENTRY_FANS']; + + $sUrl = bx_append_url_params($sUrl, ['profile_id' => $aContentInfo['profile_id']]); + } + else + $sUrl = 'page.php?i=' . $CNF['URI_VIEW_ENTRY'] . '&id=' . $aContentInfo[$CNF['FIELD_ID']]; + + if(bx_is_api()) + return bx_api_get_block('redirect', ['uri' => '/' . BxDolPermalinks::getInstance()->permalink($sUrl), 'timeout' => 1000]); + + /** + * @hooks + * @hookdef hook-bx_base_groups-redirect_after_edit '{module_name}', 'redirect_after_edit' - hook to override redirect URL which is used after content changing + * It's equivalent to @ref hook-bx_base_general-redirect_after_edit + * @hook @ref hook-bx_base_groups-redirect_after_edit + */ + bx_alert($this->_oModule->getName(), 'redirect_after_edit', 0, false, [ + 'content' => $aContentInfo, + 'override_result' => &$sUrl, + ]); + + $this->_redirectAndExit($sUrl); + } + + public function onDataDeleteAfter ($iContentId, $aContentInfo, $oProfile) + { + $CNF = &$this->_oModule->_oConfig->CNF; + + $oGroupProfile = BxDolProfile::getInstanceByContentAndType($iContentId, $this->_oModule->_oConfig->getName()); + + if(isset($CNF['TABLE_QUESTIONS'], $CNF['TABLE_ANSWERS'])) + $this->_oModule->_oDb->deleteQuestionnaires($iContentId); + + if ($oGroupProfile && isset($CNF['TABLE_ADMINS'])) + $this->_oModule->_oDb->deleteAdminsByGroupId($oGroupProfile->id()); + + if (isset($CNF['OBJECT_CONNECTIONS']) && $oGroupProfile && ($oConnection = BxDolConnection::getObjectInstance($CNF['OBJECT_CONNECTIONS']))) + $oConnection->onDeleteInitiatorAndContent($oGroupProfile->id()); + + if((isset($CNF['OBJECT_PRIVACY_VIEW']) && $oPrivacyView = BxDolPrivacy::getObjectInstance($CNF['OBJECT_PRIVACY_VIEW'])) !== false) + $oPrivacyView->deleteGroupCustomByContentId($iContentId); + + if((isset($CNF['OBJECT_PRIVACY_POST']) && $oPrivacyPost = BxDolPrivacy::getObjectInstance($CNF['OBJECT_PRIVACY_POST'])) !== false) + $oPrivacyPost->deleteGroupCustomByContentId($iContentId); + + return ''; + } + + protected function inviteMembers ($oGroupProfile, $aInitialProfiles) + { + $CNF = &$this->_oModule->_oConfig->CNF; + + if(empty($CNF['OBJECT_CONNECTIONS']) || !$aInitialProfiles) + return; + + $oConnection = BxDolConnection::getObjectInstance($CNF['OBJECT_CONNECTIONS']); + if(!$oConnection) + return; + + $iGroupId = $oGroupProfile->id(); + + if (!is_array($aInitialProfiles)) + $aInitialProfiles = [$aInitialProfiles]; + + // insert invited members, so they will join without confirmation + foreach($aInitialProfiles as $iProfileId) { + $oProfile = BxDolProfile::getInstance($iProfileId); + if(!$oProfile) + continue; + + if($oConnection->isConnected($iGroupId, $iProfileId, true) || $oConnection->isConnected($iGroupId, $iProfileId)) + continue; + + $this->_oModule->serviceAddMutualConnection ($iGroupId, $iProfileId, true); + } + } + + /** + * Make author admin if their is in initial invitations list + * @param $oGroupProfile group id + * @param $aInitialProfiles array of initial profile ids + * @return nothing + */ + protected function makeAuthorAdmin ($oGroupProfile, $aInitialProfiles) + { + $this->makeAdmin (bx_get_logged_profile_id(), $oGroupProfile, $aInitialProfiles); + } + + /** + * Make profile admin if he is in initial invitations list + * @param $iProfileId profile id + * @param $oGroupProfile group id + * @param $aInitialProfiles array of initial profile ids + * @return nothing + */ + protected function makeAdmin ($iProfileId, $oGroupProfile, $aInitialProfiles) + { + $CNF = &$this->_oModule->_oConfig->CNF; + + if (!isset($CNF['OBJECT_CONNECTIONS']) || !$CNF['OBJECT_CONNECTIONS'] || !is_array($aInitialProfiles) || !in_array($iProfileId, $aInitialProfiles)) + return; + + if (!($oConnection = BxDolConnection::getObjectInstance($CNF['OBJECT_CONNECTIONS']))) + return; + + if (!$oConnection->isConnected($oGroupProfile->id(), (int)$iProfileId)) + $oConnection->addConnection($oGroupProfile->id(), (int)$iProfileId); + if (!$oConnection->isConnected((int)$iProfileId, $oGroupProfile->id())) + $oConnection->addConnection((int)$iProfileId, $oGroupProfile->id()); + + if (!$this->_oModule->_oDb->isAdmin ($oGroupProfile->id(), $iProfileId)) + $this->_oModule->_oDb->toAdmins ($oGroupProfile->id(), $iProfileId); + } +} + +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/groups/classes/BxBaseModGroupsGridConnections.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/groups/classes/BxBaseModGroupsGridConnections.php new file mode 100644 index 0000000000..219c2823cd --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/groups/classes/BxBaseModGroupsGridConnections.php @@ -0,0 +1,482 @@ +<?php defined('BX_DOL') or die('hack attempt'); +/** + * Copyright (c) UNA, Inc - https://una.io + * MIT License - https://opensource.org/licenses/MIT + * + * @defgroup BaseGroups Base classes for groups modules + * @ingroup UnaModules + * + * @{ + */ + +class BxBaseModGroupsGridConnections extends BxDolGridConnections +{ + protected $_oModule; + protected $_sContentModule; + + protected $_bRoles; + protected $_aRoles; + + protected $_iGroupProfileId; + protected $_aContentInfo = array(); + + protected $_bPaidJoin; + protected $_bMember; + protected $_bManageMembers; + + public function __construct ($aOptions, $oTemplate = false) + { + $this->_oModule = BxDolModule::getInstance($this->_sContentModule); + + $CNF = &$this->_oModule->_oConfig->CNF; + + $this->_sObjectConnections = $CNF['OBJECT_CONNECTIONS']; + + parent::__construct ($aOptions, $oTemplate); + if(!$this->_bInit) + return; + + $this->_bRoles = $this->_oModule->_oConfig->isRoles(); + $this->_aRoles = $this->_oModule->_oConfig->getRoles(); + + $this->_iGroupProfileId = $this->_oProfile->id(); + + $this->_aContentInfo = $this->_oModule->_oDb->getContentInfoById($this->_oProfile->getContentId()); + if($this->_oModule->checkAllowedEdit($this->_aContentInfo) === CHECK_ACTION_RESULT_ALLOWED || $this->_iGroupProfileId == bx_get_logged_profile_id()) + $this->_bOwner = true; + + $this->_bPaidJoin = $this->_oModule->isPaidJoinByProfile($this->_iGroupProfileId); + + $this->_bMember = $this->_oModule->isFan($this->_aContentInfo[$CNF['FIELD_ID']]); + $this->_bManageMembers = $this->_oModule->checkAllowedManageFans($this->_iGroupProfileId) === CHECK_ACTION_RESULT_ALLOWED || $this->_oModule->checkAllowedManageAdmins($this->_iGroupProfileId) === CHECK_ACTION_RESULT_ALLOWED; + + $aSQLParts = $this->_oConnection->getConnectedInitiatorsAsSQLParts('p', 'id', $this->_iGroupProfileId, $this->_bOwner ? false : true); + $this->addMarkers(array( + 'profile_id' => $this->_iGroupProfileId, + 'join_connections' => $aSQLParts['join'], + 'content_module' => $this->_sContentModule, + )); + } + + public function getCode ($isDisplayHeader = true) + { + $sResult = parent::getCode($isDisplayHeader); + if(!$sResult) + return $sResult; + + if($this->_bRoles) + $sResult .= $this->_oModule->_oTemplate->getJsCode('main', array( + 'sObjNameGrid' => $this->_sObject, + )); + + return $sResult; + } + + public function performActionQuestionnaire() + { + $CNF = &$this->_oModule->_oConfig->CNF; + + if(($mixedResult = $this->_oModule->checkAllowedManageAdmins($this->_iGroupProfileId)) !== CHECK_ACTION_RESULT_ALLOWED) + return $this->_getActionResult(['msg' => $mixedResult]); + + if($this->_bIsApi) + $iId = bx_get($CNF['FIELD_ID']); + else + list($iId, $iViewedId) = $this->_prepareIds(); + + if(!$iId) + return $this->_getActionResult(['msg' => _t('_sys_txt_error_occured')]); + + $sPopupContent = $this->_oModule->_oTemplate->getPopupQuestionnaire($this->_aContentInfo[$CNF['FIELD_ID']], $iId); + if(!$sPopupContent) + return $this->_getActionResult([]); + + if($this->_bIsApi) + return [bx_api_get_block('simple_list', $sPopupContent)]; + + $oFunctions = BxTemplFunctions::getInstance(); + return $this->_getActionResult(['popup' => $oFunctions->transBox(str_replace('_', '-', $this->_sContentModule) . '-questionnaire-popup', $oFunctions->simpleBoxContent($sPopupContent))]); + } + + public function performActionSetRole() + { + if(!$this->_bRoles) + return $this->_getActionResult([]); + + if(($mixedResult = $this->_oModule->checkAllowedManageAdmins($this->_iGroupProfileId)) !== CHECK_ACTION_RESULT_ALLOWED) + return $this->_getActionResult(['msg' => $mixedResult]); + + list($iId, $iViewedId) = $this->_prepareIds(); + if(!$iId) + return $this->_getActionResult(['msg' => _t('_sys_txt_error_occured')]); + + if(empty($this->_aRoles) || !is_array($this->_aRoles)) + return $this->_getActionResult(['msg' => _t('_sys_txt_error_occured')]); + + $iRole = $this->_oModule->_oDb->getRole($this->_iGroupProfileId, $iId); + + if(!$this->_oModule->_oConfig->isMultiRoles()) { + $sJsObject = $this->_oModule->_oConfig->getJsObject('main'); + $sHtmlIdPrefix = str_replace('_', '-', $this->_sContentModule) . '-set-role-'; + + $aMenuItems = []; + foreach($this->_aRoles as $iRoleId => $sRoleTitle) + $aMenuItems[] = array( + 'id' => $sHtmlIdPrefix . $iRoleId, + 'name' => $sHtmlIdPrefix . $iRoleId, + 'class' => '', + 'link' => 'javascript:void(0)', + 'onclick' => $sJsObject . '.onClickSetRole(' . $iId . ', ' . $iRoleId . ')', + 'target' => '_self', + 'title' => $sRoleTitle, + 'active' => 1 + ); + + $oMenu = new BxTemplMenu(array('template' => 'menu_vertical.html', 'menu_id'=> $sHtmlIdPrefix . 'menu', 'menu_items' => $aMenuItems)); + if(!empty($iRole)) + $oMenu->setSelected('', $sHtmlIdPrefix . $iRole); + + $sPopupContent = $oMenu->getCode(); + } + else + $sPopupContent = $this->_oModule->_oTemplate->getPopupSetRole($this->_aRoles, $iId, $iRole); + + $oFunctions = BxTemplFunctions::getInstance(); + return $this->_getActionResult(['popup' => $oFunctions->transBox(str_replace('_', '-', $this->_sContentModule) . '-set-role-popup', $oFunctions->simpleBoxContent($sPopupContent))]); + } + + public function performActionSetRoleSubmit() + { + if(!$this->_bRoles) + return $this->_getActionResult([]); + + if(($mixedResult = $this->_oModule->checkAllowedManageAdmins($this->_iGroupProfileId)) !== CHECK_ACTION_RESULT_ALLOWED) + return $this->_getActionResult(['msg' => $mixedResult]); + + list($iId, $iViewedId) = $this->_prepareIds(); + + if(!$iId) + return $this->_getActionResult(['msg' => _t('_sys_txt_error_occured')]); + + if(!$this->_oModule->setRole($this->_iGroupProfileId, $iId, bx_process_input(bx_get('role'), BX_DATA_INT))) + return $this->_getActionResult(['msg' => _t('_error occured')]); + + return $this->_getActionResult(!$this->_bIsApi ? ['grid' => $this->getCode(false), 'blink' => $iId] : []); + } + + public function performActionDeleteAndBan() + { + $this->_replaceMarkers (); + + $aResult = []; + $iAffected = 0; + + $aIds = bx_get('ids'); + if(!$aIds || !is_array($aIds)) + return $this->_getActionResult($aResult); + + $oConnection = BxDolConnection::getObjectInstance('sys_profiles_bans'); + + foreach($aIds as $mixedId) { + if(!$this->_delete($mixedId)) + continue; + + if($oConnection !== false) { + list($iProfileId, $iContextId) = $this->__prepareIds($mixedId); + + $oConnection->addConnection($iContextId, $iProfileId, [ + 'module' => $this->_sContentModule + ]); + } + + $iAffected += 1; + } + + if($iAffected) + $aResult = !$this->_bIsApi ? ['grid' => $this->getCode(false)] : []; + else + $aResult = ['msg' => _t("_sys_grid_delete_failed")]; + + return $this->_getActionResult($aResult); + } + + protected function _getCellRole($mixedValue, $sKey, $aField, $aRow) + { + $iProfileRole = $this->_oModule->_oDb->getRole($this->_iGroupProfileId, $aRow[$this->_aOptions['field_id']]); + + if(!empty($iProfileRole) && $this->_oModule->_oConfig->isMultiRoles()) { + $aRoles = array(); + foreach($this->_aRoles as $iRole => $sRole) { + if(!$iRole) + continue; + + if($iProfileRole & (1 << ($iRole - 1))) + $aRoles[] = $sRole; + } + + $mixedValue = implode(', ', $aRoles); + } + else + $mixedValue = !empty($this->_aRoles[$iProfileRole]) ? $this->_aRoles[$iProfileRole] : _t('_uknown'); + + return parent::_getCellDefault($mixedValue, $sKey, $aField, $aRow); + } + + protected function _getCellHeaderRoleAdded($sKey, $aField) + { + if(!$this->_bPaidJoin || !($this->_bMember || $this->_bManageMembers)) + return $this->_bIsApi ? [] : ''; + + return parent::_getCellHeaderDefault ($sKey, $aField); + } + + protected function _getCellRoleAdded($mixedValue, $sKey, $aField, $aRow) + { + $mixedValue = ''; + if(!$this->_bPaidJoin || !($this->_bMember || $this->_bManageMembers)) + return $this->_bIsApi ? [] : $mixedValue; + + $iProfileId = (int)$aRow[$this->_aOptions['field_id']]; + if($this->_bManageMembers || $iProfileId == bx_get_logged_profile_id()) { + $aRole = $this->_oModule->_oDb->getRoles(array('type' => 'by_gf_id', 'group_profile_id' => $this->_iGroupProfileId, 'fan_id' => $iProfileId)); + if(!empty($aRole) && is_array($aRole)) { + if(!empty($aRole['added'])) { + if($this->_bIsApi) + return ['type' => 'time', 'data' => $aRole['added']]; + + $mixedValue = bx_time_js($aRole['added'], BX_FORMAT_DATE, true); + } + else { + if($this->_bIsApi) + return ['type' => 'text', 'data' => '']; + + $mixedValue = ''; + } + } + } + + return parent::_getCellDefault($mixedValue, $sKey, $aField, $aRow); + } + + protected function _getCellHeaderRoleExpired($sKey, $aField) + { + if(!$this->_bPaidJoin || !($this->_bMember || $this->_bManageMembers)) + return $this->_bIsApi ? [] : ''; + + return parent::_getCellHeaderDefault ($sKey, $aField); + } + + protected function _getCellRoleExpired($mixedValue, $sKey, $aField, $aRow) + { + $mixedValue = ''; + if(!$this->_bPaidJoin || !($this->_bMember || $this->_bManageMembers)) + return $this->_bIsApi ? [] : ''; + + $iProfileId = (int)$aRow[$this->_aOptions['field_id']]; + if($this->_bManageMembers || $iProfileId == bx_get_logged_profile_id()) { + $aRole = $this->_oModule->_oDb->getRoles(array('type' => 'by_gf_id', 'group_profile_id' => $this->_iGroupProfileId, 'fan_id' => $iProfileId)); + if(!empty($aRole) && is_array($aRole)) { + if(!empty($aRole['expired'])) { + if($this->_bIsApi) + return ['type' => 'time', 'data' => $aRole['expired']]; + + $mixedValue = bx_time_js($aRole['expired'], BX_FORMAT_DATE, true); + } + else { + if($this->_bIsApi) + return ['type' => 'text', 'data' => '']; + + $mixedValue = ''; + } + } + } + + return parent::_getCellDefault($mixedValue, $sKey, $aField, $aRow); + } + + protected function _getActionQuestionnaire ($sType, $sKey, $a, $isSmall = false, $isDisabled = false, $aRow = []) + { + $CNF = &$this->_oModule->_oConfig->CNF; + + if(!$this->_oModule->_oDb->areQuestionsAnswered($this->_aContentInfo[$CNF['FIELD_ID']], $aRow[$this->_aOptions['field_id']])) + return $this->_bIsApi ? [] : ''; + + return parent::_getActionDefault ($sType, $sKey, $a, $isSmall, $isDisabled, $aRow); + } + + protected function _getActionSetRole ($sType, $sKey, $a, $isSmall = false, $isDisabled = false, $aRow = []) + { + /** + * Note. The feature isn't available in API for now. + */ + if($this->_bIsApi) + return []; + + if ($this->_oModule->checkAllowedManageAdmins($this->_iGroupProfileId) !== CHECK_ACTION_RESULT_ALLOWED) + return $this->_bIsApi ? [] : ''; + + return parent::_getActionDefault ($sType, $sKey, $a, $isSmall, $isDisabled, $aRow); + } + + protected function _getActionSetRoleSubmit ($sType, $sKey, $a, $isSmall = false, $isDisabled = false, $aRow = []) + { + return $this->_bIsApi ? [] : ''; + } + + protected function _getActionAccept ($sType, $sKey, $a, $isSmall = false, $isDisabled = false, $aRow = []) + { + if ($aRow['mutual']) + return $this->_bIsApi ? [] : ''; + + if ($this->_oModule->checkAllowedManageFans($this->_iGroupProfileId) !== CHECK_ACTION_RESULT_ALLOWED) + return $this->_bIsApi ? [] : ''; + + if (isset($aRow[$this->_aOptions['field_id']])) + $a['attr']['bx_grid_action_data'] = $aRow[$this->_aOptions['field_id']] . ':' . $this->_iGroupProfileId; + + return parent::_getActionAccept($sType, $sKey, $a, $isSmall, $isDisabled, $aRow); + } + + protected function _getActionDelete ($sType, $sKey, $a, $isSmall = false, $isDisabled = false, $aRow = []) + { + if ($this->_oModule->checkAllowedManageFans($this->_iGroupProfileId) !== CHECK_ACTION_RESULT_ALLOWED) + return $this->_bIsApi ? [] : ''; + + if (isset($aRow[$this->_aOptions['field_id']])) + $a['attr']['bx_grid_action_data'] = $aRow[$this->_aOptions['field_id']] . ':' . $this->_iGroupProfileId; + + return parent::_getActionDelete($sType, $sKey, $a, $isSmall, $isDisabled, $aRow); + } + + protected function _getActionDeleteAndBan ($sType, $sKey, $a, $isSmall = false, $isDisabled = false, $aRow = []) + { + return $this->_getActionDelete($sType, $sKey, $a, $isSmall, $isDisabled, $aRow); + } + + /** + * Note. Methods related to 'To Admin'/'From Admin' functionality can be removed after UNA 12 will be released. + */ + protected function _getActionToAdmins ($sType, $sKey, $a, $isSmall = false, $isDisabled = false, $aRow = []) + { + if ($this->_oModule->_oDb->isAdmin($this->_iGroupProfileId, $aRow[$this->_aOptions['field_id']])) + return ''; + + return $this->_getActionManageAdmins ($sType, $sKey, $a, $isSmall, $isDisabled, $aRow); + } + + protected function _getActionFromAdmins ($sType, $sKey, $a, $isSmall = false, $isDisabled = false, $aRow = []) + { + if (!$this->_oModule->_oDb->isAdmin($this->_iGroupProfileId, $aRow[$this->_aOptions['field_id']])) + return ''; + + return $this->_getActionManageAdmins ($sType, $sKey, $a, $isSmall, $isDisabled, $aRow); + } + + protected function _getActionManageAdmins ($sType, $sKey, $a, $isSmall = false, $isDisabled = false, $aRow = []) + { + if (!$this->_oConnection->isConnected($aRow[$this->_aOptions['field_id']], $this->_iGroupProfileId, true)) + return ''; + + if ($this->_oModule->checkAllowedManageAdmins($this->_iGroupProfileId) !== CHECK_ACTION_RESULT_ALLOWED) + return ''; + + if (isset($aRow[$this->_aOptions['field_id']])) + $a['attr']['bx_grid_action_data'] = $aRow[$this->_aOptions['field_id']] . ':' . $this->_iGroupProfileId; + + return parent::_getActionDefault ($sType, $sKey, $a, $isSmall, $isDisabled, $aRow); + } + + /** + * 'To Admins' action handler + */ + public function performActionToAdmins() + { + $this->_performActionAdmins('toAdmins'); + } + + /** + * 'From Admins' action handler + */ + public function performActionFromAdmins() + { + $this->_performActionAdmins('fromAdmins'); + } + + public function _performActionAdmins($sFunc) + { + list ($iId, $iGroupProfileId) = $this->_prepareIds(); + + if (!$iId) { + echoJson(array('msg' => _t('_sys_txt_error_occured'))); + exit; + } + + if (CHECK_ACTION_RESULT_ALLOWED !== $this->_oModule->checkAllowedManageAdmins($iGroupProfileId)) { + echoJson(array('msg' => _t('_sys_txt_access_denied'))); + exit; + } + + if (!$this->_oModule->_oDb->$sFunc($iGroupProfileId, $iId)) { + echoJson(array('msg' => _t('_sys_txt_error_occured'))); + } + else { + + $sEmailTemplate = 'toAdmins' == $sFunc ? $this->_oModule->_oConfig->CNF['EMAIL_FAN_BECOME_ADMIN'] : $this->_oModule->_oConfig->CNF['EMAIL_ADMIN_BECOME_FAN']; + list($iGroupProfileId, $iProfileId) = $this->_prepareGroupProfileAndMemberProfile($iGroupProfileId, $iId); + if (bx_get_logged_profile_id() != $iProfileId) { + // notify about admin status + sendMailTemplate($sEmailTemplate, 0, $iProfileId, array( + 'EntryUrl' => BxDolProfile::getInstance($iGroupProfileId)->getUrl(), + 'EntryTitle' => BxDolProfile::getInstance($iGroupProfileId)->getDisplayName(), + ), BX_EMAIL_NOTIFY); + } + + // subscribe admins automatically + if ('toAdmins' == $sFunc && ($oConn = BxDolConnection::getObjectInstance('sys_profiles_subscriptions'))) + $oConn->addConnection($iProfileId, $iGroupProfileId); + + echoJson(array('grid' => $this->getCode(false), 'blink' => $iId)); + } + } + + protected function _delete ($mixedId) + { + list ($iId, $iViewedId) = $this->_prepareIds(); + + // send email notification + $sEmailTemplate = $this->_oConnection->isConnected($iViewedId, $iId, true) ? $this->_oModule->_oConfig->CNF['EMAIL_FAN_REMOVE'] : $this->_oModule->_oConfig->CNF['EMAIL_JOIN_REJECT']; + list($iGroupProfileId, $iProfileId) = $this->_prepareGroupProfileAndMemberProfile($iId, $iViewedId); + if (bx_get_logged_profile_id() != $iProfileId) { + sendMailTemplate($sEmailTemplate, 0, $iProfileId, array( + 'EntryUrl' => BxDolProfile::getInstance($iGroupProfileId)->getUrl(), + 'EntryTitle' => BxDolProfile::getInstance($iGroupProfileId)->getDisplayName(), + ), BX_EMAIL_NOTIFY); + } + + // delete admin associated with profile + $this->_oModule->_oDb->deleteAdminsByGroupId($iGroupProfileId, $iProfileId); + + return parent::_delete ($mixedId); + } + + /** + * @return array where first element is group profile id and second element is some other persons profile id + */ + protected function _prepareGroupProfileAndMemberProfile($iId1, $iId2) + { + if (BxDolProfile::getInstance($iId1)->getModule() == $this->_sContentModule) + return array($iId1, $iId2); + else + return array($iId2, $iId1); + } + + protected function _addJsCss() + { + parent::_addJsCss(); + + if($this->_bRoles) + $this->_oModule->_oTemplate->addJs(['modules/base/groups/js/|main.js', 'main.js']); + } +} + +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/groups/classes/BxBaseModGroupsModule.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/groups/classes/BxBaseModGroupsModule.php new file mode 100644 index 0000000000..73197ad685 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/groups/classes/BxBaseModGroupsModule.php @@ -0,0 +1,2481 @@ +<?php defined('BX_DOL') or die('hack attempt'); +/** + * Copyright (c) UNA, Inc - https://una.io + * MIT License - https://opensource.org/licenses/MIT + * + * @defgroup BaseGroups Base classes for groups modules + * @ingroup UnaModules + * + * @{ + */ + +define('BX_BASE_MOD_GROUPS_MMODE_MULTI_ROLES', 'multi_roles'); + +define('BX_BASE_MOD_GROUPS_ROLE_COMMON', 0); +define('BX_BASE_MOD_GROUPS_ROLE_ADMINISTRATOR', 1); +define('BX_BASE_MOD_GROUPS_ROLE_MODERATOR', 2); + +define('BX_BASE_MOD_GROUPS_ACTION_EDIT', 'edit'); +define('BX_BASE_MOD_GROUPS_ACTION_CHANGE_COVER', 'change_cover'); +define('BX_BASE_MOD_GROUPS_ACTION_INVITE', 'invite'); +define('BX_BASE_MOD_GROUPS_ACTION_MANAGE_FANS', 'manage_fans'); +define('BX_BASE_MOD_GROUPS_ACTION_MANAGE_ROLES', 'manage_roles'); +define('BX_BASE_MOD_GROUPS_ACTION_DELETE', 'delete'); +define('BX_BASE_MOD_GROUPS_ACTION_EDIT_CONTENT', 'edit_any'); +define('BX_BASE_MOD_GROUPS_ACTION_DELETE_CONTENT', 'delete_any'); +define('BX_BASE_MOD_GROUPS_ACTION_TIMELINE_POST_PIN', 'pin'); //for timeline posts only + +define('BX_BASE_MOD_GROUPS_PERIOD_UNIT_DAY', 'day'); +define('BX_BASE_MOD_GROUPS_PERIOD_UNIT_WEEK', 'week'); +define('BX_BASE_MOD_GROUPS_PERIOD_UNIT_MONTH', 'month'); +define('BX_BASE_MOD_GROUPS_PERIOD_UNIT_YEAR', 'year'); + +/** + * Groups profiles module. + */ +class BxBaseModGroupsModule extends BxBaseModProfileModule +{ + function __construct(&$aModule) + { + parent::__construct($aModule); + + $CNF = &$this->_oConfig->CNF; + + if(isset($CNF['FIELD_PUBLISHED'])) + $this->_aSearchableNamesExcept = array_merge($this->_aSearchableNamesExcept, array( + $CNF['FIELD_PUBLISHED'], + )); + } + + /** + * Get possible recipients for start conversation form + */ + public function actionAjaxGetInitialMembers () + { + $sTerm = bx_get('term'); + + $a = BxDolService::call('system', 'profiles_search', [$sTerm, ['module' => $this->_oConfig->getName()]], 'TemplServiceProfiles'); + + header('Content-Type:text/javascript; charset=utf-8'); + echo(json_encode($a)); + } + + public function serviceGetInitialMembers ($sParams) + { + $aOptions = json_decode($sParams, true); + if (!$sParams || !isset($aOptions['term'])) + return []; + + $a = BxDolService::call('system', 'profiles_search', [$aOptions['term'], ['module' => $this->_oConfig->getName()]], 'TemplServiceProfiles'); + + return $a; + } + + /** + * Process Process Invitation + */ + public function actionProcessInvite ($sKey, $iGroupProfileId, $bAccept) + { + $aData = $this->_oDb->getInviteByKey($sKey, $iGroupProfileId); + if (isset($aData['invited_profile_id'])){ + $CNF = &$this->_oConfig->CNF; + if (!isset($CNF['OBJECT_CONNECTIONS']) || !($oConnection = BxDolConnection::getObjectInstance($CNF['OBJECT_CONNECTIONS']))) + return ''; + $iInvitedProfileId = $aData['invited_profile_id']; + if ($iInvitedProfileId != bx_get_logged_profile_id()) + return ''; + if ($bAccept){ + if($oConnection && !$oConnection->isConnected($iInvitedProfileId, $iGroupProfileId)){ + $oConnection->addConnection($iInvitedProfileId, $iGroupProfileId); + $oConnection->addConnection($iGroupProfileId, $iInvitedProfileId); + } + } + $this->_oDb->deleteInviteByKey($sKey, $iGroupProfileId); + } + } + + public function actionCheckName() + { + $CNF = &$this->_oConfig->CNF; + + $sName = bx_process_input(bx_get('name')); + if(empty($sName)) + return echoJson(array()); + + $sResult = ''; + + $iId = (int)bx_get('id'); + if(!empty($iId)) { + $aPrice = $this->_oDb->getPrices(array('type' => 'by_id', 'value' => $iId)); + if(strcmp($sName, $aPrice[$CNF['FIELD_PRICE_NAME']]) == 0) + $sResult = $sName; + } + + echoJson(array( + 'name' => !empty($sResult) ? $sResult : $this->_oConfig->getPriceName($sName) + )); + } + + public function actionGetQuestionnaire() + { + $sSource = ''; + if(($sSource = bx_get('s')) !== false) + $sSource = bx_process_url_param($sSource); + + $sObject = ''; + if(($sObject = bx_get('o')) !== false) + $sObject = bx_process_url_param($sObject); + + $sAction = ''; + if(($sAction = bx_get('a')) !== false) + $sAction = bx_process_url_param($sAction); + + $iContentProfileId = 0; + if(($iContentProfileId = bx_get('cpi')) !== false) + $iContentProfileId = (int)$iContentProfileId; + + echoJson($this->serviceGetQuestionnaire($sSource, $sObject, $sAction, $iContentProfileId)); + } + + public function serviceManageTools($sType = 'common') + { + $this->_oTemplate->addJs(['modules/base/groups/js/|manage_tools.js']); + + return parent::serviceManageTools($sType); + } + + public function decodeDataAPI($aData, $aParams = []) + { + $CNF = $this->_oConfig->CNF; + + $aResult = parent::decodeDataAPI($aData, $aParams); + + if(isset($aParams['template']) && $aParams['template'] == 'unit_wo_info') + return $aResult; + + if(getParam('sys_api_conn_in_prof_units') == 'on' && ($oConnection = BxDolConnection::getObjectInstance($CNF['OBJECT_CONNECTIONS'])) !== false) { + $oProfile = BxDolProfile::getInstanceByContentAndType($aData[$CNF['FIELD_ID']], $this->_aModule['name']); + + $aResult['members_count'] = $oConnection->getConnectedInitiatorsCount($oProfile->id(), false); + $aResult['members_list'] = $oConnection->getConnectedListAPI($oProfile->id(), false, BX_CONNECTIONS_CONTENT_TYPE_INITIATORS); + } + $aResult['visibility'] = $aData[$CNF['FIELD_ALLOW_VIEW_TO']]; + + return $aResult; + } + + public function serviceGetMenuAddonManageTools() + { + $CNF = &$this->_oConfig->CNF; + + $aResult = parent::serviceGetMenuAddonManageTools(); + + if(!empty($CNF['FIELD_STATUS_ADMIN'])) + $aResult['counter1_value'] = $this->_oDb->getEntriesNumByParams([[ + 'key' => $CNF['FIELD_STATUS_ADMIN'], + 'value' => BX_BASE_MOD_GENERAL_STATUS_PENDING, + 'operator' => '=' + ]]); + + return $aResult; + } + + public function serviceGetOptionsMembersMode() + { + $CNF = &$this->_oConfig->CNF; + + return array( + array('key' => '', 'value' => _t('_None')), + array('key' => BX_BASE_MOD_GROUPS_MMODE_MULTI_ROLES, 'value' => _t($CNF['T']['option_members_mode_' . BX_BASE_MOD_GROUPS_MMODE_MULTI_ROLES])), + ); + } + + public function serviceGetSearchResultUnit ($iContentId, $sUnitTemplate = '') + { + if(empty($sUnitTemplate)) + $sUnitTemplate = 'unit.html'; + + return parent::serviceGetSearchResultUnit($iContentId, $sUnitTemplate); + } + + /** + * @see BxBaseModProfileModule::serviceGetSpaceTitle + */ + public function serviceGetSpaceTitle() + { + return _t($this->_oConfig->CNF['T']['txt_sample_single']); + } + + /** + * @see iBxDolProfileService::serviceGetParticipatingProfiles + */ + public function serviceGetParticipatingProfiles($iProfileId, $aConnectionObjects = false) + { + if (isset($this->_oConfig->CNF['OBJECT_CONNECTIONS'])){ + $aConnectionObjects = array($this->_oConfig->CNF['OBJECT_CONNECTIONS'], 'sys_profiles_subscriptions'); + return parent::serviceGetParticipatingProfiles($iProfileId, $aConnectionObjects); + } + return parent::serviceGetParticipatingProfiles($iProfileId); + } + + public function serviceGetSafeServices() + { + return array_merge(parent::serviceGetSafeServices(), [ + 'GetQuestionnaire' => '', + 'GetInitialMembers' => '', + 'EntityInvite' => '', + ]); + } + + /** + * Check if this module entry can be used as profile + */ + public function serviceActAsProfile () + { + return false; + } + + /** + * Check if this module is group profile + */ + public function serviceIsGroupProfile () + { + return true; + } + + public function serviceIsEnableForContext($iProfileId = 0) + { + $CNF = &$this->_oConfig->CNF; + + $sCnfKey = 'ENABLE_FOR_CONTEXT_IN_MODULES'; + if(empty($iProfileId) || empty($CNF[$sCnfKey]) || !is_array($CNF[$sCnfKey])) + return false; + + $oProfile = BxDolProfile::getInstance($iProfileId); + if(!$oProfile) + return false; + + if(!in_array($oProfile->getModule(), $CNF[$sCnfKey])) + return false; + + return true; + } + + /** + * check if provided profile is member of the group + */ + public function serviceIsFan ($iGroupProfileId, $iProfileId = false) + { + $oGroupProfile = BxDolProfile::getInstance($iGroupProfileId); + return $oGroupProfile !== false && $this->isFan($oGroupProfile->getContentId(), $iProfileId); + } + + /** + * check if provided profile is admin of the group + */ + public function serviceIsAdmin ($iGroupProfileId, $iProfileId = false) + { + if(!$iProfileId) + $iProfileId = bx_get_logged_profile_id(); + + $oGroupProfile = BxDolProfile::getInstance($iGroupProfileId); + if(!$oGroupProfile) + return false; + + $iGroupContentId = $oGroupProfile->getContentId(); + if(!$this->isFan($iGroupContentId, $iProfileId)) + return false; + + $aGroupContentInfo = $this->_oDb->getContentInfoById($iGroupContentId); + return $this->_oDb->isAdmin($iGroupProfileId, $iProfileId, $aGroupContentInfo); + } + + public function serviceGetAdminRole($iGroupProfileId, $iProfileId = false) + { + if(!$iProfileId) + $iProfileId = bx_get_logged_profile_id(); + + if(!$this->serviceIsAdmin($iGroupProfileId, $iProfileId)) + return 0; + + return $this->_oDb->getRole($iGroupProfileId, $iProfileId); + } + + /* + * Get context (group) advanced members who can perform the specified action. + * If 'Roles' are disabled for the context then all context admins are returned. + */ + public function serviceGetAdminsByAction($iGroupProfileId, $mixedAction) + { + if(!$this->_oConfig->isAdmins()) + return []; + + $aGroupContentInfo = $this->_oDb->getContentInfoByProfileId($iGroupProfileId); + if(empty($aGroupContentInfo) || !is_array($aGroupContentInfo)) + return []; + + $aAdmins = $this->_oDb->getAdmins($iGroupProfileId); + if(!$this->_oConfig->isRoles()) + return $aAdmins; + + if(!is_array($mixedAction)) + $mixedAction = [$mixedAction]; + + $aResult = []; + foreach($mixedAction as $sAction) + foreach($aAdmins as $iAdminProfileId) + if(!in_array($iAdminProfileId, $aResult) && $this->isAllowedActionByRole($sAction, $aGroupContentInfo, $iGroupProfileId, $iAdminProfileId)) + $aResult[] = $iAdminProfileId; + + return $aResult; + } + + public function serviceGetAdminsToManageContent($iGroupProfileId) + { + return $this->serviceGetAdminsByAction($iGroupProfileId, [ + BX_BASE_MOD_GROUPS_ACTION_EDIT_CONTENT, + BX_BASE_MOD_GROUPS_ACTION_DELETE_CONTENT + ]); + } + + /** + * Delete profile from fans and admins tables + * @param $iProfileId profile id + */ + public function serviceDeleteProfileFromFansAndAdmins ($iProfileId) + { + $CNF = &$this->_oConfig->CNF; + + $this->_oDb->deleteAdminsByProfileId($iProfileId); + + if (isset($CNF['OBJECT_CONNECTIONS']) && ($oConnection = BxDolConnection::getObjectInstance($CNF['OBJECT_CONNECTIONS']))) + $oConnection->onDeleteInitiatorAndContent($iProfileId); + } + + /** + * Reset group's author for particular group + * @param $iContentId group id + * @parem $iAuthorId new author profile ID + * @return false of error, or number of updated records on success + */ + public function serviceReassignEntityAuthor ($iContentId, $iAuthorId = 0) + { + $aContentInfo = $this->_oDb->getContentInfoById((int)$iContentId); + if (!$aContentInfo) + return false; + + if (empty($iAuthorId)) { + $oGroupProfile = BxDolProfile::getInstanceByContentAndType($iContentId, $this->getName()); + if (!$oGroupProfile) + return false; + + $aAdmins = $this->_oDb->getAdmins($oGroupProfile->id()); + if($aAdmins) + $iAuthorId = array_pop($aAdmins); + } + + return $this->_oDb->updateAuthorById($iContentId, $iAuthorId); + } + + /** + * Entry actions and social sharing block + */ + public function serviceEntityAllActions ($mixedContent = false, $aParams = array()) + { + $CNF = &$this->_oConfig->CNF; + + if(!empty($mixedContent)) { + if(!is_array($mixedContent)) + $mixedContent = array((int)$mixedContent, (method_exists($this->_oDb, 'getContentInfoById')) ? $this->_oDb->getContentInfoById((int)$mixedContent) : array()); + } + else { + $mixedContent = $this->_getContent(); + if($mixedContent === false) + return false; + } + + list($iContentId, $aContentInfo) = $mixedContent; + + if(!empty($CNF['FIELD_PICTURE']) && !empty($aContentInfo[$CNF['FIELD_PICTURE']])) + $aParams = array_merge(array( + 'entry_thumb' => (int)$aContentInfo[$CNF['FIELD_PICTURE']] + ), $aParams); + + return parent::serviceEntityAllActions ($mixedContent, $aParams); + } + + /** + * Reset group's author when author profile is deleted + * @param $iProfileId author profile id + * @param $iAuthorId new author profile id + * @return number of changed items + */ + public function serviceReassignEntitiesByAuthor ($iProfileId, $iAuthorId = 0) + { + $a = $this->_oDb->getEntriesByAuthor((int)$iProfileId); + if (!$a) + return 0; + + $iCount = 0; + foreach ($a as $aContentInfo) + $iCount += ('' == $this->serviceReassignEntityAuthor($aContentInfo[$this->_oConfig->CNF['FIELD_ID']], $iAuthorId) ? 1 : 0); + + return $iCount; + } + + public function servicePrepareFields ($aFieldsProfile) + { + $CNF = &$this->_oConfig->CNF; + + $aFieldsProfile[$CNF['FIELD_NAME']] = $aFieldsProfile['name']; + $aFieldsProfile[$CNF['FIELD_TEXT']] = isset($aFieldsProfile['description']) ? $aFieldsProfile['description'] : ''; + unset($aFieldsProfile['name']); + unset($aFieldsProfile['description']); + return $aFieldsProfile; + } + + public function serviceOnRemoveConnection ($iGroupProfileId, $iInitiatorId) + { + $CNF = &$this->_oConfig->CNF; + + list ($iProfileId, $iGroupProfileId, $oGroupProfile) = $this->_prepareProfileAndGroupProfile($iGroupProfileId, $iInitiatorId); + if (!$oGroupProfile) + return false; + + $this->_oDb->fromAdmins($iGroupProfileId, $iProfileId); + + if ($oConn = BxDolConnection::getObjectInstance('sys_profiles_subscriptions')) + return $oConn->removeConnection($iProfileId, $iGroupProfileId); + + return false; + } + + public function serviceAddMutualConnection ($iGroupProfileId, $iInitiatorId, $bSendInviteOnly = false) + { + $CNF = &$this->_oConfig->CNF; + + list ($iProfileId, $iGroupProfileId, $oGroupProfile) = $this->_prepareProfileAndGroupProfile($iGroupProfileId, $iInitiatorId); + if (!$oGroupProfile) + return false; + + if (!($aContentInfo = $this->_oDb->getContentInfoById((int)BxDolProfile::getInstance($iGroupProfileId)->getContentId()))) + return false; + + if (!isset($CNF['OBJECT_CONNECTIONS']) || !($oConnection = BxDolConnection::getObjectInstance($CNF['OBJECT_CONNECTIONS']))) + return false; + + $sEntryTitle = $aContentInfo[$CNF['FIELD_NAME']]; + $sEntryUrl = bx_absolute_url(BxDolPermalinks::getInstance()->permalink('page.php?i=' . $CNF['URI_VIEW_ENTRY'] . '&id=' . $aContentInfo[$CNF['FIELD_ID']])); + + // send invitation to the group + $sModule = $this->getName(); + if ($bSendInviteOnly && !$oConnection->isConnected((int)$iInitiatorId, $oGroupProfile->id()) && !$oConnection->isConnected($oGroupProfile->id(), (int)$iInitiatorId) && bx_get_logged_profile_id() != $iProfileId) { + /** + * @hooks + * @hookdef hook-bx_base_groups-join_invitation '{module_name}', 'join_invitation' - hook before adding (sending) new join to context invitation + * - $unit_name - module name + * - $action - equals `join_invitation` + * - $object_id - context id + * - $sender_id - context profile id + * - $extra_params - array of additional params with the following array keys: + * - `content` - [array] context info array as key&value pairs + * - `entry_title` - [string] context title + * - `entry_url` - [string] context URL + * - `group_profile` - [int] context profile id + * - `profile` - [int] profile id who was invited + * - `notification_subobject_id` - [int] profile id who was invited + * - `object_author_id` - [int] context profile id + * @hook @ref hook-bx_base_groups-join_invitation + */ + bx_alert($sModule, 'join_invitation', $aContentInfo[$CNF['FIELD_ID']], $iGroupProfileId, [ + 'content' => $aContentInfo, + 'entry_title' => $sEntryTitle, + 'entry_url' => $sEntryUrl, + 'group_profile' => $iGroupProfileId, + 'profile' => $iProfileId, + 'notification_subobject_id' => $iProfileId, + 'object_author_id' => $iGroupProfileId + ]); + + /** + * 'Invitation Received' alert for Notifications module. + * Note. It's essential to use Recipient ($iInitiatorId) in 'object_author_id' parameter. + * In this case notification will be received by Recipient profile. + */ + /** + * @hooks + * @hookdef hook-bx_base_groups-join_invitation_notif '{module_name}', 'join_invitation_notif' - hook before adding new join to context invitation. Is needed for Notifications module. + * - $unit_name - module name + * - $action - equals `join_invitation_notif` + * - $object_id - context id + * - $sender_id - context profile id + * - $extra_params - array of additional params with the following array keys: + * - `object_author_id` - [int] profile id who was invited + * - `privacy_view` - [int] or [string] privacy for view context action, @see BxDolPrivacy + * @hook @ref hook-bx_base_groups-join_invitation_notif + */ + bx_alert($sModule, 'join_invitation_notif', $aContentInfo[$CNF['FIELD_ID']], $iGroupProfileId, [ + 'object_author_id' => $iInitiatorId, + 'privacy_view' => isset($aContentInfo[$CNF['FIELD_ALLOW_VIEW_TO']]) ? $aContentInfo[$CNF['FIELD_ALLOW_VIEW_TO']] : 3, + ]); + } + // send notification to group's admins that new connection is pending confirmation + elseif (!$bSendInviteOnly && $oConnection->isConnected((int)$iInitiatorId, $oGroupProfile->id()) && !$oConnection->isConnected($oGroupProfile->id(), (int)$iInitiatorId) && $aContentInfo['join_confirmation']) { + /** + * @hooks + * @hookdef hook-bx_base_groups-join_request '{module_name}', 'join_request' - hook before adding new join to context request + * - $unit_name - module name + * - $action - equals `join_request` + * - $object_id - context id + * - $sender_id - context profile id + * - $extra_params - array of additional params with the following array keys: + * - `object_author_id` - [int] context profile id + * - `performer_id` - [int] profile id who wants to join + * - `content` - [array] context info array as key&value pairs + * - `entry_title` - [string] context title + * - `entry_url` - [string] context URL + * - `group_profile` - [int] context profile id + * - `profile` - [int] profile id who wants to join + * @hook @ref hook-bx_base_groups-join_request + */ + bx_alert($this->getName(), 'join_request', $aContentInfo[$CNF['FIELD_ID']], $iGroupProfileId, [ + 'object_author_id' => $iGroupProfileId, + 'performer_id' => $iProfileId, + + 'content' => $aContentInfo, + 'entry_title' => $sEntryTitle, + 'entry_url' => $sEntryUrl, + + 'group_profile' => $iGroupProfileId, + 'profile' => $iProfileId + ]); + } + // send notification that join request was accepted + else if (!$bSendInviteOnly && $oConnection->isConnected((int)$iInitiatorId, $oGroupProfile->id(), true) && $oGroupProfile->getModule() != $this->getName() && bx_get_logged_profile_id() != $iProfileId) { + /** + * @hooks + * @hookdef hook-bx_base_groups-join_request_accepted '{module_name}', 'join_request_accepted' - hook before accepting join to context request + * It's equivalent to @ref hook-bx_base_groups-join_request + * @hook @ref hook-bx_base_groups-join_request_accepted + */ + bx_alert($this->getName(), 'join_request_accepted', $aContentInfo[$CNF['FIELD_ID']], $iGroupProfileId, [ + 'object_author_id' => $iGroupProfileId, + 'performer_id' => $iProfileId, + + 'content' => $aContentInfo, + 'entry_title' => $sEntryTitle, + 'entry_url' => $sEntryUrl, + + 'group_profile' => $iGroupProfileId, + 'profile' => $iProfileId + ]); + } + + // new fan was added + if ($oConnection->isConnected($oGroupProfile->id(), (int)$iInitiatorId, true)) { + // follow group on join + if (BxDolService::call($oGroupProfile->getModule(), 'act_as_profile')){ + $this->addFollower($oGroupProfile->id(), (int)$iInitiatorId); + } + else{ + $this->addFollower((int)$iInitiatorId, $oGroupProfile->id()); + } + + /** + * @hooks + * @hookdef hook-bx_base_groups-fan_added '{module_name}', 'fan_added' - hook before adding (registering) new context member + * It's equivalent to @ref hook-bx_base_groups-join_request + * @hook @ref hook-bx_base_groups-fan_added + */ + bx_alert($this->getName(), 'fan_added', $aContentInfo[$CNF['FIELD_ID']], $iGroupProfileId, [ + 'object_author_id' => $iGroupProfileId, + 'performer_id' => $iProfileId, + + 'content' => $aContentInfo, + 'entry_title' => $sEntryTitle, + 'entry_url' => $sEntryUrl, + + 'group_profile' => $iGroupProfileId, + 'profile' => $iProfileId, + ]); + + $this->doAudit($iGroupProfileId, $iInitiatorId, '_sys_audit_action_group_join_request_accepted'); + + return false; + } + + // don't automatically add connection (mutual) if group requires manual join confirmation + if ($bSendInviteOnly || $aContentInfo['join_confirmation']) + return false; + + // check if connection already exists + if ($oConnection->isConnected($oGroupProfile->id(), (int)$iInitiatorId, true) || $oConnection->isConnected($oGroupProfile->id(), (int)$iInitiatorId)) + return false; + + if (!$oConnection->addConnection($oGroupProfile->id(), (int)$iInitiatorId)) + return false; + + return true; + } + + public function serviceFansTable () + { + $CNF = &$this->_oConfig->CNF; + + $oGrid = BxDolGrid::getObjectInstance($CNF['OBJECT_GRID_CONNECTIONS']); + if(!$oGrid) + return false; + + if($this->_bIsApi){ + return [ + bx_api_get_block('grid', $oGrid->getCodeAPI()) + ]; + } + + return $oGrid->getCode(); + } + + public function serviceInvitesTable () + { + $CNF = &$this->_oConfig->CNF; + + if(!isset($CNF['OBJECT_GRID_INVITES'])) + return false; + + $oGrid = BxDolGrid::getObjectInstance($CNF['OBJECT_GRID_INVITES']); + if(!$oGrid) + return false; + + if($this->_bIsApi) + return [ + bx_api_get_block('grid', $oGrid->getCodeAPI()) + ]; + + return $oGrid->getCode(); + } + + public function serviceBansTable () + { + $CNF = &$this->_oConfig->CNF; + + if(!isset($CNF['OBJECT_GRID_BANS'])) + return false; + + $oGrid = BxDolGrid::getObjectInstance($CNF['OBJECT_GRID_BANS']); + if(!$oGrid) + return false; + + if($this->_bIsApi) + return [ + bx_api_get_block('grid', $oGrid->getCodeAPI()) + ]; + + return $oGrid->getCode(); + } + + public function serviceFans ($iContentId = 0, $bAsArray = false) + { + $CNF = &$this->_oConfig->CNF; + + if (!$iContentId) + $iContentId = bx_process_input(bx_get('id'), BX_DATA_INT); + + if (!$iContentId) + return false; + + $aContentInfo = $this->_oDb->getContentInfoById($iContentId); + if (!$aContentInfo) + return false; + + if (!($oGroupProfile = BxDolProfile::getInstanceByContentAndType($iContentId, $this->getName()))) + return false; + + if(!$bAsArray) { + bx_import('BxDolConnection'); + $mixedResult = $this->serviceBrowseConnectionsQuick ($oGroupProfile->id(), $CNF['OBJECT_CONNECTIONS'], BX_CONNECTIONS_CONTENT_TYPE_CONTENT, true); + if (!$mixedResult) + return MsgBox(_t('_sys_txt_empty')); + } + else + $mixedResult = BxDolConnection::getObjectInstance($CNF['OBJECT_CONNECTIONS'])->getConnectedContent($oGroupProfile->id(), true); + + return $mixedResult; + } + + public function serviceFansWithoutAdmins ($iContentId = 0, $bAsArray = false) + { + if (!$iContentId) + $iContentId = bx_process_input(bx_get('id'), BX_DATA_INT); + if (!$iContentId) + return false; + + $aContentInfo = $this->_oDb->getContentInfoById($iContentId); + if (!$aContentInfo) + return false; + + if (!($oGroupProfile = BxDolProfile::getInstanceByContentAndType($iContentId, $this->getName()))) + return false; + + $CNF = &$this->_oConfig->CNF; + + $aFans = BxDolConnection::getObjectInstance($CNF['OBJECT_CONNECTIONS'])->getConnectedContent($oGroupProfile->id(), true); + if(empty($aFans) || !is_array($aFans)) + return false; + + $aAdmins = $this->_oDb->getAdmins($oGroupProfile->id()); + if(!empty($aAdmins) && is_array($aAdmins)) + $aFans = array_diff($aFans, $aAdmins); + + $iStart = (int)bx_get('start'); + $iLimit = !empty($CNF['PARAM_NUM_CONNECTIONS_QUICK']) ? getParam($CNF['PARAM_NUM_CONNECTIONS_QUICK']) : 4; + if(!$iLimit) + $iLimit = 4; + + return $this->_serviceBrowseQuick($aFans, $iStart, $iLimit); + } + + public function serviceAdmins ($iContentId = 0) + { + $CNF = &$this->_oConfig->CNF; + + if(!$iContentId) + $iContentId = bx_process_input(bx_get('id'), BX_DATA_INT); + if(!$iContentId) + return false; + + $oGroupProfile = BxDolProfile::getInstanceByContentAndType($iContentId, $this->getName()); + if(!$oGroupProfile) + return false; + + $iStart = (int)bx_get('start'); + $iLimit = !empty($CNF['PARAM_NUM_CONNECTIONS_QUICK']) ? getParam($CNF['PARAM_NUM_CONNECTIONS_QUICK']) : 4; + if(!$iLimit) + $iLimit = 4; + + $aProfiles = $this->_oDb->getAdmins($oGroupProfile->id(), $iStart, $iLimit+1); + if(empty($aProfiles) || !is_array($aProfiles)) + return false; + + return $this->_serviceBrowseQuick($aProfiles, $iStart, $iLimit); + } + + public function serviceMembersByRole ($iContentId = 0, $iRole = BX_BASE_MOD_GROUPS_ROLE_COMMON) + { + $CNF = &$this->_oConfig->CNF; + + if(!$iContentId) + $iContentId = bx_process_input(bx_get('id'), BX_DATA_INT); + if(!$iContentId) + return false; + + $oGroupProfile = BxDolProfile::getInstanceByContentAndType($iContentId, $this->getName()); + if(!$oGroupProfile) + return false; + + $iStart = (int)bx_get('start'); + $iLimit = !empty($CNF['PARAM_NUM_CONNECTIONS_QUICK']) ? getParam($CNF['PARAM_NUM_CONNECTIONS_QUICK']) : 4; + if(!$iLimit) + $iLimit = 4; + + $aProfiles = $this->_oDb->getRoles([ + 'type' => 'fan_pids_by_group_pid', + 'group_profile_id' => $oGroupProfile->id(), + 'role' => $iRole, + 'start' => $iStart, + 'limit' => $iLimit + 1 + ]); + + if(empty($aProfiles) || !is_array($aProfiles)) + return false; + + return $this->_serviceBrowseQuick($aProfiles, $iStart, $iLimit); + } + + public function serviceBrowseJoinedEntries ($iProfileId = 0, $bDisplayEmptyMsg = false) + { + if (!$iProfileId) + $iProfileId = bx_process_input(bx_get('profile_id'), BX_DATA_INT); + if (!$iProfileId) + return ''; + + return $this->_serviceBrowse ('joined_entries', array('joined_profile' => $iProfileId), BX_DB_PADDING_DEF, $bDisplayEmptyMsg); + } + + public function serviceBrowseFollowedEntries ($iProfileId = 0, $bDisplayEmptyMsg = false) + { + if (!$iProfileId) + $iProfileId = bx_process_input(bx_get('profile_id'), BX_DATA_INT); + if (!$iProfileId) + return ''; + + return $this->_serviceBrowse ('followed_entries', array('followed_profile' => $iProfileId), BX_DB_PADDING_DEF, $bDisplayEmptyMsg); + } + + public function serviceBrowseCreatedEntries ($iProfileId = 0, $bDisplayEmptyMsg = false) + { + if (!$iProfileId) + $iProfileId = bx_process_input(bx_get('profile_id'), BX_DATA_INT); + if (!$iProfileId) + return ''; + + return $this->_serviceBrowse ('created_entries', array('author' => $iProfileId), BX_DB_PADDING_DEF, $bDisplayEmptyMsg); + } + + public function serviceBrowseRecommendationsFans ($iProfileId = 0, $aParams = []) + { + $CNF = &$this->_oConfig->CNF; + + if($this->_bIsApi) + $aParams = bx_api_get_browse_params($aParams, true); + + if(!$iProfileId) + $iProfileId = bx_get_logged_profile_id(); + if(!$iProfileId) + return ''; + + $aParams = array_merge([ + 'empty_message' => false, + 'start' => 0, + 'per_page' => 0 + ], $aParams); + + if(($iStartGet = bx_get('start')) !== false) + $aParams['start'] = (int)$iStartGet; + + if(($iPerPageGet = bx_get('per_page')) !== false) + $aParams['per_page'] = (int)$iPerPageGet; + + $oRecommendation = BxDolRecommendation::getObjectInstance($CNF['OBJECT_RECOMMENDATIONS_FANS']); + if(!$oRecommendation) + return false; + + if($this->_bIsApi) { + $aData = $oRecommendation->getCodeAPI($iProfileId, $aParams); + $aData = array_merge($aData, [ + 'module' => 'system', + 'unit' => 'mixed', + 'request_url' => '/api.php?r=bx_groups/browse_recommendations_fans¶ms[]=' . $iProfileId . '¶ms[]=' + ]); + + return [bx_api_get_block('browse', $aData)]; + } + + $sCode = $oRecommendation->getCode($iProfileId, $aParams); + if(!$sCode && $aParams['empty_message']) + $sCode = MsgBox(_t(!empty($aParams['empty_message_text']) ? $aParams['empty_message_text'] : '_Empty')); + + return $sCode; + } + + public function serviceBrowseMembers ($iProfileId = 0, $aParams = []) + { + $CNF = &$this->_oConfig->CNF; + + if(!$iProfileId) + $iProfileId = bx_process_input(bx_get('profile_id'), BX_DATA_INT); + if(!$iProfileId) + return ''; + + $oGroupProfile = BxDolProfile::getInstance($iProfileId); + if(!($oGroupProfile)) + return ''; + + return bx_srv('system', 'browse_members', [$oGroupProfile->id(), $CNF['OBJECT_CONNECTIONS'], $aParams], 'TemplServiceProfiles'); + } + + public function serviceEntityEditQuestionnaire($iProfileId = 0) + { + $CNF = &$this->_oConfig->CNF; + + if(!$iProfileId) + $iProfileId = bx_process_input(bx_get('profile_id'), BX_DATA_INT); + if(!$iProfileId) + return ''; + + $aProfileInfo = BxDolProfileQuery::getInstance()->getInfoById($iProfileId); + if(empty($aProfileInfo) || !is_array($aProfileInfo)) + return ''; + + $aContentInfo = $this->_oDb->getContentInfoById($aProfileInfo['content_id']); + if(empty($aContentInfo) || !is_array($aContentInfo)) + return ''; + + if($this->checkAllowedEdit($aContentInfo) !== CHECK_ACTION_RESULT_ALLOWED) + return MsgBox(_t('_Access denied')); + + $oGrid = BxDolGrid::getObjectInstance($CNF['OBJECT_GRID_QUESTIONS_MANAGE']); + if(!$oGrid) + return ''; + + if($this->_bIsApi){ + return [ + bx_api_get_block('grid', $oGrid->getCodeAPI()) + ]; + + } + + return $oGrid->getCode(); + } + + public function serviceEntityPricing($iProfileId = 0) + { + $CNF = &$this->_oConfig->CNF; + + if(!$iProfileId) + $iProfileId = bx_process_input(bx_get('profile_id'), BX_DATA_INT); + if(!$iProfileId) + return ''; + + if(!$this->_oConfig->isPaidJoin()) + return ''; + + $oPayments = BxDolPayments::getInstance(); + if(!$oPayments->isActive()) + return MsgBox(_t('_sys_payments_err_no_payments')); + + if($this->checkAllowedUsePaidJoin() !== CHECK_ACTION_RESULT_ALLOWED) + return MsgBox(_t('_Access denied')); + + if($this->checkAllowedManageAdmins($iProfileId) !== CHECK_ACTION_RESULT_ALLOWED) + return MsgBox(_t('_Access denied')); + + $oGrid = BxDolGrid::getObjectInstance($CNF['OBJECT_GRID_PRICES_MANAGE']); + if(!$oGrid) + return ''; + + $sNote = ''; + if(!$oPayments->isAcceptingPayments($this->_iProfileId)) + $sNote = MsgBox(_t('_sys_payments_err_not_accept_payments', $oPayments->getDetailsUrl())); + + return $sNote . $oGrid->getCode(); + } + + public function serviceEntityJoin($iProfileId = 0) + { + $CNF = &$this->_oConfig->CNF; + + if(!$iProfileId) + $iProfileId = bx_process_input(bx_get('profile_id'), BX_DATA_INT); + if(!$iProfileId) + return ''; + + if(!$this->_oConfig->isPaidJoin()) + return ''; + + $oGrid = BxDolGrid::getObjectInstance($CNF['OBJECT_GRID_PRICES_VIEW']); + if(!$oGrid) + return ''; + + return $oGrid->getCode(); + } + + public function serviceEntityInvite ($iContentId = 0, $bErrorMsg = true) + { + $CNF = &$this->_oConfig->CNF; + + if(!isset($CNF['OBJECT_FORM_ENTRY_DISPLAY_INVITE'])) + return false; + + return $this->_serviceEntityForm ('inviteForm', $iContentId, false, false, $bErrorMsg); + } + + /** + * Entry social sharing block + */ + public function serviceEntitySocialSharing ($mixedContent = false, $aParams = array()) + { + if(!empty($mixedContent)) { + if(!is_array($mixedContent)) + $mixedContent = array((int)$mixedContent, array()); + } + else { + $mixedContent = $this->_getContent(); + if($mixedContent === false) + return false; + } + + list($iContentId, $aContentInfo) = $mixedContent; + + $oGroupProfile = BxDolProfile::getInstanceByContentAndType((int)$iContentId, $this->getName()); + if(!$oGroupProfile) + return false; + + return parent::serviceEntitySocialSharing(array($iContentId, $aContentInfo), array( + 'title' => $oGroupProfile->getDisplayName() + )); + } + + public function serviceIsPricingAvaliable($iProfileId) + { + if(!$this->_oConfig->isPaidJoin()) + return false; + + if($this->checkAllowedUsePaidJoin() !== CHECK_ACTION_RESULT_ALLOWED) + return false; + + if($this->checkAllowedManageAdmins($iProfileId) !== CHECK_ACTION_RESULT_ALLOWED) + return false; + + return true; + } + + public function serviceIsPaidJoinAvaliable($iGroupProfileId, $iProfileId = 0) + { + return $this->isPaidJoinByProfileForProfile($iGroupProfileId, $iProfileId); + } + + public function serviceIsPaidJoinAvaliableByContent($iGroupContentId, $iProfileId = 0) + { + $oGroupProfile = BxDolProfile::getInstanceByContentAndType($iGroupContentId, $this->getName()); + if(!$oGroupProfile) + return false; + + return $this->isPaidJoinByProfileForProfile($oGroupProfile->id(), $iProfileId); + } + + public function serviceIsFreeJoinAvaliable($iGroupProfileId, $iProfileId = 0) + { + return !$this->isPaidJoinByProfileForProfile($iGroupProfileId, $iProfileId); + } + + public function serviceIsFreeJoinAvaliableByContent($iGroupContentId, $iProfileId = 0) + { + $oGroupProfile = BxDolProfile::getInstanceByContentAndType($iGroupContentId, $this->getName()); + if(!$oGroupProfile) + return false; + + return !$this->isPaidJoinByProfileForProfile($oGroupProfile->id(), $iProfileId); + } + + /** + * Is Paid Join enabled in the group and whether a profile can use it. + * + * @param type $iGroupProfileId - Group profile ID. + * @param type $iProfileId - Profile ID of the user who wants to join. + * @return boolean + */ + public function isPaidJoinByProfileForProfile($iGroupProfileId, $iProfileId = 0) + { + $CNF = &$this->_oConfig->CNF; + + if(empty($iProfileId)) + $iProfileId = $this->_iProfileId; + + if(BxDolConnection::getObjectInstance($CNF['OBJECT_CONNECTIONS'])->isConnected($iProfileId, $iGroupProfileId)) + return false; + + return $this->isPaidJoinByProfile($iGroupProfileId); + } + + /** + * Is Paid Join enabled as is and whether a group has pricing plans added. + * + * @param type $iGroupProfileId - Group profile ID. + * @return boolean + */ + public function isPaidJoinByProfile($iGroupProfileId) + { + if(!$this->_oConfig->isPaidJoin()) + return false; + + $aPrices = $this->_oDb->getPrices(array('type' => 'by_profile_id', 'profile_id' => $iGroupProfileId)); + if(empty($aPrices) || !is_array($aPrices)) + return false; + + return true; + } + + /** + * Integration with Payments. + */ + public function serviceGetPaymentData() + { + return $this->_aModule; + } + + public function serviceGetCartItem($mixedItemId) + { + $CNF = &$this->_oConfig->CNF; + + if(!$mixedItemId) + return array(); + + if(is_numeric($mixedItemId)) + $aItem = $this->_oDb->getPrices(array('type' => 'by_id', 'value' => (int)$mixedItemId)); + else + $aItem = $this->_oDb->getPrices(array('type' => 'by_name', 'value' => $mixedItemId)); + + if(empty($aItem) || !is_array($aItem)) + return array(); + + if(!$this->isPaidJoinByProfile($aItem['profile_id'])) + return array(); + + $oGroupProfile = BxDolProfile::getInstance($aItem['profile_id']); + if(!$oGroupProfile) + return array(); + + $aGroupProfile = $this->_oDb->getContentInfoById($oGroupProfile->getContentId()); + + $aRoles = BxDolFormQuery::getDataItems($CNF['OBJECT_PRE_LIST_ROLES']); + + $sTitle = ''; + if(!empty($aItem['period']) && !empty($aItem['period_unit'])) + $sTitle = _t($CNF['T']['txt_cart_item_title'], $oGroupProfile->getDisplayName(), $aRoles[$aItem['role_id']], $aItem['period'], $aItem['period_unit']); + else + $sTitle = _t($CNF['T']['txt_cart_item_title_lifetime'], $oGroupProfile->getDisplayName(), $aRoles[$aItem['role_id']]); + + return array ( + 'id' => $aItem['id'], + 'author_id' => $aGroupProfile[$CNF['FIELD_AUTHOR']], + 'name' => $aItem['name'], + 'title' => $sTitle, + 'description' => '', + 'url' => $oGroupProfile->getUrl(), + 'price_single' => $aItem['price'], + 'price_recurring' => $aItem['price'], + 'period_recurring' => $aItem['period'], + 'period_unit_recurring' => $aItem['period_unit'], + 'trial_recurring' => 0 + ); + } + + public function serviceGetCartItems($iSellerId) + { + $CNF = &$this->_oConfig->CNF; + + if(empty($iSellerId)) + return array(); + + $sModule = $this->getName(); + $aRoles = BxDolFormQuery::getDataItems($CNF['OBJECT_PRE_LIST_ROLES']); + + $aGroups = $this->_oDb->getEntriesBy(array('type' => 'author', 'author' => $iSellerId)); + + $aResult = array(); + foreach($aGroups as $aGroup) { + $oGroupProfile = BxDolProfile::getInstanceByContentAndType($aGroup[$CNF['FIELD_ID']], $sModule); + if(!$oGroupProfile) + continue; + + $aPrices = $this->_oDb->getPrices(array('type' => 'by_profile_id', 'profile_id' => $oGroupProfile->id())); + if(empty($aPrices) || !is_array($aPrices)) + continue; + + $sTitle = $oGroupProfile->getDisplayName(); + $sUrl = $oGroupProfile->getUrl(); + + foreach($aPrices as $aPrice) + $aResult[] = array( + 'id' => $aPrice['id'], + 'author_id' => $iSellerId, + 'name' => $aPrice['name'], + 'title' => _t($CNF['T']['txt_cart_item_title'], $sTitle, $aRoles[$aPrice['role_id']], $aPrice['period'], $aPrice['period_unit']), + 'description' => '', + 'url' => $sUrl, + 'price_single' => $aPrice['price'], + 'price_recurring' => $aPrice['price'], + 'period_recurring' => $aPrice['period'], + 'period_unit_recurring' => $aPrice['period_unit'] + ); + } + + return $aResult; + } + + public function serviceRegisterCartItem($iClientId, $iSellerId, $iItemId, $iItemCount, $sOrder, $sLicense) + { + return $this->_serviceRegisterItem($iClientId, $iSellerId, $iItemId, $iItemCount, $sOrder); + } + + public function serviceRegisterSubscriptionItem($iClientId, $iSellerId, $iItemId, $iItemCount, $sOrder, $sLicense) + { + return $this->_serviceRegisterItem($iClientId, $iSellerId, $iItemId, $iItemCount, $sOrder); + } + + public function serviceReregisterCartItem($iClientId, $iSellerId, $iItemIdOld, $iItemIdNew, $sOrder) + { + return $this->_serviceReregisterItem($iClientId, $iSellerId, $iItemIdOld, $iItemIdNew, $sOrder); + } + + public function serviceReregisterSubscriptionItem($iClientId, $iSellerId, $iItemIdOld, $iItemIdNew, $sOrder) + { + return $this->_serviceReregisterItem($iClientId, $iSellerId, $iItemIdOld, $iItemIdNew, $sOrder); + } + + public function serviceUnregisterCartItem($iClientId, $iSellerId, $iItemId, $iItemCount, $sOrder, $sLicense) + { + return $this->_serviceUnregisterItem($iClientId, $iSellerId, $iItemId, $iItemCount, $sOrder); + } + + public function serviceUnregisterSubscriptionItem($iClientId, $iSellerId, $iItemId, $iItemCount, $sOrder, $sLicense) + { + return $this->_serviceUnregisterItem($iClientId, $iSellerId, $iItemId, $iItemCount, $sOrder); + } + + public function serviceCancelSubscriptionItem($iClientId, $iSellerId, $iItemId, $iItemCount, $sOrder) + { + return true; + } + + protected function _serviceRegisterItem($iClientId, $iSellerId, $iItemId, $iItemCount, $sOrder) + { + $CNF = &$this->_oConfig->CNF; + + $aItem = $this->serviceGetCartItem($iItemId); + if(empty($aItem) || !is_array($aItem)) + return array(); + + $aItemInfo = $this->_oDb->getPrices(array('type' => 'by_id', 'value' => $iItemId)); + + $mixedPeriod = false; + if((int)$aItemInfo['period'] != 0) + $mixedPeriod = array( + 'period' => (int)$aItemInfo['period'], + 'period_unit' => $aItemInfo['period_unit'], + 'period_reserve' => $CNF['PARAM_RECURRING_RESERVE'] + ); + + if(!$this->setRole($aItemInfo['profile_id'], $iClientId, $aItemInfo['role_id'], $mixedPeriod, $sOrder)) + return array(); + + return $aItem; + } + + protected function _serviceReregisterItem($iClientId, $iSellerId, $iItemIdOld, $iItemIdNew, $sOrder) + { + $aItem = $this->serviceGetCartItem($iItemIdNew); + if(empty($aItem) || !is_array($aItem)) + return array(); + + $aItemInfoOld = $this->_oDb->getPrices(array('type' => 'by_id', 'value' => $iItemIdOld)); + if(empty($aItemInfoOld) || !is_array($aItemInfoOld)) + return array(); + + $aItemInfoNew = $this->_oDb->getPrices(array('type' => 'by_id', 'value' => $iItemIdNew)); + if(empty($aItemInfoNew) || !is_array($aItemInfoNew)) + return array(); + + if(!$this->unsetRole($aItemInfoOld['profile_id'], $iClientId)) + return array(); + + $aResult = $this->_serviceRegisterItem($iClientId, $iSellerId, $iItemIdNew, 1, $sOrder); + if(empty($aResult) || !is_array($aResult)) + return array(); + + return $aItem; + } + + protected function _serviceUnregisterItem($iClientId, $iSellerId, $iItemId, $iItemCount, $sOrder) + { + $aItemInfo = $this->_oDb->getPrices(array('type' => 'by_id', 'value' => $iItemId)); + if(empty($aItemInfo) || !is_array($aItemInfo)) + return false; + + return $this->unsetRole($aItemInfo['profile_id'], $iClientId); + } + + public function serviceGetQuestionnaire($sSource, $sObject, $sAction, $iContentProfileId) + { + $CNF = &$this->_oConfig->CNF; + $sMsg = _t('_sys_txt_not_found'); + + $aContentInfo = $this->_oDb->getContentInfoByProfileId($iContentProfileId); + if(empty($aContentInfo) || !is_array($aContentInfo)) + return $this->_bIsApi ? [bx_api_get_msg($sMsg)] : ['code' => 1, 'msg' => $sMsg]; + + $oForm = null; + if(($oConnection = BxDolConnection::getObjectInstance($sObject)) !== false) { + $oForm = $oConnection->getQuestionnaireForm($sAction, $iContentProfileId, ['request' => [ + 's' => $sSource, + ]]); + + if($oForm === false) + return $this->_bIsApi ? [bx_api_get_msg($sMsg)] : ['code' => 3, 'msg' => $sMsg]; + } + else + return $this->_bIsApi ? [bx_api_get_msg($sMsg)] : ['code' => 2, 'msg' => $sMsg]; + + $oForm->initChecker(); + if($oForm->isSubmittedAndValid()) { + $iProfileId = bx_get_logged_profile_id(); + + $aQuestions = $this->_oDb->getQuestions(['sample' => 'content_pid', 'content_pid' => $iContentProfileId]); + foreach($aQuestions as $aQuestion) + $this->_oDb->insertAnswer((int)$aQuestion['id'], $iProfileId, $oForm->getCleanValue('question_' . $aQuestion['id'])); + + return $this->_bIsApi ? [] : ['code' => 0, 'o' => $sObject, 'a' => $sAction, 'cpi' => $iContentProfileId, 'ci' => $aContentInfo[$CNF['FIELD_ID']], 'eval' => $this->_oConfig->getJsObject($sSource) . '.connActionPerformed(oData)']; + } + + if($this->_bIsApi) + return [bx_api_get_block('form', $oForm->getCodeAPI(), ['ext' => [ + 'name' => $this->_oModule->getName(), + 'request' => ['url' => $oForm->aFormAttrs['action'], 'immutable' => true]] + ])]; + + bx_import('BxTemplFunctions'); + $sContent = BxTemplFunctions::getInstance()->popupBox($this->_oConfig->getHtmlIds('popup_questionnaire'), _t($CNF['T']['popup_title_questionnaire']), $this->_oTemplate->parseHtmlByName('popup_qnr_questionnaire.html', [ + 'form_id' => $oForm->getId(), + 'form' => $oForm->getCode(true), + ])); + + return ['popup' => ['html' => $sContent, 'options' => ['closeOnOuterClick' => false]]]; + } + + /** + * Data for Notifications module + */ + public function serviceGetNotificationsData() + { + $sModule = $this->_aModule['name']; + + $aSettingsTypes = ['follow_member', 'follow_context']; + if($this->serviceActAsProfile()) + $aSettingsTypes = ['personal', 'follow_member']; + + return [ + 'handlers' => [ + ['group' => $sModule . '_vote', 'type' => 'insert', 'alert_unit' => $sModule, 'alert_action' => 'doVote', 'module_name' => $sModule, 'module_method' => 'get_notifications_vote', 'module_class' => 'Module'], + ['group' => $sModule . '_vote', 'type' => 'delete', 'alert_unit' => $sModule, 'alert_action' => 'undoVote'], + + ['group' => $sModule . '_score_up', 'type' => 'insert', 'alert_unit' => $sModule, 'alert_action' => 'doVoteUp', 'module_name' => $sModule, 'module_method' => 'get_notifications_score_up', 'module_class' => 'Module'], + + ['group' => $sModule . '_score_down', 'type' => 'insert', 'alert_unit' => $sModule, 'alert_action' => 'doVoteDown', 'module_name' => $sModule, 'module_method' => 'get_notifications_score_down', 'module_class' => 'Module'], + + ['group' => $sModule . '_fan_added', 'type' => 'insert', 'alert_unit' => $sModule, 'alert_action' => 'fan_added', 'module_name' => $sModule, 'module_method' => 'get_notifications_fan_added', 'module_class' => 'Module'], + + ['group' => $sModule . '_join_invitation', 'type' => 'insert', 'alert_unit' => $sModule, 'alert_action' => 'join_invitation_notif', 'module_name' => $sModule, 'module_method' => 'get_notifications_join_invitation', 'module_class' => 'Module'], + + ['group' => $sModule . '_join_request', 'type' => 'insert', 'alert_unit' => $sModule, 'alert_action' => 'join_request', 'module_name' => $sModule, 'module_method' => 'get_notifications_join_request', 'module_class' => 'Module', 'module_event_privacy' => $this->_oConfig->CNF['OBJECT_PRIVACY_VIEW_NOTIFICATION_EVENT']], + + ['group' => $sModule . '_timeline_post_common', 'type' => 'insert', 'alert_unit' => $sModule, 'alert_action' => 'timeline_post_common', 'module_name' => $sModule, 'module_method' => 'get_notifications_timeline_post_common', 'module_class' => 'Module'], + + //--- Moderation related: For 'admins'. + ['group' => $sModule . '_object_pending_approval', 'type' => 'insert', 'alert_unit' => $sModule, 'alert_action' => 'pending_approval', 'module_name' => $sModule, 'module_method' => 'get_notifications_post_pending_approval', 'module_class' => 'Module'], + ], + 'settings' => [ + ['group' => 'vote', 'unit' => $sModule, 'action' => 'doVote', 'types' => $aSettingsTypes], + + ['group' => 'score_up', 'unit' => $sModule, 'action' => 'doVoteUp', 'types' => $aSettingsTypes], + + ['group' => 'score_down', 'unit' => $sModule, 'action' => 'doVoteDown', 'types' => $aSettingsTypes], + + ['group' => 'fan', 'unit' => $sModule, 'action' => 'fan_added', 'types' => $aSettingsTypes], + + ['group' => 'invite', 'unit' => $sModule, 'action' => 'join_invitation_notif', 'types' => ['personal']], + + ['group' => 'join', 'unit' => $sModule, 'action' => 'join_request', 'types' => $aSettingsTypes], + + ['group' => 'timeline_post', 'unit' => $sModule, 'action' => 'timeline_post_common', 'types' => $aSettingsTypes], + + //--- Moderation related: For 'admins'. + ['group' => 'action_required', 'unit' => $sModule, 'action' => 'pending_approval', 'types' => ['personal']], + ], + 'alerts' => [ + ['unit' => $sModule, 'action' => 'doVote'], + ['unit' => $sModule, 'action' => 'undoVote'], + + ['unit' => $sModule, 'action' => 'doVoteUp'], + ['unit' => $sModule, 'action' => 'doVoteDown'], + + ['unit' => $sModule, 'action' => 'fan_added'], + + ['unit' => $sModule, 'action' => 'join_invitation_notif'], + + ['unit' => $sModule, 'action' => 'join_request'], + + ['unit' => $sModule, 'action' => 'timeline_post_common'], + + //--- Moderation related: For 'admins'. + ['unit' => $sModule, 'action' => 'pending_approval'], + ] + ]; + } + + public function serviceGetNotificationsInsertData($oAlert, $aHandler, $aDataItems) + { + if($oAlert->sAction != 'join_invitation_notif' || empty($aDataItems) || !is_array($aDataItems)) + return $aDataItems; + + foreach($aDataItems as $iIndex => $aDataItem) + $aDataItems[$iIndex]['object_privacy_view'] = BX_DOL_PG_ALL; + + return $aDataItems; + } + + /** + * Notification about new invitation to join the group + */ + public function serviceGetNotificationsJoinInvitation($aEvent) + { + $CNF = &$this->_oConfig->CNF; + + $iContentId = (int)$aEvent['object_id']; + $oGroupProfile = BxDolProfile::getInstanceByContentAndType((int)$iContentId, $this->getName()); + if(!$oGroupProfile) + return array(); + + $aContentInfo = $this->_oDb->getContentInfoById($iContentId); + if(empty($aContentInfo) || !is_array($aContentInfo)) + return array(); + + /* + * It's essential that 'object_owner_id' contains invited member profile id. + */ + $oProfile = BxDolProfile::getInstance((int)$aEvent['object_owner_id']); + if(!$oProfile) + return array(); + + /* + * Note. Group Profile URL is used for both Entry and Subentry URLs, + * because Subentry URL has higher display priority and notification + * should be linked to Group Profile (Group Profile -> Members tab) + * instead of Personal Profile of invited member. + */ + $sEntryUrl = bx_absolute_url(str_replace(BX_DOL_URL_ROOT, '', $oGroupProfile->getUrl()), '{bx_url_root}'); + + return array( + 'entry_sample' => $CNF['T']['txt_sample_single'], + 'entry_url' => $sEntryUrl, + 'entry_caption' => $oGroupProfile->getDisplayName(), + 'subentry_sample' => $oProfile->getDisplayName(), + 'subentry_url' => $sEntryUrl, + 'lang_key' => $this->_oConfig->CNF['T']['txt_ntfs_join_invitation'] + ); + } + + /** + * Notification about new member requst in the group + */ + public function serviceGetNotificationsJoinRequest($aEvent) + { + return $this->_serviceGetNotification($aEvent, 'join_request', $this->_oConfig->CNF['T']['txt_ntfs_join_request']); + } + + /** + * Notification about new member in the group + */ + public function serviceGetNotificationsFanAdded($aEvent) + { + return $this->_serviceGetNotification($aEvent, 'fan_added', $this->_oConfig->CNF['T']['txt_ntfs_fan_added']); + } + + protected function _serviceGetNotification($aEvent, $sType, $sLangKey) + { + $CNF = &$this->_oConfig->CNF; + + $iContentId = (int)$aEvent['object_id']; + $oGroupProfile = BxDolProfile::getInstanceByContentAndType((int)$iContentId, $this->getName()); + if(!$oGroupProfile) + return array(); + + $aContentInfo = $this->_oDb->getContentInfoById($iContentId); + if(empty($aContentInfo) || !is_array($aContentInfo)) + return array(); + + $oProfile = BxDolProfile::getInstance((int)$aEvent['subobject_id']); + if(!$oProfile) + return array(); + + $iGroupProfileId = $oGroupProfile->id(); + + /* + * Note. Group Profile URL is used for both Entry and Subentry URLs, + * because Subentry URL has higher display priority and notification + * should be linked to Group Profile (Group Profile -> Members tab or Manage page) + * instead of Personal Profile of a member, who performed an action. + */ + if($sType == 'join_request' && !empty($CNF['URL_ENTRY_MANAGE'])) + $sEntryUrl = bx_absolute_url(BxDolPermalinks::getInstance()->permalink($CNF['URL_ENTRY_MANAGE'], [ + 'profile_id' => $iGroupProfileId + ]), '{bx_url_root}'); + else if(!empty($CNF['URL_ENTRY_FANS'])) + $sEntryUrl = bx_absolute_url(BxDolPermalinks::getInstance()->permalink($CNF['URL_ENTRY_FANS'], [ + 'profile_id' => $iGroupProfileId + ]), '{bx_url_root}'); + else + $sEntryUrl = bx_absolute_url(str_replace(BX_DOL_URL_ROOT, '', $oGroupProfile->getUrl()), '{bx_url_root}'); + + return [ + 'entry_sample' => $CNF['T']['txt_sample_single'], + 'entry_url' => $sEntryUrl, + 'entry_caption' => $oGroupProfile->getDisplayName(), + 'entry_author' => $iGroupProfileId, + 'subentry_sample' => $oProfile->getDisplayName(), + 'subentry_url' => $sEntryUrl, + 'lang_key' => $sLangKey + ]; + } + + /** + * Data for Timeline module + */ + public function serviceGetTimelineData() + { + $aResult = BxBaseModGeneralModule::serviceGetTimelineData(); + + $sModule = $this->_aModule['name']; + $aResult['handlers'] = array_merge($aResult['handlers'], [ + ['group' => $sModule . '_object', 'type' => 'update', 'alert_unit' => $sModule, 'alert_action' => 'context_cover_changed'], + ['group' => $sModule . '_object', 'type' => 'update', 'alert_unit' => $sModule, 'alert_action' => 'context_cover_deleted'] + ]); + $aResult['alerts'] = array_merge($aResult['alerts'], [ + ['unit' => $sModule, 'action' => 'context_cover_changed'], + ['unit' => $sModule, 'action' => 'context_cover_deleted'] + ]); + + return $aResult; + } + + /** + * Entry post for Timeline module + */ + public function serviceGetTimelinePost($aEvent, $aBrowseParams = array()) + { + $CNF = &$this->_oConfig->CNF; + + $a = parent::serviceGetTimelinePost($aEvent, $aBrowseParams); + if($a === false) + return false; + + $oGroupProfile = BxDolProfile::getInstanceByContentAndType($aEvent['object_id'], $this->getName()); + $a['content']['url'] = $oGroupProfile->getUrl(); + $a['content']['title'] = $oGroupProfile->getDisplayName(); + + $oConnection = BxDolConnection::getObjectInstance($CNF['OBJECT_CONNECTIONS']); + if($oConnection) + $a['content']['members'] = $oConnection->getConnectedInitiatorsCount($oGroupProfile->id(), true); + + if(isset($aEvent['object_privacy_view'])) + $a['content']['visibility'] = $aEvent['object_privacy_view']; + + if(isset($CNF['FIELD_PUBLISHED'])) { + $aContentInfo = $this->_oDb->getContentInfoById($aEvent['object_id']); + if($aContentInfo[$CNF['FIELD_PUBLISHED']] > $a['date']) + $a['date'] = $aContentInfo[$CNF['FIELD_PUBLISHED']]; + } + + return $a; + } + + + // ====== PERMISSION METHODS + /** + * @return CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. + */ + public function checkAllowedUsePaidJoin($isPerformAction = false) + { + // check ACL + $aCheck = checkActionModule($this->_iProfileId, 'use paid join', $this->getName(), $isPerformAction); + if($aCheck[CHECK_ACTION_RESULT] !== CHECK_ACTION_RESULT_ALLOWED) + return $aCheck[CHECK_ACTION_MESSAGE]; + + return CHECK_ACTION_RESULT_ALLOWED; + } + + /** + * @return CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. + */ + public function checkAllowedView ($aDataEntry, $isPerformAction = false) + { + return $this->serviceCheckAllowedViewForProfile ($aDataEntry, $isPerformAction); + } + + public function serviceCheckAllowedViewForProfile ($aDataEntry, $isPerformAction = false, $iProfileId = false) + { + $CNF = &$this->_oConfig->CNF; + + $iGroupContentId = (int)$aDataEntry[$CNF['FIELD_ID']]; + + $bInvited = false; + if(!empty($CNF['TABLE_INVITES'])) { + $iGroupProfileId = BxDolProfile::getInstanceByContentAndType($iGroupContentId, $this->getName())->id(); + + if(($sKey = bx_get('key')) !== false) { + $mixedInvited = $this->isInvited($sKey, $iGroupProfileId); + if($mixedInvited === true) + $bInvited = true; + } + else { + $mixedInvited = $this->isInvitedByProfileId($iProfileId ? $iProfileId : bx_get_logged_profile_id(), $iGroupProfileId); + if($mixedInvited === true) + $bInvited = true; + } + } + + if ($this->isFan($iGroupContentId, $iProfileId) || $bInvited) + return CHECK_ACTION_RESULT_ALLOWED; + + return parent::serviceCheckAllowedViewForProfile ($aDataEntry, $isPerformAction, $iProfileId); + } + + /** + * @return CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. + */ + public function checkAllowedCompose(&$aDataEntry, $isPerformAction = false) + { + if(!$this->isFan($aDataEntry[$this->_oConfig->CNF['FIELD_ID']])) + return _t('_sys_txt_access_denied'); + + return parent::checkAllowedCompose ($aDataEntry, $isPerformAction); + } + + /** + * @return CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. + */ + public function checkAllowedFanAdd(&$aDataEntry, $isPerformAction = false) + { + $mixedResult = $this->_modGroupsCheckAllowedFanAdd($aDataEntry, $isPerformAction); + + /** + * @hooks + * @hookdef hook-system-check_allowed_fan_add 'system', 'check_allowed_fan_add' - hook to override the result of checking whether 'fan add' to context action is allowed or not to currently logged in user + * - $unit_name - equals `system` + * - $action - equals `check_allowed_fan_add` + * - $object_id - not used + * - $sender_id - not used + * - $extra_params - array of additional params with the following array keys: + * - `module` - [string] module name + * - `content_info` - [array] context info array as key&value pairs + * - `profile_id` - [int] currently logged in profile id to be checked the availability of the action to + * - `override_result` - [string] or [int] by ref, check action result, can be overridden in hook processing. Return string with an error if action isn't allowed or CHECK_ACTION_RESULT_ALLOWED, @see BxDolAcl + * @hook @ref hook-system-check_allowed_fan_add + */ + bx_alert('system', 'check_allowed_fan_add', 0, 0, [ + 'module' => $this->getName(), + 'content_info' => $aDataEntry, + 'profile_id' => bx_get_logged_profile_id(), + 'override_result' => &$mixedResult + ]); + + return $mixedResult; + } + + public function _modGroupsCheckAllowedFanAdd (&$aDataEntry, $isPerformAction = false) + { + if ($this->isFan($aDataEntry[$this->_oConfig->CNF['FIELD_ID']]) || !isLogged()) + return _t('_sys_txt_access_denied'); + + return $this->_checkAllowedConnect ($aDataEntry, $isPerformAction, $this->_oConfig->CNF['OBJECT_CONNECTIONS'], false, false); + } + + /** + * @return CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. + */ + public function checkAllowedFanRemove (&$aDataEntry, $isPerformAction = false) + { + if (CHECK_ACTION_RESULT_ALLOWED === $this->_checkAllowedConnect ($aDataEntry, $isPerformAction, $this->_oConfig->CNF['OBJECT_CONNECTIONS'], false, true, true)) + return CHECK_ACTION_RESULT_ALLOWED; + return $this->_checkAllowedConnect ($aDataEntry, $isPerformAction, $this->_oConfig->CNF['OBJECT_CONNECTIONS'], false, true, false); + } + + protected function _checkAllowedActionByFan($sAction, $aDataEntry, $iProfileId = 0) + { + $CNF = &$this->_oConfig->CNF; + + $bRoles = $this->_oConfig->isRoles(); + if(empty($iProfileId)) + $iProfileId = bx_get_logged_profile_id(); + + $oGroupProfile = BxDolProfile::getInstanceByContentAndType($aDataEntry[$CNF['FIELD_ID']], $this->getName()); + if(!$oGroupProfile) + return $sAction == BX_BASE_MOD_GROUPS_ACTION_DELETE ? CHECK_ACTION_RESULT_ALLOWED : _t('_sys_txt_not_found'); + + $iGroupProfileId = $oGroupProfile->id(); + + if(!$bRoles && $this->_oDb->isAdmin($iGroupProfileId, $iProfileId, $aDataEntry)) + return CHECK_ACTION_RESULT_ALLOWED; + + if($bRoles && $this->isAllowedActionByRole($sAction, $aDataEntry, $iGroupProfileId, $iProfileId)) + return CHECK_ACTION_RESULT_ALLOWED; + + return _t('_sys_txt_access_denied'); + } + + public function isAllowedActionByRole($mAction, $aDataEntry, $iGroupProfileId, $iProfileId) + { + $iProfileRole = $this->_oDb->getRole($iGroupProfileId, $iProfileId); + + if (is_array($mAction)) { + $sAction = $mAction['action']; + $sActionModule = $mAction['module']; + } else { + $sAction = $mAction; + $sActionModule = $this->getName(); + } + + $bResult = false; + if($iProfileId) + $bResult = $this->isAllowedModuleActionByRole($sActionModule, $sAction, $iProfileRole); + + // in case neither of the profile's roles are having permissions set explicitly then fallback to an old way + if ($bResult === NULL) { + $bResult = false; + if($this->isFanByGroupProfileId($iGroupProfileId)) { + switch ($sAction) { + case BX_BASE_MOD_GROUPS_ACTION_DELETE: + case BX_BASE_MOD_GROUPS_ACTION_EDIT: + case BX_BASE_MOD_GROUPS_ACTION_CHANGE_COVER: + case BX_BASE_MOD_GROUPS_ACTION_MANAGE_ROLES: + if($this->isRole($iProfileRole, BX_BASE_MOD_GROUPS_ROLE_ADMINISTRATOR)) + $bResult = true; + break; + + case BX_BASE_MOD_GROUPS_ACTION_MANAGE_FANS: + case BX_BASE_MOD_GROUPS_ACTION_INVITE: + case BX_BASE_MOD_GROUPS_ACTION_EDIT_CONTENT: + case BX_BASE_MOD_GROUPS_ACTION_DELETE_CONTENT: + case BX_BASE_MOD_GROUPS_ACTION_TIMELINE_POST_PIN: + if($this->isRole($iProfileRole, BX_BASE_MOD_GROUPS_ROLE_ADMINISTRATOR) || $this->isRole($iProfileRole, BX_BASE_MOD_GROUPS_ROLE_MODERATOR)) + $bResult = true; + break; + + default: + $bResult = true; + } + } + } + + /** + * @hooks + * @hookdef hook-system-check_allowed_action_by_role 'system', 'check_allowed_action_by_role' - hook to override the result of checking whether an action is allowed or not to context member by his role in the context + * - $unit_name - equals `system` + * - $action - equals `check_allowed_action_by_role` + * - $object_id - not used + * - $sender_id - not used + * - $extra_params - array of additional params with the following array keys: + * - `module` - [string] module name + * - `multi_roles` - [boolean] whether multi roles are enabled in context or not + * - `action` - [string] action to be checked + * - `action_module` - [string] module name which the action belongs to + * - `content_profile_id` - [int] context profile id + * - `content_info` - [array] context info array as key&value pairs + * - `profile_id` - [int] profile id to be checked the availability of the action to + * - `profile_role` - [int] profile role in the context + * - `override_result` - [boolean] by ref, check action result, can be overridden in hook processing. + * @hook @ref hook-system-check_allowed_action_by_role + */ + bx_alert('system', 'check_allowed_action_by_role', 0, 0, [ + 'module' => $this->getName(), + 'multi_roles' => $this->_oConfig->isMultiRoles(), + 'action' => $sAction, + 'action_module' => $sActionModule, + 'content_profile_id' => $iGroupProfileId, + 'content_info' => $aDataEntry, + 'profile_id' => $iProfileId, + 'profile_role' => $iProfileRole, + 'override_result' => &$bResult + ]); + + return $bResult; + } + + public function isAllowedModuleActionByRole($sModule, $sAction, $iProfileRole) + { + static $aRoles; + + if (!$aRoles && isset($this->_oConfig->CNF['OBJECT_PRE_LIST_ROLES']) && !empty($this->_oConfig->CNF['OBJECT_PRE_LIST_ROLES'])) + $aRoles = BxBaseFormView::getDataItems($this->_oConfig->CNF['OBJECT_PRE_LIST_ROLES'], true, BX_DATA_VALUES_ALL); + + if ($aRoles) { + foreach ($aRoles as $iRole => $aRoleData) { + if ($iRole == 0 && $iProfileRole == 0 || $iRole > 0 && $this->isRole($iProfileRole, $iRole)) { + $mPermissions = isset($aRoles[$iRole]) && isset($aRoles[$iRole]['Data']) && !empty($aRoles[$iRole]['Data']) ? unserialize($aRoles[$iRole]['Data']) : false; + if ($mPermissions && isset($mPermissions[$sModule])) { + return isset($mPermissions[$sModule][$sAction]) && $mPermissions[$sModule][$sAction]; + } + } + } + } + + return NULL; + } + + public function isAllowedModuleActionByProfile($iContentId, $sPostModule, $sAction, $iProfileId = 0) { + if (!$iProfileId) $iProfileId = bx_get_logged_profile_id(); + + if ($iProfileId && $this->isFan($iContentId, $iProfileId)) { + $sModuleName = $this->getName(); + $oGroupProfile = BxDolProfile::getInstanceByContentAndType($iContentId, $sModuleName); + $aDataEntry = $this->_oDb->getContentInfoById($iContentId); + $bResult = $this->isAllowedActionByRole(['action' => $sAction, 'module' => $sPostModule], $aDataEntry, $oGroupProfile->id(), $iProfileId); + + if ($bResult === true) return CHECK_ACTION_RESULT_ALLOWED; + if ($bResult === false) return _t('_sys_txt_access_denied'); + } + + return NULL; //undefined, because the profile is either not a fan or his role is not having permissions defined. So process the default way then. + } + + public function isRole($iProfileRole, $iRole) + { + if(!$this->_oConfig->isMultiRoles()) + return $iProfileRole == $iRole; + else + return $iProfileRole & (1 << ($iRole - 1)); + } + + public function serviceIsRole($iProfileRole, $iRole) + { + return $this->isRole($iProfileRole, $iRole); + } + + public function checkAllowedManageFans($mixedDataEntry, $isPerformAction = false) + { + $aDataEntry = array(); + if(!is_array($mixedDataEntry)) { + $oGroupProfile = BxDolProfile::getInstance((int)$mixedDataEntry); + if($oGroupProfile && $this->getName() == $oGroupProfile->getModule()) + $aDataEntry = $this->_oDb->getContentInfoById($oGroupProfile->getContentId()); + } + else + $aDataEntry = $mixedDataEntry; + + if($this->_checkAllowedActionByFan(BX_BASE_MOD_GROUPS_ACTION_MANAGE_FANS, $aDataEntry) === CHECK_ACTION_RESULT_ALLOWED) + return CHECK_ACTION_RESULT_ALLOWED; + + return parent::checkAllowedEdit($aDataEntry, $isPerformAction); + } + + public function checkAllowedManageAdmins($mixedDataEntry, $isPerformAction = false) + { + $aDataEntry = array(); + if(!is_array($mixedDataEntry)) { + $oGroupProfile = BxDolProfile::getInstance((int)$mixedDataEntry); + if($oGroupProfile && $this->getName() == $oGroupProfile->getModule()) + $aDataEntry = $this->_oDb->getContentInfoById($oGroupProfile->getContentId()); + } + else + $aDataEntry = $mixedDataEntry; + + if($this->_checkAllowedActionByFan(BX_BASE_MOD_GROUPS_ACTION_MANAGE_ROLES, $aDataEntry) === CHECK_ACTION_RESULT_ALLOWED) + return CHECK_ACTION_RESULT_ALLOWED; + + return parent::checkAllowedEdit($aDataEntry, $isPerformAction); + } + + public function checkAllowedEdit($aDataEntry, $isPerformAction = false) + { + if($this->_checkAllowedActionByFan(BX_BASE_MOD_GROUPS_ACTION_EDIT, $aDataEntry) === CHECK_ACTION_RESULT_ALLOWED) + return CHECK_ACTION_RESULT_ALLOWED; + + return parent::checkAllowedEdit($aDataEntry, $isPerformAction); + } + + public function checkAllowedInvite($aDataEntry, $isPerformAction = false) + { + if($this->_checkAllowedActionByFan(BX_BASE_MOD_GROUPS_ACTION_INVITE, $aDataEntry) === CHECK_ACTION_RESULT_ALLOWED) + return CHECK_ACTION_RESULT_ALLOWED; + + return parent::checkAllowedEdit($aDataEntry, $isPerformAction); + } + + public function checkAllowedChangeCover($aDataEntry, $isPerformAction = false) + { + if($this->_checkAllowedActionByFan(BX_BASE_MOD_GROUPS_ACTION_CHANGE_COVER, $aDataEntry) === CHECK_ACTION_RESULT_ALLOWED) + return CHECK_ACTION_RESULT_ALLOWED; + + return parent::checkAllowedChangeCover($aDataEntry, $isPerformAction); + } + + public function checkAllowedDelete(&$aDataEntry, $isPerformAction = false) + { + if($this->_checkAllowedActionByFan(BX_BASE_MOD_GROUPS_ACTION_DELETE, $aDataEntry) === CHECK_ACTION_RESULT_ALLOWED) + return CHECK_ACTION_RESULT_ALLOWED; + + return parent::checkAllowedDelete($aDataEntry, $isPerformAction); + } + + public function checkAllowedJoin(&$aDataEntry, $isPerformAction = false) + { + if (bx_get('key')){ + $sKey = bx_get('key'); + $oGroupProfile = BxDolProfile::getInstanceByContentAndType($aDataEntry[$this->_oConfig->CNF['FIELD_ID']], $this->getName()); + $aData = $this->_oDb->getInviteByKey($sKey, $oGroupProfile->id()); + if (isset($aData['invited_profile_id']) && $aData['invited_profile_id'] == bx_get_logged_profile_id()){ + return CHECK_ACTION_RESULT_ALLOWED; + } + } + return _t('_sys_txt_access_denied'); + } + + public function checkAllowedSubscribeAdd(&$aDataEntry, $isPerformAction = false) + { + $mixedResult = $this->_modGroupsCheckAllowedSubscribeAdd($aDataEntry, $isPerformAction); + + /** + * @hooks + * @hookdef hook-system-check_allowed_subscribe_add 'system', 'check_allowed_subscribe_add' - hook to override the result of checking whether currently logged in user can subscribe (follow) the context or not + * - $unit_name - equals `system` + * - $action - equals `check_allowed_subscribe_add` + * - $object_id - not used + * - $sender_id - not used + * - $extra_params - array of additional params with the following array keys: + * - `module` - [string] module name + * - `content_info` - [array] context info array as key&value pairs + * - `profile_id` - [int] currently logged in profile id to be checked the availability of the action to + * - `override_result` - [string] or [int] by ref, check action result, can be overridden in hook processing. Return string with an error if action isn't allowed or CHECK_ACTION_RESULT_ALLOWED, @see BxDolAcl + * @hook @ref hook-system-check_allowed_subscribe_add + */ + bx_alert('system', 'check_allowed_subscribe_add', 0, 0, [ + 'module' => $this->getName(), + 'content_info' => $aDataEntry, + 'profile_id' => bx_get_logged_profile_id(), + 'override_result' => &$mixedResult + ]); + + return $mixedResult; + } + + /** + * Note. Is mainly needed for internal usage. Access level is 'public' to allow outer calls from alerts. + */ + public function _modGroupsCheckAllowedSubscribeAdd(&$aDataEntry, $isPerformAction = false) + { + $CNF = &$this->_oConfig->CNF; + + if(!$this->isFan($aDataEntry[$CNF['FIELD_ID']]) && (!isset($CNF['PARAM_SBS_WO_JOIN']) || getParam($CNF['PARAM_SBS_WO_JOIN']) != 'on')) + return _t('_sys_txt_access_denied'); + + return parent::_modProfileCheckAllowedSubscribeAdd($aDataEntry, $isPerformAction); + } + + /** + * @deprecated since version 11.0.3 and can be removed in the next version. + */ + public function _checkAllowedSubscribeAdd (&$aDataEntry, $isPerformAction = false) + { + return parent::checkAllowedSubscribeAdd ($aDataEntry, $isPerformAction); + } + + public function doAudit($iGroupProfileId, $iFanId, $sAction) + { + $oProfile = BxDolProfile::getInstance($iFanId); + + $iContentId = $oProfile->getContentId(); + $sModule = $oProfile->getModule(); + $oModule = BxDolModule::getInstance($sModule); + if (BxDolRequest::serviceExists($sModule, 'act_as_profile') && BxDolService::call($sModule, 'act_as_profile') && $oModule->_oConfig){ + $CNF = $oModule->_oConfig->CNF; + + $aContentInfo = BxDolRequest::serviceExists($sModule, 'get_all') ? BxDolService::call($sModule, 'get_all', array(array('type' => 'id', 'id' => $iContentId))) : array(); + + $AuditParams = array( + 'content_title' => (isset($CNF['FIELD_TITLE']) && isset($aContentInfo[$CNF['FIELD_TITLE']])) ? $aContentInfo[$CNF['FIELD_TITLE']] : '', + 'context_profile_id' => $iGroupProfileId, + 'context_profile_title' => BxDolProfile::getInstance($iGroupProfileId)->getDisplayName() + ); + + bx_audit( + $iContentId, + $sModule, + $sAction, + $AuditParams + ); + } + } + + protected function _checkAllowedConnect (&$aDataEntry, $isPerformAction, $sObjConnection, $isMutual, $isInvertResult, $isSwap = false) + { + $sResult = $this->checkAllowedView($aDataEntry); + + $oPrivacy = BxDolPrivacy::getObjectInstance($this->_oConfig->CNF['OBJECT_PRIVACY_VIEW']); + + // if profile view isn't allowed but visibility is in partially visible groups + // then display buttons to connect (befriend, join) to profile, + // if other conditions (in parent::_checkAllowedConnect) are met as well + if (CHECK_ACTION_RESULT_ALLOWED !== $sResult && !in_array($aDataEntry[$this->_oConfig->CNF['FIELD_ALLOW_VIEW_TO']], array_merge($oPrivacy->getPartiallyVisiblePrivacyGroups(), array('s')))) + return $sResult; + + return parent::_checkAllowedConnect ($aDataEntry, $isPerformAction, $sObjConnection, $isMutual, $isInvertResult, $isSwap); + } + + + // ====== COMMON METHODS + public function onUpdateImage($iContentId, $sFiledName, $sFiledValue, $iProfileId = 0) + { + $CNF = &$this->_oConfig->CNF; + + $aContentInfo = $this->_oDb->getContentInfoById($iContentId); + + $aField2Method = [ + $CNF['FIELD_PICTURE'] => 'picture', + $CNF['FIELD_COVER'] => 'cover', + ]; + + if(!empty($aField2Method[$sFiledName])) + /** + * @hooks + * @hookdef hook-bx_base_groups-context_picture_changed '{module_name}', 'context_picture_changed' - hook after context picture was changed + * - $unit_name - module name + * - $action - equals `context_picture_changed` + * - $object_id - context id + * - $sender_id - profile id who performed the action + * - $extra_params - array of additional params with the following array keys: + * - `status` - [string] context status + * - `status_admin` - [string] context admin status + * - `privacy_view` - [int] or [string] privacy for view context action, @see BxDolPrivacy + * - `cf` - [int] context's audience filter value + * @hook @ref hook-bx_base_groups-context_picture_changed + */ + /** + * @hooks + * @hookdef hook-bx_base_groups-context_cover_changed '{module_name}', 'context_cover_changed' - hook after context cover was changed + * It's equivalent to @ref hook-bx_base_groups-context_picture_changed + * @hook @ref hook-bx_base_groups-context_cover_changed + */ + bx_alert($this->getName(), 'context_' . $aField2Method[$sFiledName] . '_changed', $iContentId, $iProfileId, $this->_alertParams($aContentInfo)); + } + + protected function _alertParams($aContentInfo) + { + $aParams = parent::_alertParams($aContentInfo); + + $CNF = &$this->_oConfig->CNF; + + if(!empty($CNF['FIELD_CF']) && isset($aContentInfo[$CNF['FIELD_CF']])) + $aParams['cf'] = $aContentInfo[$CNF['FIELD_CF']]; + + return $aParams; + } + + public function alertAfterAdd($aContentInfo) + { + $CNF = &$this->_oConfig->CNF; + + $iId = (int)$aContentInfo[$CNF['FIELD_ID']]; + $iAuthorId = (int)$aContentInfo[$CNF['FIELD_AUTHOR']]; + + $sAction = 'added'; + if(isset($CNF['FIELD_STATUS_ADMIN']) && isset($aContentInfo[$CNF['FIELD_STATUS_ADMIN']]) && $aContentInfo[$CNF['FIELD_STATUS_ADMIN']] == BX_BASE_MOD_GENERAL_STATUS_PENDING) + $sAction = 'deferred'; + + $sModule = $this->getName(); + $aParams = $this->_alertParams($aContentInfo); + /** + * @hooks + * @hookdef hook-system-prepare_alert_params 'system', 'prepare_alert_params' - hook to override alert (hook) params + * - $unit_name - equals `system` + * - $action - equals `prepare_alert_params` + * - $object_id - not used + * - $sender_id - not used + * - $extra_params - array of additional params with the following array keys: + * - `unit` - [string] unit name + * - `action` - [string] by ref, action, can be overridden in hook processing + * - `object_id` - [int] by ref, object id, can be overridden in hook processing + * - `sender_id` - [int] by ref, action performer profile id, can be overridden in hook processing + * - `extras` - [array] by ref, extra params array as key&value pairs, can be overridden in hook processing + * @hook @ref hook-system-prepare_alert_params + */ + bx_alert('system', 'prepare_alert_params', 0, 0, [ + 'unit'=> $sModule, + 'action' => &$sAction, + 'object_id' => &$iId, + 'sender_id' => &$iAuthorId, + 'extras' => &$aParams + ]); + /** + * @hooks + * @hookdef hook-bx_base_groups-added '{module_name}', 'added' - hook after context was added (published) + * - $unit_name - module name + * - $action - equals `added` + * - $object_id - context id + * - $sender_id - not used + * - $extra_params - array of additional params with the following array keys: + * - `status` - [string] context status + * - `status_admin` - [string] context admin status + * - `privacy_view` - [int] or [string] privacy for view context action, @see BxDolPrivacy + * - `cf` - [int] context's audience filter value + * @hook @ref hook-bx_base_groups-added + */ + /** + * @hooks + * @hookdef hook-bx_base_groups-deferred '{module_name}', 'deferred' - hook after context was added with pending approval status + * It's equivalent to @ref hook-bx_base_groups-added + * @hook @ref hook-bx_base_groups-deferred + */ + bx_alert($sModule, $sAction, $iId, false, $aParams); + + $this->_processModerationNotifications($aContentInfo); + } + + public function addFollower ($iProfileId1, $iProfileId2) + { + $oConnectionFollow = BxDolConnection::getObjectInstance('sys_profiles_subscriptions'); + if($oConnectionFollow && !$oConnectionFollow->isConnected($iProfileId1, $iProfileId2)){ + $oConnectionFollow->addConnection($iProfileId1, $iProfileId2); + return true; + } + return false; + } + + public function isFan ($iContentId, $iProfileId = false) + { + $CNF = &$this->_oConfig->CNF; + + $oGroupProfile = BxDolProfile::getInstanceByContentAndType($iContentId, $this->getName()); + if($oGroupProfile && isset($CNF['OBJECT_CONNECTIONS'])) + return ($oConnection = BxDolConnection::getObjectInstance($CNF['OBJECT_CONNECTIONS'])) && $oConnection->isConnected($iProfileId ? $iProfileId : bx_get_logged_profile_id(), $oGroupProfile->id(), true); + + return false; + } + + public function isFanByGroupProfileId ($iGroupProfileId, $iProfileId = false) + { + $CNF = &$this->_oConfig->CNF; + + $oGroupProfile = BxDolProfile::getInstance($iGroupProfileId); + if($oGroupProfile && isset($CNF['OBJECT_CONNECTIONS'])) + return ($oConnection = BxDolConnection::getObjectInstance($CNF['OBJECT_CONNECTIONS'])) && $oConnection->isConnected($iProfileId ? $iProfileId : bx_get_logged_profile_id(), $oGroupProfile->id(), true); + + return false; + } + + public function isInvited ($sKey, $iGroupProfileId) + { + $CNF = &$this->_oConfig->CNF; + $aData = $this->_oDb->getInviteByKey($sKey, $iGroupProfileId); + if (!isset($aData['invited_profile_id'])) + return _t($CNF['T']['txt_invitation_popup_error_invitation_absent']); + + if ($aData['invited_profile_id'] != bx_get_logged_profile_id()) + return _t($CNF['T']['txt_invitation_popup_error_wrong_user']); + + return true; + } + + public function isInvitedByProfileId ($iProfileId, $iGroupProfileId) + { + $CNF = &$this->_oConfig->CNF; + + $aData = $this->_oDb->getInviteByInvited($iProfileId, $iGroupProfileId); + if (!isset($aData['invited_profile_id'])) + return _t($CNF['T']['txt_invitation_popup_error_invitation_absent']); + + if ($aData['invited_profile_id'] != bx_get_logged_profile_id()) + return _t($CNF['T']['txt_invitation_popup_error_wrong_user']); + + return true; + } + + public function serviceIsInvited($iGroupProfileId, $iProfileId = false, $sKey = '') + { + if(!$iProfileId) + $iProfileId = bx_get_logged_profile_id(); + + if(empty($sKey) && ($sKey = bx_get('key')) !== false) + $sKey = bx_process_input($sKey); + + $mixedInvited = false; + if(!empty($sKey)) + $mixedInvited = $this->isInvited($sKey, $iGroupProfileId); + else if($iProfileId !== false) + $mixedInvited = $this->isInvitedByProfileId($iProfileId, $iGroupProfileId); + + return $mixedInvited === true; + } + + public function serviceIsNotInvited($iGroupProfileId, $iProfileId = false, $sKey = '') + { + return !$this->serviceIsInvited($iGroupProfileId, $iProfileId, $sKey); + } + + public function serviceGetInvitedKey($iGroupProfileId, $iProfileId = false) + { + $sKey = ''; + if(($sKey = bx_get('key')) !== false) + $sKey = bx_process_input($sKey); + + if(!$sKey) { + if(!$iProfileId) + $iProfileId = bx_get_logged_profile_id(); + + if($iProfileId !== false) { + $aInvite = $this->_oDb->getInviteByInvited($iProfileId, $iGroupProfileId); + if(!empty($aInvite) && is_array($aInvite)) + $sKey = $aInvite['key']; + } + } + + return $sKey; + } + + public function getRole($iGroupProfileId, $iFanProfileId) + { + if(!$this->isFanByGroupProfileId($iGroupProfileId, $iFanProfileId)) + return false; + + return $this->_oDb->getRole($iGroupProfileId, $iFanProfileId); + } + + public function setRole($iGroupProfileId, $iFanProfileId, $mixedRole, $mixedPeriod = false, $sOrder = '') + { + $CNF = &$this->_oConfig->CNF; + + if(!isset($CNF['OBJECT_CONNECTIONS'])) + return false; + + $oConnection = BxDolConnection::getObjectInstance($CNF['OBJECT_CONNECTIONS']); + $oGroupProfile = BxDolProfile::getInstance($iGroupProfileId); + if(!$oConnection || !$oGroupProfile) + return false; + + if(!$oConnection->isConnected($iFanProfileId, $iGroupProfileId, true) && !$oConnection->addConnection($iFanProfileId, $iGroupProfileId)) + return false; + + if(!$this->_oDb->setRole($iGroupProfileId, $iFanProfileId, $mixedRole, $mixedPeriod, $sOrder)) + return false; + + $this->onSetRole($iGroupProfileId, $iFanProfileId, $mixedRole); + + return true; + } + + public function onSetRole($iGroupProfileId, $iFanProfileId, $mixedRole) + { + $CNF = &$this->_oConfig->CNF; + + $iProfileId = bx_get_logged_profile_id(); + $oGroupProfile = BxDolProfile::getInstance($iGroupProfileId); + $aGroupProfileInfo = $this->_oDb->getContentInfoById((int)$oGroupProfile->getContentId()); + $aRoles = BxDolFormQuery::getDataItems($CNF['OBJECT_PRE_LIST_ROLES']); + + // notify about admin status + if(!empty($CNF['EMAIL_FAN_SET_ROLE']) && $iFanProfileId != $iProfileId) { + $aSetRoles = is_array($mixedRole) ? $mixedRole : [$mixedRole]; + $aRolesNames = []; + foreach ($aSetRoles as $iRole) + $aRolesNames[] = $aRoles[(int)$iRole]; + + sendMailTemplate($CNF['EMAIL_FAN_SET_ROLE'], 0, $iFanProfileId, array( + 'EntryUrl' => $oGroupProfile->getUrl(), + 'EntryTitle' => $oGroupProfile->getDisplayName(), + 'Role' => implode(', ', $aRolesNames), + ), BX_EMAIL_NOTIFY); + } + + /** + * @hooks + * @hookdef hook-bx_base_groups-set_role '{module_name}', 'set_role' - hook after 'set role' action was applied to context member + * - $unit_name - module name + * - $action - equals `set_role` + * - $object_id - context id + * - $sender_id - context profile id + * - $extra_params - array of additional params with the following array keys: + * - `object_author_id` - [int] context profile id + * - `performer_id` - [int] performer profile id + * - `fan_id` - [int] context member profile id + * - `content` - [array] context info array as key&value pairs + * - `role` - [int] or [array] role or an array of roles to be set + * - `group_profile` - [int] context profile id + * - `profile` - [int] performer profile id + * @hook @ref hook-bx_base_groups-set_role + */ + bx_alert($this->getName(), 'set_role', $aGroupProfileInfo[$CNF['FIELD_ID']], $iGroupProfileId, array( + 'object_author_id' => $iGroupProfileId, + 'performer_id' => $iProfileId, + 'fan_id' => $iFanProfileId, + + 'content' => $aGroupProfileInfo, + 'role' => $mixedRole, + + 'group_profile' => $iGroupProfileId, + 'profile' => $iProfileId + )); + + $this->doAudit($iGroupProfileId, $iFanProfileId, '_sys_audit_action_group_role_changed'); + } + + public function unsetRole($iGroupProfileId, $iFanProfileId) + { + $CNF = &$this->_oConfig->CNF; + + if(!isset($CNF['OBJECT_CONNECTIONS'])) + return false; + + $oConnection = BxDolConnection::getObjectInstance($CNF['OBJECT_CONNECTIONS']); + $oGroupProfile = BxDolProfile::getInstance($iGroupProfileId); + if(!$oConnection || !$oGroupProfile) + return false; + + if($oConnection->isConnected($iFanProfileId, $iGroupProfileId, true) && !$oConnection->removeConnection($iFanProfileId, $iGroupProfileId)) + return false; + + $iRole = $this->_oDb->getRole($iGroupProfileId, $iFanProfileId); + + if(!$this->_oDb->unsetRole($iGroupProfileId, $iFanProfileId)) + return false; + + $this->onUnsetRole($iGroupProfileId, $iFanProfileId, $iRole); + + return true; + } + + public function onUnsetRole($iGroupProfileId, $iFanProfileId, $iRole) + { + $CNF = &$this->_oConfig->CNF; + + $iProfileId = bx_get_logged_profile_id(); + $oGroupProfile = BxDolProfile::getInstance($iGroupProfileId); + $aGroupProfileInfo = $this->_oDb->getContentInfoById((int)$oGroupProfile->getContentId()); + + /** + * @hooks + * @hookdef hook-bx_base_groups-set_role '{module_name}', 'set_role' - hook after 'set role' action was applied to context member + * - $unit_name - module name + * - $action - equals `set_role` + * - $object_id - context id + * - $sender_id - context profile id + * - $extra_params - array of additional params with the following array keys: + * - `object_author_id` - [int] context profile id + * - `performer_id` - [int] performer profile id + * - `fan_id` - [int] context member profile id + * - `content` - [array] context info array as key&value pairs + * - `role` - [int] or [array] role or an array of roles to be set + * - `group_profile` - [int] context profile id + * - `profile` - [int] performer profile id + * @hook @ref hook-bx_base_groups-set_role + */ + bx_alert($this->getName(), 'set_role', $aGroupProfileInfo[$CNF['FIELD_ID']], $iGroupProfileId, array( + 'object_author_id' => $iGroupProfileId, + 'performer_id' => $iProfileId, + 'fan_id' => $iFanProfileId, + + 'content' => $aGroupProfileInfo, + 'role' => $iRole, + + 'group_profile' => $iGroupProfileId, + 'profile' => $iProfileId + )); + + $this->doAudit($iGroupProfileId, $iFanProfileId, '_sys_audit_action_group_role_changed'); + } + + public function getGroupsByFan($iProfileId, $mixedRole = false) + { + $CNF = &$this->_oConfig->CNF; + + if(!isset($CNF['OBJECT_CONNECTIONS'])) + return false; + + if($mixedRole === false) + $mixedRole = BX_BASE_MOD_GROUPS_ROLE_COMMON; + + if(!is_array($mixedRole)) + $mixedRole = [$mixedRole]; + + $aResult = []; + foreach($mixedRole as $iRole) { + switch($iRole) { + case BX_BASE_MOD_GROUPS_ROLE_COMMON: + $aIds = BxDolConnection::getObjectInstance($CNF['OBJECT_CONNECTIONS'])->getConnectedContent($iProfileId); + break; + + default: + $aIds = $this->_oDb->getRoles([ + 'type' => 'group_pids_by_fan_id', + 'fan_id' => $iProfileId, + 'role' => $iRole + ]); + } + + $aResult = array_merge($aResult, $aIds); + } + + return $aResult; + } + + public function getMenuItemTitleByConnection($sConnection, $sAction, $iContentProfileId, $iInitiatorProfileId = 0) + { + $CNF = $this->_oConfig->getCNF(); + + $aResult = parent::getMenuItemTitleByConnection($sConnection, $sAction, $iContentProfileId, $iInitiatorProfileId); + if(!empty($aResult)) + return $aResult; + + $oConnection = BxDolConnection::getObjectInstance($sConnection); + if(!$oConnection) + return false; + + if(!$iInitiatorProfileId) + $iInitiatorProfileId = bx_get_logged_profile_id(); + + $aResult = []; + if($oConnection->isConnectedNotMutual($iInitiatorProfileId, $iContentProfileId)) + $aResult = [ + 'add' => _t(!empty($CNF['T']['menu_item_title_sm_join_requested']) ? $CNF['T']['menu_item_title_sm_join_requested'] : '_sys_menu_item_title_sm_join_requested'), + 'remove' => _t(!empty($CNF['T']['menu_item_title_sm_leave_cancel']) ? $CNF['T']['menu_item_title_sm_leave_cancel'] : '_sys_menu_item_title_sm_leave_cancel'), + ]; + else if($oConnection->isConnectedNotMutual($iContentProfileId, $iInitiatorProfileId)) + $aResult = [ + 'add' => _t(!empty($CNF['T']['menu_item_title_sm_join_confirm']) ? $CNF['T']['menu_item_title_sm_join_confirm'] : '_sys_menu_item_title_sm_join_confirm'), + 'remove' => _t(!empty($CNF['T']['menu_item_title_sm_leave_reject']) ? $CNF['T']['menu_item_title_sm_leave_reject'] : '_sys_menu_item_title_sm_leave_reject'), + ]; + else if($oConnection->isConnected($iInitiatorProfileId, $iContentProfileId, true)) + $aResult = [ + 'add' => '', + 'remove' => _t(!empty($CNF['T']['menu_item_title_sm_leave']) ? $CNF['T']['menu_item_title_sm_leave'] : '_sys_menu_item_title_sm_leave'), + ]; + else + $aResult = [ + 'add' => _t(!empty($CNF['T']['menu_item_title_sm_join']) ? $CNF['T']['menu_item_title_sm_join'] : '_sys_menu_item_title_sm_join'), + 'remove' => '', + ]; + + return !empty($sAction) && isset($aResult[$sAction]) ? $aResult[$sAction] : $aResult; + } + + protected function _getImagesForTimelinePost($aEvent, $aContentInfo, $sUrl, $aBrowseParams = array()) + { + $CNF = &$this->_oConfig->CNF; + + $iImageId = 0; + $sImageMd = $sImageXl = ''; + if(isset($CNF['FIELD_COVER']) && !empty($aContentInfo[$CNF['FIELD_COVER']])) { + $iImageId = (int)$aContentInfo[$CNF['FIELD_COVER']]; + $sImageMd = $this->_oConfig->getImageUrl($iImageId, ['OBJECT_IMAGES_TRANSCODER_GALLERY']); + $sImageXl = $this->_oConfig->getImageUrl($iImageId, ['OBJECT_IMAGES_TRANSCODER_COVER']); + } + + if($sImageXl == '' && isset($CNF['FIELD_PICTURE']) && !empty($aContentInfo[$CNF['FIELD_PICTURE']])) { + $iImageId = (int)$aContentInfo[$CNF['FIELD_PICTURE']]; + $sImageMd = $this->_oConfig->getImageUrl($iImageId, ['OBJECT_IMAGES_TRANSCODER_GALLERY']); + $sImageXl = $this->_oConfig->getImageUrl($iImageId, ['OBJECT_IMAGES_TRANSCODER_COVER']); + } + + if(empty($sImageXl)) + return []; + + $aImage = [ + 'id' => $iImageId, + 'url' => $sUrl, + 'src' => $sImageXl, + 'src_orig' => $sImageXl + ]; + + if(!empty($sImageMd)) + $aImage['src_medium'] = $sImageMd; + + return [ + $aImage + ]; + } + + protected function _prepareProfileAndGroupProfile($iGroupProfileId, $iInitiatorId) + { + if (!($oGroupProfile = BxDolProfile::getInstance($iGroupProfileId))) + return array(0, 0, null); + + if ($oGroupProfile->getModule() == $this->getName()) { + $iProfileId = $iInitiatorId; + $iGroupProfileId = $oGroupProfile->id(); + } else { + $iProfileId = $oGroupProfile->id(); + $iGroupProfileId = $iInitiatorId; + } + + return array($iProfileId, $iGroupProfileId, $oGroupProfile); + } +} + +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/groups/classes/BxBaseModGroupsPageEntry.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/groups/classes/BxBaseModGroupsPageEntry.php new file mode 100644 index 0000000000..4bd3ab23d1 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/groups/classes/BxBaseModGroupsPageEntry.php @@ -0,0 +1,156 @@ +<?php defined('BX_DOL') or die('hack attempt'); +/** + * Copyright (c) UNA, Inc - https://una.io + * MIT License - https://opensource.org/licenses/MIT + * + * @defgroup BaseGroups Base classes for groups modules + * @ingroup UnaModules + * + * @{ + */ + +/** + * Profile create/edit/delete pages. + */ +class BxBaseModGroupsPageEntry extends BxBaseModProfilePageEntry +{ + public function __construct($aObject, $oTemplate = false) + { + parent::__construct($aObject, $oTemplate); + + $CNF = &$this->_oModule->_oConfig->CNF; + + $this->_sCoverClass = 'bx-base-group-cover-wrapper ' . $this->_oModule->getName() . '_cover'; + + $bLoggedOwner = isset($this->_aContentInfo[$CNF['FIELD_AUTHOR']]) && $this->_aContentInfo[$CNF['FIELD_AUTHOR']] == bx_get_logged_profile_id(); + $bLoggedModerator = $this->_oModule->checkAllowedEditAnyEntry() === CHECK_ACTION_RESULT_ALLOWED; + + if(!empty($CNF['FIELD_CF']) && isset($this->_aContentInfo[$CNF['FIELD_CF']])) { + $oCf = BxDolContentFilter::getInstance(); + if($oCf->isEnabled() && !$oCf->isAllowed($this->_aContentInfo[$CNF['FIELD_CF']])) { + $this->setPageCover(false); + return; + } + } + + $aInformers = array (); + $oInformer = BxDolInformer::getInstance($this->_oTemplate); + if($oInformer && ($bLoggedOwner || $bLoggedModerator)) { + $sStatus = isset($CNF['FIELD_STATUS']) && isset($this->_aContentInfo[$CNF['FIELD_STATUS']]) ? $this->_aContentInfo[$CNF['FIELD_STATUS']] : ''; + $sStatusAdmin = isset($CNF['FIELD_STATUS_ADMIN']) && isset($this->_aContentInfo[$CNF['FIELD_STATUS_ADMIN']]) ? $this->_aContentInfo[$CNF['FIELD_STATUS_ADMIN']] : ''; + + //--- Display 'approving' informer. + if(!empty($sStatusAdmin) && $sStatusAdmin != BX_BASE_MOD_GENERAL_STATUS_ACTIVE) { + if(!empty($CNF['INFORMERS']['approving']) && isset($CNF['INFORMERS']['approving']['map'][$sStatusAdmin])) { + $aInformer = $CNF['INFORMERS']['approving']; + $aInformers[] = ['name' => $aInformer['name'], 'msg' => _t($aInformer['map'][$sStatusAdmin]['msg']), 'type' => $aInformer['map'][$sStatusAdmin]['type']]; + } + } + + //--- Display 'scheduled' informer if an item wasn't published yet. + if(isset($CNF['FIELD_PUBLISHED'])) { + if(!empty($CNF['INFORMERS']['scheduled']) && isset($CNF['INFORMERS']['scheduled']['map'][$sStatus])) { + $this->addMarkers(array( + 'date_publish_uf' => bx_time_js((int)$this->_aContentInfo[$CNF['FIELD_PUBLISHED']], BX_FORMAT_DATE, true) + )); + + $aInformer = $CNF['INFORMERS']['scheduled']; + $aInformers[] = array ('name' => $aInformer['name'], 'msg' => _t($aInformer['map'][$sStatus]['msg']), 'type' => $aInformer['map'][$sStatus]['type']); + } + } + + if($aInformers) + foreach($aInformers as $aInformer) + $oInformer->add($aInformer['name'], $this->_replaceMarkers($aInformer['msg']), $aInformer['type']); + } + } + + protected function _getInvitationCode($aParams = []) + { + $CNF = &$this->_oModule->_oConfig->CNF; + + if(empty($CNF['TABLE_INVITES']) || !$this->_oProfile) + return ''; + + $iProfileId = bx_get_logged_profile_id(); + $iGroupProfileId = $this->_oProfile->id(); + if(!$this->_oModule->serviceIsInvited($iGroupProfileId, $iProfileId)) + return ''; + + $sId = $this->_oModule->getName() . '_popup_invite'; + $sKey = $this->_oModule->serviceGetInvitedKey($iGroupProfileId, $iProfileId); + + $sCode = $this->_oModule->_oTemplate->getJsCode('invite_popup', array( + 'sPopupId' => $sId, + 'sKey' => $sKey, + 'sAcceptUrl' => bx_absolute_url(BxDolPermalinks::getInstance()->permalink('page.php?i=' . $CNF['URI_VIEW_ENTRY'] . '&id=' . $this->_aProfileInfo['content_id'])), + 'sDeclineUrl' => BX_DOL_URL_ROOT, + 'iGroupProfileId' => $this->_oProfile->id(), + )); + + if(!isset($aParams['use_invitation_popup']) || $aParams['use_invitation_popup'] === true) + $sCode .= BxTemplFunctions::getInstance()->popupBox($sId, _t($CNF['T']['txt_invitation_popup_title']), $this->_oModule->_oTemplate->parseHtmlByName('popup_invite.html', array( + 'popup_id' => $sId, + 'text' => _t($CNF['T']['txt_invitation_popup_text']), + 'button_accept' => _t($CNF['T']['txt_invitation_popup_accept_button']), + 'button_decline' => _t($CNF['T']['txt_invitation_popup_decline_button']), + )), true); + + $this->_oTemplate->addJs([ + 'modules/base/groups/js/|invite_popup.js', + 'invite_popup.js' + ]); + return $sCode; + } + + public function getCode () + { + return $this->_getInvitationCode() . parent::getCode(); + } + + protected function _isAvailablePage($a) + { + if(!$this->_aContentInfo || !$this->_oModule->isEntryActive($this->_aContentInfo)) + return false; + + return parent::_isAvailablePage($a); + } + + protected function _isVisiblePage ($a) + { + + $CNF = &$this->_oModule->_oConfig->CNF; + + if(!$this->_aContentInfo) + return false; + + if(($mixedAllowView = $this->_oModule->checkAllowedView($this->_aContentInfo)) !== CHECK_ACTION_RESULT_ALLOWED) { + $bPartiallyVisible = false; + if(!empty($CNF['OBJECT_PRIVACY_VIEW']) && ($oPrivacy = BxDolPrivacy::getObjectInstance($CNF['OBJECT_PRIVACY_VIEW'])) !== false) + $bPartiallyVisible = $oPrivacy->isPartiallyVisible($this->_aContentInfo[$CNF['FIELD_ALLOW_VIEW_TO']]); + /* + * If partially visible, replace current page with different set of blocks. + */ + + $bJoinPage = isset($CNF['OBJECT_PAGE_JOINED_ENTRY']) && $this->_sObject === $CNF['OBJECT_PAGE_JOINED_ENTRY']; + if($bPartiallyVisible && ($this->_sObject === $CNF['OBJECT_PAGE_VIEW_ENTRY'] || $bJoinPage)) { + $sPage = $bJoinPage ? $CNF['OBJECT_PAGE_JOINED_ENTRY'] : $CNF['OBJECT_PAGE_VIEW_ENTRY_CLOSED']; + $aObject = BxDolPageQuery::getPageObject($sPage); + $this->_sObject = $aObject['object']; + $this->_aObject = $aObject; + $this->_oQuery = new BxDolPageQuery($this->_aObject); + } + else + return $mixedAllowView; + } + + if(!BxDolPage::_isVisiblePage($a)) + return false; + + $this->_oModule->checkAllowedView($this->_aContentInfo, true); + + return true; + } +} + +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/groups/classes/BxBaseModGroupsTemplate.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/groups/classes/BxBaseModGroupsTemplate.php new file mode 100644 index 0000000000..4f9d844320 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/groups/classes/BxBaseModGroupsTemplate.php @@ -0,0 +1,146 @@ +<?php defined('BX_DOL') or die('hack attempt'); +/** + * Copyright (c) UNA, Inc - https://una.io + * MIT License - https://opensource.org/licenses/MIT + * + * @defgroup BaseGroups Base classes for groups modules + * @ingroup UnaModules + * + * @{ + */ + +/* + * Groups module representation. + */ +class BxBaseModGroupsTemplate extends BxBaseModProfileTemplate +{ + protected $_iUnitCharsSummary; + + protected $_sUnitClassWoCover; + + function __construct(&$oConfig, &$oDb) + { + parent::__construct($oConfig, $oDb); + + $this->_bLetterAvatar = false; + $this->_iUnitCharsSummary = 50; + + $this->_sUnitClassWoCover = $this->_sUnitClass; //--- Save default 'Unit' class (from BxBaseModProfileTemplate) as 'Unit W\O Cover' class here. + $this->_sUnitClassWithCover .= ' bx-base-groups-unit-with-cover'; + $this->_sUnitClass = $this->_sUnitClassWithCover; + $this->_sUnitClassWoInfo .= ' bx-base-groups-unit-wo-info'; + $this->_sUnitClassWoInfoShowCase .= ' bx-base-groups-unit-wo-info bx-base-groups-unit-wo-info-showcase'; + $this->_sUnitClassShowCase .= ' bx-base-groups-unit-with-cover bx-base-groups-unit-showcase'; + } + + public function addLocationBase() + { + parent::addLocationBase(); + + $this->addLocation('mod_groups', BX_DIRECTORY_PATH_MODULES . 'base' . DIRECTORY_SEPARATOR . 'groups' . DIRECTORY_SEPARATOR, BX_DOL_URL_MODULES . 'base/groups/'); + } + + function unitVars ($aData, $isCheckPrivateContent = true, $mixedTemplate = false, $aParams = array()) + { + $aVars = parent::unitVars ($aData, $isCheckPrivateContent, $mixedTemplate, $aParams); + + $CNF = &$this->_oConfig->CNF; + + $oProfile = BxDolProfile::getInstance($aData[$CNF['FIELD_AUTHOR']]); + if (!$oProfile) + $oProfile = BxDolProfileUndefined::getInstance(); + + $aVars['title'] = (boolean)$aVars['public'] ? bx_process_output($aData[$CNF['FIELD_NAME']]) : _t($CNF['T']['txt_private_group']); + $aVars['description'] = ''; + if(!empty($CNF['FIELD_TEXT']) && !empty($aData[$CNF['FIELD_TEXT']]) && (boolean)$aVars['public']) + $aVars['description'] = strmaxtextlen(strip_tags($aData[$CNF['FIELD_TEXT']]), $this->_iUnitCharsSummary); + + $aVars['author'] = $oProfile->getDisplayName(); + $aVars['author_url'] = $oProfile->getUrl(); + $aVars['author_icon'] = $oProfile->getIcon(); + $aVars['author_thumb'] = $oProfile->getThumb(); + $aVars['author_avatar'] = $oProfile->getAvatar(); + + return $aVars; + } + + public function getPopupSetRole($aRoles, $iProfileId, $iProfileRole) + { + $sJsObject = $this->_oConfig->getJsObject('main'); + $sHtmlIdPrefix = str_replace('_', '-', $this->_oConfig->getName()) . '-role'; + + $aTmplVarsRoles = array(); + foreach($aRoles as $iRole => $sRole) + $aTmplVarsRoles[] = array( + 'id' => $sHtmlIdPrefix . '-' . $iRole, + 'value' => $iRole, + 'onclick' => $sJsObject . '.onClickSetRoleMulti(this, ' . $iProfileId . ', ' . $iRole . ')', + 'title' => $sRole, + 'bx_if:show_checked' => array( + 'condition' => $iRole != 0 && $iProfileRole & (1 << ($iRole - 1)), + 'content' => array() + ) + ); + + return $this->parseHtmlByName('set_role_popup.html', array( + 'bx_repeat:roles' => $aTmplVarsRoles + )); + } + + public function getPopupQuestionnaire($iContentId, $iProfileId) + { + $aAnswers = $this->_oModule->_oDb->getQuestions(['sample' => 'answers', 'content_id' => $iContentId, 'profile_id' => $iProfileId]); + if(empty($aAnswers) || !is_array($aAnswers)) + return $this->_bIsApi ? [] : ''; + + $aTmplVarsAnswers = []; + foreach($aAnswers as $aAnswer) + $aTmplVarsAnswers[] = [ + 'question' => $aAnswer['question'], + 'answer' => $aAnswer['answer'], + ]; + + if($this->_bIsApi) + return $aTmplVarsAnswers; + + return $this->parseHtmlByName('popup_qnr_answers.html', ['bx_repeat:answers' => $aTmplVarsAnswers]); + } + + protected function _getUnitClass($aData, $sTemplateName = 'unit.html') + { + $CNF = &$this->_oConfig->CNF; + + $sResult = ''; + + switch($sTemplateName) { + case 'unit_wo_cover.html': + $sResult = $this->_sUnitClassWoCover; + break; + + default: + $sResult = parent::_getUnitClass($aData, $sTemplateName); + } + + return $sResult . ' ' . str_replace('_', '-', $this->_oConfig->getName()) . '-unit-' . $aData[$CNF['FIELD_ID']]; + } + + protected function _getUnitSize($aData, $sTemplateName = 'unit.html') + { + $sResult = ''; + + switch($sTemplateName) { + case 'unit.html': + case 'unit_with_cover.html': + $sResult = 'ava'; + break; + + default: + $sResult = $this->_sUnitSizeDefault; + break; + } + + return $sResult; + } +} + +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/profile/classes/BxBaseModProfileMenuViewActionsAll.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/profile/classes/BxBaseModProfileMenuViewActionsAll.php new file mode 100644 index 0000000000..700e6fb7da --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/profile/classes/BxBaseModProfileMenuViewActionsAll.php @@ -0,0 +1,210 @@ +<?php defined('BX_DOL') or die('hack attempt'); +/** + * Copyright (c) UNA, Inc - https://una.io + * MIT License - https://opensource.org/licenses/MIT + * + * @defgroup BaseProfile Base classes for profile modules + * @ingroup UnaModules + * + * @{ + */ + +/** + * View entry all actions menu + */ +class BxBaseModProfileMenuViewActionsAll extends BxBaseModGeneralMenuViewActions +{ + protected $_oProfile; + protected $_aProfileInfo; + + protected $_aConnectionToFunctionCheck; + + public function __construct($aObject, $oTemplate = false) + { + parent::__construct($aObject, $oTemplate); + + $this->_aConnectionToFunctionCheck = $this->_oModule->_oConfig->getConnectionToFunctionCheck(); + + if(empty($this->_iContentId) && bx_get('profile_id') !== false) + $this->setContentId(BxDolProfile::getInstance(bx_process_input(bx_get('profile_id'), BX_DATA_INT))->getContentId()); + } + + public function setContentId($iContentId) + { + parent::setContentId($iContentId); + + $this->_oProfile = BxDolProfile::getInstanceByContentAndType($this->_iContentId, $this->_sModule); + if(!$this->_oProfile) + return; + + $this->_aProfileInfo = $this->_oProfile->getInfo(); + + $this->addMarkers($this->_aProfileInfo); + $this->addMarkers(array( + 'profile_id' => $this->_oProfile->id() + )); + } + + protected function getMenuItemTitleByConnection($sConnection, $sAction, $iContentProfile, $iInitiatorProfile) + { + return ''; + } + + protected function _getMenuItemConnectionApi($sConnection, $sAction, &$aItem) + { + if(!isLogged() || (isset($this->_aConnectionToFunctionCheck[$sConnection]) && $this->_oModule->{$this->_aConnectionToFunctionCheck[$sConnection][$sAction]}($this->_aContentInfo) !== CHECK_ACTION_RESULT_ALLOWED)) + return false; + + $iInitiatorProfile = bx_get_logged_profile_id(); + $iContentProfile = $this->_oProfile->id(); + $sTitle = $this->_oModule->getMenuItemTitleByConnection($sConnection, $sAction, $iContentProfile, $iInitiatorProfile); + + if(empty($sTitle)) + $sTitle = $this->getMenuItemTitleByConnection($sConnection, $sAction, $iContentProfile, $iInitiatorProfile); + if(empty($sTitle)) + return false; + + return [ + 'id' => $aItem['id'], + 'name' => $aItem['name'], + 'title' => $sTitle, + 'display_type' => 'element', + 'data' => [ + 'type' => 'connections', + 'o' => $sConnection, + 'a' => $sAction, + 'iid' => $iInitiatorProfile, + 'cid' => $iContentProfile, + 'title' => $sTitle, + 'primary' => !empty($aItem['primary']), + ] + ]; + } + + protected function _getMenuItemProfileFriendAdd($aItem) + { + if($this->_bIsApi) + return $this->_getMenuItemConnectionApi('sys_profiles_friends', 'add', $aItem); + + return $this->_getMenuItemByNameActions($aItem); + } + + protected function _getMenuItemProfileFriendRemove($aItem) + { + if($this->_bIsApi) + return $this->_getMenuItemConnectionApi('sys_profiles_friends', 'remove', $aItem); + + return $this->_getMenuItemByNameActions($aItem); + } + + protected function _getMenuItemProfileRelationAdd($aItem) + { + return $this->_getMenuItemByNameActions($aItem); + } + + protected function _getMenuItemProfileRelationRemove($aItem) + { + return $this->_getMenuItemByNameActions($aItem); + } + + protected function _getMenuItemProfileSubscribeAdd($aItem) + { + if($this->_bIsApi) + return $this->_getMenuItemConnectionApi('sys_profiles_subscriptions', 'add', $aItem); + + return $this->_getMenuItemByNameActions($aItem); + } + + protected function _getMenuItemProfileSubscribeRemove($aItem) + { + if($this->_bIsApi) + return $this->_getMenuItemConnectionApi('sys_profiles_subscriptions', 'remove', $aItem); + + return $this->_getMenuItemByNameActions($aItem); + } + + protected function _getMenuItemProfileSetAclLevel($aItem) + { + $aItem = $this->_getMenuItemByNameActions($aItem); + if (!$this->_bIsApi) + return $aItem; + + $aItem['display_type'] = 'callback'; + $oAcl = BxDolAcl::getInstance(); + $aAclLevels = $oAcl->getMembershipsBy(array('type' => 'all_active_not_automatic_pair')); + $aValues = []; + + $aProfileAclLevel = $oAcl->getMemberMembershipInfo($this->_oProfile->id()); + + foreach ($aAclLevels as $k => $s){ + $aValues[] = ['value' => $k, 'label' => _t($s)]; + } + $aItem['content_type'] = 'memberships'; + $aItem['data'] = ['values' => $aValues, 'profile_id' => $this->_oProfile->id(), 'value' => $aProfileAclLevel['id']]; + return $aItem; + } + + protected function _getMenuItemView($aItem, $aParams = array()) + { + return parent::_getMenuItemView($aItem, array_merge($aParams, [ + 'object_options' => ['show_counter' => false] + ])); + } + + protected function _getMenuItemComment($aItem, $aParams = array()) + { + return parent::_getMenuItemComment($aItem, array_merge($aParams, [ + 'object_options' => ['show_counter' => false] + ])); + } + + protected function _getMenuItemVote($aItem, $aParams = array()) + { + return parent::_getMenuItemVote($aItem, array_merge($aParams, [ + 'object_options' => ['show_counter' => false] + ])); + } + + protected function _getMenuItemReaction($aItem, $aParams = array()) + { + return parent::_getMenuItemReaction($aItem, array_merge($aParams, [ + 'object_options' => ['show_counter' => false] + ])); + } + + protected function _getMenuItemScore($aItem, $aParams = array()) + { + return parent::_getMenuItemScore($aItem, array_merge($aParams, [ + 'object_options' => ['show_counter' => false] + ])); + } + + protected function _getMenuItemMessenger($aItem, $aParams = array()) + { + $aItem = BxTemplMenu::_getMenuItem($aItem); + if($aItem === false) + return false; + + if(!$this->_bIsApi) + return $this->_getMenuItemDefault($aItem); + + $sModule = 'bx_messenger'; + $sMethod = 'find_convo'; + if(!bx_is_srv($sModule, $sMethod)) + return false; + + return [ + 'id' => $aItem['id'], + 'name' => $aItem['name'], + 'title' => $aItem['title'], + 'display_type' => 'callback', + 'data' => [ + 'request_url' => $sModule . '/get_convo_url/Services¶ms[]=' . json_encode(['recipient' => $this->_oProfile->id()]), + 'on_callback' => 'redirect' + ], + 'primary' => $aItem['primary'], + ]; + } +} + +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/profile/classes/BxBaseModProfileModule.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/profile/classes/BxBaseModProfileModule.php new file mode 100644 index 0000000000..17620ded7e --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/profile/classes/BxBaseModProfileModule.php @@ -0,0 +1,2506 @@ +<?php defined('BX_DOL') or die('hack attempt'); +/** + * Copyright (c) UNA, Inc - https://una.io + * MIT License - https://opensource.org/licenses/MIT + * + * @defgroup BaseProfile Base classes for profile modules + * @ingroup UnaModules + * + * @{ + */ + +define('BX_DOL_PROFILE_REDIRECT_PROFILE', 'profile'); +define('BX_DOL_PROFILE_REDIRECT_LAST', 'last'); +define('BX_DOL_PROFILE_REDIRECT_CUSTOM', 'custom'); +define('BX_DOL_PROFILE_REDIRECT_HOMEPAGE', 'homepage'); + +define('BX_DOL_PROFILE_ACTIVATE_ALWAYS', 'on'); +define('BX_DOL_PROFILE_ACTIVATE_NEVER', 'off'); +define('BX_DOL_PROFILE_ACTIVATE_ADD', 'add'); +define('BX_DOL_PROFILE_ACTIVATE_EDIT', 'edit'); + +/** + * Base class for profile modules. + */ +class BxBaseModProfileModule extends BxBaseModGeneralModule implements iBxDolContentInfoService, iBxDolProfileService +{ + protected $_iAccountId; + + function __construct(&$aModule) + { + parent::__construct($aModule); + + $CNF = &$this->_oConfig->CNF; + + if(!empty($CNF['FIELD_ALLOW_POST_TO'])) + $this->_aSearchableNamesExcept[] = $CNF['FIELD_ALLOW_POST_TO']; + + if(!empty($CNF['FIELD_ALLOW_CONTACT_TO'])) + $this->_aSearchableNamesExcept[] = $CNF['FIELD_ALLOW_CONTACT_TO']; + + $this->_iAccountId = getLoggedId(); + } + + public function actionDeleteProfileImg($iFileId, $iContentId, $sFieldPicture) + { + $aResult = array(); + $CNF = &$this->_oConfig->CNF; + + $oSrorage = BxDolStorage::getObjectInstance($CNF['OBJECT_STORAGE']); + if (!($aFile = $oSrorage->getFile((int)$iFileId)) || !($aContentInfo = $this->_oDb->getContentInfoById($iContentId)) || $aContentInfo[$sFieldPicture] != (int)$iFileId) + $aResult = array('error' => 1, 'msg' => _t('_sys_storage_err_file_not_found')); + + $oAccountProfile = BxDolProfile::getInstanceAccountProfile(); + if ($oAccountProfile) + $iAccountProfileId = $oAccountProfile->id(); + + if ((!$aResult && !isLogged()) || (!$aResult && $aFile['profile_id'] != $iAccountProfileId && !$this->_isModerator())) + $aResult = array('error' => 2, 'msg' => _t('_Access denied')); + + $oForm = BxDolForm::getObjectInstance($CNF['OBJECT_FORM_ENTRY'], $CNF['OBJECT_FORM_ENTRY_DISPLAY_ADD'], $this->_oTemplate); + + if (!$aResult && !$oForm->_deleteFile($iContentId, $sFieldPicture, (int)$iFileId, true)) + $aResult = array('error' => 3, 'msg' => _t('_Failed')); + elseif (!$aResult) + $aResult = array('error' => 0, 'msg' => ''); + + header('Content-Type: application/json; charset=utf-8'); + echo json_encode($aResult); + } + + public function actionProfileCalendarData() + { + $iProfileId = (int)bx_get('profile_id'); + $aEntries = array(); + $BxDolModuleQuery = BxDolModuleQuery::getInstance(); + $aModules = $BxDolModuleQuery->getModulesBy(array('type' => 'modules', 'active' => 1)); + foreach($aModules as $aModule){ + $sModuleName = $aModule['name']; + $oModule = BxDolModule::getInstance($sModuleName); + if($oModule instanceof iBxDolCalendarService){ + if(BxDolRequest::serviceExists($sModuleName, 'get_calendar_entries')){ + $aEntries2 = BxDolService::call($sModuleName, 'get_calendar_entries', array($iProfileId)); + $aEntries = array_merge($aEntries, $aEntries2); + } + } + } + + header('Content-Type: application/json; charset=utf-8'); + echo json_encode($aEntries); + } + + public function actionEmbed($iContentId, $sUnitTemplate = '', $sAddCode = '') + { + return parent::actionEmbed($iContentId, 'unit_with_cover.html'); + } + + // ====== SERVICE METHODS + + public function serviceGetSafeServices() + { + $a = parent::serviceGetSafeServices(); + return array_merge($a, array ( + 'ProfileUnitSafe' => '', + 'ProfileUrl' => '', + 'EntityCreate' => '', + 'BrowseRecommended' => '', + 'BrowseRecentProfiles' => '', + 'BrowseActiveProfiles' => '', + 'BrowseTopProfiles' => '', + 'BrowseOnlineProfiles' => '', + 'BrowseConnections' => '', + 'BrowseConnectionsEverywhere' => '', + 'BrowseByAcl' => '', + )); + } + + public function serviceGetOptionsRedirectAfterAdd() + { + $CNF = &$this->_oConfig->CNF; + + $aResult = array(); + $aChoices = array(BX_DOL_PROFILE_REDIRECT_PROFILE, BX_DOL_PROFILE_REDIRECT_LAST, BX_DOL_PROFILE_REDIRECT_CUSTOM, BX_DOL_PROFILE_REDIRECT_HOMEPAGE); + foreach($aChoices as $sChoice) + $aResult[] = array('key' => $sChoice, 'value' => _t($CNF['T']['option_redirect_aadd_' . $sChoice])); + + return $aResult; + } + + public function serviceGetOptionsActivation() + { + $CNF = &$this->_oConfig->CNF; + + $aResult = array(); + $aChoices = array(BX_DOL_PROFILE_ACTIVATE_ALWAYS, BX_DOL_PROFILE_ACTIVATE_NEVER, BX_DOL_PROFILE_ACTIVATE_ADD, BX_DOL_PROFILE_ACTIVATE_EDIT); + foreach($aChoices as $sChoice) + $aResult[] = array('key' => $sChoice, 'value' => _t($CNF['T']['option_activation_' . $sChoice])); + + return $aResult; + } + + public function serviceGetThumb ($iContentId, $sTranscoder = '') + { + $CNF = &$this->_oConfig->CNF; + + if(bx_is_api()){ + $aContentInfo = $this->_oDb->getContentInfoById($iContentId); + return bx_api_get_image($CNF['OBJECT_STORAGE'], $aContentInfo[$CNF['FIELD_PICTURE']]); + } + + if(empty($sTranscoder) && !empty($CNF['OBJECT_IMAGES_TRANSCODER_THUMB'])) + $sTranscoder = $CNF['OBJECT_IMAGES_TRANSCODER_THUMB']; + + $mixedResult = $this->_getFieldValueThumb('FIELD_PICTURE', $iContentId, $sTranscoder); + return $mixedResult !== false ? $mixedResult : ''; + } + + public function serviceGetCover ($iContentId, $sTranscoder = '') + { + $CNF = &$this->_oConfig->CNF; + + if(bx_is_api()){ + $aContentInfo = $this->_oDb->getContentInfoById($iContentId); + $aTmp = bx_api_get_image($CNF['OBJECT_STORAGE'], $aContentInfo[$CNF['FIELD_COVER']]); + if (!$aTmp){ + return ['storage' => $CNF['OBJECT_STORAGE']]; + } + return $aTmp; + } + + if(empty($sTranscoder) && !empty($CNF['OBJECT_IMAGES_TRANSCODER_COVER'])) + $sTranscoder = $CNF['OBJECT_IMAGES_TRANSCODER_COVER']; + + $mixedResult = $this->_getFieldValueThumb('FIELD_COVER', $iContentId, $sTranscoder); + return $mixedResult !== false ? $mixedResult : ''; + } + + public function serviceGetSearchResultUnit ($iContentId, $sUnitTemplate = '') + { + if(empty($sUnitTemplate)) + $sUnitTemplate = 'unit_with_cover.html'; + + return parent::serviceGetSearchResultUnit($iContentId, $sUnitTemplate); + } + + public function serviceGetSearchableFieldsExtended($aInputsAdd = array()) + { + $CNF = &$this->_oConfig->CNF; + + $aResult = parent::serviceGetSearchableFieldsExtended($aInputsAdd); + if(!$this->serviceActAsProfile()) + return $aResult; + + if(!in_array('online', $this->_aSearchableNamesExcept)) + $aResult['online'] = array( + 'type' => 'checkbox', + 'caption' => $CNF['T']['form_field_online'], + 'info' => '', + 'value' => '1', + 'values' => '', + 'pass' => '' + ); + + if(!empty($CNF['FIELD_PICTURE']) && !in_array($CNF['FIELD_PICTURE'], $this->_aSearchableNamesExcept)) + $aResult[$CNF['FIELD_PICTURE']] = array( + 'type' => 'checkbox', + 'caption' => $CNF['T']['form_field_picture'], + 'info' => '', + 'value' => '1', + 'values' => '', + 'pass' => '', + 'search_operator' => '>=' + ); + + return $aResult; + } + + + /** + * @page service Service Calls + * @section bx_base_profile Base Profile + * @subsection bx_base_profile-general General + * @subsubsection bx_base_profile-entity_calendar entity_calendar + * + * @code bx_srv('bx_persons', 'entity_calendar', [...]); @endcode + * + * Get calendar block + * @param $iContentId content ID + * + * @see BxBaseModProfileModule::serviceEntityCalendar + */ + /** + * @ref bx_base_profile-entity_calendar "entity_calendar" + */ + public function serviceEntityCalendar($iContentId = 0, $sTemplate = 'calendar.html') + { + $iContentId = $this->_getContent($iContentId, false); + $oProfile = BxDolProfile::getInstanceByContentAndType($iContentId, $this->_oConfig->getName()); + if($oProfile){ + $o = new BxTemplCalendar(array( + 'eventSources' => array ( + bx_append_url_params(BX_DOL_URL_ROOT . $this->_oConfig->getBaseUri() . 'profile_calendar_data', array('profile_id' => $oProfile->id())), + ), + ), $this->_oTemplate); + return $o->display($sTemplate); + } + return ''; + } + + public function servicePrivateProfileMsg() + { + $sMessage = ''; + + $mixedContent = $this->_getContent(); + if($mixedContent) { + list($iContentId, $aContentInfo) = $mixedContent; + $sMessage = $this->checkAllowedView($aContentInfo); + } + else + $sMessage = MsgBox(_t('_sys_access_denied_to_private_content')); + + return !$this->_bIsApi ? $sMessage : [bx_api_get_msg($sMessage, ['ext' => ['msg_type' => 'result']])]; + } + + public function serviceGetContentInfoById($iContentId) + { + return $this->_oDb->getContentInfoById((int)$iContentId); + } + + public function serviceGetContentInfoByProfileId($iProfileId) + { + return $this->_oDb->getContentInfoByProfileId((int)$iProfileId); + } + + public function serviceGetMenuAddonManageTools() + { + $CNF = &$this->_oConfig->CNF; + + $iNumTotal = $this->_oDb->getEntriesNumByParams(); + + $iNum1 = $this->_oDb->getEntriesNumByParams([ + [ + 'key' => 'status', + 'table' => 'sys_profiles', + 'value' => BX_PROFILE_STATUS_PENDING, + 'operator' => '=' + ] + ]); + + $iNum2 = 0; + if (isset($CNF['OBJECT_REPORTS'])){ + $iNum2 = $this->_oDb->getEntriesNumByParams([ + [ + 'key' => 'reports', + 'value' => '0', + 'operator' => '>' + ] + ]); + } + + return array('counter1_value' => $iNum1, 'counter2_value' => $iNum2, 'counter3_value' => $iNumTotal, 'counter1_caption' => _t('_sys_menu_dashboard_manage_tools_addon_counter1_caption_profile_default')); + } + + public function serviceGetMenuAddonManageToolsProfileStats($iProfileId = 0) + { + if(!$iProfileId) + $iProfileId = bx_get_logged_profile_id(); + + $aAccountInfo = BxDolProfileQuery::getInstance()->getAccountInfoByProfileId($iProfileId); + if(empty($aAccountInfo) || !is_array($aAccountInfo)) + return 0; + + bx_import('SearchResult', $this->_aModule); + $sClass = $this->_aModule['class_prefix'] . 'SearchResult'; + $o = new $sClass(); + $o->fillFilters([ + 'account_id' => $aAccountInfo['id'], + 'perofileStatus' => '' + ]); + $o->unsetPaginate(); + + return $o->getNum(); + } + + public function serviceGetMenuAddonFavoritesProfileStats() + { + bx_import('SearchResult', $this->_aModule); + $sClass = $this->_aModule['class_prefix'] . 'SearchResult'; + $o = new $sClass('favorite', array('user' => bx_get_logged_profile_id())); + $o->unsetPaginate(); + + return $o->getNum(); + } + + public function serviceGetSubmenuObject () + { + return $this->_oConfig->CNF['OBJECT_MENU_SUBMENU_VIEW_ENTRY']; + } + + public function serviceGetMenuSetNameForMenuTrigger ($sMenuTriggerName) + { + $CNF = &$this->_oConfig->CNF; + + if (isset($CNF['TRIGGER_MENU_PROFILE_VIEW_SUBMENU']) && $CNF['TRIGGER_MENU_PROFILE_VIEW_SUBMENU'] == $sMenuTriggerName) + return $CNF['OBJECT_MENU_SUBMENU_VIEW_ENTRY']; + elseif (isset($CNF['TRIGGER_MENU_PROFILE_SNIPPET_META']) && $CNF['TRIGGER_MENU_PROFILE_SNIPPET_META'] == $sMenuTriggerName) + return $CNF['OBJECT_MENU_SNIPPET_META']; + else if (isset($CNF['TRIGGER_MENU_PROFILE_VIEW_ACTIONS']) && $CNF['TRIGGER_MENU_PROFILE_VIEW_ACTIONS'] == $sMenuTriggerName) { + if(empty($CNF['OBJECT_MENU_ACTIONS_VIEW_ENTRY_ALL'])) + return $CNF['OBJECT_MENU_ACTIONS_VIEW_ENTRY']; + else + return array($CNF['OBJECT_MENU_ACTIONS_VIEW_ENTRY'], $CNF['OBJECT_MENU_ACTIONS_VIEW_ENTRY_ALL']); + } + + return ''; + } + + public function serviceGetSnippetMenuVars($iProfileId, $bPublic = null, $aParams = []) + { + return $this->_oTemplate->getSnippetMenuVars($iProfileId, $bPublic, $aParams); + } + + public function serviceGetPageObjectForPageTrigger ($sPageTriggerName) + { + if (isset($this->_oConfig->CNF['TRIGGER_PAGE_VIEW_ENTRY']) && $this->_oConfig->CNF['TRIGGER_PAGE_VIEW_ENTRY'] == $sPageTriggerName) + return $this->_oConfig->CNF['OBJECT_PAGE_VIEW_ENTRY']; + + return ''; + } + + public function serviceProfilesSearch ($sTerm, $iLimit) + { + $aRet = array(); + + $a = $this->_oDb->searchByTerm($sTerm, $iLimit); + foreach ($a as $r) { + $oProfile = BxDolProfile::getInstance($r['profile_id']); + + if (bx_is_api()) { + $aData = $oProfile->getUnitAPI(0, ['template' => 'unit_wo_info']); + $aRet[] = $aData['author_data']; + } + else{ + $aRet[] = array ( + 'label' => $this->serviceProfileName($r['content_id']), + 'value' => $r['profile_id'], + 'url' => $oProfile->getUrl(), + 'thumb' => $oProfile->getThumb(), + 'unit' => $oProfile->getUnit(0, ['template' => ['name' => 'unit_wo_info', 'size' => 'icon']]) + ); + } + } + + return $aRet; + } + + /** + * @page service Service Calls + * @section bx_base_profile Base Profile + * @subsection bx_base_profile-general General + * @subsubsection bx_base_profile-profile_unit_safe profile_unit_safe + * + * @code bx_srv('bx_persons', 'profile_unit_safe', [...]); @endcode + * + * Get profile unit + * @param $iContentId content ID + * + * @see BxBaseModProfileModule::serviceProfileUnitSafe + */ + /** + * @ref bx_base_profile-profile_unit_safe "profile_unit_safe" + */ + public function serviceProfileUnitSafe ($iContentId, $aParams = array()) + { + unset($aParams['check_private_content']); + return $this->serviceProfileUnit ($iContentId, $aParams); + } + + public function serviceProfileUnit ($iContentId, $aParams = []) + { + $mixedContent = $this->_getContent($iContentId); + if($mixedContent === false) + return false; + + list($iContentId, $aContentInfo) = $mixedContent; + + $bCheckPrivateContent = isset($aParams['check_private_content']) ? (bool)$aParams['check_private_content'] : true; + + $aUnitTemplate = ['name' => 'unit.html', 'size' => false, 'vars' => []]; + if(!empty($aParams['template'])) { + $mixedTemplate = $aParams['template']; + unset($aParams['template']); + + if(is_string($mixedTemplate)) + $aUnitTemplate['name'] = $mixedTemplate . '.html'; + else if(is_array($mixedTemplate)) { + if(!empty($mixedTemplate['name'])) + $aUnitTemplate['name'] = $mixedTemplate['name'] . '.html'; + + if(!empty($mixedTemplate['size'])) + $aUnitTemplate['size'] = $mixedTemplate['size']; + + if(!empty($mixedTemplate['vars'])) + $aUnitTemplate['vars'] = $mixedTemplate['vars']; + } + } + + $aUnitParams = []; + if(!empty($aParams)) + $aUnitParams = $aParams; + + return $this->_oTemplate->unit($aContentInfo, $bCheckPrivateContent, array_values($aUnitTemplate), $aUnitParams); + } + + public function serviceProfileUnitApi ($iContentId, $aParams = []) + { + $mixedContent = $this->_getContent($iContentId); + if($mixedContent === false) + return false; + + list($iContentId, $aContentInfo) = $mixedContent; + + return $this->_oTemplate->unitAPI($aContentInfo, $aParams); + } + + public function serviceHasImage ($iContentId) + { + $CNF = &$this->_oConfig->CNF; + + $mixedContent = $this->_getContent($iContentId, 'getContentInfoById'); + if($mixedContent === false) + return false; + + list($iContentId, $aContentInfo) = $mixedContent; + + return !empty($aContentInfo[$CNF['FIELD_PICTURE']]); + } + + public function serviceProfilePicture ($iContentId) + { + return $this->_serviceTemplateFunc('urlPicture', $iContentId); + } + + public function serviceProfileAvatar ($iContentId) + { + return $this->_serviceTemplateFunc('urlAvatar', $iContentId); + } + + public function serviceProfileAvatarBig ($iContentId) + { + return $this->_serviceTemplateFunc('urlAvatarBig', $iContentId); + } + + public function serviceProfileCover ($iContentId) + { + return $this->_serviceTemplateFunc('urlCover', $iContentId); + } + + public function serviceProfileUnitCover ($iContentId) + { + return $this->_serviceTemplateFunc('urlCoverUnit', $iContentId); + } + + public function serviceProfileEditUrl ($iContentId) + { + return bx_absolute_url(BxDolPermalinks::getInstance()->permalink('page.php?i=' . $this->_oConfig->CNF['URI_EDIT_ENTRY'] . '&id=' . $iContentId)); + } + + public function serviceProfileThumb ($iContentId) + { + return $this->_serviceTemplateFunc('urlThumb', $iContentId); + } + + public function serviceProfileIcon ($iContentId) + { + return $this->_serviceTemplateFunc('urlIcon', $iContentId); + } + + public function serviceProfileName ($iContentId) + { + if (!$iContentId) + return false; + $aContentInfo = $this->_oDb->getContentInfoById($iContentId); + if (!$aContentInfo) + return false; + + $sDisplayName = $this->getProfileName($aContentInfo); + + /** + * @hooks + * @hookdef hook-bx_base_profile-profile_name '{module_name}', 'profile_name' - hook to override profile display name + * - $unit_name - module name + * - $action - equals `profile_name` + * - $object_id - profile id + * - $sender_id - not used + * - $extra_params - array of additional params with the following array keys: + * - `info` - [array] profile info array as key&value pairs + * - `display_name` - [string] by ref, profile display name, can be overridden in hook processing + * @hook @ref hook-bx_base_profile-profile_name + */ + bx_alert($this->getName(), 'profile_name', $aContentInfo['profile_id'], 0, [ + 'info' => $aContentInfo, + 'display_name' => &$sDisplayName + ]); + + return $sDisplayName; + } + + public function serviceProfileSettings ($iContentId) + { + if (!$iContentId) + return false; + $aContentInfo = $this->_oDb->getContentInfoById($iContentId); + if (!$aContentInfo) + return false; + + if (isset($aContentInfo['settings'])) + return json_decode($aContentInfo['settings']); + } + + public function serviceProfileSettingsSet ($iContentId, $oValue) + { + $CNF = $this->_oConfig->CNF; + $this->_oDb->updateEntriesBy(['settings' => json_encode($oValue)], [$CNF['FIELD_ID'] => $iContentId]); + } + + public function serviceProfileCreateUrl ($bAbsolute = true) + { + $CNF = $this->_oConfig->CNF; + if(empty($CNF['URL_CREATE'])) + return false; + + return $bAbsolute ? bx_absolute_url(BxDolPermalinks::getInstance()->permalink($CNF['URL_CREATE'])) : $CNF['URL_CREATE']; + } + + /** + * @page service Service Calls + * @section bx_base_profile Base Profile + * @subsection bx_base_profile-general General + * @subsubsection bx_base_profile-profile_url profile_url + * + * @code bx_srv('bx_persons', 'profile_url', [...]); @endcode + * + * Get profile URL + * @param $iContentId content ID + * + * @see BxBaseModProfileModule::serviceProfileUrl + */ + /** + * @ref bx_base_profile-profile_url "profile_url" + */ + public function serviceProfileUrl ($iContentId) + { + if (!$iContentId) + return false; + $aContentInfo = $this->_oDb->getContentInfoById($iContentId); + if (!$aContentInfo) + return false; + $CNF = $this->_oConfig->CNF; + return bx_absolute_url(BxDolPermalinks::getInstance()->permalink('page.php?i=' . $CNF['URI_VIEW_ENTRY'] . '&id=' . $aContentInfo[$CNF['FIELD_ID']])); + } + + /** + * @see iBxDolProfileService::serviceGetSpaceTitle + */ + public function serviceGetSpaceTitle() + { + return _t('_sys_ps_space_title_friend'); + } + + /** + * @see iBxDolProfileService::serviceGetParticipatingProfiles + */ + public function serviceGetParticipatingProfiles($iProfileId, $aConnectionObjects = false) + { + if (false === $aConnectionObjects) + $aConnectionObjects = array('sys_profiles_friends'); + + $a = array(); + foreach ($aConnectionObjects as $sConnectionObject) { + if (!($o = BxDolConnection::getObjectInstance($sConnectionObject))) + continue; + + if (BX_CONNECTIONS_TYPE_MUTUAL == $o->getType()) + $a = array_merge($a, $o->getConnectedContentByType($iProfileId, $this->getName(), true)); + else + $a = array_merge($a, $o->getConnectedContentByType($iProfileId, $this->getName())); + } + $aRet = array_unique($a); + + // the check for an ability to post in profile has been moved to BxDolPrivacy because we need to have an extended check + // with an ability to check for extended roles taking into account the type of content which is going be posted/edited + // so now this service returns just a fans, not filtered by an ability to post into an entry's context + /*foreach ($a as $iConnectedProfileId) { + if (!($oConnectedProfile = BxDolProfile::getInstance($iConnectedProfileId))) + continue; + + if (CHECK_ACTION_RESULT_ALLOWED === bx_srv($oConnectedProfile->getModule(), 'check_allowed_post_in_profile', array($oConnectedProfile->getContentId(), $iProfileId))) + $aRet[] = $iConnectedProfileId; + }*/ + + /** + * @hooks + * @hookdef hook-system-get_participating_profiles 'system', 'get_participating_profiles' - hook to override context participants list + * - $unit_name - equals `system` + * - $action - equals `get_participating_profiles` + * - $object_id - context profile id + * - $sender_id - not used + * - $extra_params - array of additional params with the following array keys: + * - `module` - [string] module name + * - `profiles` - [array] by ref, a list of participating profiles ids, can be overridden in hook processing + * @hook @ref hook-system-get_participating_profiles + */ + bx_alert('system', 'get_participating_profiles', $iProfileId, false, [ + 'module' => $this->_oConfig->getName(), + 'profiles' => &$aRet + ]); + + return $aRet; + } + + /** + * Prepare fields from some universal set of fields to fields in particular profile module. + * By default only 'name' and 'description' fields are supported. + * After fields convertion it can be used in @see BxBaseModGeneralModule::serviceEntityAdd + * @param $aFieldsProfile fields in soem universal format. + * @return array which is ready to use for particular module + */ + public function servicePrepareFields ($aFieldsProfile) + { + /** + * @hooks + * @hookdef hook-bx_base_profile-prepare_fields '{module_name}', 'prepare_fields' - hook to override prepared profile fields + * - $unit_name - module name + * - $action - equals `prepare_fields` + * - $object_id - not used + * - $sender_id - not used + * - $extra_params - array of additional params with the following array keys: + * - `fields_orig` - [array] original fields array as key&value pairs + * - `fields_result` - [array] by ref, resulting fields array as key&value pairs, can be overridden in hook processing + * @hook @ref hook-bx_base_profile-prepare_fields + */ + bx_alert($this->getName(), 'prepare_fields', 0, 0, [ + 'fields_orig' => $aFieldsProfile, + 'fields_result' => &$aFieldsProfile + ]); + + return $aFieldsProfile; + } + + protected function _servicePrepareFields ($aFieldsProfile, $aFieldsDefault, $aMap) + { + $aFieldsOrig = $aFieldsProfile; + + bx_import('BxDolPrivacy'); + $aFieldsDefault2 = array( + 'allow_view_to' => BX_DOL_PG_ALL, + 'allow_contact_to' => BX_DOL_PG_ALL, + 'allow_post_to' => BX_DOL_PG_FRIENDS, + ); + $aFieldsProfile = array_merge($aFieldsDefault2, $aFieldsDefault, $aFieldsProfile); + + foreach ($aMap as $k => $v) { + if (isset($aFieldsProfile[$v])) + $aFieldsProfile[$k] = $aFieldsProfile[$v]; + if ($k != $v && !isset($aMap[$v])) + unset($aFieldsProfile[$v]); + } + + /** + * @hooks + * @hookdef hook-bx_base_profile-prepare_fields '{module_name}', 'prepare_fields' - hook to override prepared profile fields + * - $unit_name - module name + * - $action - equals `prepare_fields` + * - $object_id - not used + * - $sender_id - not used + * - $extra_params - array of additional params with the following array keys: + * - `fields_orig` - [array] original fields array as key&value pairs + * - `fields_result` - [array] by ref, resulting fields array as key&value pairs, can be overridden in hook processing + * @hook @ref hook-bx_base_profile-prepare_fields + */ + bx_alert($this->getName(), 'prepare_fields', 0, 0, [ + 'fields_orig' => $aFieldsOrig, + 'fields_result' => &$aFieldsProfile + ]); + + return $aFieldsProfile; + } + + public function serviceFormsHelper () + { + return parent::serviceFormsHelper (); + } + + /** + * @page service Service Calls + * @section bx_base_profile Base Profile + * @subsection bx_base_profile-forms Forms + * @subsubsection bx_base_profile-entity_create entity_create + * + * @code bx_srv('bx_persons', 'entity_create', [...]); @endcode + * + * Get profile creation form + * @param $sDisplay optional form display name + * + * @see BxBaseModProfileModule::serviceEntityCreate + */ + /** + * @ref bx_base_profile-entity_create "entity_create" + */ + public function serviceEntityCreate ($sDisplay = false) + { + BxDolInformer::getInstance($this->_oTemplate)->setEnabled(false); + + return parent::serviceEntityCreate ($sDisplay); + } + + public function serviceActAsProfile () + { + return true; + } + + /** + * @page service Service Calls + * @section bx_base_profile Base Profile + * @subsection bx_base_profile-browse Browse + * @subsubsection bx_base_profile-browse_recommended browse_recommended + * + * @code bx_srv('bx_persons', 'browse_recommended', [...]); @endcode + * + * Browse recommended profiles + * @param $sUnitView optional, unit view, for example - showcase + * @param $bEmptyMessage optional, display or not "empty" message when there is no content + * @param $bAjaxPaginate optional, use AJAX paginate or not + * + * @see BxBaseModProfileModule::serviceBrowseRecommended + */ + /** + * @ref bx_base_profile-browse_recommended "browse_recommended" + */ + public function serviceBrowseRecommended ($sUnitView = false, $bEmptyMessage = false, $bAjaxPaginate = true) + { + if (!isLogged()) + return ''; + return $this->_serviceBrowse ('recommended', $sUnitView ? array('unit_view' => $sUnitView) : false, BX_DB_PADDING_DEF, $bEmptyMessage, $bAjaxPaginate); + } + + /** + * @page service Service Calls + * @section bx_base_profile Base Profile + * @subsection bx_base_profile-browse Browse + * @subsubsection bx_base_profile-browse_recent_profiles browse_recent_profiles + * + * @code bx_srv('bx_persons', 'browse_recent_profiles', [...]); @endcode + * + * Browse recently joined profiles + * @param $bEmptyMessage optional, display or not "empty" message when there is no content + * @param $bAjaxPaginate optional, use AJAX paginate or not + * + * @see BxBaseModProfileModule::serviceBrowseRecentProfiles + */ + /** + * @ref bx_base_profile-browse_recent_profiles "browse_recent_profiles" + */ + public function serviceBrowseRecentProfiles ($bDisplayEmptyMsg = false, $bAjaxPaginate = true, $sUnitView = false) + { + return $this->_serviceBrowse ('recent', $sUnitView ? array('unit_view' => $sUnitView) : false, BX_DB_PADDING_DEF, $bDisplayEmptyMsg, $bAjaxPaginate); + } + + /** + * @page service Service Calls + * @section bx_base_profile Base Profile + * @subsection bx_base_profile-browse Browse + * @subsubsection bx_base_profile-browse_active_profiles browse_active_profiles + * + * @code bx_srv('bx_persons', 'browse_active_profiles', [...]); @endcode + * + * Browse recently active profiles + * @param $bEmptyMessage optional, display or not "empty" message when there is no content + * @param $bAjaxPaginate optional, use AJAX paginate or not + * + * @see BxBaseModProfileModule::serviceBrowseActiveProfiles + */ + /** + * @ref bx_base_profile-browse_active_profiles "browse_active_profiles" + */ + public function serviceBrowseActiveProfiles ($sUnitView = false, $bEmptyMessage = false, $bAjaxPaginate = false) + { + return $this->_serviceBrowse ('active', $sUnitView ? array('unit_view' => $sUnitView) : false, BX_DB_PADDING_DEF, $bEmptyMessage, $bAjaxPaginate); + } + + /** + * @page service Service Calls + * @section bx_base_profile Base Profile + * @subsection bx_base_profile-browse Browse + * @subsubsection bx_base_profile-browse_familiar_profiles browse_familiar_profiles + * + * @code bx_srv('bx_persons', 'browse_familiar_profiles', [...]); @endcode + * + * Browse profiles you might be familiar with. By default using 'Profile Friends' connection. + * @param $bEmptyMessage optional, display or not "empty" message when there is no content + * @param $bAjaxPaginate optional, use AJAX paginate or not + * + * @see BxBaseModProfileModule::serviceBrowseFamiliarProfiles + */ + /** + * @ref bx_base_profile-browse_familiar_profiles "browse_familiar_profiles" + */ + public function serviceBrowseFamiliarProfiles ($sConnection = '', $sUnitView = false, $bEmptyMessage = false, $bAjaxPaginate = false) + { + $aParams = [ + 'object' => 'sys_profiles_friends', + 'profile' => bx_get_logged_profile_id(), + ]; + + if(!empty($sConnection)) { + if(is_string($sConnection)) + $aParams['object'] = $sConnection; + else if(is_array($sConnection)) + $aParams = array_merge($aParams, $sConnection); + } + + if($sUnitView) + $aParams['unit_view'] = $sUnitView; + + return $this->_serviceBrowse ('familiar', $aParams, BX_DB_PADDING_DEF, $bEmptyMessage, $bAjaxPaginate); + } + + /** + * @page service Service Calls + * @section bx_base_profile Base Profile + * @subsection bx_base_profile-browse Browse + * @subsubsection bx_base_profile-browse_top_profiles browse_top_profiles + * + * @code bx_srv('bx_persons', 'browse_top_profiles', [...]); @endcode + * + * Browse top profiles + * @param $bEmptyMessage optional, display or not "empty" message when there is no content + * @param $bAjaxPaginate optional, use AJAX paginate or not + * + * @see BxBaseModProfileModule::serviceBrowseTopProfiles + */ + /** + * @ref bx_base_profile-browse_top_profiles "browse_top_profiles" + */ + public function serviceBrowseTopProfiles ($bDisplayEmptyMsg = false, $bAjaxPaginate = false) + { + return $this->_serviceBrowse ('top', false, BX_DB_PADDING_DEF, $bDisplayEmptyMsg, $bAjaxPaginate); + } + + /** + * @page service Service Calls + * @section bx_base_profile Base Profile + * @subsection bx_base_profile-browse Browse + * @subsubsection bx_base_profile-browse_online_profiles browse_online_profiles + * + * @code bx_srv('bx_persons', 'browse_online_profiles', [...]); @endcode + * + * Browse online profiles + * @param $bEmptyMessage optional, display or not "empty" message when there is no content + * @param $bAjaxPaginate optional, use AJAX paginate or not + * + * @see BxBaseModProfileModule::serviceBrowseOnlineProfiles + */ + /** + * @ref bx_base_profile-browse_online_profiles "browse_online_profiles" + */ + public function serviceBrowseOnlineProfiles ($bDisplayEmptyMsg = false, $bAjaxPaginate = false) + { + return $this->_serviceBrowse ('online', false, BX_DB_PADDING_DEF, $bDisplayEmptyMsg, $bAjaxPaginate); + } + + public function serviceBrowseConnections ($iProfileId, $sObjectConnections = 'sys_profiles_friends', $sConnectionsType = 'content', $iMutual = false, $iDesignBox = BX_DB_PADDING_DEF, $iProfileId2 = 0) + { + return $this->_serviceBrowse ( + 'connections', [ + 'object' => $sObjectConnections, + 'type' => $sConnectionsType, + 'mutual' => $iMutual, + 'profile' => (int)$iProfileId, + 'profile2' => (int)$iProfileId2 + ], $iDesignBox + ); + } + + public function serviceBrowseRelationsQuick ($iProfileId, $sObjectConnections = 'sys_profiles_friends', $sConnectionsType = 'content', $iMutual = false, $iProfileId2 = 0) + { + // get connections object + $oConnection = BxDolConnection::getObjectInstance($sObjectConnections); + if (!$oConnection) + return ''; + + // set some vars + $iStart = (int)bx_get('start'); + $iLimit = empty($this->_oConfig->CNF['PARAM_NUM_CONNECTIONS_QUICK']) ? 4 : getParam($this->_oConfig->CNF['PARAM_NUM_CONNECTIONS_QUICK']); + if (!$iLimit) + $iLimit = 4; + + // get connections array + bx_import('BxDolConnection'); + $aConnections = $oConnection->getConnectionsAsArrayExt($sConnectionsType, $iProfileId, $iProfileId2, $iMutual, $iStart, $iLimit + 1, BX_CONNECTIONS_ORDER_ADDED_DESC); + if(empty($aConnections) || !is_array($aConnections)) + return ''; + + $aResult = array(); + foreach($aConnections as $iProfile => $aConnection) + $aResult[] = array( + 'id' => $iProfile, + 'info' => array( + 'addon' => $oConnection->getRelationTranslation($aConnection['relation']) + ) + ); + + return $this->_serviceBrowseQuick($aResult, $iStart, $iLimit); + } + + public function serviceBrowseConnectionsQuick ($iProfileId, $sObjectConnections = 'sys_profiles_friends', $sConnectionsType = 'content', $iMutual = false, $iProfileId2 = 0) + { + // get connections object + $oConnection = BxDolConnection::getObjectInstance($sObjectConnections); + if (!$oConnection) + return ''; + + // set some vars + $iLimit = empty($this->_oConfig->CNF['PARAM_NUM_CONNECTIONS_QUICK']) ? 4 : getParam($this->_oConfig->CNF['PARAM_NUM_CONNECTIONS_QUICK']); + if (!$iLimit) + $iLimit = 4; + $iStart = (int)bx_get('start'); + + // get connections array + bx_import('BxDolConnection'); + $a = $oConnection->getConnectionsAsArray ($sConnectionsType, $iProfileId, $iProfileId2, $iMutual, (int)bx_get('start'), $iLimit + 1, BX_CONNECTIONS_ORDER_ADDED_DESC); + if (!$a) + return ''; + + return $this->_serviceBrowseQuick($a, $iStart, $iLimit); + } + + public function serviceBrowseConnectionsByType ($aParamsCnn, $aParamsBrs = array()) + { + $sAll = 'all'; + + $aParamsCnn['object'] = !empty($aParamsCnn['object']) ? $aParamsCnn['object'] : 'sys_profiles_friends'; + $aParamsCnn['type'] = !empty($aParamsCnn['type']) ? $aParamsCnn['type'] : 'content'; + $aParamsCnn['profile_id2'] = !empty($aParamsCnn['profile_id2']) ? (int)$aParamsCnn['profile_id2'] : 0; + $aParamsCnn['mutual'] = isset($aParamsCnn['mutual']) ? $aParamsCnn['mutual'] : false; + + $oConnection = BxDolConnection::getObjectInstance($aParamsCnn['object']); + if(!$oConnection) + return ''; + + $aSQLParts = $oConnection->getConnectionsAsSQLParts ($aParamsCnn['type'], 'sys_profiles', 'id', $aParamsCnn['profile_id'], $aParamsCnn['profile_id2'], $aParamsCnn['mutual']); + + $sType = !empty($aParamsBrs['type']) ? $aParamsBrs['type'] : $sAll; + if(bx_get('type') !== false) + $sType = bx_process_input(bx_get('type')); + + $iStart = (int)bx_get('start'); + + $iLimitDefault = 4; + $iLimit = !empty($this->_oConfig->CNF['PARAM_NUM_CONNECTIONS_QUICK']) ? getParam($this->_oConfig->CNF['PARAM_NUM_CONNECTIONS_QUICK']) : $iLimitDefault; + if(!empty($aParamsBrs['per_page'])) + $iLimit = (int)$aParamsBrs['per_page']; + if(!$iLimit) + $iLimit = $iLimitDefault; + + $aProfiles = BxDolProfileQuery::getInstance()->getConnectedProfilesByType($aSQLParts, ($sType != $sAll ? $sType : ''), $iStart, $iLimit + 1); + + $mixedMenu = ''; + if(!isset($aParamsBrs['filter_menu']) || $aParamsBrs['filter_menu'] === true) { + $aModules = array( + array('name' => $sAll) + ); + $aModules = array_merge($aModules, BxDolModuleQuery::getInstance()->getModulesBy(array('type' => 'modules', 'active' => 1))); + + $aMenuItems = array(); + foreach($aModules as $aModule) + if($aModule['name'] == $sAll || BxDolRequest::serviceExists($aModule['name'], 'act_as_profile')) + $aMenuItems[] = array( + 'id' => $aModule['name'], + 'name' => $aModule['name'], + 'class' => '', + 'link' => 'javascript:void(0)', + 'onclick' => "return !loadDynamicBlockAutoPaginate(this, " . $iStart . ", " . $iLimit . ", " . bx_js_string(json_encode(array('type' => $aModule['name']))) . ");", + 'target' => '_self', + 'title' => _t('_' . $aModule['name']), + 'active' => 1 + ); + + if(!empty($aMenuItems)) { + $mixedMenu = new BxTemplMenu(array('template' => 'menu_vertical.html', 'menu_id'=> $this->_oConfig->getName() . '-connections-by-type', 'menu_items' => $aMenuItems)); + $mixedMenu->setSelected('', $sType); + } + } + + return array( + 'menu' => $mixedMenu, + 'content' => $this->_serviceBrowseQuick(array_keys($aProfiles), $iStart, $iLimit, array('type' => $sType)) + ); + } + + /** + * @page service Service Calls + * @section bx_base_profile Base Profile + * @subsection bx_base_profile-browse Browse + * @subsubsection bx_base_profile-browse_by_acl browse_by_acl + * + * @code bx_srv('bx_persons', 'browse_by_acl', [...]); @endcode + * + * Browse profiles by membership(ACL) level + * @param $mixedLevelId membership level, or array of membership levels + * @param $iDesignBox optional, design box identifier + * + * @see BxBaseModProfileModule::serviceBrowseByAcl + */ + /** + * @ref bx_base_profile-browse_by_acl "browse_by_acl" + */ + public function serviceBrowseByAcl ($mixedLevelId, $iDesignBox = BX_DB_PADDING_DEF) + { + return $this->_serviceBrowse ( + 'acl', + array( + 'level' => $mixedLevelId, + ), + $iDesignBox, + true + ); + } + + public function serviceEntityEditCover ($iContentId = 0) + { + return $this->_serviceEntityForm ('editDataForm', $iContentId, $this->_oConfig->CNF['OBJECT_FORM_ENTRY_DISPLAY_EDIT_COVER']); + } + + /** + * @page service Service Calls + * @section bx_base_profile Base Profile + * @subsection bx_base_profile-page_blocks Page Blocks + * @subsubsection bx_base_profile-entity_cover entity_cover + * + * @code bx_srv('bx_persons', 'entity_cover', [...]); @endcode + * + * Get cover + * @param $iContentId content ID + * + * @see BxBaseModProfileModule::serviceEntityCover + */ + /** + * @ref bx_base_general-entity_cover "entity_cover" + */ + public function serviceEntityCover ($iContentId = 0, $aParams = []) + { + $mixedContent = $this->_getContent($iContentId); + if($mixedContent === false) + return false; + + list($iContentId, $aContentInfo) = $mixedContent; + + if($this->_bIsApi) { + $CNF = &$this->_oConfig->CNF; + + $aContentInfo['cover'] = $this->serviceGetCover($iContentId); + $aContentInfo['image'] = $this->serviceGetThumb($iContentId); + + $sKey = 'OBJECT_MENU_VIEW_ENTRY_META'; + if(!empty($CNF[$sKey]) && ($oMetaMenu = BxTemplMenu::getObjectInstance($CNF[$sKey])) !== false) + $aContentInfo['meta_menu'] = $oMetaMenu->getCodeAPI(); + + $sKey = 'OBJECT_MENU_ACTIONS_VIEW_ENTRY_ALL'; + if(!empty($CNF[$sKey]) && ($oActionMenu = BxTemplMenu::getObjectInstance($CNF[$sKey])) !== false) + $aContentInfo['actions_menu'] = $oActionMenu->getCodeAPI(); + + if(($oMenuManage = BxDolMenu::getObjectInstance('sys_site_manage')) !== false) { + if(!empty($CNF['FIELD_ID'])) + $oMenuManage->setContentId($aContentInfo[$CNF['FIELD_ID']]); + + $aObjectManage = []; + if(!empty($CNF['OBJECT_MENU_MANAGE_VIEW_ENTRY'])) + $aObjectManage = [$CNF['OBJECT_MENU_MANAGE_VIEW_ENTRY']]; + else if(!empty($CNF['OBJECT_MENU_ACTIONS_VIEW_ENTRY_MORE'])) + $aObjectManage = [$CNF['OBJECT_MENU_ACTIONS_VIEW_ENTRY_MORE'], true]; + + call_user_func_array([$oMenuManage, 'setObjectManage'], $aObjectManage); + + $aMenuManage = $oMenuManage->getCodeAPI(); + if(!empty($aMenuManage) && is_array($aMenuManage)) { + if(isset($aContentInfo['actions_menu']) && is_array($aContentInfo['actions_menu'])) + $aContentInfo['actions_menu']['items'] = array_merge($aContentInfo['actions_menu']['items'], $aMenuManage['items']); + else + $aContentInfo['actions_menu'] = $aMenuManage; + } + } + + if(($oProfile = BxDolProfile::getInstanceByContentAndType($iContentId, $this->getName())) !== false); + $aContentInfo['profile'] = BxDolProfile::getData($oProfile, [ + 'get_avatar' => 'getAvatarBig', + 'with_info' => false + ]); + + return [bx_api_get_block('entity_cover', $aContentInfo)]; + } + + return $this->_oTemplate->getBlockCover($aContentInfo, $aParams); + } + + /** + * Entry comments + */ + public function serviceEntityCommentsByProfile ($iProfileId) + { + $CNF = &$this->_oConfig->CNF; + if(empty($CNF['OBJECT_COMMENTS'])) + return ''; + + $oProfile = BxDolProfile::getInstance($iProfileId); + if(!$oProfile) + return ''; + + return $this->_entityComments($CNF['OBJECT_COMMENTS'], $oProfile->getContentId()); + } + + /** + * Entry social sharing block + */ + public function serviceEntitySocialSharing ($mixedContent = false, $aParams = array()) + { + if(!empty($mixedContent)) { + if(!is_array($mixedContent)) + $mixedContent = array((int)$mixedContent, array()); + } + else { + $mixedContent = $this->_getContent(); + if($mixedContent === false) + return false; + } + + list($iContentId, $aContentInfo) = $mixedContent; + + return parent::serviceEntitySocialSharing(array($iContentId, $aContentInfo), array( + 'id_thumb' => !empty($CNF['FIELD_PICTURE']) && !empty($aContentInfo[$CNF['FIELD_PICTURE']]) ? $aContentInfo[$CNF['FIELD_PICTURE']] : 0, + )); + } + + public function serviceProfileMembership ($iContentId = 0) + { + $mixedContent = $this->_getContent($iContentId); + if($mixedContent === false) + return false; + + list($iContentId, $aContentInfo) = $mixedContent; + + return BxDolAcl::getInstance()->getProfileMembership($aContentInfo['profile_id']); + } + + public function serviceProfileFriends ($iContentId = 0) + { + $mixedContent = $this->_getContent($iContentId); + if($mixedContent === false) + return false; + + list($iContentId, $aContentInfo) = $mixedContent; + + bx_import('BxDolConnection'); + $s = $this->serviceBrowseConnectionsQuick ($aContentInfo['profile_id'], 'sys_profiles_friends', BX_CONNECTIONS_CONTENT_TYPE_CONTENT, true); + if (!$s) + return MsgBox(_t('_sys_txt_empty')); + + return $s; + } + + public function serviceProfileFriendsMutual ($iContentId = 0) + { + $mixedContent = $this->_getContent($iContentId); + if($mixedContent === false) + return false; + + list($iContentId, $aContentInfo) = $mixedContent; + + $iViewer = bx_get_logged_profile_id(); + $iOwner = (int)$aContentInfo['profile_id']; + if($iViewer == $iOwner) + return false; + + bx_import('BxDolConnection'); + $s = $this->serviceBrowseConnectionsQuick ($iOwner, 'sys_profiles_friends', BX_CONNECTIONS_CONTENT_TYPE_COMMON, true, $iViewer); + if(!$s) + return MsgBox(_t('_sys_txt_empty')); + + return $s; + } + + public function serviceProfileSubscriptions ($iContentId = 0, $aParams = array()) + { + $mixedContent = $this->_getContent($iContentId); + if($mixedContent === false) + return false; + + list($iContentId, $aContentInfo) = $mixedContent; + + bx_import('BxDolConnection'); + $aResult = $this->serviceBrowseConnectionsByType(array( + 'profile_id' => $aContentInfo['profile_id'], + 'object' => 'sys_profiles_subscriptions', + 'type' => BX_CONNECTIONS_CONTENT_TYPE_CONTENT + ), array( + 'type' => isset($aParams['type']) ? $aParams['type'] : '', + 'filter_menu' => isset($aParams['filter_menu']) ? $aParams['filter_menu'] : true, + )); + if(empty($aResult['content'])) + $aResult['content'] = MsgBox(_t('_sys_txt_empty')); + + return $aResult; + } + + public function serviceProfileSubscribedMe ($iContentId = 0) + { + $mixedContent = $this->_getContent($iContentId); + if($mixedContent === false) + return false; + + list($iContentId, $aContentInfo) = $mixedContent; + + bx_import('BxDolConnection'); + $s = $this->serviceBrowseConnectionsQuick ($aContentInfo['profile_id'], 'sys_profiles_subscriptions', BX_CONNECTIONS_CONTENT_TYPE_INITIATORS); + if (!$s) + return MsgBox(_t('_sys_txt_empty')); + + return $s; + } + + public function serviceProfileRelations ($iContentId = 0, $aParams = array()) + { + if(!BxDolRelation::isEnabled()) + return false; + + $mixedContent = $this->_getContent($iContentId); + if($mixedContent === false) + return false; + + list($iContentId, $aContentInfo) = $mixedContent; + + bx_import('BxDolConnection'); + $s = $this->serviceBrowseRelationsQuick ($aContentInfo['profile_id'], 'sys_profiles_relations', BX_CONNECTIONS_CONTENT_TYPE_CONTENT, 1); + if (!$s) + return MsgBox(_t('_sys_txt_empty')); + + return $s; + } + + public function serviceProfileRelatedMe ($iContentId = 0) + { + if(!BxDolRelation::isEnabled()) + return false; + + $mixedContent = $this->_getContent($iContentId); + if($mixedContent === false) + return false; + + list($iContentId, $aContentInfo) = $mixedContent; + + bx_import('BxDolConnection'); + $s = $this->serviceBrowseRelationsQuick ($aContentInfo['profile_id'], 'sys_profiles_relations', BX_CONNECTIONS_CONTENT_TYPE_INITIATORS, 1); + if (!$s) + return MsgBox(_t('_sys_txt_empty')); + + return $s; + } + + /** + * check enabled profile activation letter + */ + public function serviceIsEnableProfileActivationLetter() + { + $CNF = &$this->_oConfig->CNF; + return isset($CNF['PARAM_ENABLE_ACTIVATION_LETTER']) ? (bool)getParam($CNF['PARAM_ENABLE_ACTIVATION_LETTER']) : true; + } + + public function serviceIsEnableRelations() + { + if(!BxDolRelation::isEnabled()) + return false; + + $sModule = $this->_oConfig->getName(); + $oRelations = BxDolConnection::getObjectInstance('sys_profiles_relations'); + return $oRelations->isRelationAvailableWithProfile($sModule) || $oRelations->isRelationAvailableFromProfile($sModule); + } + + /** + * For internal usage only. + */ + public function serviceDeleteEntityService ($iContentId, $bDeleteWithContent = false) + { + return parent::serviceDeleteEntity ($iContentId, 'deleteDataService'); + } + + /** + * Data for Notifications module + */ + public function serviceGetNotificationsData() + { + $a = parent::serviceGetNotificationsData(); + + $sModule = $this->_aModule['name']; + + $a['handlers'][] = array('group' => $sModule . '_timeline_post_common', 'type' => 'insert', 'alert_unit' => $sModule, 'alert_action' => 'timeline_post_common', 'module_name' => $sModule, 'module_method' => 'get_notifications_timeline_post_common', 'module_class' => 'Module'); + + $a['settings'][] = array('group' => 'timeline_post', 'unit' => $sModule, 'action' => 'timeline_post_common', 'types' => array('follow_member')); + + $a['alerts'][] = array('unit' => $sModule, 'action' => 'timeline_post_common'); + + return $a; + } + + public function serviceGetNotificationsPost($aEvent) + { + $aResult = parent::serviceGetNotificationsVote($aEvent); + if(empty($aResult) || !is_array($aResult) || !$this->serviceActAsProfile()) + return $aResult; + + $oProfile = BxDolProfile::getInstanceByContentAndType((int)$aEvent['object_id'], $this->_oConfig->getName()); + if($oProfile !== false) + $aResult['entry_author'] = $oProfile->id(); + + return $aResult; + } + + public function serviceGetNotificationsVote($aEvent) + { + $aResult = parent::serviceGetNotificationsVote($aEvent); + if(empty($aResult) || !is_array($aResult) || !$this->serviceActAsProfile()) + return $aResult; + + $oProfile = BxDolProfile::getInstanceByContentAndType((int)$aEvent['object_id'], $this->_oConfig->getName()); + if($oProfile !== false) + $aResult['entry_author'] = $oProfile->id(); + + return $aResult; + } + + /** + * Notification about new member requst in the group + */ + public function serviceGetNotificationsTimelinePostCommon($aEvent) + { + $CNF = &$this->_oConfig->CNF; + + $iContentId = (int)$aEvent['object_id']; + $oGroupProfile = BxDolProfile::getInstanceByContentAndType((int)$iContentId, $this->getName()); + if(!$oGroupProfile) + return []; + + $aContentInfo = $this->_oDb->getContentInfoById($iContentId); + if(empty($aContentInfo) || !is_array($aContentInfo)) + return []; + + $aSubcontentInfo = BxDolService::call('bx_timeline', 'get_info', array((int)$aEvent['subobject_id'], false)); + if(empty($aSubcontentInfo) || !is_array($aSubcontentInfo)) + return []; + + $sEntrySummary = isset($aContentInfo[$CNF['FIELD_TEXT']]) ? $aContentInfo[$CNF['FIELD_TEXT']] : ''; + + $sSubentryUrl = bx_absolute_url(str_replace(BX_DOL_URL_ROOT, '', BxDolService::call('bx_timeline', 'get_link', array((int)$aEvent['subobject_id']))), '{bx_url_root}'); + $sSubentrySample = $aSubcontentInfo['title']; + if(empty($sSubentrySample)) + $sSubentrySample = strmaxtextlen($aSubcontentInfo['description'], 20, '...'); + $sSubentrySummary = $aSubcontentInfo['description']; + + return [ + 'entry_sample' => $CNF['T']['txt_sample_single'], + 'entry_url' => bx_absolute_url(str_replace(BX_DOL_URL_ROOT, '', $oGroupProfile->getUrl()), '{bx_url_root}'), + 'entry_caption' => $oGroupProfile->getDisplayName(), + 'entry_summary' => $sEntrySummary, + 'entry_author' => $oGroupProfile->id(), + 'subentry_sample' => $sSubentrySample, + 'subentry_url' => $sSubentryUrl, + 'subentry_summary' => $sSubentrySummary, + 'lang_key' => $CNF['T']['txt_ntfs_timeline_post_common'], + ]; + } + + /** + * Data for Timeline module + */ + public function serviceGetTimelineData() + { + $CNF = &$this->_oConfig->CNF; + $sModule = $this->_aModule['name']; + + $aAlerts = array(); + $aHandlers = array(); + if(!empty($CNF['FIELD_PICTURE'])) { + $aAlerts = array_merge($aAlerts, array( + array('unit' => $sModule, 'action' => 'profile_picture_changed'), + array('unit' => $sModule, 'action' => 'profile_picture_deleted') + )); + $aHandlers = array_merge($aHandlers, array( + array('group' => $sModule . '_profile_picture', 'type' => 'insert', 'alert_unit' => $sModule, 'alert_action' => 'profile_picture_changed', 'module_name' => $sModule, 'module_method' => 'get_timeline_profile_picture', 'module_class' => 'Module', 'groupable' => 0, 'group_by' => ''), + array('group' => $sModule . '_profile_picture', 'type' => 'delete', 'alert_unit' => $sModule, 'alert_action' => 'profile_picture_deleted') + )); + } + + if(!empty($CNF['FIELD_COVER'])) { + $aAlerts = array_merge($aAlerts, array( + array('unit' => $sModule, 'action' => 'profile_cover_changed'), + array('unit' => $sModule, 'action' => 'profile_cover_deleted') + )); + $aHandlers = array_merge($aHandlers, array( + array('group' => $sModule . '_profile_cover', 'type' => 'insert', 'alert_unit' => $sModule, 'alert_action' => 'profile_cover_changed', 'module_name' => $sModule, 'module_method' => 'get_timeline_profile_cover', 'module_class' => 'Module', 'groupable' => 0, 'group_by' => ''), + array('group' => $sModule . '_profile_cover', 'type' => 'delete', 'alert_unit' => $sModule, 'alert_action' => 'profile_cover_deleted') + )); + } + + $aResult = array(); + if(!empty($aAlerts) && !empty($aHandlers)) + $aResult = array( + 'handlers' => $aHandlers, + 'alerts' => $aAlerts + ); + + return $aResult; + } + + /** + * Entry post for Timeline module + */ + public function serviceGetTimelineProfilePicture($aEvent, $aBrowseParams = []) + { + $aResult = $this->_serviceGetTimelineProfileImage($aEvent, $aBrowseParams, [ + 'stg' => 'OBJECT_STORAGE', + 'trans' => ['OBJECT_IMAGES_TRANSCODER_GALLERY', 'OBJECT_IMAGES_TRANSCODER_AVATAR'], + 'trans_orig' => ['OBJECT_IMAGES_TRANSCODER_PICTURE', 'OBJECT_IMAGES_TRANSCODER_GALLERY'], + 'txt_ss' => 'txt_sample_pp_single', + 'txt_sswa' => 'txt_sample_pp_single_with_article', + 'txt_sa' => 'txt_sample_pi_action', + 'txt_sau' => 'txt_sample_pi_action_user' + ]); + + if($aResult !== false) + $aResult['allowed_view'] = ['module' => $this->_oConfig->getName(), 'method' => 'get_timeline_profile_picture_allowed_view']; + + return $aResult; + } + + public function serviceGetTimelineProfilePictureAllowedView($aEvent) + { + return $this->_serviceGetTimelineProfileImageAllowedView($aEvent); + } + + public function serviceGetTimelineProfileCover($aEvent, $aBrowseParams = []) + { + $aResult = $this->_serviceGetTimelineProfileImage($aEvent, $aBrowseParams, [ + 'stg' => 'OBJECT_STORAGE_COVER', + 'trans' => ['OBJECT_IMAGES_TRANSCODER_GALLERY', 'OBJECT_IMAGES_TRANSCODER_COVER_THUMB'], + 'trans_orig' => ['OBJECT_IMAGES_TRANSCODER_COVER', 'OBJECT_IMAGES_TRANSCODER_GALLERY'], + 'txt_ss' => 'txt_sample_pc_single', + 'txt_sswa' => 'txt_sample_pc_single_with_article', + 'txt_sa' => 'txt_sample_pi_action', + 'txt_sau' => 'txt_sample_pi_action_user' + ]); + + if($aResult !== false) + $aResult['allowed_view'] = ['module' => $this->_oConfig->getName(), 'method' => 'get_timeline_profile_cover_allowed_view']; + + return $aResult; + } + + public function serviceGetTimelineProfileCoverAllowedView($aEvent) + { + return $this->_serviceGetTimelineProfileImageAllowedView($aEvent); + } + + public function serviceGetMenuItemTitleByConnection($sConnection, $sAction, $iContentProfileId, $iInitiatorProfileId = 0) + { + return $this->getMenuItemTitleByConnection($sConnection, $sAction, $iContentProfileId, $iInitiatorProfileId); + } + + + // ====== PERMISSION METHODS + /** + * @see iBxDolProfileService::serviceCheckAllowedProfileView + */ + public function serviceCheckAllowedProfileView($iContentId) + { + return $this->serviceCheckAllowedWithContent('View', $iContentId); + } + + /** + * @see iBxDolProfileService::serviceCheckAllowedProfileContact + */ + public function serviceCheckAllowedProfileContact($iContentId) + { + return $this->serviceCheckAllowedWithContent('Contact', $iContentId); + } + + /** + * @see iBxDolProfileService::serviceCheckAllowedPostInProfile + */ + public function serviceCheckAllowedPostInProfile($iContentId, $sPostModule = '') + { + $CNF = &$this->_oConfig->CNF; + + if(!empty($CNF['FIELD_ALLOW_VIEW_TO']) && getParam('sys_treat_cxt_in_cxt_as_cnt') == 'on') { + $aContentInfo = $this->_oDb->getContentInfoById($iContentId); + if($aContentInfo && isset($aContentInfo[$CNF['FIELD_ALLOW_VIEW_TO']]) && (int)$aContentInfo[$CNF['FIELD_ALLOW_VIEW_TO']] < 0) + return _t('_sys_txt_access_denied'); + } + + // for groups based profiles we do have a Role permissions which have a higher priority than the site-wide permissions. + if (method_exists($this, 'isAllowedModuleActionByProfile')) { + $bResult = $this->isAllowedModuleActionByProfile($iContentId, $sPostModule, 'post'); + // if a profile is having a role and a role is having permissions set then it overrides the site-wide setting. + if ($bResult !== NULL) return $bResult; + } + + return $this->serviceCheckAllowedWithContent('Post', $iContentId); + } + + /** + * @see iBxDolProfileService::serviceCheckAllowedModuleActionInProfile + */ + public function serviceCheckAllowedModuleActionInProfile($iContentId, $sPostModule, $sActionName) + { + if (method_exists($this, 'isAllowedModuleActionByProfile')) { + $bResult = $this->isAllowedModuleActionByProfile($iContentId, $sPostModule, $sActionName); + if ($bResult !== NULL) return $bResult; + } + + return _t('_Access denied'); + } + + /** + * @see iBxDolProfileService::serviceCheckSpacePrivacy + */ + public function serviceCheckSpacePrivacy($iContentId) + { + return $this->serviceCheckAllowedProfileView($iContentId); + } + + /** + * Check if the profile can be viewed. + * + * NOTE. This service should be used if it's needed to pass some specific values in + * $isPerformAction and $iProfileId parameters, otherwise it's recommended to use + * BxBaseModProfileModule::serviceCheckAllowedProfileView service method or + * BxDolProfile::checkAllowedProfileView method. + * + * @param type $aDataEntry - entry which the action will be performed for + * @param type $isPerformAction - perform or just check the action + * @param type $iProfileId - performer's profile ID + * @return integer - one of CHECK_ACTION_RESULT_XXX constants. + */ + public function serviceCheckAllowedViewForProfile ($aDataEntry, $isPerformAction = false, $iProfileId = false) + { + if (!$iProfileId) + $iProfileId = $this->_iProfileId; + + if(empty($aDataEntry) || !is_array($aDataEntry)) + return _t('_sys_txt_not_found'); + + $oProfile = BxDolProfile::getInstanceByContentAndType($aDataEntry[$this->_oConfig->CNF['FIELD_ID']], $this->getName()); + if ($oProfile && $oProfile->id() == $iProfileId) + return CHECK_ACTION_RESULT_ALLOWED; + + return parent::serviceCheckAllowedViewForProfile ($aDataEntry, $isPerformAction, $iProfileId); + } + + /** + * Check if posting (comment, post in Timeline) is available. + * + * NOTE. This service should be used if it's needed to pass some specific values in + * $isPerformAction and $iProfileId parameters, otherwise it's recommended to use + * BxBaseModProfileModule::serviceCheckAllowedPostInProfile service method or + * BxDolProfile::checkAllowedPostInProfile method. + * + * @param type $aDataEntry - entry which the action will be performed for + * @param type $isPerformAction - perform or just check the action + * @param type $iProfileId - performer's profile ID + * @return integer - one of CHECK_ACTION_RESULT_XXX constants. + */ + public function serviceCheckAllowedPostForProfile ($aDataEntry, $isPerformAction = false, $iProfileId = false) + { + $CNF = &$this->_oConfig->CNF; + + if(!$iProfileId) + $iProfileId = $this->_iProfileId; + + // check is view allowed + if(($mixedResult = $this->serviceCheckAllowedViewForProfile($aDataEntry, $isPerformAction, $iProfileId)) !== CHECK_ACTION_RESULT_ALLOWED) + return $mixedResult; + + // moderator and owner always have access + $oProfile = BxDolProfile::getInstanceByContentAndType($aDataEntry[$CNF['FIELD_ID']], $this->getName()); + if(($oProfile && $oProfile->id() == $iProfileId) || $this->_isModerator($isPerformAction)) + return CHECK_ACTION_RESULT_ALLOWED; + + // check privacy + if(!empty($CNF['OBJECT_PRIVACY_POST'])) { + $oPrivacy = BxDolPrivacy::getObjectInstance($CNF['OBJECT_PRIVACY_POST']); + if($oPrivacy && !$oPrivacy->check($aDataEntry[$CNF['FIELD_ID']], $iProfileId)) + return _t('_sys_access_denied_to_private_content'); + } + + // check alert to allow custom checks + $mixedResult = null; + + /** + * @hooks + * @hookdef hook-system-check_allowed_post 'system', 'check_allowed_post' - hook to override the result of checking whether 'post' action is allowed or not to specified profile + * It's equivalent to @ref hook-system-check_allowed_view + * @hook @ref hook-system-check_allowed_post + */ + bx_alert('system', 'check_allowed_post', 0, 0, [ + 'module' => $this->getName(), + 'content_info' => $aDataEntry, + 'profile_id' => $iProfileId, + 'override_result' => &$mixedResult + ]); + if($mixedResult !== null) + return $mixedResult; + + return CHECK_ACTION_RESULT_ALLOWED; + } + + /** + * Check if profile can be contacted. + * + * NOTE. This service should be used if it's needed to pass some specific values in + * $isPerformAction and $iProfileId parameters, otherwise it's recommended to use + * BxBaseModProfileModule::serviceCheckAllowedProfileContact service method or + * BxDolProfile::checkAllowedProfileContact method. + * + * @param type $aDataEntry - entry which the action will be performed for + * @param type $isPerformAction - perform or just check the action + * @param type $iProfileId - performer's profile ID + * @return integer - one of CHECK_ACTION_RESULT_XXX constants. + */ + public function serviceCheckAllowedContactForProfile ($aDataEntry, $isPerformAction = false, $iProfileId = false) + { + $mixedResult = $this->_serviceCheckAllowedContactForProfile($aDataEntry, $isPerformAction, $iProfileId); + + /** + * @hooks + * @hookdef hook-system-check_allowed_contact 'system', 'check_allowed_contact' - hook to override the result of checking whether 'contact' action is allowed or not to specified profile + * It's equivalent to @ref hook-system-check_allowed_view + * @hook @ref hook-system-check_allowed_contact + */ + bx_alert('system', 'check_allowed_contact', 0, 0, [ + 'module' => $this->getName(), + 'content_info' => $aDataEntry, + 'profile_id' => $iProfileId, + 'override_result' => &$mixedResult + ]); + + return $mixedResult; + } + + public function serviceSetViewProfileCover($oPage, $aProfileInfo) + { + $this->_oTemplate->setCover($oPage,$aProfileInfo); + } + + /** + * Returns list of members by mode with limited number of records for React Jot + * @param string $sMode + * @param int $iStart + * @param int $iPerPage + * @return mixed + */ + public function serviceGetMembers($sMode = 'active', $iStart = 0, $iPerPage = 10){ + bx_import('SearchResult', $this->_aModule); + $sClass = $this->_aModule['class_prefix'] . 'SearchResult'; + $o = new $sClass($sMode); + + $o -> aCurrent['paginate'] = array('perPage' => $iPerPage, 'forceStart' => $iStart); + return $o -> getSearchData(); + } + + /** + * @return CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. So make sure to make strict(===) checking. + */ + public function checkAllowedAdd ($isPerformAction = false) + { + if($this->serviceActAsProfile() && ($oAccount = BxDolAccount::getInstance()) !== false && $oAccount->isProfilesLimitReached()) + return _t('_sys_txt_access_denied'); + + return parent::checkAllowedAdd ($isPerformAction); + } + + /** + * @return CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. So make sure to make strict(===) checking. + */ + public function checkAllowedView ($aDataEntry, $isPerformAction = false) + { + return $this->serviceCheckAllowedViewForProfile ($aDataEntry, $isPerformAction); + } + + /** + * @return CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. + */ + public function checkAllowedViewProfileImage ($aDataEntry, $isPerformAction = false) + { + $CNF = &$this->_oConfig->CNF; + + // check privacy + if (empty($CNF['OBJECT_PRIVACY_VIEW']) || isAdmin() || CHECK_ACTION_RESULT_ALLOWED === $this->checkAllowedEditAnyEntry()) + return CHECK_ACTION_RESULT_ALLOWED; + + $oPrivacy = BxDolPrivacy::getObjectInstance($CNF['OBJECT_PRIVACY_VIEW']); + if ($oPrivacy && !$oPrivacy->check($aDataEntry[$CNF['FIELD_ID']]) && !$oPrivacy->isPartiallyVisible($aDataEntry[$CNF['FIELD_ALLOW_VIEW_TO']])) + return _t('_sys_access_denied_to_private_content'); + + return CHECK_ACTION_RESULT_ALLOWED; + } + + /** + * @return CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. + */ + public function checkAllowedViewCoverImage ($aDataEntry, $isPerformAction = false) + { + return $this->checkAllowedViewProfileImage($aDataEntry); + } + + /** + * @return CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. + */ + public function checkAllowedPost ($aDataEntry, $isPerformAction = false) + { + return $this->serviceCheckAllowedPostForProfile ($aDataEntry, $isPerformAction); + } + + /** + * @return CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. + */ + public function checkAllowedContact ($aDataEntry, $isPerformAction = false) + { + return $this->serviceCheckAllowedContactForProfile ($aDataEntry, $isPerformAction); + } + + /** + * @return CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. + */ + public function checkAllowedEdit ($aDataEntry, $isPerformAction = false) + { + if(empty($aDataEntry) || !is_array($aDataEntry)) + return _t('_sys_txt_not_found'); + + // moderator always has access + if ($this->_isModerator($isPerformAction)) + return CHECK_ACTION_RESULT_ALLOWED; + + // owner (checked by account instead of author!) always have access + $oProfile = BxDolProfile::getInstanceByContentAndType($aDataEntry[$this->_oConfig->CNF['FIELD_ID']], $this->_aModule['name']); + if (!$oProfile) + return _t('_sys_txt_error_occured'); + + if ($oProfile->id() == $this->_iProfileId || $oProfile->getAccountId() == $this->_iAccountId) + return CHECK_ACTION_RESULT_ALLOWED; + + return _t('_sys_txt_access_denied'); + } + + /** + * Check if user can change cover image + */ + public function checkAllowedChangeCover ($aDataEntry, $isPerformAction = false) + { + // moderator always has access + if ($this->_isModerator($isPerformAction)) + return CHECK_ACTION_RESULT_ALLOWED; + + // owner (checked by account instead of author!) always have access + $oProfile = BxDolProfile::getInstanceByContentAndType($aDataEntry[$this->_oConfig->CNF['FIELD_ID']], $this->_aModule['name']); + if (!$oProfile) + return _t('_sys_txt_error_occured'); + + if ($oProfile->id() == $this->_iProfileId || $oProfile->getAccountId() == $this->_iAccountId) + return CHECK_ACTION_RESULT_ALLOWED; + + return _t('_sys_txt_access_denied'); + } + + /** + * @return CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. + */ + public function checkAllowedDelete (&$aDataEntry, $isPerformAction = false) + { + // moderator always has access + if ($this->_isModerator($isPerformAction)) + return CHECK_ACTION_RESULT_ALLOWED; + + // owner (checked by account instead of author!) always have access + $aCheck = checkActionModule($this->_iProfileId, 'delete entry', $this->getName(), $isPerformAction); + + $oProfile = BxDolProfile::getInstanceByContentAndType($aDataEntry[$this->_oConfig->CNF['FIELD_ID']], $this->_aModule['name'], $isPerformAction); + if (!$oProfile) + return _t('_sys_txt_error_occured'); + + if (($oProfile->id() == $this->_iProfileId || $oProfile->getAccountId() == $this->_iAccountId) && $aCheck[CHECK_ACTION_RESULT] === CHECK_ACTION_RESULT_ALLOWED) + return CHECK_ACTION_RESULT_ALLOWED; + + return _t('_sys_txt_access_denied'); + } + + /** + * @return CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. + */ + public function checkAllowedViewMoreMenu (&$aDataEntry, $isPerformAction = false) + { + $oMenu = BxTemplMenu::getObjectInstance($this->_oConfig->CNF['OBJECT_MENU_ACTIONS_VIEW_ENTRY_MORE']); + if (!$oMenu || !$oMenu->getCode()) + return _t('_sys_txt_access_denied'); + return CHECK_ACTION_RESULT_ALLOWED; + } + + /** + * Compose differs from Contact. For example, a user should NOT be able to start conversation (compose) + * with himself but he should be able to view conversation page where he is one of the participants. + * + * @return CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. + */ + public function checkAllowedCompose(&$aDataEntry, $isPerformAction = false) + { + $CNF = &$this->_oConfig->CNF; + + $oProfile = BxDolProfile::getInstanceByContentAndType($aDataEntry[$CNF['FIELD_ID']], $this->getName()); + if($oProfile && $oProfile->id() == $this->_iProfileId) + return _t('_sys_txt_access_denied'); + + return $this->checkAllowedContact($aDataEntry, $isPerformAction); + } + + /** + * @return CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. + */ + public function checkAllowedFriendAdd (&$aDataEntry, $isPerformAction = false) + { + return $this->_checkAllowedConnect ($aDataEntry, $isPerformAction, ['sys_profiles_friends', 'checkAllowedAddConnection'], false, false); + } + + /** + * @return CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. + */ + public function checkAllowedFriendRemove (&$aDataEntry, $isPerformAction = false) + { + if (CHECK_ACTION_RESULT_ALLOWED === $this->_checkAllowedConnect ($aDataEntry, $isPerformAction, ['sys_profiles_friends', 'checkAllowedRemoveConnection'], false, true, true)) + return CHECK_ACTION_RESULT_ALLOWED; + + return $this->_checkAllowedConnect ($aDataEntry, $isPerformAction, ['sys_profiles_friends', 'checkAllowedRemoveConnection'], false, true, false); + } + + /** + * @return CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. + */ + public function checkAllowedRelationAdd (&$aDataEntry, $isPerformAction = false) + { + $sResult = _t('_sys_txt_access_denied'); + if(!BxDolRelation::isEnabled()) + return $sResult; + + if(($sMsg = $this->checkAllowedView($aDataEntry)) !== CHECK_ACTION_RESULT_ALLOWED) + return $sMsg; + + return $this->_checkAllowedConnect ($aDataEntry, $isPerformAction, 'sys_profiles_relations', false, false); + } + + /** + * @return CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. + */ + public function checkAllowedRelationRemove (&$aDataEntry, $isPerformAction = false) + { + $sResult = _t('_sys_txt_access_denied'); + if(!BxDolRelation::isEnabled()) + return $sResult; + + return $this->_checkAllowedConnect ($aDataEntry, $isPerformAction, 'sys_profiles_relations', false, true); + } + + public function checkAllowedRelationsView (&$aDataEntry, $isPerformAction = false) + { + $sResult = _t('_sys_txt_access_denied'); + if(!BxDolRelation::isEnabled()) + return $sResult; + + $sModule = $this->_oConfig->getName(); + $oRelations = BxDolConnection::getObjectInstance('sys_profiles_relations'); + if(!$oRelations->isRelationAvailableWithProfile($sModule) && !$oRelations->isRelationAvailableFromProfile($sModule)) + return $sResult; + + if(empty($aDataEntry) || !is_array($aDataEntry)) + return $sResult; + + return CHECK_ACTION_RESULT_ALLOWED; + } + + /** + * @return CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. + */ + public function checkAllowedSubscribeAdd(&$aDataEntry, $isPerformAction = false) + { + $mixedResult = $this->_modProfileCheckAllowedSubscribeAdd($aDataEntry, $isPerformAction); + + /** + * @hooks + * @hookdef hook-system-check_allowed_subscribe_add 'system', 'check_allowed_subscribe_add' - hook to override the result of checking whether 'subscribe' action is allowed or not to currently logged in user + * It's equivalent to @ref hook-system-check_allowed_view + * @hook @ref hook-system-check_allowed_subscribe_add + */ + bx_alert('system', 'check_allowed_subscribe_add', 0, 0, [ + 'module' => $this->getName(), + 'content_info' => $aDataEntry, + 'profile_id' => bx_get_logged_profile_id(), + 'override_result' => &$mixedResult + ]); + + return $mixedResult; + } + + /** + * Note. Is mainly needed for internal usage. Access level is 'public' to allow outer calls from alerts. + */ + public function _modProfileCheckAllowedSubscribeAdd(&$aDataEntry, $isPerformAction = false) + { + if(($sMsg = $this->checkAllowedView($aDataEntry)) !== CHECK_ACTION_RESULT_ALLOWED) + return $sMsg; + + return $this->_checkAllowedConnect($aDataEntry, $isPerformAction, 'sys_profiles_subscriptions', false, false); + } + + /** + * @return CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. + */ + public function checkAllowedSubscribeRemove (&$aDataEntry, $isPerformAction = false) + { + return $this->_checkAllowedConnect ($aDataEntry, $isPerformAction, 'sys_profiles_subscriptions', false, true); + } + + public function checkAllowedSubscriptionsView (&$aDataEntry, $isPerformAction = false) + { + $CNF = &$this->_oConfig->CNF; + + $sResult = _t('_sys_txt_access_denied'); + if(empty($aDataEntry) || !is_array($aDataEntry)) + return $sResult; + + $oProfile = BxDolProfile::getInstanceByContentAndType($aDataEntry[$CNF['FIELD_ID']], $this->_aModule['name']); + if(!$oProfile || ($oProfile->id() != $this->_iProfileId && $this->_oDb->getParam($CNF['PARAM_PUBLIC_SBSN']) != 'on' && $this->_oDb->getParam($CNF['PARAM_PUBLIC_SBSD']) != 'on')) + return $sResult; + + return CHECK_ACTION_RESULT_ALLOWED; + } + + public function checkMyself($iContentId) + { + $iLogged = (int)bx_get_logged_profile_id(); + if(empty($iLogged)) + return false; + + $oProfile = BxDolProfile::getInstanceByContentAndType((int)$iContentId, $this->_oConfig->getName()); + if(!$oProfile) + return false; + + return $oProfile->id() == $iLogged; + } + + public function isAllowDeleteOrDisable($iActorProfileId, $iTargetProfileId) + { + if (BxDolAcl::getInstance()->isMemberLevelInSet(array(MEMBERSHIP_ID_MODERATOR), $iActorProfileId) && BxDolAcl::getInstance()->isMemberLevelInSet(array(MEMBERSHIP_ID_MODERATOR, MEMBERSHIP_ID_ADMINISTRATOR), $iTargetProfileId)) + return false; + + return true; + } + + public function getProfileObject($iContentId) + { + $oProfile = BxDolProfile::getInstanceByContentAndType((int)$iContentId, $this->_oConfig->getName()); + if (!$oProfile) + $oProfile = BxDolProfileUndefined::getInstance(); + + return $oProfile; + } + + protected function _serviceCheckAllowedContactForProfile($aDataEntry, $isPerformAction = false, $iProfileId = false) + { + $CNF = &$this->_oConfig->CNF; + + if(!$iProfileId) + $iProfileId = $this->_iProfileId; + + /* + * allow to 'contact myself'. It's needed to allow a user to view conversation page + * where he is one of the participants. + */ + $oProfile = BxDolProfile::getInstanceByContentAndType($aDataEntry[$CNF['FIELD_ID']], $this->getName()); + if($oProfile && $oProfile->id() == $iProfileId) + return CHECK_ACTION_RESULT_ALLOWED; + + // moderator always has access + if($this->_isModeratorForProfile($isPerformAction, $iProfileId)) + return CHECK_ACTION_RESULT_ALLOWED; + + // check privacy + if(!empty($CNF['OBJECT_PRIVACY_CONTACT'])) { + $oPrivacy = BxDolPrivacy::getObjectInstance($CNF['OBJECT_PRIVACY_CONTACT']); + if($oPrivacy && !$oPrivacy->check($aDataEntry[$CNF['FIELD_ID']], $iProfileId)) + return _t('_sys_access_denied_to_private_content'); + } + + return CHECK_ACTION_RESULT_ALLOWED; + } + + // ====== COMMON METHODS + public function onUpdateImage($iContentId, $sFiledName, $sFiledValue, $iProfileId = 0) + { + $CNF = &$this->_oConfig->CNF; + + $sModule = $this->getName(); + + if(!$iProfileId && ($oProfile = BxDolProfile::getInstanceByContentAndType($iContentId, $sModule)) !== false) + $iProfileId = $oProfile->id(); + + $aField2Method = [ + $CNF['FIELD_PICTURE'] => 'picture', + $CNF['FIELD_COVER'] => 'cover', + ]; + + if(!empty($aField2Method[$sFiledName])) + /** + * @hooks + * @hookdef hook-bx_base_profile-profile_picture_changed '{module_name}', 'profile_picture_changed' - hook after profile picture was changed + * - $unit_name - module name + * - $action - equals `profile_picture_changed` + * - $object_id - image id + * - $sender_id - profile id who performed the action + * - $extra_params - array of additional params with the following array keys: + * - `object_author_id` - [int] profile id + * - `content` - [int] profile content id + * - `field` - [string] field name + * @hook @ref hook-bx_base_profile-profile_picture_changed + */ + /** + * @hooks + * @hookdef hook-bx_base_profile-profile_cover_changed '{module_name}', 'profile_cover_changed' - hook after profile cover was changed + * It's equivalent to @ref hook-bx_base_profile-profile_picture_changed + * @hook @ref hook-bx_base_profile-profile_cover_changed + */ + bx_alert($sModule, 'profile_' . $aField2Method[$sFiledName] . '_changed', $sFiledValue, $iProfileId, [ + 'object_author_id' => $iProfileId, + 'content' => $iContentId, + 'field' => $sFiledName + ]); + } + + protected function _alertParams($aContentInfo) + { + $aParams = parent::_alertParams($aContentInfo); + + $CNF = &$this->_oConfig->CNF; + + if(!empty($CNF['FIELD_STATUS']) && isset($aContentInfo[$CNF['FIELD_STATUS']])) + $aParams['status'] = $aContentInfo[$CNF['FIELD_STATUS']]; + + if(!empty($CNF['FIELD_STATUS_ADMIN']) && isset($aContentInfo[$CNF['FIELD_STATUS_ADMIN']])) + $aParams['status_admin'] = $aContentInfo[$CNF['FIELD_STATUS_ADMIN']]; + + if(!empty($CNF['FIELD_ALLOW_VIEW_TO']) && isset($aContentInfo[$CNF['FIELD_ALLOW_VIEW_TO']])) + $aParams['privacy_view'] = $aContentInfo[$CNF['FIELD_ALLOW_VIEW_TO']]; + + return $aParams; + } + + public function alertAfterAdd($aContentInfo) + { + $CNF = &$this->_oConfig->CNF; + + $iContentId = (int)$aContentInfo[$CNF['FIELD_ID']]; + + $aParams = $this->_alertParams($aContentInfo); + + /** + * @hooks + * @hookdef hook-bx_base_profile-added '{module_name}', 'added' - hook after profile was added + * - $unit_name - module name + * - $action - equals `added` + * - $object_id - profile content id + * - $sender_id - not used + * - $extra_params - array of additional params with the following array keys: + * - `status` - [string] context status + * - `status_admin` - [string] context admin status + * - `privacy_view` - [int] or [string] privacy for view context action, @see BxDolPrivacy + * @hook @ref hook-bx_base_profile-added + */ + bx_alert($this->getName(), 'added', $iContentId, false, $aParams); + } + + public function alertAfterEdit($aContentInfo) + { + $CNF = &$this->_oConfig->CNF; + + $sModule = $this->getName(); + $iContentId = (int)$aContentInfo[$CNF['FIELD_ID']]; + + $aParams = $this->_alertParams($aContentInfo); + /** + * @hooks + * @hookdef hook-bx_base_profile-edited '{module_name}', 'edited' - hook after profile was changed + * It's equivalent to @ref hook-bx_base_profile-added + * @hook @ref hook-bx_base_profile-edited + */ + bx_alert($sModule, 'edited', $iContentId, false, $aParams); + + $oProfile = BxDolProfile::getInstanceByContentAndType($iContentId, $sModule); + + /** + * @hooks + * @hookdef hook-profile-edit 'profile', 'edit' - hook after profile was changed + * - $unit_name - equals `profile` + * - $action - equals `edit` + * - $object_id - profile id + * - $sender_id - not used + * - $extra_params - array of additional params with the following array keys: + * - `content` - [int] profile content id + * - `module` - [string] module name + * @hook @ref hook-profile-added + */ + bx_alert('profile', 'edit', $oProfile->id(), 0, [ + 'content' => $iContentId, + 'module' => $sModule + ]); + } + + public function getProfileByCurrentUrl () + { + $iProfileId = bx_process_input(bx_get('profile_id'), BX_DATA_INT); + + if ($iProfileId) + return BxDolProfile::getInstance($iProfileId); + + $iContentId = bx_process_input(bx_get('id'), BX_DATA_INT); + if ($iContentId) + return BxDolProfile::getInstanceByContentAndType($iContentId, $this->getName()); + + return false; + } + + public function getEntryImageData($aContentInfo, $sField = 'FIELD_PICTURE', $aTranscoders = array()) + { + return parent::getEntryImageData($aContentInfo, $sField, $aTranscoders); + } + + public function getProfileName ($aContentInfo) + { + return bx_process_output($aContentInfo[$this->_oConfig->CNF['FIELD_NAME']]); + } + + public function getMenuItemTitleByConnection($sConnection, $sAction, $iContentProfileId, $iInitiatorProfileId = 0) + { + $oConnection = BxDolConnection::getObjectInstance($sConnection); + if(!$oConnection) + return false; + + if(!$iInitiatorProfileId) + $iInitiatorProfileId = bx_get_logged_profile_id(); + + $aResult = []; + switch($sConnection) { + case 'sys_profiles_friends': + $aResult = $this->_getMenuItemTitleProfilesFriends($sAction, $iContentProfileId, $iInitiatorProfileId, $oConnection); + break; + + case 'sys_profiles_subscriptions': + $aResult = $this->_getMenuItemTitleProfilesSubscriptions($sAction, $iContentProfileId, $iInitiatorProfileId, $oConnection); + break; + } + + return $aResult; + } + + protected function _getMenuItemTitleProfilesFriends($sAction, $iContentProfileId, $iInitiatorProfileId, &$oConnection) + { + $CNF = $this->_oConfig->getCNF(); + + $aResult = []; + if($oConnection->isConnectedNotMutual($iInitiatorProfileId, $iContentProfileId)) + $aResult = [ + 'add' => _t(!empty($CNF['T']['menu_item_title_befriend_sent']) ? $CNF['T']['menu_item_title_befriend_sent'] : '_sys_menu_item_title_sm_befriend_sent'), + 'remove' => _t(!empty($CNF['T']['menu_item_title_unfriend_cancel']) ? $CNF['T']['menu_item_title_unfriend_cancel'] : '_sys_menu_item_title_sm_unfriend_cancel'), + ]; + else if($oConnection->isConnectedNotMutual($iContentProfileId, $iInitiatorProfileId)) + $aResult = [ + 'add' => _t(!empty($CNF['T']['menu_item_title_befriend_confirm']) ? $CNF['T']['menu_item_title_befriend_confirm'] : '_sys_menu_item_title_sm_befriend_confirm'), + 'remove' => _t(!empty($CNF['T']['menu_item_title_unfriend_reject']) ? $CNF['T']['menu_item_title_unfriend_reject'] : '_sys_menu_item_title_sm_unfriend_reject'), + ]; + else if($oConnection->isConnected($iInitiatorProfileId, $iContentProfileId, true)) + $aResult = [ + 'add' => '', + 'remove' => _t(!empty($CNF['T']['menu_item_title_unfriend']) ? $CNF['T']['menu_item_title_unfriend'] : '_sys_menu_item_title_sm_unfriend'), + ]; + else + $aResult = [ + 'add' => _t(!empty($CNF['T']['menu_item_title_befriend']) ? $CNF['T']['menu_item_title_befriend'] : '_sys_menu_item_title_sm_befriend'), + 'remove' => '', + ]; + + return !empty($sAction) && isset($aResult[$sAction]) ? $aResult[$sAction] : $aResult; + } + + protected function _getMenuItemTitleProfilesSubscriptions($sAction, $iContentProfileId, $iInitiatorProfileId, &$oConnection) + { + $CNF = $this->_oConfig->getCNF(); + + $aResult = []; + if($oConnection->isConnected($iInitiatorProfileId, $iContentProfileId)) + $aResult = [ + 'add' => '', + 'remove' => _t(!empty($CNF['T']['menu_item_title_unsubscribe']) ? $CNF['T']['menu_item_title_unsubscribe'] : '_sys_menu_item_title_sm_unsubscribe'), + ]; + else + $aResult = [ + 'add' => _t(!empty($CNF['T']['menu_item_title_subscribe']) ? $CNF['T']['menu_item_title_subscribe'] : '_sys_menu_item_title_sm_subscribe'), + 'remove' => '', + ]; + + return !empty($sAction) && !empty($aResult[$sAction]) ? $aResult[$sAction] : $aResult; + } + + public function decodeDataAPI($aData, $aParams = []) + { + $CNF = $this->_oConfig->CNF; + + $sModule = $this->getName(); + $iId = (int)$aData[$CNF['FIELD_ID']]; + $oProfile = BxDolProfile::getInstanceByContentAndType($iId, $sModule); + + $aResult = [ + 'id' => $iId, + 'module' => $sModule, + 'module_title' => _t($CNF['T']['txt_sample_single']), + 'added' => $aData[$CNF['FIELD_ADDED']], + 'author' => $aData[$CNF['FIELD_AUTHOR']], + 'author_data' => $oProfile !== false ? BxDolProfile::getData($oProfile->id()) : '', + 'title' => $aData[$CNF['FIELD_TITLE']], + $CNF['FIELD_TITLE'] => $aData[$CNF['FIELD_TITLE']], + 'url' => bx_api_get_relative_url($this->serviceGetLink($iId)), + 'image' => $this->serviceGetThumb($iId), + 'cover' => $this->serviceGetCover($iId), + ]; + + if(isset($aParams['template']) && $aParams['template'] == 'unit_wo_info') + return $aResult; + + if(isset($aParams['extended']) && $aParams['extended'] === true) + $aResult['text'] = $aData[$CNF['FIELD_TEXT']]; + + if(getParam('sys_api_conn_in_prof_units') == 'on' && $oProfile !== false) { + $iProfileId = $oProfile->id(); + $aResult['title'] = $oProfile->getDisplayName(); + if(($oConnection = BxDolConnection::getObjectInstance('sys_profiles_friends')) !== false && isset($CNF['URI_VIEW_FRIENDS'])) { + $aResult['friends_count'] = $oConnection->getConnectedContentCount($iProfileId, true); + $aResult['friends_list'] = $oConnection->getConnectedListAPI($iProfileId, true, BX_CONNECTIONS_CONTENT_TYPE_CONTENT); + if(isLogged()) { + $iLoggedId = bx_get_logged_profile_id(); + $aResult['mutual_friends_count'] = $oConnection->getCommonContentCount($iProfileId, $iLoggedId, true); + $aResult['mutual_friends_list'] = $oConnection->getCommonListAPI($iProfileId, $iLoggedId, true); + } + } + + if(($oConnection = BxDolConnection::getObjectInstance('sys_profiles_subscriptions')) !== false){ + $aResult['followers_count'] = $oConnection->getConnectedInitiatorsCount($iProfileId); + $aResult['followers_list'] = $oConnection->getConnectedListAPI($iProfileId, false, BX_CONNECTIONS_CONTENT_TYPE_INITIATORS); + } + } + + $sKey = 'OBJECT_MENU_SNIPPET_META'; + if(!empty($CNF[$sKey]) && ($oMetaMenu = BxDolMenu::getObjectInstance($CNF[$sKey], $this->_oTemplate)) !== false) { + $oPrivacy = BxDolPrivacy::getObjectInstance($CNF['OBJECT_PRIVACY_VIEW']); + $bPublic = !$oPrivacy || $oPrivacy->check($iId) || $oPrivacy->isPartiallyVisible($aData[$CNF['FIELD_ALLOW_VIEW_TO']]); + + $oMetaMenu->setContentId($iId); + $oMetaMenu->setContentPublic($bPublic); + if(isset($aParams['context'])) + $oMetaMenu->setContext($aParams['context']); + + $aResult['meta'] = $oMetaMenu->getCodeAPI(); + } + + return $aResult; + } + + + // ====== PROTECTED METHODS + protected function _checkAllowedConnect (&$aDataEntry, $isPerformAction, $mixedConnection, $isMutual, $isInvertResult, $isSwap = false) + { + if (!$this->_iProfileId) + return _t('_sys_txt_access_denied'); + + $CNF = &$this->_oConfig->CNF; + + $oProfile = BxDolProfile::getInstanceByContentAndType($aDataEntry[$CNF['FIELD_ID']], $this->_aModule['name']); + if (!$oProfile || $oProfile->id() == $this->_iProfileId) + return _t('_sys_txt_access_denied'); + + $sConnObject = ''; + $sConnMethod = 'checkAllowedConnect'; + if(is_array($mixedConnection)) + list($sConnObject, $sConnMethod) = $mixedConnection; + else + $sConnObject = $mixedConnection; + + return BxDolConnection::getObjectInstance($sConnObject)->$sConnMethod($this->_iProfileId, $oProfile->id(), $isPerformAction, $isMutual, $isInvertResult, $isSwap); + } + + protected function _buildRssParams($sMode, $aArgs) + { + $aParams = array (); + $sMode = bx_process_input($sMode); + switch ($sMode) { + case 'connections': + $aParams = array( + 'object' => isset($aArgs[0]) ? $aArgs[0] : '', + 'type' => isset($aArgs[1]) ? $aArgs[1] : '', + 'profile' => isset($aArgs[2]) ? (int)$aArgs[2] : 0, + 'mutual' => isset($aArgs[3]) ? (int)$aArgs[3] : 0, + 'profile2' => isset($aArgs[4]) ? (int)$aArgs[4] : 0, + ); + break; + } + + return $aParams; + } + + protected function _serviceGetTimelineProfileImage($aEvent, $aBrowseParams, $aBuildParams) + { + $CNF = &$this->_oConfig->CNF; + + $aFileInfo = BxDolStorage::getObjectInstance($CNF[$aBuildParams['stg']])->getFile((int)$aEvent['object_id']); + if(empty($aFileInfo) || !is_array($aFileInfo)) + return false; + + $aEventContent = unserialize($aEvent['content']); + if(!is_array($aEventContent) || empty($aEventContent['content'])) + return false; + + $aContentInfo = $this->_oDb->getContentInfoById($aEventContent['content']); + if(empty($aContentInfo) || !is_array($aContentInfo)) + return false; + + $oProfile = BxDolProfile::getInstanceMagic($aContentInfo['profile_id']); + if (!$oProfile->isActive()) + return false; + + $sUserName = $oProfile->getDisplayName(); + + $sSample = isset($CNF['T'][$aBuildParams['txt_sswa']]) ? $CNF['T'][$aBuildParams['txt_sswa']] : $CNF['T'][$aBuildParams['txt_ss']]; + + //--- Title & Description + $sTitle = !empty($aContentInfo[$CNF['FIELD_TITLE']]) ? $aContentInfo[$CNF['FIELD_TITLE']] : ''; + if(empty($sTitle) && !empty($aContentInfo[$CNF['FIELD_TEXT']])) + $sTitle = $aContentInfo[$CNF['FIELD_TEXT']]; + + $sDescription = _t($CNF['T'][$aBuildParams['txt_sau']], $sUserName, _t($sSample)); + + return array( + 'owner_id' => $aEvent['owner_id'], + 'object_owner_id' => $aContentInfo['profile_id'], + 'icon' => !empty($CNF['ICON']) ? $CNF['ICON'] : '', + 'sample' => $sSample, + 'sample_wo_article' => $CNF['T'][$aBuildParams['txt_ss']], + 'sample_action' => isset($CNF['T'][$aBuildParams['txt_sa']]) ? $CNF['T'][$aBuildParams['txt_sa']] : '', + 'url' => bx_absolute_url(BxDolPermalinks::getInstance()->permalink('page.php?i=' . $CNF['URI_VIEW_ENTRY'] . '&id=' . $aContentInfo[$CNF['FIELD_ID']])), + 'content' => $this->_getContentForTimelineProfileImage($aEvent, $aBrowseParams, $aBuildParams, $aContentInfo, $aFileInfo), //a string to display or array to parse default template before displaying. + 'date' => $aContentInfo[$CNF['FIELD_ADDED']], + 'views' => '', + 'votes' => '', + 'scores' => '', + 'reports' => '', + 'comments' => '', + 'title' => $sTitle, //may be empty. + 'description' => $sDescription //may be empty. + ); + } + + protected function _serviceGetTimelineProfileImageAllowedView($aEvent) + { + $sError = _t('_sys_access_denied_to_private_content'); + + if(empty($aEvent['content']) || !is_array($aEvent['content']) || empty($aEvent['content']['id'])) + return $sError; + + $aContentInfo = $this->_oDb->getContentInfoById($aEvent['content']['id']); + if(empty($aContentInfo) || !is_array($aContentInfo)) + return $sError; + + return $this->serviceCheckAllowedViewForProfile($aContentInfo); + } + + protected function _getContentForTimelineProfileImage($aEvent, $aBrowseParams, $aBuildParams, $aContentInfo, $aFileInfo) + { + $CNF = &$this->_oConfig->CNF; + + $sUrl = bx_absolute_url(BxDolPermalinks::getInstance()->permalink('page.php?i=' . $CNF['URI_VIEW_ENTRY'] . '&id=' . $aContentInfo[$CNF['FIELD_ID']])); + + //--- Image(s) + $sImage = $this->_oConfig->getImageUrl($aFileInfo['id'], $aBuildParams['trans']); + $sImageOrig = $this->_oConfig->getImageUrl($aFileInfo['id'], $aBuildParams['trans_orig']); + if(!empty($sImage)) { + if(empty($sImageOrig)) + $sImageOrig = $sImage; + + $a = ['id' => $aFileInfo['id'], 'url' => $sUrl, 'src' => $sImage]; + if(CHECK_ACTION_RESULT_ALLOWED === $this->checkAllowedView($aContentInfo)) { + $a['src_orig'] = $sImageOrig; + + $sCnfKey = 'OBJECT_IMAGES_TRANSCODER_GALLERY'; + if(!empty($CNF[$sCnfKey]) && ($sSrcMedium = $this->_oConfig->getImageUrl($aFileInfo['id'], [$sCnfKey])) != '') + $a['src_medium'] = $sSrcMedium; + } + $aImages = [$a]; + } + + return array( + 'sample' => isset($CNF['T'][$aBuildParams['txt_sswa']]) ? $CNF['T'][$aBuildParams['txt_sswa']] : $CNF['T'][$aBuildParams['txt_ss']], + 'sample_wo_article' => $CNF['T'][$aBuildParams['txt_ss']], + 'sample_action' => isset($CNF['T'][$aBuildParams['txt_sa']]) ? $CNF['T'][$aBuildParams['txt_sa']] : '', + 'id' => $aContentInfo[$CNF['FIELD_ID']], + 'url' => $sUrl, + 'title' => '', + 'text' => '', + 'images' => $aImages, + 'videos' => array() + ); + } + + protected function _entityComments($sObject, $iId = 0) + { + if(!$iId) + $iId = bx_process_input(bx_get('id'), BX_DATA_INT); + + if(!$iId) + $iId = bx_process_input(bx_get('profile_id'), BX_DATA_INT); + + if(!$iId) + return false; + + $oCmts = BxDolCmts::getObjectInstance($sObject, $iId); + if(!$oCmts || !$oCmts->isEnabled()) + return false; + + if (bx_is_api()) + return [bx_srv('system', 'get_data_api', [['module' => $sObject, 'object_id' => $iId]], 'TemplCmtsServices')]; + + return $oCmts->getCommentsBlock(array(), array('in_designbox' => false)); + } + + protected function _getContent($iContentId = 0, $sFuncGetContent = 'getContentInfoById') + { + if(!$iContentId && bx_get('id') === false && bx_get('profile_id') !== false) { + $oProfile = BxDolProfile::getInstance((int)bx_get('profile_id')); + if($oProfile) + $iContentId = $oProfile->getContentId(); + } + + return parent::_getContent($iContentId, $sFuncGetContent); + } +} + +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/profile/template/search_extended_results.html b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/profile/template/search_extended_results.html new file mode 100644 index 0000000000..76a2ff9f14 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/profile/template/search_extended_results.html @@ -0,0 +1,7 @@ +<div class="bx-search-result-block __class__"> + <div class="bx-search-result-sorting bx-def-margin-sec-bottom bx-clearfix">__sort__</div> + <div class="bx-search-result-content bx-base-pofile-units-wrapper bx-def-margin-sec-lefttopright-neg bx-def-margin-sec-bottom-neg bx-clearfix">__code__</div> + <bx_if:show_paginate> + <div class="bx-search-result-paginate bx-def-margin-top">__paginate__</div> + </bx_if:show_paginate> +</div> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/text/classes/BxBaseModTextConfig.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/text/classes/BxBaseModTextConfig.php new file mode 100644 index 0000000000..3d81a7eed8 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/text/classes/BxBaseModTextConfig.php @@ -0,0 +1,142 @@ +<?php defined('BX_DOL') or die('hack attempt'); +/** + * Copyright (c) UNA, Inc - https://una.io + * MIT License - https://opensource.org/licenses/MIT + * + * @defgroup BaseText Base classes for text modules + * @ingroup UnaModules + * + * @{ + */ + +bx_import('BxDolInformer'); + +class BxBaseModTextConfig extends BxBaseModGeneralConfig +{ + /** + * Determine whether Timeline post will use common content (header image + text) + * or content received from attachments (header image + text + images + videos + polls). + * By default the first variant is used. + * Note. The variable can be removed in future, when all Text Based modules + * implement 'attachments' related parameters. + */ + protected $_bAttachmentsInTimeline; + + protected $_aPregPatterns; + + function __construct($aModule) + { + parent::__construct($aModule); + + $this->CNF = array( + // modules icon + 'ICON_POLLS_ANSWERS' => 'vote-yea', + 'ICON_POLLS_RESULTS' => 'poll-h', + + // database tables + 'TABLE_POLLS' => $aModule['db_prefix'] . 'polls', + 'TABLE_POLLS_ANSWERS' => $aModule['db_prefix'] . 'polls_answers', + 'TABLE_POLLS_ANSWERS_VOTES' => $aModule['db_prefix'] . 'polls_answers_votes', + 'TABLE_POLLS_ANSWERS_VOTES_TRACK' => $aModule['db_prefix'] . 'polls_answers_votes_track', + + 'TABLE_LINKS' => $aModule['db_prefix'] . 'links', + 'TABLE_LINKS2CONTENT' => $aModule['db_prefix'] . 'links2content', + + // database fields + 'FIELD_POLL_ID' => 'id', + 'FIELD_POLL_AUTHOR_ID' => 'author_id', + 'FIELD_POLL_CONTENT_ID' => 'content_id', + 'FIELD_POLL_TEXT' => 'text', + 'FIELD_POLL_ANSWERS' => 'answers', + + 'FIELD_ATTACH_LINK_CONTENT_ID' => 'content_id', + 'FIELD_ATTACH_LINK_URL' => 'url', + 'FIELD_ATTACH_LINK_CONTROLS' => 'controls', + + // some params + 'PARAM_POLL_ENABLED' => true, + 'PARAM_POLL_HIDDEN_RESULTS' => false, + 'PARAM_POLL_ANONYMOUS_VOTING' => true, + 'PARAM_MULTICAT_ENABLED' => false, + 'PARAM_LINKS_ENABLED' => false, + 'PARAM_LINKS_LIMIT' => 'sys_attach_links_max', + + // objects + 'OBJECT_VOTES_POLL_ANSWERS' => $this->_sName . '_poll_answers', + 'OBJECT_FORM_ATTACH_LINK' => $this->_sName . '_attach_link', + 'OBJECT_FORM_ATTACH_LINK_DISPLAY_ADD' => $this->_sName . '_attach_link_add', + + + // styles + 'STYLES_POLLS_EMBED_CLASS' => 'body.bx-page-iframe.bx-def-color-bg-page', + 'STYLES_POLLS_EMBED_CONTENT' => array( + 'background-color' => '#ffffff' + ), + ); + + $sPrefix = str_replace('_', '-', $this->_sName); + $this->_aPrefixes = [ + 'style' => $sPrefix, + ]; + + $this->_aJsClasses = array( + 'poll' => $this->_sClassPrefix . 'Polls', + 'links' => $this->_sClassPrefix . 'Links', + 'categories' => $this->_sClassPrefix . 'Categories' + ); + + $this->_aJsObjects = array( + 'poll' => 'o' . $this->_sClassPrefix . 'Polls', + 'links' => 'o' . $this->_sClassPrefix . 'Links', + 'categories' => 'o' . $this->_sClassPrefix . 'Categories' + ); + + $this->_aHtmlIds = array( + 'add_poll_popup' => $sPrefix . '-add-poll-popup', + 'add_poll_form_field' => $sPrefix . '-add-poll-form-field', + 'polls_showcase' => $sPrefix . '-polls-showcase-', + 'poll' => $sPrefix . '-poll-', + 'poll_content' => $sPrefix . '-poll-content-', + 'poll_view_menu' => $sPrefix . '-poll-view-menu', + 'poll_view_link_answers' => $sPrefix . '-poll-view-answers-', + 'poll_view_link_results' => $sPrefix . '-poll-view-results-', + + 'attach_link_popup' => $sPrefix . '-attach-link-popup', + 'attach_link_form_field' => $sPrefix . '-attach-link-form-field-', + 'attach_link_item' => $sPrefix . '-attach-link-item-', + ); + + $this->_aPregPatterns = array( + "meta_title" => "/<title>(.*)<\/title>/", + "meta_description" => "/<meta[\s]+[^>]*?name[\s]?=[\s\"\']+description[\s\"\']+content[\s]?=[\s\"\']+(.*?)[\"\']+.*?>/", + "url" => "/(([A-Za-z]{3,9}:(?:\/\/)?)(?:[\-;:&=\+\$,\w]+@)?[A-Za-z0-9\.\-]+|(?:www\.|[\-;:&=\+\$,\w]+@)[A-Za-z0-9\.\-]+)((?:\/[\+~%#\/\.\w\-_!\(\)]*)?\??(?:[\-\+=&;%@\.\w_]*)#?(?:[\.\!\/\\\w]*))?/" + ); + + $this->_bAttachmentsInTimeline = false; + } + + public function isAttachLinks() + { + return !empty($this->CNF['TABLE_LINKS']) && $this->CNF['PARAM_LINKS_ENABLED'] == true; + } + + public function isAttachmentsInTimeline() + { + return $this->_bAttachmentsInTimeline; + } + + public function getPregPattern($sType) + { + return $this->_aPregPatterns[$sType]; + } + + public function getHtmlIds($sKey = '') + { + if(empty($sKey)) + return $this->_aHtmlIds; + + return isset($this->_aHtmlIds[$sKey]) ? $this->_aHtmlIds[$sKey] : ''; + } +} + +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/text/classes/BxBaseModTextModule.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/text/classes/BxBaseModTextModule.php new file mode 100644 index 0000000000..b2cc79d154 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/text/classes/BxBaseModTextModule.php @@ -0,0 +1,1075 @@ +<?php defined('BX_DOL') or die('hack attempt'); +/** + * Copyright (c) UNA, Inc - https://una.io + * MIT License - https://opensource.org/licenses/MIT + * + * @defgroup BaseText Base classes for text modules + * @ingroup UnaModules + * + * @{ + */ + +define('BX_BASE_MOD_TEXT_STATUS_ACTIVE', 'active'); +define('BX_BASE_MOD_TEXT_STATUS_HIDDEN', 'hidden'); +define('BX_BASE_MOD_TEXT_STATUS_AWAITING', 'awaiting'); +/** + * Saved for backward compatibility. + * Can be removed in future releases of UNA 13. + */ +define('BX_BASE_MOD_TEXT_STATUS_PENDING', 'pending'); + +/** + * Base module class for text based modules + */ +class BxBaseModTextModule extends BxBaseModGeneralModule implements iBxDolContentInfoService +{ + function __construct(&$aModule) + { + parent::__construct($aModule); + } + + + // ====== ACTIONS METHODS + + public function actionEmbedPoll($iPollId = 0) + { + if(empty($iPollId) && bx_get('poll_id') !== false) + $iPollId = (int)bx_get('poll_id'); + + $aParams = bx_get_with_prefix('param'); + array_walk($aParams, function(&$sValue) { + $sValue = bx_process_input($sValue); + }); + + $this->_oTemplate->embedPollItem($iPollId, $aParams); + } + + public function actionEmbedPolls($iId = 0) + { + list($iContentId, $aContentInfo) = $this->_getContent($iId); + if($iContentId === false) + return; + + $aParams = bx_get_with_prefix('param'); + array_walk($aParams, function(&$sValue) { + $sValue = bx_process_input($sValue); + }); + + $this->_oTemplate->embedPollItems($aContentInfo, $aParams); + } + + public function actionGetPoll() + { + $iPollId = (int)bx_get('poll_id'); + $sView = bx_process_input(bx_get('view')); + + $sMethod = 'serviceGetBlockPoll' . bx_gen_method_name($sView); + if(!method_exists($this, $sMethod)) + return echoJson(array()); + + $aBlock = $this->$sMethod($iPollId, true); + if(empty($aBlock) || !is_array($aBlock)) + return echoJson(array()); + + return echoJson(array( + 'content' => $aBlock['content'] + )); + } + public function actionDeletePoll() + { + $CNF = &$this->_oConfig->CNF; + + $iId = bx_process_input(bx_get('id'), BX_DATA_INT); + if(empty($iId)) + return echoJson(array()); + + $aResult = array(); + if($this->_oDb->deletePolls(array($CNF['FIELD_POLL_ID'] => $iId))) + $aResult = array('code' => 0); + else + $aResult = array('code' => 1, 'message' => _t($CNF['txt_err_cannot_perform_action'])); + + echoJson($aResult); + } + + public function actionGetPollForm() + { + echo $this->_oTemplate->getPollForm(); + } + + public function actionSubmitPollForm() + { + echoJson($this->getPollForm()); + } + + public function actionFileEmbedVideo($iFileId) + { + $this->_oTemplate->embedVideo($iFileId); + } + + public function actionFileEmbedSound($iFileId) + { + $this->_oTemplate->embedSound($iFileId); + } + + + // ====== SERVICE METHODS + + public function serviceGetSafeServices() + { + $a = parent::serviceGetSafeServices(); + return array_merge($a, array ( + 'GetBlockPollAnswers' => '', + 'GetBlockPollResults' => '', + 'GetMenuAddonManageToolsProfileStats' => '', + 'BrowsePublic' => '', + 'BrowsePopular' => '', + 'BrowseTop' => '', + 'BrowseUpdated' => '', + 'BrowseAuthor' => '', + 'CategoriesMultiListContext' => '' + )); + } + + public function serviceManageTools($sType = 'common') + { + $this->_oTemplate->addJs(['modules/base/text/js/|manage_tools.js']); + + return parent::serviceManageTools($sType); + } + + /** + * @page service Service Calls + * @section bx_base_text Base Text + * @subsection bx_base_general-page_blocks Page Blocks + * @subsubsection bx_base_general-categories_multi_list_context categories_multi_list_context + * + * @code bx_srv('bx_posts', 'categories_multi_list_context', [...]); @endcode + * + * Display multi-categorories block with number of posts in each category for current context + * @param $bDisplayEmptyCats display empty categories + * + * @see BxBaseModGeneralModule::serviceCategoriesMultiListContext + */ + /** + * @ref bx_base_general-categories_multi_list_context "categories_multi_list_context" + */ + public function serviceCategoriesMultiListContext($iProfileId = 0, $bDisplayEmptyCats = true) + { + if ($iProfileId == 0) + $iProfileId = bx_process_input(bx_get('profile_id'), BX_DATA_INT); + + $oCategories = BxDolCategories::getInstance(); + $aCats = $oCategories->getData([ + 'type' => 'by_module&context_with_num', + 'module' => $this->getName(), + 'context_id' => $iProfileId + ] + ); + $aVars = array('bx_repeat:cats' => array()); + foreach ($aCats as $oCat) { + $sValue = $oCat['value']; + $iNum = $oCat['num']; + + $aVars['bx_repeat:cats'][] = array( + 'url' => $oCategories->getUrl($this->getName(), $sValue, '&context_id=' . $iProfileId), + 'name' => _t($sValue), + 'value' => $sValue, + 'num' => $iNum, + ); + } + + if (!$aVars['bx_repeat:cats']) + return ''; + + return $this->_oTemplate->parseHtmlByName('category_list_multi.html', $aVars); + } + + /** + * @page service Service Calls + * @section bx_base_text Base Text + * @subsection bx_base_text-polls Polls Blocks + * @subsubsection bx_base_text-get_block_poll_answers get_block_poll_answers + * + * @code bx_srv('bx_posts', 'get_block_poll_answers', [...]); @endcode + * + * Get block with poll answers + * @param $iPollId poll ID + * + * @see BxBaseModTextModule::serviceGetBlockPollAnswers + */ + /** + * @ref bx_base_text-get_block_poll_answers "get_block_poll_answers" + */ + public function serviceGetBlockPollAnswers($iPollId, $bForceDisplay = false) + { + if(!$iPollId) + return false; + + if(!$bForceDisplay && $this->isPollPerformed($iPollId)) + return $this->serviceGetBlockPollResults($iPollId); + + return $this->_serviceTemplateFunc('entryPollAnswers', $iPollId, 'getPollInfoById'); + } + + /** + * @page service Service Calls + * @section bx_base_text Base Text + * @subsection bx_base_text-polls Polls Blocks + * @subsubsection bx_base_text-get_block_poll_results get_block_poll_results + * + * @code bx_srv('bx_posts', 'get_block_poll_results', [...]); @endcode + * + * Get block with poll results + * @param $iPollId poll ID + * + * @see BxBaseModTextModule::serviceGetBlockPollResults + */ + /** + * @ref bx_base_text-get_block_poll_results "get_block_poll_results" + */ + public function serviceGetBlockPollResults($iPollId) + { + return $this->_serviceTemplateFunc('entryPollResults', $iPollId, 'getPollInfoById'); + } + + /** + * Display media EXIF information. + * @param $iMediaId media ID, if it's omitted then it's taken from 'id' GET variable. + * @return HTML string with EXIF info. On error empty string is returned. + */ + public function serviceMediaExif ($iMediaId = 0) + { + $CNF = &$this->_oConfig->CNF; + return $this->_serviceTemplateFunc ('mediaExif', $iMediaId, $CNF['FUNCTION_FOR_GET_ITEM_INFO']); + } + + public function serviceGetThumb ($iContentId, $sTranscoder = '') + { + $CNF = &$this->_oConfig->CNF; + if(bx_is_api()){ + $aContentInfo = $this->_oDb->getContentInfoById($iContentId); + if (isset($CNF['FIELD_THUMB'])) + return bx_api_get_image($CNF['OBJECT_STORAGE'], $aContentInfo[$CNF['FIELD_THUMB']]); + } + + if(empty($sTranscoder) && !empty($CNF['OBJECT_IMAGES_TRANSCODER_GALLERY'])) + $sTranscoder = $CNF['OBJECT_IMAGES_TRANSCODER_GALLERY']; + + $mixedResult = $this->_getFieldValueThumb('FIELD_THUMB', $iContentId, $sTranscoder); + return $mixedResult !== false ? $mixedResult : ''; + } + + public function serviceGetMenuAddonManageTools() + { + $CNF = &$this->_oConfig->CNF; + + $iNumTotal = $this->_oDb->getEntriesNumByParams(); + + $iNum1 = $this->_oDb->getEntriesNumByParams([ + [ + 'key' => $CNF['FIELD_STATUS'], + 'value' => 'hidden', + 'operator' => '=' + ] + ]); + + $iNum2 = 0; + if (isset($CNF['OBJECT_REPORTS'])){ + $iNum2 = $this->_oDb->getEntriesNumByParams([ + [ + 'key' => 'reports', + 'value' => '0', + 'operator' => '>' + ] + ]); + } + return array('counter1_value' => $iNum1, 'counter2_value' => $iNum2, 'counter3_value' => $iNumTotal ); + } + + /** + * @page service Service Calls + * @section bx_base_text Base Text + * @subsection bx_base_text-other Other + * @subsubsection bx_base_text-get_menu_addon_manage_tools_profile_stats get_menu_addon_manage_tools_profile_stats + * + * @code bx_srv('bx_posts', 'get_menu_addon_manage_tools_profile_stats', []); @endcode + * + * Get number of posts for currently logged in user + * + * @see BxBaseModTextModule::serviceGetMenuAddonManageToolsProfileStats + */ + /** + * @ref bx_base_text-get_menu_addon_manage_tools_profile_stats "get_menu_addon_manage_tools_profile_stats" + */ + public function serviceGetMenuAddonManageToolsProfileStats($iProfileId = 0) + { + if(!$iProfileId) + $iProfileId = bx_get_logged_profile_id(); + + bx_import('SearchResult', $this->_aModule); + $sClass = $this->_aModule['class_prefix'] . 'SearchResult'; + $o = new $sClass(); + $o->fillFilters([ + 'author' => $iProfileId + ]); + $o->unsetPaginate(); + + return $o->getNum(); + } + + /** + * @page service Service Calls + * @section bx_base_text Base Text + * @subsection bx_base_text-browse Browse + * @subsubsection bx_base_text-browse_public browse_public + * + * @code bx_srv('bx_posts', 'browse_public', [...]); @endcode + * + * Display public posts + * @param $sUnitView unit view, such as: full, extended, gallery, showcase + * @param $bEmptyMessage display or not "empty" message when there is no content + * @param $bAjaxPaginate use AJAX paginate or not + * + * @see BxBaseModTextModule::serviceBrowsePublic + */ + /** + * @ref bx_base_text-browse_public "browse_public" + */ + public function serviceBrowsePublic ($sUnitView = false, $bEmptyMessage = true, $bAjaxPaginate = true) + { + return $this->_serviceBrowse ('public', $sUnitView ? array('unit_view' => $sUnitView) : false, BX_DB_PADDING_DEF, $bEmptyMessage, $bAjaxPaginate); + } + + /** + * @page service Service Calls + * @section bx_base_text Base Text + * @subsection bx_base_text-browse Browse + * @subsubsection bx_base_text-browse_popular browse_popular + * + * @code bx_srv('bx_posts', 'browse_popular', [...]); @endcode + * + * Display popular posts + * @param $sUnitView unit view, such as: full, extended, gallery, showcase + * @param $bEmptyMessage display or not "empty" message when there is no content + * @param $bAjaxPaginate use AJAX paginate or not + * + * @see BxBaseModTextModule::serviceBrowsePopular + */ + /** + * @ref bx_base_text-browse_popular "browse_popular" + */ + public function serviceBrowsePopular ($sUnitView = false, $bEmptyMessage = true, $bAjaxPaginate = true) + { + return $this->_serviceBrowse ('popular', $sUnitView ? array('unit_view' => $sUnitView) : false, BX_DB_PADDING_DEF, $bEmptyMessage, $bAjaxPaginate); + } + + /** + * @page service Service Calls + * @section bx_base_text Base Text + * @subsection bx_base_text-browse Browse + * @subsubsection bx_base_text-browse_top browse_top + * + * @code bx_srv('bx_posts', 'browse_top', [...]); @endcode + * + * Display top posts + * @param $sUnitView unit view, such as: full, extended, gallery, showcase + * @param $bEmptyMessage display or not "empty" message when there is no content + * @param $bAjaxPaginate use AJAX paginate or not + * + * @see BxBaseModTextModule::serviceBrowseTop + */ + /** + * @ref bx_base_text-browse_top "browse_top" + */ + public function serviceBrowseTop ($sUnitView = false, $bEmptyMessage = true, $bAjaxPaginate = true) + { + return $this->_serviceBrowse ('top', $sUnitView ? array('unit_view' => $sUnitView) : false, BX_DB_PADDING_DEF, $bEmptyMessage, $bAjaxPaginate); + } + + /** + * @page service Service Calls + * @section bx_base_text Base Text + * @subsection bx_base_text-browse Browse + * @subsubsection bx_base_text-browse_updated browse_updated + * + * @code bx_srv('bx_posts', 'browse_updated', [...]); @endcode + * + * Display recently updated posts + * @param $sUnitView unit view, such as: full, extended, gallery, showcase + * @param $bEmptyMessage display or not "empty" message when there is no content + * @param $bAjaxPaginate use AJAX paginate or not + * + * @see BxBaseModTextModule::serviceBrowseUpdated + */ + /** + * @ref bx_base_text-browse_updated "browse_updated" + */ + public function serviceBrowseUpdated ($sUnitView = false, $bEmptyMessage = true, $bAjaxPaginate = true) + { + return $this->_serviceBrowse ('updated', $sUnitView ? array('unit_view' => $sUnitView) : false, BX_DB_PADDING_DEF, $bEmptyMessage, $bAjaxPaginate); + } + + /** + * @page service Service Calls + * @section bx_base_text Base Text + * @subsection bx_base_text-browse Browse + * @subsubsection bx_base_text-browse_author browse_author + * + * @code bx_srv('bx_posts', 'browse_author', [...]); @endcode + * + * Display posts of specified author + * @param $iProfileId profile ID + * @param $aParams additional params, see BxBaseModGeneralModule::serviceBrowse + * + * @see BxBaseModTextModule::serviceBrowseAuthor + */ + /** + * @ref bx_base_text-browse_author "browse_author" + */ + public function serviceBrowseAuthor ($iProfileId = 0, $aParams = array()) + { + return $this->_serviceBrowseWithParam ('author', 'profile_id', $iProfileId, $aParams); + } + + /** + * @page service Service Calls + * @section bx_base_text Base Text + * @subsection bx_base_text-page_blocks Page Blocks + * @subsubsection bx_base_text-entity_author entity_author + * + * @code bx_srv('bx_posts', 'entity_author', [...]); @endcode + * + * Display author block for the specified post + * @param $iContentId content ID + * + * @see BxBaseModTextModule::serviceEntityAuthor + */ + /** + * @ref bx_base_text-entity_author "entity_author" + */ + public function serviceEntityAuthor ($iContentId = 0) + { + return $this->_serviceTemplateFunc ('entryAuthor', $iContentId); + } + + /** + * @page service Service Calls + * @section bx_base_text Base Text + * @subsection bx_base_text-page_blocks Page Blocks + * @subsubsection bx_base_text-entity_polls entity_polls + * + * @code bx_srv('bx_posts', 'entity_polls', [...]); @endcode + * + * Display polls for the specified post + * @param $iContentId content ID + * + * @see BxBaseModTextModule::serviceEntityPolls + */ + /** + * @ref bx_base_text-entity_polls "entity_polls" + */ + public function serviceEntityPolls ($iContentId = 0) + { + return $this->_serviceTemplateFunc ('entryPolls', $iContentId); + } + + /** + * @page service Service Calls + * @section bx_base_text Base Text + * @subsection bx_base_text-page_blocks Page Blocks + * @subsubsection bx_base_text-entity_breadcrumb entity_breadcrumb + * + * @code bx_srv('bx_forum', 'entity_breadcrumb', [...]); @endcode + * + * Display breadcrumb for the specified post + * @param $iContentId content ID + * + * @see BxBaseModTextModule::serviceEntityBreadcrumb + */ + /** + * @ref bx_base_text-entity_breadcrumb "entity_breadcrumb" + */ + public function serviceEntityBreadcrumb ($iContentId = 0) + { + return $this->_serviceTemplateFunc ('entryBreadcrumb', $iContentId); + } + + /** + * Delete all content by profile + * @param $iProfileId profile id + * @return number of deleted items + */ + public function serviceDeleteEntitiesByAuthor ($iProfileId) + { + $a = $this->_oDb->getEntriesByAuthor((int)$iProfileId); + if (!$a) + return 0; + + $iCount = 0; + foreach ($a as $aContentInfo) + $iCount += ('' == $this->serviceDeleteEntity($aContentInfo[$this->_oConfig->CNF['FIELD_ID']]) ? 1 : 0); + + return $iCount; + } + + + // ====== PERMISSION METHODS + + /** + * @return CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. So make sure to make strict(===) checking. + */ + public function checkAllowedSetThumb ($iContentId = 0) + { + // check ACL + $aCheck = checkActionModule($this->_iProfileId, 'set thumb', $this->getName(), false); + if ($aCheck[CHECK_ACTION_RESULT] !== CHECK_ACTION_RESULT_ALLOWED) + return $aCheck[CHECK_ACTION_MESSAGE]; + return CHECK_ACTION_RESULT_ALLOWED; + } + + public function isAllowedApprove($mixedContent, $isPerformAction = false) + { + return $this->checkAllowedApprove($mixedContent, $isPerformAction) === CHECK_ACTION_RESULT_ALLOWED; + } + + public function checkAllowedApprove($mixedContent, $isPerformAction = false) + { + $CNF = &$this->_oConfig->CNF; + + $sTxtError = '_sys_txt_access_denied'; + $iProfileId = bx_get_logged_profile_id(); + + if(!is_array($mixedContent)) + $mixedContent = $this->_oDb->getContentInfoById((int)$mixedContent); + + if(empty($mixedContent) || !is_array($mixedContent)) + return _t($sTxtError); + + if(!isset($CNF['FIELD_STATUS_ADMIN']) || $mixedContent[$CNF['FIELD_STATUS_ADMIN']] != BX_BASE_MOD_GENERAL_STATUS_PENDING) + return _t($sTxtError); + + if($this->_isModerator()) + return CHECK_ACTION_RESULT_ALLOWED; + + if(!empty($CNF['FIELD_ALLOW_VIEW_TO']) && (int)$mixedContent[$CNF['FIELD_ALLOW_VIEW_TO']] < 0) { + $iContextProfileId = abs((int)$mixedContent[$CNF['FIELD_ALLOW_VIEW_TO']]); + $oContextProfile = BxDolProfile::getInstance($iContextProfileId); + + $aAdmins = bx_srv($oContextProfile->getModule(), 'get_admins_to_manage_content', [$iContextProfileId]); + if(!empty($aAdmins) && in_array($iProfileId, $aAdmins)) + return CHECK_ACTION_RESULT_ALLOWED; + } + + return _t($sTxtError); + } + + public function isPollPerformed($iObjectId, $iAuthorId = 0, $iAuthorIp = 0) + { + if(empty($iAuthorId)) { + $iAuthorId = bx_get_logged_profile_id(); + $iAuthorIp = bx_get_ip_hash(getVisitorIP()); + } + + return $this->_oDb->isPollPerformed($iObjectId, $iAuthorId, $iAuthorIp); + } + + + // ====== COMMON METHODS + public function deleteAttachLinks($iId) + { + if(!$this->_oConfig->isAttachLinks()) + return; + + $CNF = &$this->_oConfig->CNF; + + $aLinks = $this->_oDb->getLinks($iId); + if(empty($aLinks) || !is_array($aLinks)) + return; + + $oStorage = BxDolStorage::getObjectInstance($CNF['OBJECT_STORAGE_PHOTOS']); + foreach($aLinks as $aLink) + if(!empty($aLink['media_id'])) + $oStorage->deleteFile($aLink['media_id']); + + $this->_oDb->deleteLinks($iId); + } + + public function deleteAttachLinksUnused($iProfileId) + { + if(!$this->_oConfig->isAttachLinks()) + return; + + $CNF = &$this->_oConfig->CNF; + + $aLinks = $this->_oDb->getUnusedLinks($iProfileId); + if(empty($aLinks) || !is_array($aLinks)) + return; + + $oStorage = BxDolStorage::getObjectInstance($CNF['OBJECT_STORAGE_PHOTOS']); + foreach($aLinks as $aLink) + if(!empty($aLink['media_id'])) + $oStorage->deleteFile($aLink['media_id']); + + $this->_oDb->deleteUnusedLinks($iProfileId); + } + + public function onApprove($mixedContent) + { + $CNF = &$this->_oConfig->CNF; + + if(!is_array($mixedContent)) + $mixedContent = $this->_oDb->getContentInfoById((int)$mixedContent); + + $this->alertAfterApprove($mixedContent); + + $this->onPublished($mixedContent[$CNF['FIELD_ID']]); + } + + public function alertAfterAdd($aContentInfo) + { + $CNF = &$this->_oConfig->CNF; + + $iId = (int)$aContentInfo[$CNF['FIELD_ID']]; + $iAuthorId = (int)$aContentInfo[$CNF['FIELD_AUTHOR']]; + + $sAction = 'added'; + if(isset($CNF['FIELD_STATUS']) && isset($aContentInfo[$CNF['FIELD_STATUS']]) && $aContentInfo[$CNF['FIELD_STATUS']] == BX_BASE_MOD_TEXT_STATUS_AWAITING) + $sAction = 'deferred'; + else if(isset($CNF['FIELD_STATUS_ADMIN']) && isset($aContentInfo[$CNF['FIELD_STATUS_ADMIN']]) && $aContentInfo[$CNF['FIELD_STATUS_ADMIN']] == BX_BASE_MOD_GENERAL_STATUS_PENDING) + $sAction = 'deferred'; + + $aParams = $this->_alertParamsAdd($aContentInfo); + + /** + * @hooks + * @hookdef hook-system-prepare_alert_params 'system', 'prepare_alert_params' - hook to override alert (hook) params + * - $unit_name - equals `system` + * - $action - equals `prepare_alert_params` + * - $object_id - not used + * - $sender_id - not used + * - $extra_params - array of additional params with the following array keys: + * - `unit` - [string] unit name + * - `action` - [string] by ref, action, can be overridden in hook processing + * - `object_id` - [int] by ref, object id, can be overridden in hook processing + * - `sender_id` - [int] by ref, action performer profile id, can be overridden in hook processing + * - `extras` - [array] by ref, extra params array as key&value pairs, can be overridden in hook processing + * @hook @ref hook-system-prepare_alert_params + */ + bx_alert('system', 'prepare_alert_params', 0, 0, [ + 'unit'=> $this->getName(), + 'action' => &$sAction, + 'object_id' => &$iId, + 'sender_id' => &$iAuthorId, + 'extras' => &$aParams + ]); + + /** + * @hooks + * @hookdef hook-bx_base_text-added '{module_name}', 'added' - hook after content was added (published) + * - $unit_name - module name + * - $action - equals `added` + * - $object_id - content id + * - $sender_id - content author profile id + * - $extra_params - array of additional params with the following array keys: + * - `status` - [string] content status + * - `status_admin` - [string] content admin status + * - `privacy_view` - [int] or [string] privacy for view content action, @see BxDolPrivacy + * - `cf` - [int] content's audience filter value + * @hook @ref hook-bx_base_text-added + */ + /** + * @hooks + * @hookdef hook-bx_base_text-deferred '{module_name}', 'deferred' - hook after content was added with pending approval status + * It's equivalent to @ref hook-bx_base_text-added + * @hook @ref hook-bx_base_text-deferred + */ + bx_alert($this->getName(), $sAction, $iId, $iAuthorId, $aParams); + + $this->_processModerationNotifications($aContentInfo); + } + + public function alertAfterEdit($aContentInfo) + { + $CNF = &$this->_oConfig->CNF; + + $iId = (int)$aContentInfo[$CNF['FIELD_ID']]; + + $aParams = $this->_alertParamsEdit($aContentInfo); + + /** + * @hooks + * @hookdef hook-bx_base_text-edited '{module_name}', 'edited' - hook after content was changed + * It's equivalent to @ref hook-bx_base_text-added + * @hook @ref hook-bx_base_text-edited + */ + bx_alert($this->getName(), 'edited', $iId, false, $aParams); + } + + /** + * Get array of params to be passed in Add/Edit Alert. + */ + protected function _alertParams($aContentInfo) + { + $aParams = parent::_alertParams($aContentInfo); + + $CNF = &$this->_oConfig->CNF; + + if(!empty($CNF['FIELD_STATUS']) && isset($aContentInfo[$CNF['FIELD_STATUS']])) + $aParams['status'] = $aContentInfo[$CNF['FIELD_STATUS']]; + + if(!empty($CNF['FIELD_STATUS_ADMIN']) && isset($aContentInfo[$CNF['FIELD_STATUS_ADMIN']])) + $aParams['status_admin'] = $aContentInfo[$CNF['FIELD_STATUS_ADMIN']]; + + if(!empty($CNF['FIELD_ALLOW_VIEW_TO']) && isset($aContentInfo[$CNF['FIELD_ALLOW_VIEW_TO']])) + $aParams['privacy_view'] = $aContentInfo[$CNF['FIELD_ALLOW_VIEW_TO']]; + + if(!empty($CNF['FIELD_CF']) && isset($aContentInfo[$CNF['FIELD_CF']])) + $aParams['cf'] = $aContentInfo[$CNF['FIELD_CF']]; + + return $aParams; + } + + protected function _alertParamsAdd($aContentInfo) + { + $aParams = $this->_alertParams($aContentInfo); + + $CNF = &$this->_oConfig->CNF; + + if(!empty($CNF['OBJECT_METATAGS'])) + $aParams['timeline_group'] = $this->_getAlertParamTimelineGroup($aContentInfo); + + return $aParams; + } + + protected function _alertParamsEdit($aContentInfo) + { + $aParams = $this->_alertParams($aContentInfo); + + $CNF = &$this->_oConfig->CNF; + + if(!empty($CNF['OBJECT_METATAGS'])) + $aParams['timeline_group'] = $this->_getAlertParamTimelineGroup($aContentInfo); + + return $aParams; + } + + protected function _getAlertParamTimelineGroup($aContentInfo) + { + $CNF = &$this->_oConfig->CNF; + + return [ + 'by' => $this->getName() . '_' . abs((int)$aContentInfo[$CNF['FIELD_AUTHOR']]) . '_' . (int)$aContentInfo[$CNF['FIELD_ID']], + 'field' => 'owner_id' + ]; + } + + public function getPollForm() + { + $CNF = &$this->_oConfig->CNF; + + if(empty($CNF['OBJECT_FORM_POLL'])) + return array('code' => 1, 'message' => '_sys_txt_error_occured'); + + $iProfileId = bx_get_logged_profile_id(); + + $oForm = BxDolForm::getObjectInstance($CNF['OBJECT_FORM_POLL'], $CNF['OBJECT_FORM_POLL_DISPLAY_ADD'], $this->_oTemplate); + $oForm->aFormAttrs['action'] = BX_DOL_URL_ROOT . $this->_oConfig->getBaseUri() . 'submit_poll_form/'; + + $oForm->initChecker(); + if($oForm->isSubmittedAndValid()) { + $iId = $oForm->insert(); + if($iId) + return array('code' => 0, 'id' => $iId, 'item' => $this->_oTemplate->getPollItem($iId, $iProfileId, array( + 'manage' => true + ))); + else + return array('code' => 2, 'message' => '_sys_txt_error_entry_creation'); + } + + return array('form' => $oForm->getCode(), 'form_id' => $oForm->id); + } + + public function getEntryImageData($aContentInfo, $sField = 'FIELD_THUMB', $aTranscoders = array()) + { + $CNF = &$this->_oConfig->CNF; + + $mResult = parent::getEntryImageData($aContentInfo, $sField, $aTranscoders); + if ($mResult === false && isset($CNF['PARAM_USE_GALERY_AS_COVER']) && getParam($CNF['PARAM_USE_GALERY_AS_COVER']) == 'on'){ + if(!empty($CNF['OBJECT_STORAGE_PHOTOS']) && !empty($CNF['OBJECT_IMAGES_TRANSCODER_PREVIEW_PHOTOS'])){ + $sStorage = $CNF['OBJECT_STORAGE_PHOTOS']; + $oStorage = BxDolStorage::getObjectInstance($sStorage); + $aGhostFiles = $oStorage->getGhosts ($this->serviceGetContentOwnerProfileId($aContentInfo[$CNF['FIELD_ID']]), $aContentInfo[$CNF['FIELD_ID']]); + if ($aGhostFiles){ + foreach ($aGhostFiles as $k => $a) { + return array('id' => $a['id'], 'transcoder' => $CNF['OBJECT_IMAGES_TRANSCODER_PREVIEW_PHOTOS']); + } + } + + } + } + + return $mResult; + } + + public function decodeDataAPI($aData, $aParams = []) + { + $CNF = &$this->_oConfig->CNF; + + $sModule = $this->getName(); + $iId = (int)$aData[$CNF['FIELD_ID']]; + + $sSummary = ''; + if(!empty($CNF['PARAM_CHARS_SUMMARY_PLAIN'])) { + $sSummary = $this->_oTemplate->getText($aData); + $sSummary = BxTemplFunctions::getInstance()->getStringWithLimitedLength(strip_tags($sSummary), (int)getParam($CNF['PARAM_CHARS_SUMMARY_PLAIN'])); + } + + $aResult = [ + 'id' => $iId, + 'module' => $sModule, + 'module_title' => _t($CNF['T']['txt_sample_single']), + 'added' => $aData[$CNF['FIELD_ADDED']], + 'author' => $aData[$CNF['FIELD_AUTHOR']], + 'author_data' => !empty($aData[$CNF['FIELD_AUTHOR']]) ? BxDolProfile::getData($aData[$CNF['FIELD_AUTHOR']]) : '', + 'title' => $aData[$CNF['FIELD_TITLE']], + 'url' => bx_api_get_relative_url($this->serviceGetLink($iId)), + 'image' => $this->serviceGetThumb($iId), + 'summary_plain' => $sSummary + ]; + + if(isset($aParams['extended']) && $aParams['extended'] === true) + $aResult['text'] = $aData[$CNF['FIELD_TEXT']]; + + if(!empty($CNF['OBJECT_MENU_SNIPPET_META']) && ($oMetaMenu = BxDolMenu::getObjectInstance($CNF['OBJECT_MENU_SNIPPET_META'], $this->_oTemplate)) !== false) { + $oMetaMenu->setContentId($iId); + + $aResult['meta'] = $oMetaMenu->getCodeAPI(); + } + + return $aResult; + } + + + // ====== PROTECTED METHODS + + protected function _getImagesForTimelinePost($aEvent, $aContentInfo, $sUrl, $aBrowseParams = array()) + { + $CNF = &$this->_oConfig->CNF; + $aResults = parent::_getImagesForTimelinePost($aEvent, $aContentInfo, $sUrl, $aBrowseParams); + + if (bx_is_api()) + return $aResults; + + if (count($aResults) == 0 && isset($CNF['PARAM_USE_GALERY_AS_COVER']) && getParam($CNF['PARAM_USE_GALERY_AS_COVER']) == 'on'){ + $aResults = $this->_getImagesForTimelinePostAttachInner($aEvent, $aContentInfo, $sUrl, $aBrowseParams); + if (count($aResults) > 1){ + $aResults = array_slice($aResults, 0, 1); + } + } + return $aResults; + } + + protected function _getImagesForTimelinePostAttach($aEvent, $aContentInfo, $sUrl, $aBrowseParams = array()) + { + $CNF = &$this->_oConfig->CNF; + $aTmp = parent::_getImagesForTimelinePost($aEvent, $aContentInfo, $sUrl, $aBrowseParams); + $aResults = $this->_getImagesForTimelinePostAttachInner($aEvent, $aContentInfo, $sUrl, $aBrowseParams); + + if (bx_is_api()) + return $aResults; + + if (count($aTmp) == 0 && count($aResults) > 0 && isset($CNF['PARAM_USE_GALERY_AS_COVER']) && getParam($CNF['PARAM_USE_GALERY_AS_COVER']) == 'on'){ + $aResults = array_slice($aResults, 1); + } + return $aResults; + } + + protected function _getImagesForTimelinePostAttachInner($aEvent, $aContentInfo, $sUrl, $aBrowseParams = array()) + { + $CNF = &$this->_oConfig->CNF; + + $aResults = parent::_getImagesForTimelinePostAttach($aEvent, $aContentInfo, $sUrl, $aBrowseParams); + + if(!$this->_oConfig->isAttachmentsInTimeline() || empty($CNF['OBJECT_STORAGE_PHOTOS']) || empty($CNF['OBJECT_IMAGES_TRANSCODER_GALLERY_PHOTOS'])) + return $aResults; + + $iContentId = (int)$aContentInfo[$CNF['FIELD_ID']]; + $oStorage = BxDolStorage::getObjectInstance($CNF['OBJECT_STORAGE_PHOTOS']); + + $aGhostFiles = $oStorage->getGhosts($this->serviceGetContentOwnerProfileId($iContentId), $iContentId); + if(!$aGhostFiles) + return []; + + $oTranscoderSm = false; + if(!empty($CNF['OBJECT_IMAGES_TRANSCODER_MINIATURE_PHOTOS'])) + $oTranscoderSm = BxDolTranscoderImage::getObjectInstance($CNF['OBJECT_IMAGES_TRANSCODER_MINIATURE_PHOTOS']); + + $oTranscoderMd = BxDolTranscoderImage::getObjectInstance($CNF['OBJECT_IMAGES_TRANSCODER_GALLERY_PHOTOS']); + + $oTranscoderXl = false; + if(!empty($CNF['OBJECT_IMAGES_TRANSCODER_VIEW_PHOTOS'])) + $oTranscoderXl = BxDolTranscoderImage::getObjectInstance($CNF['OBJECT_IMAGES_TRANSCODER_VIEW_PHOTOS']); + + foreach($aGhostFiles as $k => $a) { + $sPhotoSrcMd = $oTranscoderMd->getFileUrl($a['id']); + if(empty($sPhotoSrcMd)) + continue; + + $sPhotoSrcSm = $oTranscoderSm !== false ? $oTranscoderSm->getFileUrl($a['id']) : ''; + if(!$sPhotoSrcSm) + $sPhotoSrcSm = $sPhotoSrcMd; + + $sPhotoSrcXl = $oTranscoderXl !== false ? $oTranscoderXl->getFileUrl($a['id']) : $oStorage->getFileUrlById($a['id']); + if(!$sPhotoSrcXl) + $sPhotoSrcXl = $sPhotoSrcMd; + + if (bx_is_api()){ + $aResults[] = bx_api_get_image($CNF['OBJECT_STORAGE_PHOTOS'], (int)$a['id']); + } + else{ + $aResults[] = [ + 'id' => $a['id'], + 'src' => $sPhotoSrcMd, + 'src_small' => $sPhotoSrcSm, + 'src_medium' => $sPhotoSrcMd, + 'src_orig' => $sPhotoSrcXl, + ]; + } + } + return $aResults; + } + + protected function _getVideosForTimelinePostAttach($aEvent, $aContentInfo, $sUrl, $aBrowseParams = array()) + { + $CNF = &$this->_oConfig->CNF; + + $aResults = parent::_getVideosForTimelinePostAttach($aEvent, $aContentInfo, $sUrl, $aBrowseParams); + if(!$this->_oConfig->isAttachmentsInTimeline() || empty($CNF['OBJECT_STORAGE_VIDEOS']) || empty($CNF['OBJECT_VIDEOS_TRANSCODERS'])) + return $aResults; + + $iContentId = (int)$aContentInfo[$CNF['FIELD_ID']]; + $oStorage = BxDolStorage::getObjectInstance($CNF['OBJECT_STORAGE_VIDEOS']); + + $aGhostFiles = $oStorage->getGhosts($this->serviceGetContentOwnerProfileId($iContentId), $iContentId); + if(!$aGhostFiles) + return array(); + + $oTcPoster = BxDolTranscoderVideo::getObjectInstance($CNF['OBJECT_VIDEOS_TRANSCODERS']['poster']); + $oTcMp4 = BxDolTranscoderVideo::getObjectInstance($CNF['OBJECT_VIDEOS_TRANSCODERS']['mp4']); + $oTcMp4Hd = BxDolTranscoderVideo::getObjectInstance($CNF['OBJECT_VIDEOS_TRANSCODERS']['mp4_hd']); + if(!$oTcPoster || !$oTcMp4 || !$oTcMp4Hd) + return array(); + + $aResults = array(); + foreach ($aGhostFiles as $k => $a) { + $sVideoUrl = $oStorage->getFileUrlById($a['id']); + $aVideoFile = $oStorage->getFile($a['id']); + + $sVideoUrlHd = ''; + if (!empty($aVideoFile['dimensions']) && $oTcMp4Hd->isProcessHD($aVideoFile['dimensions'])) + $sVideoUrlHd = $oTcMp4Hd->getFileUrl($a['id']); + + $aResults[$a['id']] = array( + 'id' => $a['id'], + 'src_poster' => $oTcPoster->getFileUrl($a['id']), + 'src_mp4' => $oTcMp4->getFileUrl($a['id']), + 'src_mp4_hd' => $sVideoUrlHd, + ); + } + + return $aResults; + } + + protected function _getFilesForTimelinePostAttach($aEvent, $aContentInfo, $sUrl, $aBrowseParams = array()) + { + $CNF = &$this->_oConfig->CNF; + + $aResults = parent::_getFilesForTimelinePostAttach($aEvent, $aContentInfo, $sUrl, $aBrowseParams); + if(!$this->_oConfig->isAttachmentsInTimeline() || empty($CNF['OBJECT_STORAGE_FILES'])) + return $aResults; + + $iContentId = (int)$aContentInfo[$CNF['FIELD_ID']]; + $oStorage = BxDolStorage::getObjectInstance($CNF['OBJECT_STORAGE_FILES']); + + $aGhostFiles = $oStorage->getGhosts($this->serviceGetContentOwnerProfileId($iContentId), $iContentId); + if(!$aGhostFiles) + return array(); + + $oTranscoder = null; + if(!empty($CNF['OBJECT_IMAGES_TRANSCODER_GALLERY_FILES'])) + $oTranscoder = BxDolTranscoderImage::getObjectInstance($CNF['OBJECT_IMAGES_TRANSCODER_GALLERY_FILES']); + + foreach ($aGhostFiles as $k => $a) { + $bImage = in_array($a['ext'], array('jpg', 'jpeg', 'png', 'gif')); + + $sPhotoSrc = ''; + if($bImage && $oTranscoder) + $sPhotoSrc = $oTranscoder->getFileUrl($a['id']); + + if(empty($sPhotoSrc) && $oStorage) + $sPhotoSrc = $this->_oTemplate->getIconUrl($oStorage->getIconNameByFileName($a['file_name'])); + + $sUrl = $oStorage->getFileUrlById($a['id']); + + $aResults[] = array( + 'id' => $a['id'], + 'src' => $sPhotoSrc, + 'src_medium' => $sPhotoSrc, + 'src_orig' => $bImage ? $sUrl : '', + 'url' => !$bImage ? $sUrl : '' + ); + } + + return $aResults; + } + + protected function _getContentForTimelinePost($aEvent, $aContentInfo, $aBrowseParams = array()) + { + $aResult = parent::_getContentForTimelinePost($aEvent, $aContentInfo, $aBrowseParams); + if(!$this->_oConfig->isAttachmentsInTimeline()) + return $aResult; + + $CNF = &$this->_oConfig->CNF; + + $bDynamic = isset($aBrowseParams['dynamic_mode']) && (bool)$aBrowseParams['dynamic_mode'] === true; + if(!empty($CNF['PARAM_POLL_ENABLED']) && $CNF['PARAM_POLL_ENABLED'] == true) + $aPolls = $this->_oDb->getPolls(array('type' => 'content_id', 'content_id' => (int)$aContentInfo[$CNF['FIELD_ID']])); + if(!empty($aPolls) && is_array($aPolls)) { + $sInclude = $this->_oTemplate->addCss(array('polls.css'), $bDynamic); + + $aResult['raw'] = ($bDynamic ? $sInclude : '') . $this->_oTemplate->parseHtmlByName('poll_items_embed.html', array( + 'embed_url' => BX_DOL_URL_ROOT . bx_append_url_params($this->_oConfig->getBaseUri() . 'embed_polls/', array( + 'id' => (int)$aContentInfo[$CNF['FIELD_ID']], + 'param_switch_menu' => 0, + 'param_showcase' => 1 + )) + )); +/* + if((!empty($aResult['videos']) && is_array($aResult['videos'])) || (!empty($aResult['videos_attach']) && is_array($aResult['videos_attach']))) + $aResult['_cache'] = false; + */ + } + return $aResult; + } + + protected function _buildRssParams($sMode, $aArgs) + { + $aParams = array (); + $sMode = bx_process_input($sMode); + switch ($sMode) { + case 'author': + $aParams = array('author' => isset($aArgs[0]) ? (int)$aArgs[0] : ''); + break; + } + + return $aParams; + } + + public function serviceIsAllowedPostInContext() + { + return true; + } +} + +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/text/classes/BxBaseModTextSearchResult.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/text/classes/BxBaseModTextSearchResult.php new file mode 100644 index 0000000000..ff2a626846 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/text/classes/BxBaseModTextSearchResult.php @@ -0,0 +1,256 @@ +<?php defined('BX_DOL') or die('hack attempt'); +/** + * Copyright (c) UNA, Inc - https://una.io + * MIT License - https://opensource.org/licenses/MIT + * + * @defgroup BaseText Base classes for text modules + * @ingroup UnaModules + * + * @{ + */ + +class BxBaseModTextSearchResult extends BxBaseModGeneralSearchResult +{ + protected $sUnitViewParamName = 'unit_view'; + + function __construct($sMode = '', $aParams = array()) + { + parent::__construct($sMode, $aParams); + $this->aUnitViews = array('extended' => 'unit.html', 'gallery' => 'unit_gallery.html', 'full' => 'unit_full.html', 'showcase' => 'unit_showcase.html'); + if (!empty($aParams['unit_views'])) + $this->aUnitViews = $aParams['unit_views']; + if (!empty($aParams['unit_view'])) + $this->sUnitViewDefault = $aParams['unit_view']; + $this->aGetParams = array($this->sUnitViewParamName); + $this->sUnitTemplate = $this->aUnitViews[$this->sUnitViewDefault]; + if (isset($this->aUnitViews[bx_get($this->sUnitViewParamName)])) + $this->sUnitTemplate = $this->aUnitViews[bx_get($this->sUnitViewParamName)]; + $this->addContainerClass ('bx-def-margin-bottom-neg'); + if ('unit_gallery.html' == $this->sUnitTemplate){ + $this->removeContainerClass ('bx-def-margin-bottom-neg'); + $this->addContainerClass (array('bx-base-text-unit-gallery-wrapper', 'bx-def-margin-sec-neg')); + } + if ('unit_showcase.html' == $this->sUnitTemplate){ + $this->bShowcaseView = true; + } + } + + protected function checkRestrictionsForContext($sMode, $aParams, $oProfileAuthor){ + if(bx_get('context_id')){ + $aParams['context'] = bx_get('context_id'); + $oProfileAuthor = null; + $this->_updateCurrentForContext($sMode, $aParams, $oProfileAuthor); + } + } + + function getAlterOrder() + { + $CNF = &$this->oModule->_oConfig->CNF; + + $sTable = $this->aCurrent['table']; + + $aSql = array(); + switch ($this->aCurrent['sorting']) { + case 'last': + $aSql['order'] = ' ORDER BY `' . $sTable . '`.`' . $CNF['FIELD_ADDED'] . '` DESC'; + break; + + case 'updated': + $aSql['order'] = ' ORDER BY `' . $sTable . '`.`' . $CNF['FIELD_CHANGED'] . '` DESC'; + break; + + case 'featured': + $aSql['order'] = ' ORDER BY `' . $sTable . '`.`featured` DESC'; + break; + + case 'popular': + $aSql['order'] = ' ORDER BY `' . $sTable . '`.`' . $CNF['FIELD_VIEWS'] . '` DESC'; + break; + + case 'top': + $aSql['order'] = ''; + + $aPartsUp = $aPartsDown = array(0); + if(!empty($CNF['OBJECT_VOTES']) && ($oVote = BxDolVote::getObjectInstance($CNF['OBJECT_VOTES'], 0, false)) !== false && $oVote->isEnabled()) { + $aVote = $oVote->getSystemInfo(); + if(!empty($aVote['trigger_table']) && !empty($aVote['trigger_field_count'])) + $aPartsUp[] = '`' . $aVote['trigger_table'] . '`.`' . $aVote['trigger_field_count'] . '`'; + } + + if(!empty($CNF['OBJECT_REACTIONS']) && ($oReaction = BxDolVote::getObjectInstance($CNF['OBJECT_REACTIONS'], 0, false)) !== false && $oReaction->isEnabled()) { + $aReaction = $oReaction->getSystemInfo(); + if(!empty($aReaction['trigger_table']) && !empty($aReaction['trigger_field_count'])) + $aPartsUp[] = '`' . $aReaction['trigger_table'] . '`.`' . $aReaction['trigger_field_count'] . '`'; + } + + if(!empty($CNF['OBJECT_SCORES']) && ($oScore = BxDolScore::getObjectInstance($CNF['OBJECT_SCORES'], 0, false)) !== false && $oScore->isEnabled()) { + $aScore = $oScore->getSystemInfo(); + if(!empty($aScore['trigger_table']) && !empty($aScore['trigger_field_cup']) && !empty($aScore['trigger_field_cdown'])) { + $aPartsUp[] = '`' . $aScore['trigger_table'] . '`.`' . $aScore['trigger_field_cup'] . '`'; + $aPartsDown[] = '`' . $aScore['trigger_table'] . '`.`' . $aScore['trigger_field_cdown'] . '`'; + } + } + + if(empty($aPartsUp) && empty($aPartsDown)) + break; + + $aSql['order'] = ' ORDER BY ' . pow(10, 8) . ' * ((' . implode(' + ', $aPartsUp) . ') - (' . implode(' + ', $aPartsDown) . ')) / (UNIX_TIMESTAMP() - `' . $sTable . '`.`' . $CNF['FIELD_ADDED'] . '`) DESC'; + break; + } + + return $aSql; + } + + function getRssUnitImage (&$a, $sField) + { + $CNF = &$this->oModule->_oConfig->CNF; + + if(empty($sField) || empty($a[$sField]) || empty($CNF['OBJECT_IMAGES_TRANSCODER_GALLERY'])) + return ''; + + $oTranscoder = BxDolTranscoderImage::getObjectInstance($CNF['OBJECT_IMAGES_TRANSCODER_GALLERY']); + if(!$oTranscoder) + return ''; + + return $oTranscoder->getFileUrl($a[$sField]); + } + + protected function processReplaceableMarkers($oProfileAuthor) + { + if ($oProfileAuthor) { + $this->addMarkers($oProfileAuthor->getInfo()); // profile info is replaceable + $this->addMarkers(array('profile_id' => $oProfileAuthor->id())); // profile id is replaceable + $this->addMarkers(array('display_name' => $oProfileAuthor->getDisplayName())); // profile display name is replaceable + } + + $this->sBrowseUrl = $this->_replaceMarkers($this->sBrowseUrl); + $this->aCurrent['title'] = $this->_replaceMarkers($this->aCurrent['title']); + } + + protected function getCurrentOnclick($aAdditionalParams = array(), $bReplacePagesParams = true) + { + // always add UnitView as additional param + $sUnitView = bx_process_input(bx_get($this->sUnitViewParamName)); + if ($sUnitView && isset($this->aUnitViews[$sUnitView])) + $aAdditionalParams = array_merge(array($this->sUnitViewParamName => $sUnitView), $aAdditionalParams); + + return parent::getCurrentOnclick($aAdditionalParams, $bReplacePagesParams); + } + + protected function _updateCurrentForAuthor($sMode, $aParams, &$oProfileAuthor) + { + $CNF = &$this->oModule->_oConfig->CNF; + + $oProfileAuthor = BxDolProfile::getInstance((int)$aParams['author']); + if (!$oProfileAuthor) + return false; + + $iProfileAuthor = $oProfileAuthor->id(); + if (bx_get_logged_profile_id() == $iProfileAuthor || $this->oModule->_isModerator()) { + // for real owner and for moderators show anonymous posts + $this->aCurrent['restriction']['author']['operator'] = 'in'; + $this->aCurrent['restriction']['author']['value'] = array($iProfileAuthor, -$iProfileAuthor); + } + else { + $this->aCurrent['restriction']['author']['value'] = $iProfileAuthor; + } + + if(!empty($aParams['except'])) + $this->aCurrent['restriction']['except']['value'] = is_array($aParams['except']) ? $aParams['except'] : array($aParams['except']); + + if(!empty($aParams['per_page'])) + $this->aCurrent['paginate']['perPage'] = is_numeric($aParams['per_page']) ? (int)$aParams['per_page'] : (int)getParam($aParams['per_page']); + + $this->sBrowseUrl = 'page.php?i=' . $CNF['URI_AUTHOR_ENTRIES'] . '&profile_id={profile_id}'; + $this->aCurrent['title'] = _t($CNF['T']['txt_all_entries_by_author']); + $this->aCurrent['rss']['link'] = 'modules/?r=' . $this->oModule->_oConfig->getUri() . '/rss/' . $sMode . '/' . $iProfileAuthor; + + return true; + } + + protected function _updateCurrentForContext($sMode, $aParams, &$oProfileContext) + { + $CNF = &$this->oModule->_oConfig->CNF; + + if(empty($aParams['context'])) + return false; + + $oProfileContext = BxDolProfile::getInstance((int)$aParams['context']); + if(!$oProfileContext) + return false; + + $iProfileIdContext = $oProfileContext->id(); + $this->aCurrent['restriction']['context'] = array( + 'value' => -$iProfileIdContext, + 'field' => $CNF['FIELD_ALLOW_VIEW_TO'], + 'operator' => '=', + ); + + if(!empty($aParams['per_page'])) + $this->aCurrent['paginate']['perPage'] = is_numeric($aParams['per_page']) ? (int)$aParams['per_page'] : (int)getParam($aParams['per_page']); + + $this->sBrowseUrl = 'page.php?i=' . $CNF['URI_ENTRIES_BY_CONTEXT'] . '&profile_id={profile_id}'; + $this->aCurrent['title'] = _t($CNF['T']['txt_all_entries_by_context']); + $this->aCurrent['rss']['link'] = 'modules/?r=' . $this->oModule->_oConfig->getUri() . '/rss/' . $sMode . '/' . $iProfileIdContext; + + return true; + } + + protected function _updateCurrentForFavorite($sMode, $aParams, &$oProfileAuthor) + { + $CNF = &$this->oModule->_oConfig->CNF; + + $sSystem = ''; + $iListId = 0; + + if(!empty($aParams['system'])) { + $sSystem = $aParams['system']; + unset($aParams['system']); + } + + if(!empty($aParams['list_id'])) { + $iListId = $aParams['list_id']; + unset($aParams['list_id']); + } + + $oProfileAuthor = BxDolProfile::getInstance((int)$aParams['user']); + if(!$oProfileAuthor) + return false; + + $iProfileAuthor = $oProfileAuthor->id(); + $oFavorite = $this->oModule->getObjectFavorite($sSystem); + if(!$oFavorite->isPublic() && $iProfileAuthor != bx_get_logged_profile_id()) + return false; + + $aConditions = $oFavorite->getConditionsTrack($this->aCurrent['table'], 'id', $iProfileAuthor, $iListId); + if(!empty($aConditions) && is_array($aConditions)) { + if(empty($this->aCurrent['restriction']) || !is_array($this->aCurrent['restriction'])) + $this->aCurrent['restriction'] = array(); + $this->aCurrent['restriction'] = array_merge($this->aCurrent['restriction'], $aConditions['restriction']); + + if(empty($this->aCurrent['join']) || !is_array($this->aCurrent['join'])) + $this->aCurrent['join'] = array(); + $this->aCurrent['join'] = array_merge($this->aCurrent['join'], $aConditions['join']); + } + + $this->sBrowseUrl = 'page.php?i=' . $CNF['URI_AUTHOR_ENTRIES'] . '&profile_id={profile_id}'; + $this->aCurrent['title'] = _t($CNF['T']['txt_all_entries_by_author']); + $this->aCurrent['rss']['link'] = 'modules/?r=' . $this->oModule->_oConfig->getUri() . '/rss/' . $sMode . '/' . $iProfileAuthor; + + return true; + } + + function _getPseud () + { + return array( + 'id' => 'id', + 'title' => 'title', + 'text' => 'text', + 'added' => 'added', + 'author' => 'author', + 'photo' => 'photo', + ); + } +} + +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/text/classes/BxBaseModTextTemplate.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/text/classes/BxBaseModTextTemplate.php new file mode 100644 index 0000000000..9257ad9f64 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/text/classes/BxBaseModTextTemplate.php @@ -0,0 +1,1178 @@ +<?php defined('BX_DOL') or die('hack attempt'); +/** + * Copyright (c) UNA, Inc - https://una.io + * MIT License - https://opensource.org/licenses/MIT + * + * @defgroup BaseText Base classes for text modules + * @ingroup UnaModules + * + * @{ + */ + +/** + * Module representation. + */ +class BxBaseModTextTemplate extends BxBaseModGeneralTemplate +{ + protected $_sUnitClassShowCase; + + function __construct(&$oConfig, &$oDb) + { + parent::__construct($oConfig, $oDb); + + $this->_sUnitClassShowCase = 'bx-base-unit-showcase bx-base-text-unit-showcase bx-def-margin-sec-bottom'; + } + + public function addLocationBase() + { + parent::addLocationBase(); + + $this->addLocation('mod_text', BX_DIRECTORY_PATH_MODULES . 'base' . DIRECTORY_SEPARATOR . 'text' . DIRECTORY_SEPARATOR, BX_DOL_URL_MODULES . 'base/text/'); + } + + public function getJsCode($sType, $aParams = array(), $bWrap = true) + { + $CNF = &$this->getModule()->_oConfig->CNF; + + $aParams = array_merge(array( + 'aHtmlIds' => $this->_oConfig->getHtmlIds(), + 'sEditorId' => isset($CNF['FIELD_TEXT_ID']) ? $CNF['FIELD_TEXT_ID'] : '' + ), $aParams); + + return parent::getJsCode($sType, $aParams, $bWrap); + } + + function unit ($aData, $isCheckPrivateContent = true, $sTemplateName = 'unit.html', $aParams = array()) + { + if(!empty($aParams['template_name'])) + $sTemplateName = $aParams['template_name']; + else + $aParams['template_name'] = $sTemplateName; + + $sResult = $this->checkPrivacy ($aData, $isCheckPrivateContent, $this->getModule(), $sTemplateName); + if($sResult) + return $sResult; + + $aTemplateVars = $this->getUnit($aData, $aParams); + + /** + * @hooks + * @hookdef hook-bx_base_text-unit '{module_name}', 'unit' - hook to override content browsing unit + * - $unit_name - module name + * - $action - equals `unit` + * - $object_id - not used + * - $sender_id - not used + * - $extra_params - array of additional params with the following array keys: + * - `data` - [array] content info array as key&value pairs + * - `check_private_content` - [boolean] check if it's a provate content + * - `template` - [string] or [array] with template for content unit + * - `params` - [array] additional params array as key&value pairs + * - `tmpl_name` - [string] by ref, template name, can be overridden in hook processing + * - `tmpl_vars` - [array] by ref, template parsable variables as key&value pairs, can be overridden in hook processing + * @hook @ref hook-bx_base_text-unit + */ + bx_alert($this->getModule()->getName(), 'unit', 0, 0, [ + 'data' => $aData, + 'check_private_content' => $isCheckPrivateContent, + 'template' => $sTemplateName, + 'params' => $aParams, + 'tmpl_name' => &$sTemplateName, + 'tmpl_vars' => &$aTemplateVars + ]); + + return $this->parseHtmlByName($sTemplateName, $aTemplateVars); + } + + function entryAttachments ($aData, $aParams = array()) + { + $CNF = &$this->getModule()->_oConfig->CNF; + + $aStoragesKeys = array('OBJECT_STORAGE_PHOTOS', 'OBJECT_STORAGE_VIDEOS', 'OBJECT_STORAGE_SOUNDS', 'OBJECT_STORAGE_FILES'); + + $aStorages = array(); + foreach($aStoragesKeys as $sKey) + if(!empty($CNF[$sKey])) + $aStorages[] = $CNF[$sKey]; + + if(!empty($aStorages)) + return $this->entryAttachmentsByStorage($aStorages, $aData, array_merge($aParams, array('filter_field' => ''))); + + return parent::entryAttachments($aData, $aParams); + } + + function entryAuthor ($aData, $iProfileId = false, $sFuncAuthorDesc = 'getAuthorDesc', $sTemplateName = 'author.html', $sFuncAuthorAddon = 'getAuthorAddon') + { + $oModule = $this->getModule(); + $CNF = &$oModule->_oConfig->CNF; + + if (!$iProfileId) + $iProfileId = $aData[$CNF['FIELD_AUTHOR']]; + + if($this->_bIsApi) { + $sFldAdd = 'FIELD_ADDED'; + $sFldAvt = 'FIELD_ALLOW_VIEW_TO'; + + return [ + bx_api_get_block('entity_author', [ + 'author_data' => BxDolProfile::getData($iProfileId), + 'entry_date' => !empty($CNF[$sFldAdd]) && !empty($aData[$CNF[$sFldAdd]]) ? $aData[$CNF[$sFldAdd]] : '', + 'entry_context' => !empty($CNF[$sFldAvt]) && (int)$aData[$CNF[$sFldAvt]] < 0 ? BxDolProfile::getData(abs((int)$aData[$CNF[$sFldAvt]])) : '', + 'menu_manage' => $oModule->getEntryAllActions() + ]) + ]; + } + + $oProfile = BxDolProfile::getInstanceMagic($iProfileId); + $sName = $oProfile->getDisplayName(); + $sAddon = $sFuncAuthorAddon && is_a($oProfile, 'BxDolProfile') ? $this->$sFuncAuthorAddon($aData, $oProfile) : ''; + + return $this->parseHtmlByName($sTemplateName, [ + 'author_url' => $oProfile->getUrl(), + 'author_thumb_url' => $oProfile->getThumb(), + 'author_unit' => $oProfile->getUnit(0, ['template' => 'unit_wo_info']), + 'author_title' => $sName, + 'author_title_attr' => bx_html_attribute($sName), + 'author_desc' => $sFuncAuthorDesc ? $this->$sFuncAuthorDesc($aData, $oProfile) : '', + 'author_profile_desc' => $this->getAuthorProfileDesc($aData, $oProfile), + 'bx_if:addon' => [ + 'condition' => (bool)$sAddon, + 'content' => [ + 'content' => $sAddon, + ], + ], + ]); + } + + public function entryBreadcrumb($aContentInfo, $aTmplVarsItems = array()) + { + if(!empty($aTmplVarsItems) && is_array($aTmplVarsItems)) + return parent::entryBreadcrumb($aContentInfo, $aTmplVarsItems); + + $CNF = &$this->getModule()->_oConfig->CNF; + + $aTmplVarsItems = array(); + if(!empty($CNF['OBJECT_CATEGORY']) && !empty($CNF['FIELD_CATEGORY'])) { + $oCategory = BxDolCategory::getObjectInstance($CNF['OBJECT_CATEGORY']); + + $aParams = []; + if(isset($CNF['URL_CATEGORY'])) + $aParams['page'] = bx_append_url_params(BxDolPermalinks::getInstance()->permalink($CNF['URL_CATEGORY']), [ + 'category' => '{keyword}' + ], true, ['{keyword}']); + + $aTmplVarsItems[] = array( + 'url' => $oCategory->getCategoryUrl($aContentInfo[$CNF['FIELD_CATEGORY']], $aParams), + 'title' => $oCategory->getCategoryTitle($aContentInfo[$CNF['FIELD_CATEGORY']]) + ); + } + + $aTmplVarsItems[] = array( + 'url' => BxDolPermalinks::getInstance()->permalink('page.php?i=' . $CNF['URI_VIEW_ENTRY'] . '&id=' . $aContentInfo[$CNF['FIELD_ID']]), + 'title' => bx_process_output($aContentInfo[$CNF['FIELD_TITLE']]) + ); + + return parent::entryBreadcrumb($aContentInfo, $aTmplVarsItems); + } + + public function entryPolls($aData) + { + $CNF = &$this->getModule()->_oConfig->CNF; + + $aPolls = $this->_oDb->getPolls(array( + 'type' => 'content_id', + 'content_id' => $aData[$CNF['FIELD_ID']], + )); + if(empty($aPolls) || !is_array($aPolls)) + return; + + $iProfileId = bx_get_logged_profile_id(); + + $sPolls = ''; + foreach($aPolls as $aPoll) + $sPolls .= $this->getPollItem($aPoll, $iProfileId); + + if(empty($sPolls)) + return ''; + + $this->_addCssJs(); + return $this->getJsCode('poll') . $this->parseHtmlByName('poll_items.html', array( + 'polls' => $sPolls + )); + } + + public function entryPollAnswers($aPoll, $bDynamic = false) + { + $sContent = $this->_getPollAnswers($aPoll, $bDynamic); + if(empty($sContent)) + return ''; + + return array( + 'content' => $sContent, + 'menu' => $this->_getPollBlockMenu($aPoll, 'answers') + ); + } + + public function entryPollResults($aPoll, $bDynamic = false) + { + $sContent = $this->_getPollResults($aPoll, $bDynamic); + if(empty($sContent)) + return ''; + + return array( + 'content' => $sContent, + 'menu' => $this->_getPollBlockMenu($aPoll, 'results') + ); + } + + public function getPollForm() + { + $aForm = $this->getModule()->getPollForm(); + + return $this->parseHtmlByName('poll_form.html', array( + 'js_object' => $this->_oConfig->getJsObject('poll'), + 'form_id' => $aForm['form_id'], + 'form' => $aForm['form'], + )); + } + + public function getPollField($iContentId = 0, $iProfileId = 0) + { + if(empty($iProfileId)) + $iProfileId = bx_get_logged_profile_id(); + + $aPolls = array(); + if(!empty($iContentId)) + $aPolls = array_merge($aPolls, $this->_oDb->getPolls(array( + 'type' => 'content_id', + 'content_id' => $iContentId, + ))); + + $aPolls = array_merge($aPolls, $this->_oDb->getPolls(array( + 'type' => 'author_id', + 'author_id' => $iProfileId, + 'unused' => true + ))); + + $sPolls = ''; + foreach($aPolls as $aPoll) + $sPolls .= $this->getPollItem($aPoll, $iProfileId, array( + 'manage' => true + )); + + return $this->parseHtmlByName('poll_form_field.html', array( + 'html_id' => $this->_oConfig->getHtmlIds('add_poll_form_field'), + 'polls' => $sPolls + )); + } + + public function getPollItem($mixedPoll, $iProfileId = 0, $aParams = array()) + { + $oModule = $this->getModule(); + $CNF = &$oModule->_oConfig->CNF; + + $aPoll = is_array($mixedPoll) ? $mixedPoll : $this->_oDb->getPolls(array('type' => 'id', 'id' => (int)$mixedPoll)); + if(empty($aPoll) || !is_array($aPoll)) + return ''; + + $sJsObject = $this->_oConfig->getJsObject('poll'); + + $bDynamic = isset($aParams['dynamic']) && $aParams['dynamic'] === true; + $bManage = isset($aParams['manage']) && $aParams['manage'] === true; + $bSwitchMenu = isset($aParams['switch_menu']) ? (bool)$aParams['switch_menu'] : true; + $bForceDisplayAnswers = isset($aParams['force_display_answers']) && (bool)$aParams['force_display_answers'] === true; + + $iPollId = (int)$aPoll[$CNF['FIELD_POLL_ID']]; + $sPollView = !$bForceDisplayAnswers && $oModule->isPollPerformed($iPollId, $iProfileId) ? 'results' : 'answers'; + + $sMethod = '_getPoll' . ucfirst($sPollView); + if(!method_exists($this, $sMethod)) + return ''; + + $mixedMenu = ''; + if($bSwitchMenu) + $mixedMenu = $this->_getPollBlockMenu($aPoll, $sPollView, array('template' => 'menu_interactive.html')); + + return $this->parseHtmlByName('poll_item.html', array( + 'html_id' => $this->_oConfig->getHtmlIds('poll') . $iPollId, + 'bx_if:show_input_hidden' => array( + 'condition' => $bManage, + 'content' => array( + 'name' => $CNF['FIELD_POLL'], + 'id' => $iPollId + ) + ), + 'action_menu' => !empty($mixedMenu) ? $mixedMenu->getCode() : '', + 'bx_if:show_action_embed' => array( + 'condition' => $bManage, + 'content' => array( + 'js_object' => $sJsObject, + 'id' => $iPollId + ) + ), + 'bx_if:show_action_delete' => array( + 'condition' => $bManage, + 'content' => array( + 'js_object' => $sJsObject, + 'id' => $iPollId, + 'editor_id' => isset($CNF['FIELD_TEXT_ID']) ? $CNF['FIELD_TEXT_ID'] : '' + ) + ), + 'text' => bx_process_output($aPoll[$CNF['FIELD_POLL_TEXT']], BX_DATA_TEXT), + 'content' => $this->$sMethod($aPoll, $bDynamic) + )); + } + + public function embedPollItem($mixedPoll, $aParams = array()) + { + $CNF = &$this->getModule()->_oConfig->CNF; + + $sHeader = ''; + $sContent = $this->getPollItem($mixedPoll, 0, $aParams); + if(!empty($sContent)) { + $aPoll = is_array($mixedPoll) ? $mixedPoll : $this->_oDb->getPolls(array('type' => 'id', 'id' => (int)$mixedPoll)); + + $sHeader = strmaxtextlen($aPoll[$CNF['FIELD_POLL_TEXT']], 32, '...'); + $sContent = $this->getJsCode('poll') . $sContent; + } + + $this->_addCssJs(); + + $oTemplate = BxDolTemplate::getInstance(); + $oTemplate->addCssStyle($CNF['STYLES_POLLS_EMBED_CLASS'], $CNF['STYLES_POLLS_EMBED_CONTENT']); + $oTemplate->setPageNameIndex(BX_PAGE_EMBED); + $oTemplate->setPageHeader($sHeader); + $oTemplate->setPageContent('page_main_code', $sContent); + $oTemplate->getPageCode(); + exit; + } + + public function embedPollItems($mixedContentInfo, $aParams = array()) + { + $CNF = &$this->getModule()->_oConfig->CNF; + + $aContentInfo = is_array($mixedContentInfo) ? $mixedContentInfo : $this->_oDb->getContentInfoById((int)$mixedContentInfo); + if(empty($aContentInfo) || !is_array($aContentInfo)) + return; + + $iContentId = (int)$aContentInfo[$CNF['FIELD_ID']]; + + $aPolls = $this->_oDb->getPolls(array('type' => 'content_id', 'content_id' => $iContentId)); + if(empty($aPolls) || !is_array($aPolls)) + return; + + $iPolls = 0; + $sContent = ''; + foreach($aPolls as $aPoll) { + $sPoll = $this->getPollItem($aPoll, 0, $aParams); + if(empty($sPoll)) + continue; + + $sContent .= $sPoll; + $iPolls += 1; + } + + if(!empty($sContent) && isset($aParams['showcase']) && (bool)$aParams['showcase'] === true) { + $this->addJs(array('flickity/flickity.pkgd.min.js')); + $this->addCss(BX_DIRECTORY_PATH_PLUGINS_PUBLIC . 'flickity/|flickity.css'); + + $sContent = $this->parseHtmlByName('poll_items_showcase.html', array( + 'js_object' => $this->_oConfig->getJsObject('poll'), + 'html_id' => $this->_oConfig->getHtmlIds('polls_showcase') . $iContentId, + 'type' => $iPolls == 1 ? 'single' : 'multiple', + 'polls' => $sContent + )); + } + + $sHeader = ''; + if(!empty($sContent)) { + $sHeader = $iPolls == 1 ? array_shift($aPolls)[$CNF['FIELD_POLL_TEXT']] : _t('_polls_from', $aContentInfo[$CNF['FIELD_TITLE']]); + $sHeader = strmaxtextlen($sHeader, 32, '...'); + + $sContent = $this->getJsCode('poll') . $sContent; + } + + $this->_addCssJs(); + + $oTemplate = BxDolTemplate::getInstance(); + $oTemplate->addCssStyle($CNF['STYLES_POLLS_EMBED_CLASS'], $CNF['STYLES_POLLS_EMBED_CONTENT']); + $oTemplate->setPageNameIndex(BX_PAGE_EMBED); + $oTemplate->setPageHeader($sHeader); + $oTemplate->setPageContent('page_main_code', $sContent); + $oTemplate->getPageCode(); + exit; + } + + protected function _addCssJs() + { + $this->addJs(array( + 'modules/base/text/js/|polls.js', + 'polls.js' + )); + $this->addCss(array('polls.css')); + } + + protected function _getPollAnswers($aPoll, $bDynamic = false) + { + $CNF = &$this->getModule()->_oConfig->CNF; + + $aAnswers = $this->_oDb->getPollAnswers(array('type' => 'poll_id', 'poll_id' => $aPoll[$CNF['FIELD_POLL_ID']])); + if(empty($aAnswers) || !is_array($aAnswers)) + return ''; + + $aTmplVarsAnswers = array(); + foreach($aAnswers as $aAnswer) { + $oVotes = BxDolVote::getObjectInstance($CNF['OBJECT_VOTES_POLL_ANSWERS'], $aAnswer['id']); + + $aTmplVarsAnswers[] = array( + 'answer' => $oVotes->getElementBlock(array( + 'dynamic_mode' => $bDynamic + )) + ); + } + + return $this->parseHtmlByName('poll_item_answers.html', array( + 'html_id' => $this->_oConfig->getHtmlIds('poll_content') . $aPoll[$CNF['FIELD_POLL_ID']], + 'bx_repeat:answers' => $aTmplVarsAnswers + )); + } + + protected function _getPollResults($aPoll, $bDynamic = false) + { + $CNF = &$this->getModule()->_oConfig->CNF; + + $aAnswers = $this->_oDb->getPollAnswers(array('type' => 'poll_id', 'poll_id' => $aPoll[$CNF['FIELD_POLL_ID']])); + if(empty($aAnswers) || !is_array($aAnswers)) + return ''; + + $iTotal = 0; + foreach($aAnswers as $aAnswer) + $iTotal += $aAnswer['votes']; + + $aTmplVarsAnswers = array(); + foreach($aAnswers as $aAnswer) { + $oVotes = BxDolVote::getObjectInstance($CNF['OBJECT_VOTES_POLL_ANSWERS'], $aAnswer['id']); + $aVotesParams = array('show_counter_empty' => true, 'show_counter_in_brackets' => false, 'dynamic_mode' => $bDynamic); + + $fPercent = $iTotal > 0 ? 100 * (float)$aAnswer['votes']/$iTotal : 0; + $aTmplVarsAnswers[] = array( + 'title' => bx_process_output($aAnswer['title']), + 'width' => (int)round($fPercent) . '%', + 'votes' => $oVotes->getCounter($aVotesParams), + 'percent' => _t($CNF['T']['txt_poll_answer_vote_percent'], $iTotal > 0 ? round($fPercent, 2) : 0) + ); + } + + return $this->parseHtmlByName('poll_item_results.html', array( + 'html_id' => $this->_oConfig->getHtmlIds('poll_content') . $aPoll[$CNF['FIELD_POLL_ID']], + 'bx_repeat:answers' => $aTmplVarsAnswers, + )); + } + + protected function _getPollBlockMenu($aPoll, $sSelected = '', $aParams = array()) + { + $oModule = $this->getModule(); + $CNF = &$oModule->_oConfig->CNF; + + $sPostfix = '-' . time() . rand(0, PHP_INT_MAX); + $sJsObject = $this->_oConfig->getJsObject('poll'); + $iPollId = $aPoll[$CNF['FIELD_POLL_ID']]; + + $aViews = array( + 'answers' => true, + 'results' => $CNF['PARAM_POLL_HIDDEN_RESULTS'] === false || $oModule->isPollPerformed($iPollId) + ); + + $aMenu = array(); + foreach($aViews as $sView => $bActive) { + if(!$bActive) + continue; + + $sId = $this->_oConfig->getHtmlIds('poll_view_link_' . $sView) . $iPollId; + if(!empty($sSelected) && $sSelected == $sView) + $sSelected = $sId; + + $aMenu[] = array( + 'id' => $sId, + 'name' => $sId, + 'class' => '', + 'link' => 'javascript:void(0)', + 'onclick' => 'javascript:' . $sJsObject . '.changePollView(this, \'' . $sView . '\', ' . $iPollId . ')', + 'target' => '_self', + 'title_attr' => _t($CNF['T']['txt_poll_menu_view_' . $sView]), + 'title' => $this->parseIcon($CNF['ICON_POLLS_' . strtoupper($sView)]) + ); + } + + if(count($aMenu) <= 1) + return ''; + + $oMenu = new BxTemplMenuInteractive(array( + 'template' => !empty($aParams['template']) ? $aParams['template'] : 'menu_interactive_vertical.html', + 'menu_id' => $this->_oConfig->getHtmlIds('poll_view_menu') . $sPostfix, + 'menu_items' => $aMenu + )); + + if(!empty($sSelected)) + $oMenu->setSelected('', $sSelected); + + return $oMenu; + } + + public function getAttachLinkForm($iContentId = 0) + { + $sStylePrefix = $this->_oConfig->getPrefix('style'); + $sJsObject = $this->_oConfig->getJsObject('links'); + + $aForm = $this->getModule()->getFormAttachLink($iContentId); + + return $this->parseHtmlByName('attach_link_form.html', array( + 'style_prefix' => $sStylePrefix, + 'js_object' => $sJsObject, + 'form_id' => $aForm['form_id'], + 'form' => $aForm['form'], + )); + } + + public function getAttachLinkField($iUserId, $iContentId = 0) + { + $sStylePrefix = $this->_oConfig->getPrefix('style'); + + if(!$iContentId) + $aLinks = $this->_oDb->getUnusedLinks($iUserId); + else + $aLinks = $this->_oDb->getLinks($iContentId); + + $sLinks = ''; + foreach($aLinks as $aLink) + $sLinks .= $this->getAttachLinkItem($iUserId, $aLink); + + return $this->parseHtmlByName('attach_link_form_field.html', array( + 'html_id' => $this->_oConfig->getHtmlIds('attach_link_form_field') . $iContentId, + 'style_prefix' => $sStylePrefix, + 'links' => $sLinks + )); + } + + public function getAttachLinkItem($iUserId, $mixedLink) + { + $CNF = &$this->getModule()->_oConfig->CNF; + + $aLink = is_array($mixedLink) ? $mixedLink : $this->_oDb->getLinksBy(array('type' => 'id', 'id' => (int)$mixedLink, 'profile_id' => $iUserId)); + if(empty($aLink) || !is_array($aLink)) + return ''; + + $sLinkIdPrefix = $this->_oConfig->getHtmlIds('attach_link_item'); + $sStylePrefix = $this->_oConfig->getPrefix('style'); + $sClass = $sStylePrefix . '-al-item'; + $sJsObject = $this->_oConfig->getJsObject('links'); + + $oEmbed = BxDolEmbed::getObjectInstance(); + $bEmbed = $oEmbed !== false; + + $sThumbnail = ''; + $aLinkAttrs = array(); + if(!$bEmbed) { + $aLinkAttrs = array( + 'title' => bx_html_attribute($aLink['title']) + ); + if(!$this->_oConfig->isEqualUrls(BX_DOL_URL_ROOT, $aLink['url'])) { + $aLinkAttrs['target'] = '_blank'; + + if($this->_oDb->getParam('sys_add_nofollow') == 'on') + $aLinkAttrs['rel'] = 'nofollow'; + } + + if((int)$aLink['media_id'] != 0) + $sThumbnail = BxDolTranscoderImage::getObjectInstance($CNF['OBJECT_IMAGES_TRANSCODER_PREVIEW_PHOTOS'])->getFileUrl($aLink['media_id']); + } + else + $sClass .= ' embed'; + + return $this->parseHtmlByName('attach_link_item.html', array( + 'html_id' => $sLinkIdPrefix . $aLink['id'], + 'style_prefix' => $sStylePrefix, + 'class' => $sClass, + 'js_object' => $sJsObject, + 'id' => $aLink['id'], + 'bx_if:show_embed_outer' => array( + 'condition' => $bEmbed, + 'content' => array( + 'style_prefix' => $sStylePrefix, + 'embed' => $bEmbed ? $oEmbed->getLinkHTML($aLink['url'], $aLink['title'], 300) : '', + ) + ), + 'bx_if:show_embed_inner' => array( + 'condition' => !$bEmbed, + 'content' => array( + 'style_prefix' => $sStylePrefix, + 'bx_if:show_thumbnail' => array( + 'condition' => !empty($sThumbnail), + 'content' => array( + 'style_prefix' => $sStylePrefix, + 'thumbnail' => $sThumbnail + ) + ), + 'url' => $aLink['url'], + 'link' => $this->parseLink($aLink['url'], $aLink['title'], $aLinkAttrs) + ) + ), + )); + } + + public function getEventLinks($iContentId) + { + $CNF = &$this->getModule()->_oConfig->CNF; + + $aLinks = $this->_oDb->getLinks($iContentId); + if(empty($aLinks) || !is_array($aLinks)) + return array(); + + $oTranscoder = BxDolTranscoderImage::getObjectInstance($CNF['OBJECT_IMAGES_TRANSCODER_PREVIEW_PHOTOS']); + + $aResult = array(); + foreach($aLinks as $aLink) + $aResult[] = array( + 'url' => $aLink['url'], + 'title' => $aLink['title'], + 'text' => $aLink['text'], + 'thumbnail' => (int)$aLink['media_id'] != 0 ? $oTranscoder->getFileUrl($aLink['media_id']) : '' + ); + + return $aResult; + } + + public function getTmplVarsText($aData) + { + $CNF = &$this->getModule()->_oConfig->CNF; + $sStylePrefix = $this->_oConfig->getPrefix('style'); + + $aVars = parent::getTmplVarsText($aData); + + $aImageParams = $this->_getHeaderImageParams(); + $mixedImage = $this->_getHeaderImage($aData); + + $sImage = ''; + if($mixedImage !== false) { + if(!empty($mixedImage['object'])) + $o = BxDolStorage::getObjectInstance($mixedImage['object']); + else if(!empty($mixedImage['transcoder'])) + $o = BxDolTranscoder::getObjectInstance($mixedImage['transcoder']); + + if($o) + $sImage = $o->getFileUrlById($mixedImage['id']); + } + + if($this->_bIsApi) { + if($sImage) + $aVars['image'] = bx_api_get_image($aImageParams['storage'], $mixedImage['id']); + + return $aVars; + } + + $sAddClassPicture = ""; + $sAddCode = ""; + $oModule = $this->getModule(); + $bIsAllowEditPicture = CHECK_ACTION_RESULT_ALLOWED === $oModule->checkAllowedEdit($aData); + + if($aImageParams['field'] && $aImageParams['uploaders'] && $aImageParams['storage'] && $aImageParams['transcoder_cover']) { + /** + * @hooks + * @hookdef hook-system-image_editor 'system', 'image_editor' - hook to override content header image editor + * - $unit_name - equals `system` + * - $action - equals `image_editor` + * - $object_id - not used + * - $sender_id - not used + * - $extra_params - array of additional params with the following array keys: + * - `module` - [string] module name + * - `content_id` - [int] profile content id + * - `is_allow_edit` - [boolean] if edit action is allowed to current user + * - `image_type` - [string] image type equals to `header_image` + * - `image_url` - [string] image URL + * - `uploader` - [string] uploader name + * - `storage` - [string] storage name + * - `transcoder` - [string] transcoder name + * - `field` - [string] field name + * - `is_background` - [boolean] if image is used as background, always `false` + * - `add_class` - [string] by ref, class to add, can be overridden in hook processing + * - `add_code` - [array] by ref, code to add, can be overridden in hook processing + * @hook @ref hook-system-image_editor + */ + bx_alert('system', 'image_editor', 0, 0, [ + 'module' => $oModule->getName(), + 'content_id' => $aData[$CNF['FIELD_ID']], + 'is_allow_edit' => $bIsAllowEditPicture, + 'image_type' => 'header_image', + 'image_url' => $sImage, + 'uploader' => $aImageParams['uploaders'] && is_array($aImageParams['uploaders']) ? $aImageParams['uploaders'][0] : '', + 'storage' => $aImageParams['storage'], + 'transcoder' => $aImageParams['transcoder_cover'], + 'field' => $aImageParams['field'], + 'is_background' => false, + 'add_class' => &$sAddClassPicture, + 'add_code' => &$sAddCode + ]); + } + + $sImageTweak = ''; + $sUniqIdImage = genRndPwd (8, false); + if ($bIsAllowEditPicture && empty($sAddCode) && $aImageParams['field_position']){ + $sImageTweak = $this->_prepareImage($aData, $sUniqIdImage, $aImageParams['uploaders'], $aImageParams['storage'], $aImageParams['field'], true); + } + + + $aVars['content_description_before'] = ''; + $aVars['content_description_after'] = ''; + $aVars['bx_if:show_image'] = array( + 'condition' => !empty($sImage), + 'content' => array( + 'entry_image' => $sImage, + 'image_settings' => $aImageParams['field_position'] ? $this->_getImageSettings($aData[$aImageParams['field_position']]) : '', + 'add_class' => $sAddClassPicture, + 'img_class' => $sAddClassPicture != '' ? 'bx-media-editable-src' : '', + 'additional_code' => $sAddCode, + 'image_tweak' => $sImageTweak, + 'unique_id' => $sUniqIdImage, + ) + ); + + $aTmplVarsLinks = []; + + if(isset($CNF['FIELD_LINK'])){ + $aLinks = $this->getEventLinks($aData[$CNF['FIELD_ID']]); + + $sClass = $sStylePrefix . '-al-item'; + + $bAddNofollow = $this->_oDb->getParam('sys_add_nofollow') == 'on'; + + foreach($aLinks as $aLink) { + $sLink = ''; + + $oEmbed = BxDolEmbed::getObjectInstance(); + if ($oEmbed) { + $sLink = $this->parseHtmlByName('link_embed_provider.html', array( + 'style_prefix' => $sStylePrefix, + 'embed' => $oEmbed->getLinkHTML($aLink['url'], $aLink['title']), + )); + } + else { + $aLinkAttrs = array( + 'title' => $aLink['title'] + ); + if(!$this->_oConfig->isEqualUrls(BX_DOL_URL_ROOT, $aLink['url'])) { + $aLinkAttrs['target'] = '_blank'; + + if($bAddNofollow) + $aLinkAttrs['rel'] = 'nofollow'; + } + + $sLinkAttrs = ''; + foreach($aLinkAttrs as $sKey => $sValue) + $sLinkAttrs .= ' ' . $sKey . '="' . bx_html_attribute($sValue) . '"'; + + $sLink = $this->parseHtmlByName('link_embed_common.html', array( + 'bx_if:show_thumbnail' => [ + 'condition' => !empty($aLink['thumbnail']), + 'content' => [ + 'style_prefix' => $sStylePrefix, + 'thumbnail' => $aLink['thumbnail'], + 'link' => !empty($aLink['url']) ? $aLink['url'] : 'javascript:void(0)', + 'attrs' => $sLinkAttrs + ] + ], + 'link' => !empty($aLink['url']) ? $aLink['url'] : 'javascript:void(0)', + 'attrs' => $sLinkAttrs, + 'content' => $aLink['title'], + 'bx_if:show_text' => [ + 'condition' => !empty($aLink['text']), + 'content' => [ + 'style_prefix' => $sStylePrefix, + 'text' => $aLink['text'] + ] + ] + )); + } + + $aTmplVarsLinks[] = [ + 'style_prefix' => $sStylePrefix, + 'link' => $sLink + ]; + } + } + + $aVars['bx_if:show_links'] = [ + 'condition' => count($aTmplVarsLinks) > 0, + 'content' => [ + 'style_prefix' => $sStylePrefix, + 'bx_repeat:links' => $aTmplVarsLinks + ] + ]; + + if(!empty($CNF['OBJECT_REACTIONS']) && ($oReactions = BxDolVote::getObjectInstance($CNF['OBJECT_REACTIONS'], $aData[$CNF['FIELD_ID']])) !== false) + $aVars['content_description_after'] .= $oReactions->getCounter([ + 'show_counter' => true, + 'show_counter_empty' => false + ]); + + $this->addCss(array('cover.css')); + + return $aVars; + } + + function getAuthorDesc($aData, $oProfile) + { + $CNF = &$this->getModule()->_oConfig->CNF; + + $aItem = array( + 'bx_if:text' => array( + 'condition' => false, + 'content' => array( + 'content' => '' + ) + ), + 'bx_if:link' => array( + 'condition' => false, + 'content' => array( + 'link' => '', + 'content' => '' + ) + ) + ); + + $aTmplVarsItems = array(); + if(!empty($CNF['FIELD_ADDED']) && !empty($aData[$CNF['FIELD_ADDED']])) + $aTmplVarsItems[] = array_merge($aItem, array('bx_if:text' => array( + 'condition' => true, + 'content' => array( + 'content' => bx_time_js($aData[$CNF['FIELD_ADDED']], BX_FORMAT_DATE) + ) + ))); + + if(!empty($CNF['URI_AUTHOR_ENTRIES'])) + $aTmplVarsItems[] = array_merge($aItem, array('bx_if:link' => array( + 'condition' => true, + 'content' => array( + 'link' => BxDolPermalinks::getInstance()->permalink('page.php?i=' . $CNF['URI_AUTHOR_ENTRIES'] . '&profile_id=' . $oProfile->id()), + 'content' => _t($CNF['T']['txt_all_entries_by'], $this->getModule()->serviceGetMenuAddonManageToolsProfileStats($oProfile->id())) + ) + ))); + + return $this->parseHtmlByName('author_desc.html', array( + 'bx_repeat:items' => $aTmplVarsItems + )); + } + + function getAuthorProfileDesc ($aData, $oProfile) + { + $aSnippetMeta = $this->getProfileSnippetMenu($aData); + if(empty($aSnippetMeta) || !is_array($aSnippetMeta) || !isset($aSnippetMeta['meta'])) + return ''; + + return $aSnippetMeta['meta']; + } + + function getProfileSnippetMenu ($aData) + { + $CNF = &$this->getModule()->_oConfig->CNF; + if (!($oProfile = BxDolProfile::getInstance($aData[$CNF['FIELD_AUTHOR']]))) + return array(); + + return bx_srv($oProfile->getModule(), 'get_snippet_menu_vars', array($oProfile->id())); + } + + function getAuthorAddon ($aData, $oProfile) + { + return ''; + } + + protected function checkPrivacy ($aData, $isCheckPrivateContent, $oModule, $sTemplateName = '') + { + if ($isCheckPrivateContent && CHECK_ACTION_RESULT_ALLOWED !== ($sMsg = $oModule->checkAllowedView($aData))) { + $aVars = array ( + 'summary' => $sMsg, + ); + return $this->parseHtmlByName($sTemplateName ? str_replace('.html', '_private.html', $sTemplateName) : 'unit_private.html', $aVars); + } + + return ''; + } + + protected function getUnitThumbAndGallery ($aData) + { + $CNF = &BxDolModule::getInstance($this->MODULE)->_oConfig->CNF; + + $sPhotoThumb = ''; + $sPhotoGallery = ''; + if(!empty($CNF['FIELD_THUMB']) && !empty($aData[$CNF['FIELD_THUMB']])) { + + $oImagesTranscoder = BxDolTranscoderImage::getObjectInstance($CNF['OBJECT_IMAGES_TRANSCODER_PREVIEW']); + if ($oImagesTranscoder) + $sPhotoThumb = $oImagesTranscoder->getFileUrl($aData[$CNF['FIELD_THUMB']]); + + $oImagesTranscoder = BxDolTranscoderImage::getObjectInstance($CNF['OBJECT_IMAGES_TRANSCODER_GALLERY']); + if ($oImagesTranscoder) + $sPhotoGallery = $oImagesTranscoder->getFileUrl($aData[$CNF['FIELD_THUMB']]); + else + $sPhotoGallery = $sPhotoThumb; + } + + return array($sPhotoThumb, $sPhotoGallery); + } + + protected function getUnit ($aData, $aParams = array()) + { + $CNF = &$this->_oConfig->CNF; + $oModule = $this->getModule(); + + // get thumb url + list($sPhotoThumb, $sPhotoGallery) = $this->getUnitThumbAndGallery($aData); + + if ($sPhotoGallery == '' && isset($CNF['PARAM_USE_GALERY_AS_COVER']) && getParam($CNF['PARAM_USE_GALERY_AS_COVER']) == 'on'){ + if(!empty($CNF['OBJECT_STORAGE_PHOTOS'])){ + $sStorage = $CNF['OBJECT_STORAGE_PHOTOS']; + $oStorage = BxDolStorage::getObjectInstance($sStorage); + list($oTranscoder, $oTranscoderView) = $this->getAttachmentsImagesTranscoders($sStorage); + $aGhostFiles = $oStorage->getGhosts($oModule->serviceGetContentOwnerProfileId($aData[$CNF['FIELD_ID']]), $aData[$CNF['FIELD_ID']]); + if(!empty($aGhostFiles) && is_array($aGhostFiles)) { + $aGhostFile = array_shift($aGhostFiles); + + $sPhotoThumb = $oTranscoderView->getFileUrl($aGhostFile['id']); + $sPhotoGallery = $oTranscoder->getFileUrl($aGhostFile['id']); + } + } + } + + // get entry url + $sUrl = $this->_oConfig->getViewEntryUrl($aData[$CNF['FIELD_ID']]); + + $oProfile = BxDolProfile::getInstanceMagic($aData[$CNF['FIELD_AUTHOR']]); + + $sTitle = $this->getTitle($aData); + $sText = $this->getText($aData); + $sSummary = $this->getSummary($aData, $sTitle, $sText, $sUrl); + $sSummaryPlain = isset($CNF['PARAM_CHARS_SUMMARY_PLAIN']) && $CNF['PARAM_CHARS_SUMMARY_PLAIN'] ? BxTemplFunctions::getInstance()->getStringWithLimitedLength(strip_tags($sSummary), (int)getParam($CNF['PARAM_CHARS_SUMMARY_PLAIN'])) : ''; + + if(!empty($CNF['OBJECT_METATAGS'])) { + $oMetatags = BxDolMetatags::getObjectInstance($CNF['OBJECT_METATAGS']); + $sText = $oMetatags->metaParse($aData[$CNF['FIELD_ID']], $sText); + } + + $aTmplVarsMeta = []; + if(!empty($CNF['OBJECT_MENU_SNIPPET_META'])) { + $oMenuMeta = BxDolMenu::getObjectInstance($CNF['OBJECT_MENU_SNIPPET_META'], $this); + if($oMenuMeta) { + $oMenuMeta->setContentId($aData[$CNF['FIELD_ID']]); + if(isset($aParams['context'])) + $oMenuMeta->setContext($aParams['context']); + + $aTmplVarsMeta = [ + 'meta' => $oMenuMeta->getCode() + ]; + } + } + + $bBadgesSingle = isset($aParams['badges_single']) ? $aParams['badges_single'] : false; + $bBadgesCompact = isset($aParams['badges_compact']) ? $aParams['badges_compact'] : false; + + $sCoverData = isset($aData['thumb_data']) ? $aData['thumb_data'] : ''; + + $aTmplVars = array ( + 'class' => $this->_getUnitClass($aData,(isset($aParams['template_name']) ? $aParams['template_name'] : '')), + 'html_id' => $this->_getUnitHtmlId($aData,(isset($aParams['template_name']) ? $aParams['template_name'] : '')), + 'id' => $aData[$CNF['FIELD_ID']], + 'content_url' => $sUrl, + 'bx_if:show_onclick' => [ + 'condition' => false, + 'content' => [ + 'content_onclick' => '' + ] + ], + 'title' => $sTitle, + 'badges' => $oModule->serviceGetBadges($aData[$CNF['FIELD_ID']], $bBadgesSingle, $bBadgesCompact), + 'title_attr' => bx_html_attribute($sTitle), + 'summary' => $sSummary, + 'text' => $sText, + 'author' => $oProfile->getDisplayName(), + 'author_url' => $oProfile->getUrl(), + 'author_icon' => $oProfile->getIcon(), + 'author_thumb' => $oProfile->getThumb(), + 'author_avatar' => $oProfile->getAvatar(), + 'entry_posting_date' => bx_time_js($aData[$CNF['FIELD_ADDED']], BX_FORMAT_DATE), + 'module_name' => _t($CNF['T']['txt_sample_single']), + 'ts' => $aData[$CNF['FIELD_ADDED']], + 'bx_if:meta' => array( + 'condition' => !empty($aTmplVarsMeta), + 'content' => $aTmplVarsMeta + ), + 'bx_if:thumb' => array ( + 'condition' => $sPhotoThumb, + 'content' => array ( + 'title' => $sTitle, + 'summary_attr' => bx_html_attribute($sSummaryPlain), + 'content_url' => $sUrl, + 'bx_if:show_thumb_onclick' => [ + 'condition' => false, + 'content' => [ + 'content_onclick' => '' + ] + ], + 'thumb_url' => $sPhotoThumb ? $sPhotoThumb : '', + 'gallery_url' => $sPhotoGallery ? $sPhotoGallery : '', + 'image_settings' => $this->_getImageSettings($sCoverData), + 'strecher' => str_repeat(' ', 40), + ), + ), + 'bx_if:no_thumb' => array ( + 'condition' => !$sPhotoThumb, + 'content' => array ( + 'module_icon' => $CNF['ICON'], + 'content_url' => $sUrl, + 'bx_if:show_no_thumb_onclick' => [ + 'condition' => false, + 'content' => [ + 'content_onclick' => '' + ] + ], + 'summary_plain' => $sSummaryPlain, + 'strecher' => mb_strlen($sSummaryPlain) > 240 ? '' : str_repeat(' ', round((240 - mb_strlen($sSummaryPlain)) / 6)), + ), + ), + 'unit_content_before' => '', + 'unit_content_after' => '' + ); + + if(isset($aParams['template_vars']) && is_array($aParams['template_vars'])) + $aTmplVars = array_merge($aTmplVars, $aParams['template_vars']); + + // generate html + return $aTmplVars; + } + + protected function getAttachmentsImagesTranscoders ($sStorage = '') + { + $CNF = &$this->getModule()->_oConfig->CNF; + + $oTranscoder = null; + $oTranscoderView = null; + + if(isset($CNF['OBJECT_STORAGE_PHOTOS']) && $CNF['OBJECT_STORAGE_PHOTOS'] == $sStorage) { + if(!empty($CNF['OBJECT_IMAGES_TRANSCODER_PREVIEW_PHOTOS'])) + $oTranscoder = BxDolTranscoderImage::getObjectInstance($CNF['OBJECT_IMAGES_TRANSCODER_PREVIEW_PHOTOS']); + if(!empty($CNF['OBJECT_IMAGES_TRANSCODER_VIEW_PHOTOS'])) + $oTranscoderView = BxDolTranscoderImage::getObjectInstance($CNF['OBJECT_IMAGES_TRANSCODER_VIEW_PHOTOS']); + else if(!empty($CNF['OBJECT_IMAGES_TRANSCODER_GALLERY_PHOTOS'])) + $oTranscoderView = BxDolTranscoderImage::getObjectInstance($CNF['OBJECT_IMAGES_TRANSCODER_GALLERY_PHOTOS']); + } + else if(isset($CNF['OBJECT_STORAGE_FILES']) && $CNF['OBJECT_STORAGE_FILES'] == $sStorage) { + if(!empty($CNF['OBJECT_IMAGES_TRANSCODER_PREVIEW_FILES'])) + $oTranscoder = BxDolTranscoderImage::getObjectInstance($CNF['OBJECT_IMAGES_TRANSCODER_PREVIEW_FILES']); + if(!empty($CNF['OBJECT_IMAGES_TRANSCODER_GALLERY_FILES'])) + $oTranscoderView = BxDolTranscoderImage::getObjectInstance($CNF['OBJECT_IMAGES_TRANSCODER_GALLERY_FILES']); + } + else + list($oTranscoder, $oTranscoderView) = parent::getAttachmentsImagesTranscoders($sStorage); + + return array($oTranscoder, $oTranscoderView); + } + + protected function _getUnitName($aData, $sTemplateName = 'unit.html') + { + return trim(str_replace('.html', '', $sTemplateName)); + } + + protected function _getUnitClass($aData, $sTemplateName = 'unit.html') + { + $sResult = ''; + + switch($sTemplateName) { + case 'unit_showcase.html': + $sResult = $this->_sUnitClassShowCase; + break; + } + + return $sResult; + } + + protected function _getUnitHtmlId($aData, $sTemplateName = 'unit.html') + { + $CNF = &$this->_oConfig->CNF; + + return str_replace('_', '-', $this->MODULE . '_unit_' . $aData[$CNF['FIELD_ID']]); + } + + protected function _getHeaderImageParams() + { + $CNF = &$this->_oConfig->CNF; + + return [ + 'field' => isset($CNF['FIELD_THUMB']) ? $CNF['FIELD_THUMB'] : false, + 'field_position' => isset($CNF['FIELD_THUMB_POSITION']) ? $CNF['FIELD_THUMB_POSITION'] : false, + 'storage' => isset($CNF['OBJECT_STORAGE']) ? $CNF['OBJECT_STORAGE'] : false, + 'uploaders' => isset($CNF['OBJECT_UPLOADERS']) ? $CNF['OBJECT_UPLOADERS'] : false, + 'transcoder_cover' => isset($CNF['OBJECT_IMAGES_TRANSCODER_COVER']) ? $CNF['OBJECT_IMAGES_TRANSCODER_COVER'] : false, + ]; + } + + protected function _getHeaderImage($aData) + { + return $this->getModule()->getEntryImageData($aData); + } + + function mediaExif ($aMediaInfo, $iProfileId = false, $sFuncAuthorDesc = '', $sTemplateName = 'media-exif.html') + { + if (empty($aMediaInfo['exif'])) + return ''; + + $a = unserialize($aMediaInfo['exif']); + + $s = ''; + if (!empty($a['Make'])) { + $oModule = BxDolModule::getInstance($this->MODULE); + $CNF = &$oModule->_oConfig->CNF; + + $sCamera = BxDolMetatags::keywordsCameraModel($a); + if (!empty($CNF['OBJECT_METATAGS_MEDIA_CAMERA'])) { + $oMetatags = BxDolMetatags::getObjectInstance($CNF['OBJECT_METATAGS_MEDIA_CAMERA']); + if ($oMetatags->keywordsIsEnabled()) { + $sCamera = $oMetatags->keywordsParseOne($aMediaInfo['id'], $sCamera); + } + } + + if (!empty($sCamera)) + $s .= $this->parseHtmlByName('media-exif-value.html', array( + 'key' => _t($CNF['T']['txt_media_exif_camera']), + 'val' => $sCamera, + )); + } + + if (!empty($a['FocalLength'])) + $s .= $this->parseHtmlByName('media-exif-value.html', array( + 'key' => _t($CNF['T']['txt_media_exif_focal_length']), + 'val' => _t($CNF['T']['txt_media_exif_focal_length_value'], $a['FocalLength']), + )); + + if (!empty($a['COMPUTED']['ApertureFNumber'])) + $s .= $this->parseHtmlByName('media-exif-value.html', array( + 'key' => _t($CNF['T']['txt_media_exif_aperture']), + 'val' => $a['COMPUTED']['ApertureFNumber'], + )); + + if (!empty($a['ExposureTime'])) + $s .= $this->parseHtmlByName('media-exif-value.html', array( + 'key' => _t($CNF['T']['txt_media_exif_shutter_speed']), + 'val' => _t($CNF['T']['txt_media_exif_shutter_speed_value'], $a['ExposureTime']), + )); + + if (!empty($a['ISOSpeedRatings'])) + $s .= $this->parseHtmlByName('media-exif-value.html', array( + 'key' => _t($CNF['T']['txt_media_exif_iso']), + 'val' => $a['ISOSpeedRatings'], + )); + + if (empty($s)) + return ''; + + return $this->parseHtmlByName($sTemplateName, array('content' => $s)); + } +} + +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/text/js/links.js b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/text/js/links.js new file mode 100644 index 0000000000..3cbe76b7d3 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/text/js/links.js @@ -0,0 +1,258 @@ +/** + * Copyright (c) UNA, Inc - https://una.io + * MIT License - https://opensource.org/licenses/MIT + * + * @defgroup BaseText Base classes for text modules + * @ingroup UnaModules + * + * @{ + */ + +function BxBaseModTextLinks(oOptions) { + this._sActionsUri = oOptions.sActionUri; + this._sActionsUrl = oOptions.sActionUrl; + this._sObjName = oOptions.sObjName == undefined ? 'oBxBaseModTextLinks' : oOptions.sObjName; + this._iOwnerId = oOptions.iOwnerId == undefined ? 0 : oOptions.iOwnerId; + this._iContentId = oOptions.iContentId == undefined ? 0 : oOptions.iContentId; + this._sFormId = oOptions.sFormId == undefined ? 0 : oOptions.sFormId; + this._sEditorId = oOptions.sEditorId == undefined ? '' : oOptions.sEditorId; + this._aHtmlIds = oOptions.aHtmlIds == undefined ? {} : oOptions.aHtmlIds; + this._iLimitAttachLinks = oOptions.iLimitAttachLinks == undefined ? 0 : oOptions.iLimitAttachLinks; + this._sLimitAttachLinksErr = oOptions.sLimitAttachLinksErr == undefined ? '' : oOptions.sLimitAttachLinksErr; + this._oAttachedLinks = oOptions.oAttachedLinks == undefined ? {} : oOptions.oAttachedLinks; + + var $this = this; + + $(document).ready(function () { + $this.initFormPost($this._sFormId); + }); +} + +BxBaseModTextLinks.prototype.initFormPost = function(sFormId) +{ + var $this = this; + var oForm = $('#' + sFormId); + var oTextarea = oForm.find('textarea'); + + if (typeof window.glOnSpaceEnterInEditor === 'undefined') + window.glOnSpaceEnterInEditor = []; + + window.glOnSpaceEnterInEditor.push(function (sData, sSelector) { + if(!oTextarea.is(sSelector)) + return; + + $this.parseContent(oForm, sData, true); + }); + + var sContent = oTextarea.val(); + if(sContent && sContent.length > 0) + this.parseContent(oForm, sContent, false); + + if(this._bAutoAttach) { + if (typeof window.glOnInsertImageInEditor === 'undefined') + window.glOnInsertImageInEditor = []; + + window.glOnInsertImageInEditor.push(function (oFile, sSelector) { + + if(!oTextarea.is(sSelector)) + return false; + + const oFormData = new FormData(); + oFormData.append('file', oFile); + oFormData.append('u', $this._sAutoUploader); + oFormData.append('uid', $this._sAutoUploaderId); + + fetch($this._sActionsUrl + 'auto_attach_insertion/', {method: "POST", body: oFormData}) + .then(response => response.json()) + .then(result => { + processJsonData(result) + }); + return true; + }); + } +}; + +BxBaseModTextLinks.prototype.parseContent = function(oForm, sData, bPerformAttach) +{ + var oExp, aMatch = null; + + oExp = new RegExp(bx_get_regexp('tag'), "ig"); + sData = sData.replace(oExp, ''); + + oExp = new RegExp(bx_get_regexp('mention'), "ig"); + sData = sData.replace(oExp, ''); + + oExp = new RegExp(bx_get_regexp('url'), "ig"); + while(aMatch = oExp.exec(sData)) { + var sUrl = aMatch[0].replace(/^(\s|( ))+|(\s|( ))+$/gm,''); + if(!sUrl.length || this._oAttachedLinks[sUrl] != undefined || (this._iLimitAttachLinks != 0 && Object.keys(this._oAttachedLinks).length >= this._iLimitAttachLinks)) + continue; + + //--- Mark that 'attach link' process was started. + this._oAttachedLinks[sUrl] = 0; + + if(bPerformAttach) + this.addAttachLink(oForm, sUrl); + } +}; + +BxBaseModTextLinks.prototype.addAttachLink = function(oElement, sUrl) +{ + if(!sUrl || (this._iLimitAttachLinks != 0 && Object.keys(this._oAttachedLinks).length > this._iLimitAttachLinks)) + return; + + var $this = this; + var oData = this._getDefaultData(); + oData['url'] = sUrl; + oData['content_id'] = $this._iContentId; + + + jQuery.post ( + this._sActionsUrl + 'add_attach_link/', + oData, + function(oData) { + if(!oData.id || !oData.item || !$.trim(oData.item).length) + return; + + //--- Mark that 'attach link' process was finished. + $this._oAttachedLinks[sUrl] = oData.id; + + var iContentId = 0; + if(oData && oData.content_id != undefined) + iContentId = parseInt(oData.content_id); + + var oItem = $(oData.item).hide(); + $('#' + $this._aHtmlIds['attach_link_form_field'] + iContentId).prepend(oItem).find('#' + oItem.attr('id')).bx_anim('show', $this._sAnimationEffect, $this._sAnimationSpeed, function() { + $(this).bxProcessHtml(); + }); + }, + 'json' + ); +}; + +BxBaseModTextLinks.prototype.showAttachLink = function(oLink) +{ + if(this._iLimitAttachLinks != 0 && Object.keys(this._oAttachedLinks).length >= this._iLimitAttachLinks) { + bx_alert(this._sLimitAttachLinksErr); + return false; + } + + var oData = this._getDefaultData(); + oData['content_id'] = this._iContentId; + + $(window).dolPopupAjax({ + id: {value: this._aHtmlIds['attach_link_popup'], force: true}, + url: bx_append_url_params(this._sActionsUri + 'get_attach_link_form/', oData), + closeOnOuterClick: false, + removeOnClose: true + }); + + return false; +}; + +BxBaseModTextLinks.prototype.initFormAttachLink = function(sFormId) +{ + var $this = this; + var oForm = $('#' + sFormId); + + oForm.ajaxForm({ + dataType: "json", + clearForm: true, + beforeSubmit: function (formData, jqForm, options) { + window[$this._sObjName].beforeFormAttachLinkSubmit(oForm); + }, + success: function (oData) { + window[$this._sObjName].afterFormAttachLinkSubmit(oForm, oData); + } + }); +}; + +BxBaseModTextLinks.prototype.beforeFormAttachLinkSubmit = function(oForm) +{ + this.loadingInButton($(oForm).children().find(':submit'), true); +}; + +BxBaseModTextLinks.prototype.afterFormAttachLinkSubmit = function (oForm, oData) +{ + var $this = this; + var fContinue = function() { + if(oData && oData.item != undefined) { + $('#' + $this._aHtmlIds['attach_link_popup']).dolPopupHide({}); + + if(!$.trim(oData.item).length) + return; + + var iContentId = 0; + if(oData && oData.content_id != undefined) + iContentId = parseInt(oData.content_id); + + var oItem = $(oData.item).hide(); + $('#' + $this._aHtmlIds['attach_link_form_field'] + iContentId).prepend(oItem).find('#' + oItem.attr('id')).bx_anim('show', $this._sAnimationEffect, $this._sAnimationSpeed, function() { + $(this).bxProcessHtml(); + }); + + $this._oAttachedLinks[oData.url] = oData.id; + return; + } + + if(oData && oData.form != undefined && oData.form_id != undefined) { + $('#' + oData.form_id).replaceWith(oData.form); + $this.initFormAttachLink(oData.form_id); + + return; + } + }; + + this.loadingInButton($(oForm).find(':submit'), false); + + if(oData && oData.message != undefined) + bx_alert(oData.message, fContinue); + else + fContinue(); +}; + +BxBaseModTextLinks.prototype.deleteAttachLink = function(oLink, iId) +{ + var $this = this; + var oData = this._getDefaultData(); + oData['id'] = iId; + + var oAttachLink = $('#' + this._aHtmlIds['attach_link_item'] + iId); + bx_loading(oAttachLink, true); + + jQuery.post ( + this._sActionsUrl + 'delete_attach_link/', + oData, + function(oData) { + var fContinue = function() { + if(oData && oData.code != undefined && oData.code == 0) { + oAttachLink.bx_anim('hide', $this._sAnimationEffect, $this._sAnimationSpeed, function() { + $(this).remove; + }); + } + }; + + bx_loading(oAttachLink, false); + + if(oData && oData.message != undefined) + bx_alert(oData.message, fContinue); + else + fContinue(); + }, + 'json' + ); + + return false; +}; + +BxBaseModTextLinks.prototype._getDefaultData = function() { + var oDate = new Date(); + return jQuery.extend({}, this._oRequestParams, {_t:oDate.getTime()}); +}; + +BxBaseModTextLinks.prototype.loadingInButton = function(e, bShow) { + if($(e).length) + bx_loading_btn($(e), bShow); + else + bx_loading($('body'), bShow); +}; \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/text/template/entry-text.html b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/text/template/entry-text.html new file mode 100644 index 0000000000..782af0b744 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/text/template/entry-text.html @@ -0,0 +1,29 @@ +<div class="bx-content-description-before">__content_description_before__</div> +<div class="bx-content-description"> + <bx_if:show_image> + <div class="bx-base-text-entity-image mb-4 text-center __add_class__ relative flex justify-center items-center"> + <img class="rounded __img_class__ aspect-video object-cover bg-cover bx-image-edit-source-__unique_id__" style="background-image:url(__entry_image__); __image_settings__" src="<bx_icon_url:spacer.gif />"/> + __image_tweak__ + </div> + + __additional_code__ + </bx_if:show_image> + <div class="bx-base-text-entity-content bx-def-constraint-list bx-def-constraint-pre bx-def-constraint-object bx-def-constraint-iframe bx-def-constraint-img bx-def-vanilla-html"> + <div class="bx-base-text-title-bages"> + <h1>__entry_title__</h1> + <div class="bx-base-bages-container absolute flex -translate-y-5/4">__badges__</div> + </div> + <bx_if:show_entry_abstract> + <div class="bx-base-text-abstract mb-3 md:mb-4 lg:mb-6 text-gray-600 dark:text-gray-400 text-xl font-medium">__entry_abstract__</div> + </bx_if:show_entry_abstract> + <div class="bx-base-text-text">__entry_text__</div> + </div> + <bx_if:show_links> + <div class="__style_prefix__-item-links"> + <bx_repeat:links> + <div class="__style_prefix__-item-link mt-3 md:mt-4 lg:mt-6">__link__</div> + </bx_repeat:links> + </div> + </bx_if:show_links> +</div> +<div class="bx-content-description-after">__content_description_after__</div> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/text/template/unit_gallery.html b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/text/template/unit_gallery.html new file mode 100644 index 0000000000..97b178c32e --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/text/template/unit_gallery.html @@ -0,0 +1,29 @@ +<div id="__html_id__" class="__class__ bx-base-text-unit bx-base-text-unit-gallery bx-def-gal-unit-size flex flex-col w-full p-2 box-border"> + <div class="bx-base-text-unit-cnt bx-def-box bx-def-box-round-corners bx-def-color-bg-box h-full"> + <div class="bx-base-text-unit-content-before">__unit_content_before__</div> + <bx_if:thumb> + <a href="__content_url__" <bx_if:show_thumb_onclick>onclick="javascript:__content_onclick__"</bx_if:show_thumb_onclick> title="__summary_attr__"> + <div class="shrink-0 m-1"> + <img class="bx-def-round-corners aspect-video object-cover bg-cover w-full" alt="__title__" style="background-image:url(__gallery_url__); __image_settings__" src="<bx_icon_url:spacer.gif />" /> + </div> + </a> + </bx_if:thumb> + <bx_if:no_thumb> + <div class="bx-def-gal-img-column shrink-0 m-1"> + <div class="bx-base-text-unit-no-thumb bx-def-round-corners flex flex-col items-center justify-center aspect-video p-4 bg-gradient-to-b from-red-400 to-red-500 box-border"></div> + </div> + </bx_if:no_thumb> + <div class="bx-base-text-unit-text flex flex-col flex-1 p-3 md:p-4 lg:p-6 pt-1 md:pt-2 lg:pt-3 box-border"> + <div class="bx-base-text-unit-badges pb-1 lg:pb-2">__badges__</div> + <div class="bx-base-text-unit-title flex-auto max-h-14"> + <div class="bx-base-tut-title truncate text-left"> + <a href="__content_url__" <bx_if:show_onclick>onclick="javascript:__content_onclick__"</bx_if:show_onclick> class="text-left">__title__</a> + </div> + </div> + <div class="bx-base-text-unit-info flex flex-auto flex-col justify-end text-sm text-gray-500 dark:text-gray-400"> + <bx_if:meta><div class="bx-base-general-unit-meta pt-2">__meta__</div></bx_if:meta> + </div> + </div> + <div class="bx-base-text-unit-content-after">__unit_content_after__</div> + </div> +</div> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/oembed.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/oembed.php new file mode 100644 index 0000000000..e8a41db64b --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/oembed.php @@ -0,0 +1,24 @@ +<?php +/** + * Copyright (c) UNA, Inc - https://una.io + * MIT License - https://opensource.org/licenses/MIT + * + * @defgroup UnaCore UNA Core + * @{ + */ + +require_once('./inc/header.inc.php'); +require_once(BX_DIRECTORY_PATH_INC . "design.inc.php"); + +if (getParam('sys_embed_default') != 'sys_oembed') + exit; + +$aLinks = bx_get('l'); + +bx_import('BxDolEmbed'); +if(($oEmbed = BxDolEmbed::getObjectInstance('sys_system')) !== false) { + if(bx_get('html')) + echo '<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;"" /><style>body, html {margin:0px} A{text-decoration:none; color:#222}</style><div style=" margin:0px auto; justify-content: center;" id="ifr">' . $oEmbed->getLinkHTML($aLinks) . '</div>'; + else + echoJson($oEmbed->parseLinks($aLinks)); +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/NOTES.md b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/NOTES.md new file mode 100644 index 0000000000..f44c79c85c --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/NOTES.md @@ -0,0 +1,86 @@ +# Testing notes + +**⚠️ WARNING**: Running all tests across all services takes _hours_. It is recommended that you use the SignedURLs test as a quick validation tool across multiple services, then test against the `$standardTests` suite overnight. + +## Against Amazon S3 proper + +This is the _canonical_ method for testing this library since Amazon S3 proper is the canonical provider of the S3 API (and not all of its quirks are fully documented, we might add). + +Copy `config.dist.php` to `config.php` and enter the connection information to your Amazon S3 or compatible service. + +## Against [LocalStack](https://localstack.cloud) + +This method is very useful for development. It is the most faithful implementation of S3, but it does have some minor quirks not present in the real thing as a result of it running inside a Docker container. + +Install LocalStack [per its documentation](https://docs.localstack.cloud/getting-started/installation/), or using its Docker Desktop Extension. + +You will also need to install [`awslocal`](https://github.com/localstack/awscli-local) like so: +```php +pip install awscli +pip install awscli-local +``` + +Start LocalStack e.g. `localstack start -d` or via the Docker Desktop Extension. + +Create a new bucket called `test` i.e. `awslocal s3 mb s3://test` + +The `config.dist.php` already has a configuration for LocalStack. Yes, the access and secret key can be any random string. + +## Against Wasabi + +Wasabi nominally supports v4 signatures, but their implementation is actually _non-canonical_, as they only read the date from the optional `x-amz-date` header, without falling back to the standard HTTP `Date` header. We have changed the behaviour of the library to always go through the X-Amz-Date header as a result. Hence, the need to test with Wasabi. + +The Wasabi configuration block looks like this: + +```php + 'wasabi-v4' => [ + 'access' => 'THE_ACCESS_KEY', + 'secret' => 'VERY_SECRET_MUCH_WOW', + 'region' => 'eu-central-2', + 'bucket' => 'bucketname', + 'signature' => 'v4', + 'dualstack' => false, + 'path_access' => true, + 'ssl' => true, + 'endpoint' => 's3.eu-central-2.wasabisys.com', + ], + 'wasabi-v2' => [ + 'access' => 'THE_ACCESS_KEY', + 'secret' => 'VERY_SECRET_MUCH_WOW', + 'region' => 'eu-central-2', + 'bucket' => 'bucketname', + 'signature' => 'v2', + 'dualstack' => false, + 'path_access' => true, + 'ssl' => true, + 'endpoint' => 's3.eu-central-2.wasabisys.com', + ], + +``` + +**❗Important**: The Endpoint and Region must match each other, and the region the bucket was crated in. In the example above, we have created a bucket in the `eu-central-2` region. If you use the wrong region and/or endpoint the tests _will_ fail! + +## Against Synology C2 + +Synology C2 is an S3-“compatible” storage service. It is not very “compatible” though, since they implemented Amazon's documentation of the v4 signatures instead of how the v4 signatures work in the real world (yeah, there's a very big difference). While Amazon S3 _in reality_ expects all dates to be formatted as per RFC1123, they document that they expect them to be formatted as per “ISO 8601”, and they give their _completely wrong_ interpretation of what the “ISO 8601” format is. Synology did not catch that discrepancy, and they only expect the wrongly formatted dates which is totally NOT what S3 itself expects. Luckily, most third party implementations expect either format because they've caught the discrepancy between documentation and reality, therefore making it possible for us to come up with a viable workaround. + +And that's why we need to test with C2 as well, folks. + +The C2 config block looks like this: + +```php + 'c2' => [ + 'access' => 'THE_ACCESS_KEY', + 'secret' => 'VERY_SECRET_MUCH_WOW', + 'region' => 'eu-002', + 'bucket' => 'bucketname', + 'signature' => 'v4', + 'dualstack' => false, + 'path_access' => false, + 'ssl' => true, + 'endpoint' => 'eu-002.s3.synologyc2.net', + ], + +``` + +The endpoint URL is given in the Synology C2 Object Manager, next to each bucket. Note the part before `.s3.`. This is the **region** you need to use with v4 signatures. They do not document this anywhere. \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/AbstractTest.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/AbstractTest.php new file mode 100644 index 0000000000..e3f77cce95 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/AbstractTest.php @@ -0,0 +1,242 @@ +<?php +/** + * Akeeba Engine + * + * @package akeebaengine + * @copyright Copyright (c)2006-2024 Nicholas K. Dionysopoulos / Akeeba Ltd + * @license GNU General Public License version 3, or later + */ + +namespace Akeeba\MiniTest\Test; + +use Akeeba\S3\Connector; +use RuntimeException; + +abstract class AbstractTest +{ + const TEN_KB = 10240; + + const HUNDRED_KB = 102400; + + const SIX_HUNDRED_KB = 614400; + + const ONE_MB = 1048576; + + const FIVE_MB = 5242880; + + const SIX_MB = 6291456; + + const TEN_MB = 10485760; + + const ELEVEN_MB = 11534336; + + const BLOCK_SIZE = 1048576; + + const FILE_HASHING_ALGORITHM = 'sha256'; + + public static function setup(Connector $s3, array $options): void + { + // Runs before any test + } + + public static function teardown(Connector $s3, array $options): void + { + // Runs after all tests are finished + } + + /** + * Creates a file with random data and returns its file path. + * + * The random data in the file repeats every $blockSize bytes when $reuseBlock is true. + * + * @param int $size Size in files + * + * @param int $blockSize + * @param bool $reuseBlock + * + * @return string The full path to the temporary file. + */ + protected static function createFile(int $size = AbstractTest::SIX_HUNDRED_KB, int $blockSize = self::BLOCK_SIZE, bool $reuseBlock = true) + { + $tempFilePath = tempnam(static::getTempFolder(), 'as3'); + + if ($tempFilePath === false) + { + throw new RuntimeException("Cannot create a temporary file."); + } + + $fp = @fopen($tempFilePath, 'w', false); + + if ($fp === false) + { + throw new RuntimeException("Cannot write to the temporary file."); + } + + $blockSize = static::BLOCK_SIZE; + $lastBlockSize = $size % $blockSize; + $wholeBlocks = (int) (($size - $lastBlockSize) / $blockSize); + $blockData = static::getRandomData(); + + for ($i = 0; $i < $wholeBlocks; $i++) + { + fwrite($fp, $blockData); + + if (!$reuseBlock) + { + $blockData = static::getRandomData($blockSize); + } + } + + if ($lastBlockSize > 0) + { + fwrite($fp, $blockData, $lastBlockSize); + } + + + fclose($fp); + + return $tempFilePath; + } + + /** + * Get a writeable temporary folder + * + * @return string + */ + protected static function getTempFolder(): string + { + $tempPath = sys_get_temp_dir(); + + if (!is_writable($tempPath)) + { + $tempPath = __DIR__ . '/tmp'; + + if (!is_dir($tempPath)) + { + @mkdir($tempPath, 0755, true); + } + } + + if (!is_writable($tempPath)) + { + throw new RuntimeException("Cannot get a writeable temporary path."); + } + + return $tempPath; + } + + /** + * Checks that two files are of equal length and contents + * + * @param string $referenceFilePath The known, reference file + * @param string $unknownFilePath The file we want to verify is the same as the reference file + * + * @return bool + */ + protected static function areFilesEqual(string $referenceFilePath, string $unknownFilePath): bool + { + if (!file_exists($referenceFilePath) || !file_exists($unknownFilePath)) + { + return false; + } + + if (!is_file($referenceFilePath) || !is_file($unknownFilePath)) + { + return false; + } + + if (!is_readable($referenceFilePath) || !is_readable($unknownFilePath)) + { + return false; + } + + if (@filesize($referenceFilePath) !== @filesize($unknownFilePath)) + { + return false; + } + + return hash_file(static::FILE_HASHING_ALGORITHM, $referenceFilePath) === hash_file(static::FILE_HASHING_ALGORITHM, $unknownFilePath); + } + + /** + * Checks that two strings are of equal length and contents + * + * @param string $referenceString The known, reference file + * @param string $unknownString The file we want to verify is the same as the reference file + * + * @return bool + */ + protected static function areStringsEqual(string $referenceString, string $unknownString): bool + { + return $referenceString === $unknownString; + } + + /** + * Returns random data of the specific size in bytes + * + * @param int $length How many bytes of random data to return + * + * @return string Your random data + */ + protected static function getRandomData(int $length = self::BLOCK_SIZE): string + { + $blockData = ''; + + if (substr(strtolower(PHP_OS), 0, 7) !== 'windows') + { + $fpRandom = @fopen('/dev/urandom', 'r'); + if ($fpRandom !== false) + { + $blockData = @fread($fpRandom, $length); + @fclose($fpRandom); + } + } + + if (empty($blockData) && function_exists('random_bytes')) + { + try + { + $blockData = random_bytes($length); + } + catch (\Exception $e) + { + $blockData = ''; + } + } + + if (empty($blockData) && function_exists('openssl_random_pseudo_bytes')) + { + $blockData = openssl_random_pseudo_bytes($length); + } + + if (empty($blockData) && function_exists('mcrypt_create_iv')) + { + $blockData = mcrypt_create_iv($length, MCRYPT_DEV_URANDOM); + + if (empty($blockData)) + { + $blockData = mcrypt_create_iv($length, MCRYPT_RAND); + } + } + + if (empty($blockData)) + { + for ($i = 0; $i < $length; $i++) + { + $blockData .= ord(mt_rand(0, 255)); + } + } + + return $blockData; + } + + protected static function assert(bool $condition, string $message): void + { + if ($condition) + { + return; + } + + throw new RuntimeException($message); + } +} \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/BigFiles.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/BigFiles.php new file mode 100644 index 0000000000..506e175875 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/BigFiles.php @@ -0,0 +1,217 @@ +<?php +/** + * Akeeba Engine + * + * @package akeebaengine + * @copyright Copyright (c)2006-2024 Nicholas K. Dionysopoulos / Akeeba Ltd + * @license GNU General Public License version 3, or later + */ + +namespace Akeeba\MiniTest\Test; + + +use Akeeba\S3\Connector; +use Akeeba\S3\Input; + +/** + * Upload, download and delete big files (over 1MB), without multipart uploads. Uses string or file sources. + * + * @package Akeeba\MiniTest\Test + */ +class BigFiles extends AbstractTest +{ + /** + * Should I download the file after uploading it to test for contents consistency? + * + * @var bool + */ + protected static $downloadAfter = true; + + /** + * Should I delete the uploaded file after the test case is done? + * + * @var bool + */ + protected static $deleteRemote = true; + + /** + * Should I use multipart (chunked) uploads? + * + * @var bool + */ + protected static $multipart = false; + + /** + * Chunk size for each multipart upload. Must be at least 5MB or the library overrides us. + * + * @var int + */ + protected static $uploadChunkSize = 5242880; + + /** + * Number of uploaded chunks. + * + * This is set by static::upload(). Zero for single part uploads, non-zero for multipart uploads. + * + * @var int + */ + protected static $numberOfChunks = 0; + + public static function upload5MBString(Connector $s3, array $options): bool + { + return static::upload($s3, $options, static::FIVE_MB, 'bigtest_5mb.dat'); + } + + public static function upload6MBString(Connector $s3, array $options): bool + { + return static::upload($s3, $options, static::SIX_MB, 'bigtest_6mb.dat'); + } + + public static function upload10MBString(Connector $s3, array $options): bool + { + return static::upload($s3, $options, static::TEN_MB, 'bigtest_10mb.dat'); + } + + public static function upload11MBString(Connector $s3, array $options): bool + { + return static::upload($s3, $options, static::ELEVEN_MB, 'bigtest_11mb.dat'); + } + + public static function upload5MBFile(Connector $s3, array $options): bool + { + return static::upload($s3, $options, static::FIVE_MB, 'bigtest_5mb.dat', false); + } + + public static function upload6MBFile(Connector $s3, array $options): bool + { + return static::upload($s3, $options, static::SIX_MB, 'bigtest_6mb.dat', false); + } + + public static function upload10MBFile(Connector $s3, array $options): bool + { + return static::upload($s3, $options, static::TEN_MB, 'bigtest_10mb.dat', false); + } + + public static function upload11MBFile(Connector $s3, array $options): bool + { + return static::upload($s3, $options, static::ELEVEN_MB, 'bigtest_11mb.dat', false); + } + + protected static function upload(Connector $s3, array $options, int $size, string $uri, bool $useString = true): bool + { + // Randomize the name. Required for archive buckets where you cannot overwrite data. + $dotPos = strrpos($uri, '.'); + $uri = substr($uri, 0, $dotPos) . '.' . hash('md5', microtime(false)) . substr($uri, $dotPos); + + static::$numberOfChunks = 0; + + if ($useString) + { + $sourceData = static::getRandomData($size); + $input = Input::createFromData($sourceData); + } + else + { + // Create a file with random data + $sourceFile = static::createFile($size); + $input = Input::createFromFile($sourceFile); + } + + // Upload the file. Throws exception if it fails. + $bucket = $options['bucket']; + + if (!static::$multipart) + { + $s3->putObject($input, $bucket, $uri); + } + else + { + // Get an upload session + $uploadSession = $s3->startMultipart($input, $bucket, $uri); + + // This array holds the etags of uploaded parts. Used by finalizeMultipart. + $eTags = []; + $partNumber = 1; + + while (true) + { + // We need to create a new input for each upload chunk + if ($useString) + { + $input = Input::createFromData($sourceData); + } + else + { + $input = Input::createFromFile($sourceFile); + } + + $input->setUploadID($uploadSession); + $input->setEtags($eTags); + $input->setPartNumber($partNumber); + + $etag = $s3->uploadMultipart($input, $bucket, $uri, [], static::$uploadChunkSize); + + // If the result was null we have no more file parts to process. + if (is_null($etag)) + { + break; + } + + // Append the etag to the etags array + $eTags[] = $etag; + + // Set the etags array in the Input object (required by finalizeMultipart) + $input->setEtags($eTags); + + $partNumber++; + } + + static::$numberOfChunks = count($eTags); + + // Finalize the multipart upload. Tells Amazon to construct the file from the uploaded parts. + $s3->finalizeMultipart($input, $bucket, $uri); + } + + // Tentatively accept that this method succeeded. + $result = true; + + // Should I download the file and compare its contents? + if (static::$downloadAfter) + { + if ($useString) + { + // Download the data. Throws exception if it fails. + $downloadedData = $s3->getObject($bucket, $uri); + + // Compare the file contents. + $result = static::areStringsEqual($sourceData, $downloadedData); + } + else + { + // Download the data. Throws exception if it fails. + $downloadedFile = tempnam(static::getTempFolder(), 'as3'); + $s3->getObject($bucket, $uri, $downloadedFile); + + // Compare the file contents. + $result = static::areFilesEqual($sourceFile, $downloadedFile); + + @unlink($downloadedFile); + } + } + + // Remove the local files + if (!$useString) + { + @unlink($sourceFile); + } + + // Should I delete the remotely stored file? + if (static::$deleteRemote) + { + // Delete the remote file. Throws exception if it fails. + $s3->deleteObject($bucket, $uri); + } + + return $result; + } +} \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/BucketLocation.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/BucketLocation.php new file mode 100644 index 0000000000..7055204545 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/BucketLocation.php @@ -0,0 +1,25 @@ +<?php +/** + * Akeeba Engine + * + * @package akeebaengine + * @copyright Copyright (c)2006-2024 Nicholas K. Dionysopoulos / Akeeba Ltd + * @license GNU General Public License version 3, or later + */ + +namespace Akeeba\MiniTest\Test; + + +use Akeeba\S3\Connector; + +class BucketLocation extends AbstractTest +{ + public static function getBucketLocation(Connector $s3, array $options): bool + { + $location = $s3->getBucketLocation($options['bucket']); + + static::assert($location === $options['region'], "Bucket ‘{$options['bucket']}′ reports being in region ‘{$location}′ instead of expected ‘{$options['region']}′"); + + return true; + } +} \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/BucketsList.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/BucketsList.php new file mode 100644 index 0000000000..ebd7d5eb36 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/BucketsList.php @@ -0,0 +1,52 @@ +<?php +/** + * Akeeba Engine + * + * @package akeebaengine + * @copyright Copyright (c)2006-2024 Nicholas K. Dionysopoulos / Akeeba Ltd + * @license GNU General Public License version 3, or later + */ + +namespace Akeeba\MiniTest\Test; + + +use Akeeba\S3\Connector; +use RuntimeException; + +class BucketsList extends AbstractTest +{ + public static function listBucketsDetailed(Connector $s3, array $options): bool + { + $buckets = $s3->listBuckets(true); + + static::assert(is_array($buckets), "Detailed buckets list is not an array"); + static::assert(isset($buckets['owner']), "Detailed buckets list does not list an owner"); + static::assert(isset($buckets['owner']['id']), "Detailed buckets list does not list an owner's id"); + static::assert(isset($buckets['owner']['name']), "Detailed buckets list does not list an owner's name"); + static::assert(isset($buckets['buckets']), "Detailed buckets list does not list any buckets"); + + foreach ($buckets['buckets'] as $bucketInfo) + { + static::assert(isset($bucketInfo['name']), "Bucket information does not list a name"); + static::assert(isset($bucketInfo['time']), "Bucket information does not list a created times"); + + if ($bucketInfo['name'] === $options['bucket']) + { + return true; + } + } + + throw new RuntimeException("Detailed buckets list does not include configured bucket ‘{$options['bucket']}′"); + } + + public static function listBucketsSimple(Connector $s3, array $options): bool + { + $buckets = $s3->listBuckets(false); + + static::assert(is_array($buckets), "Simple buckets list is not an array"); + static::assert(in_array($options['bucket'], $buckets), "Simple buckets list does not include configured bucket ‘{$options['bucket']}′"); + + return true; + } + +} \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/HeadObject.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/HeadObject.php new file mode 100644 index 0000000000..87f32ed7b8 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/HeadObject.php @@ -0,0 +1,67 @@ +<?php +/** + * Akeeba Engine + * + * @package akeebaengine + * @copyright Copyright (c)2006-2024 Nicholas K. Dionysopoulos / Akeeba Ltd + * @license GNU General Public License version 3, or later + */ + + +namespace Akeeba\MiniTest\Test; + + +use Akeeba\S3\Connector; +use Akeeba\S3\Exception\CannotDeleteFile; +use Akeeba\S3\Exception\CannotGetFile; +use Akeeba\S3\Input; + +class HeadObject extends AbstractTest +{ + public static function testExistingFile(Connector $s3, array $options): bool + { + $uri = 'head_test.dat'; + + // Randomize the name. Required for archive buckets where you cannot overwrite data. + $dotPos = strrpos($uri, '.'); + $uri = substr($uri, 0, $dotPos) . '.' . hash('md5', microtime(false)) . substr($uri, $dotPos); + + // Create a file with random data + $sourceFile = static::createFile(AbstractTest::TEN_KB); + + // Upload the file. Throws exception if it fails. + $bucket = $options['bucket']; + $input = Input::createFromFile($sourceFile); + + $s3->putObject($input, $bucket, $uri); + + $headers = $s3->headObject($bucket, $uri); + + static::assert(isset($headers['size']), 'The returned headers do not contain the object size'); + static::assert($headers['size'] == AbstractTest::TEN_KB, 'The returned size does not match'); + + // Remove the local files + @unlink($sourceFile); + + // Delete the remote file. Throws exception if it fails. + $s3->deleteObject($bucket, $uri); + + return true; + } + + public static function testMissingFile(Connector $s3, array $options): bool + { + $bucket = $options['bucket']; + + try + { + $headers = $s3->headObject($bucket, hash('md5', microtime(false)) . '_does_not_exist'); + } + catch (CannotGetFile $e) + { + return true; + } + + return false; + } +} \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/ListFiles.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/ListFiles.php new file mode 100644 index 0000000000..fc6ed23230 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/ListFiles.php @@ -0,0 +1,308 @@ +<?php +/** + * Akeeba Engine + * + * @package akeebaengine + * @copyright Copyright (c)2006-2024 Nicholas K. Dionysopoulos / Akeeba Ltd + * @license GNU General Public License version 3, or later + */ + +namespace Akeeba\MiniTest\Test; + + +use Akeeba\S3\Connector; +use Akeeba\S3\Exception\CannotPutFile; +use Akeeba\S3\Input; + +class ListFiles extends AbstractTest +{ + private static $paths = [ + 'listtest_one.dat', + 'listtest_two.dat', + 'listtest_three.dat', + 'list_deeper/test_one.dat', + 'list_deeper/test_two.dat', + 'list_deeper/test_three.dat', + 'list_deeper/listtest_four.dat', + 'list_deeper/listtest_five.dat', + 'list_deeper/listtest_six.dat', + 'list_deeper/spam.dat', + 'list_deeper/listtest_deeper/seven.dat', + 'list_deeper/listtest_deeper/eight.dat', + 'spam.dat', + ]; + + public static function setup(Connector $s3, array $options): void + { + $data = static::getRandomData(static::TEN_KB); + + foreach (static::$paths as $uri) + { + $input = Input::createFromData($data); + try + { + $s3->putObject($input, $options['bucket'], $uri); + } + catch (CannotPutFile $e) + { + // Expected for archival buckets + } + } + } + + public static function teardown(Connector $s3, array $options): void + { + foreach (static::$paths as $uri) + { + try + { + $s3->deleteObject($options['bucket'], $uri); + } + catch (\Exception $e) + { + // No problem if I can't delete the file + } + } + } + + public static function testGetAll(Connector $s3, array $options): bool + { + $listing = $s3->getBucket($options['bucket'], 'listtest_'); + + static::assert(is_array($listing), "The files listing must be an array"); + static::assert(count($listing) == 3, "I am expecting to see 3 files"); + + // Make sure I have the expected files + static::assert(array_key_exists('listtest_one.dat', $listing), "File listtest_one.dat not in listing"); + static::assert(array_key_exists('listtest_two.dat', $listing), "File listtest_two.dat not in listing"); + static::assert(array_key_exists('listtest_three.dat', $listing), "File listtest_three.dat not in listing"); + + // I must not see the files in subdirectories + static::assert(!array_key_exists('listtest_four.dat', $listing), "File listtest_four.dat in listing"); + static::assert(!array_key_exists('listtest_five.dat', $listing), "File listtest_five.dat in listing"); + static::assert(!array_key_exists('listtest_six.dat', $listing), "File listtest_six.dat in listing"); + + // I must not see the files not matching the prefix I gave + static::assert(!array_key_exists('spam.dat', $listing), "File spam.dat in listing"); + static::assert(!array_key_exists('ham.dat', $listing), "File ham.dat in listing"); + + foreach ($listing as $fileName => $info) + { + static::assert(isset($info['name']), "File entries must have a name"); + static::assert(isset($info['time']), "File entries must have a time"); + static::assert(isset($info['size']), "File entries must have a size"); + static::assert(isset($info['hash']), "File entries must have a hash"); + } + + return true; + } + + public static function testGetContinue(Connector $s3, array $options): bool + { + $listing = $s3->getBucket($options['bucket'], 'listtest_', null, 1); + + static::assert(is_array($listing), "The files listing must be an array"); + static::assert(count($listing) == 1, sprintf("I am expecting to see 1 file, %s seen", count($listing))); + + $files = array_keys($listing); + $continued = $s3->getBucket($options['bucket'], 'listtest_', array_shift($files)); + + static::assert(is_array($continued), "The continued files listing must be an array"); + static::assert(count($continued) == 2, sprintf("I am expecting to see 2 files, %s seen", count($continued))); + + $listing = array_merge($listing, $continued); + + // Make sure I have the expected files + static::assert(array_key_exists('listtest_one.dat', $listing), "File listtest_one.dat not in listing"); + static::assert(array_key_exists('listtest_two.dat', $listing), "File listtest_two.dat not in listing"); + static::assert(array_key_exists('listtest_three.dat', $listing), "File listtest_three.dat not in listing"); + + // I must not see the files in subdirectories + static::assert(!array_key_exists('listtest_four.dat', $listing), "File listtest_four.dat in listing"); + static::assert(!array_key_exists('listtest_five.dat', $listing), "File listtest_five.dat in listing"); + static::assert(!array_key_exists('listtest_six.dat', $listing), "File listtest_six.dat in listing"); + + // I must not see the files not matching the prefix I gave + static::assert(!array_key_exists('spam.dat', $listing), "File spam.dat in listing"); + static::assert(!array_key_exists('ham.dat', $listing), "File ham.dat in listing"); + + foreach ($listing as $fileName => $info) + { + static::assert(isset($info['name']), "File entries must have a name"); + static::assert(isset($info['time']), "File entries must have a time"); + static::assert(isset($info['size']), "File entries must have a size"); + static::assert(isset($info['hash']), "File entries must have a hash"); + } + + return true; + } + + public static function testGetSubdirectoryFiles(Connector $s3, array $options): bool + { + $listing = $s3->getBucket($options['bucket'], 'list_deeper/test_'); + + static::assert(is_array($listing), "The files listing must be an array"); + static::assert(count($listing) == 3, "I am expecting to see 3 files"); + + // Make sure I have the expected files + static::assert(array_key_exists('list_deeper/test_one.dat', $listing), "File test_one.dat not in listing"); + static::assert(array_key_exists('list_deeper/test_two.dat', $listing), "File test_two.dat not in listing"); + static::assert(array_key_exists('list_deeper/test_three.dat', $listing), "File test_three.dat not in listing"); + + // I must not see the files with different prefix + static::assert(!array_key_exists('list_deeper/listtest_four.dat', $listing), "File listtest_four.dat in listing"); + static::assert(!array_key_exists('list_deeper/listtest_five.dat', $listing), "File listtest_five.dat in listing"); + static::assert(!array_key_exists('list_deeper/listtest_six.dat', $listing), "File listtest_six.dat in listing"); + static::assert(!array_key_exists('list_deeper/spam.dat', $listing), "File spam.dat in listing"); + + // I must not see the files in subdirectories + static::assert(!array_key_exists('list_deeper/listtest_deeper/seven.dat', $listing), "File spam.dat in listing"); + static::assert(!array_key_exists('list_deeper/listtest_deeper/eight.dat', $listing), "File spam.dat in listing"); + + foreach ($listing as $fileName => $info) + { + static::assert(isset($info['name']), "File entries must have a name"); + static::assert(isset($info['time']), "File entries must have a time"); + static::assert(isset($info['size']), "File entries must have a size"); + static::assert(isset($info['hash']), "File entries must have a hash"); + } + + return true; + } + + public static function testGetSubdirectoryFilesWithContinue(Connector $s3, array $options): bool + { + $listing = $s3->getBucket($options['bucket'], 'list_deeper/test_', null, 1); + + static::assert(is_array($listing), "The files listing must be an array"); + static::assert(count($listing) == 1, sprintf("I am expecting to see 1 file, %s seen", count($listing))); + + $files = array_keys($listing); + $continued = $s3->getBucket($options['bucket'], 'list_deeper/test_', array_shift($files)); + + static::assert(is_array($continued), "The continued files listing must be an array"); + static::assert(count($continued) == 2, sprintf("I am expecting to see 2 files, %s seen", count($continued))); + + $listing = array_merge($listing, $continued); + + static::assert(is_array($listing), "The files listing must be an array"); + static::assert(count($listing) == 3, "I am expecting to see 3 files"); + + // Make sure I have the expected files + static::assert(array_key_exists('list_deeper/test_one.dat', $listing), "File test_one.dat not in listing"); + static::assert(array_key_exists('list_deeper/test_two.dat', $listing), "File test_two.dat not in listing"); + static::assert(array_key_exists('list_deeper/test_three.dat', $listing), "File test_three.dat not in listing"); + + // I must not see the files with different prefix + static::assert(!array_key_exists('list_deeper/listtest_four.dat', $listing), "File listtest_four.dat in listing"); + static::assert(!array_key_exists('list_deeper/listtest_five.dat', $listing), "File listtest_five.dat in listing"); + static::assert(!array_key_exists('list_deeper/listtest_six.dat', $listing), "File listtest_six.dat in listing"); + static::assert(!array_key_exists('list_deeper/spam.dat', $listing), "File spam.dat in listing"); + + // I must not see the files in subdirectories + static::assert(!array_key_exists('list_deeper/listtest_deeper/seven.dat', $listing), "File spam.dat in listing"); + static::assert(!array_key_exists('list_deeper/listtest_deeper/eight.dat', $listing), "File spam.dat in listing"); + + foreach ($listing as $fileName => $info) + { + static::assert(isset($info['name']), "File entries must have a name"); + static::assert(isset($info['time']), "File entries must have a time"); + static::assert(isset($info['size']), "File entries must have a size"); + static::assert(isset($info['hash']), "File entries must have a hash"); + } + + return true; + } + + public static function testListWithPrefixSharedWithFolder(Connector $s3, array $options): bool + { + /** + * The prefix list_deeper/listtest_ matches BOTH keys (files) and common prefixes (folders). + * + * Common prefixes have priority so the first request would return zero files. The Connector catches that + * internally and performs more requests until it has at least as many files as we requeted. + */ + $listing = $s3->getBucket($options['bucket'], 'list_deeper/listtest_', null, 1); + + static::assert(is_array($listing), "The files listing must be an array"); + static::assert(count($listing) == 1, sprintf("I am expecting to see 1 files, %s seen", count($listing))); + + $files = array_keys($listing); + $continued = $s3->getBucket($options['bucket'], 'list_deeper/listtest_', array_shift($files)); + + static::assert(is_array($continued), "The continued files listing must be an array"); + static::assert(count($continued) == 2, sprintf("I am expecting to see 2 files, %s seen", count($continued))); + + $listing = array_merge($listing, $continued); + + static::assert(is_array($listing), "The files listing must be an array"); + static::assert(count($listing) == 3, "I am expecting to see 3 files"); + + // Make sure I have the expected files + static::assert(array_key_exists('list_deeper/listtest_four.dat', $listing), "File listtest_four.dat not in listing"); + static::assert(array_key_exists('list_deeper/listtest_five.dat', $listing), "File listtest_five.dat not in listing"); + static::assert(array_key_exists('list_deeper/listtest_six.dat', $listing), "File listtest_six.dat not in listing"); + + + // I must not see the files with different prefix + static::assert(!array_key_exists('list_deeper/test_one.dat', $listing), "File test_one.dat in listing"); + static::assert(!array_key_exists('list_deeper/test_two.dat', $listing), "File test_two.dat in listing"); + static::assert(!array_key_exists('list_deeper/test_three.dat', $listing), "File test_three.dat in listing"); + static::assert(!array_key_exists('list_deeper/spam.dat', $listing), "File spam.dat in listing"); + + // I must not see the files in subdirectories + static::assert(!array_key_exists('list_deeper/listtest_deeper/seven.dat', $listing), "File spam.dat in listing"); + static::assert(!array_key_exists('list_deeper/listtest_deeper/eight.dat', $listing), "File spam.dat in listing"); + + foreach ($listing as $fileName => $info) + { + static::assert(isset($info['name']), "File entries must have a name"); + static::assert(isset($info['time']), "File entries must have a time"); + static::assert(isset($info['size']), "File entries must have a size"); + static::assert(isset($info['hash']), "File entries must have a hash"); + } + + return true; + } + + public static function testCommonPrefixes(Connector $s3, array $options): bool + { + $listing = $s3->getBucket($options['bucket'], 'list_deeper/listtest_', null, null, '/', true); + + static::assert(is_array($listing), "The files listing must be an array"); + static::assert(count($listing) == 4, sprintf("I am expecting to see 4 entries, %s entries seen.", count($listing))); + + // Make sure I have the expected files + static::assert(array_key_exists('list_deeper/listtest_four.dat', $listing), "File listtest_four.dat not in listing"); + static::assert(array_key_exists('list_deeper/listtest_five.dat', $listing), "File listtest_five.dat not in listing"); + static::assert(array_key_exists('list_deeper/listtest_six.dat', $listing), "File listtest_six.dat not in listing"); + static::assert(array_key_exists('list_deeper/listtest_deeper/', $listing), "Folder listtest_deeper not in listing"); + + // I must not see the files in subdirectories + static::assert(!array_key_exists('list_deeper/listtest_deeper/seven.dat', $listing), "File seven.dat in listing"); + static::assert(!array_key_exists('list_deeper/listtest_deeper/eight.dat', $listing), "File eight.dat in listing"); + + // I must not see the files with different prefix + static::assert(!array_key_exists('list_deeper/spam.dat', $listing), "File spam.dat in listing"); + static::assert(!array_key_exists('list_deeper/test_one.dat', $listing), "File test_one.dat not in listing"); + static::assert(!array_key_exists('list_deeper/test_two.dat', $listing), "File test_two.dat not in listing"); + static::assert(!array_key_exists('list_deeper/test_three.dat', $listing), "File test_three.dat not in listing"); + + foreach ($listing as $fileName => $info) + { + if (substr($fileName, -1) !== '/') + { + static::assert(isset($info['name']), "File entries must have a name"); + static::assert(isset($info['time']), "File entries must have a time"); + static::assert(isset($info['size']), "File entries must have a size"); + static::assert(isset($info['hash']), "File entries must have a hash"); + } + else + { + static::assert(isset($info['prefix']), "Folder entries must return a prefix"); + } + } + + return true; + } +} \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/ListThousandsOfFiles.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/ListThousandsOfFiles.php new file mode 100644 index 0000000000..8485a715f4 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/ListThousandsOfFiles.php @@ -0,0 +1,111 @@ +<?php +/** + * Akeeba Engine + * + * @package akeebaengine + * @copyright Copyright (c)2006-2024 Nicholas K. Dionysopoulos / Akeeba Ltd + * @license GNU General Public License version 3, or later + */ + +namespace Akeeba\MiniTest\Test; + +use Akeeba\S3\Connector; +use Akeeba\S3\Input; + +class ListThousandsOfFiles extends AbstractTest +{ + private const PATH_PREFIX = 'massive/'; + + public static function setup(Connector $s3, array $options): void + { + if (defined('CREATE_2100_FILES') && CREATE_2100_FILES === false) + { + return; + } + + $data = static::getRandomData(128); + + echo "\nPopulating with 2100 files\n"; + + for ($i = 1; $i <= 2100; $i++) + { + if ($i % 10 === 0) + { + echo "Uploading from $i...\n"; + } + + $uri = sprintf('%stest_%04u.dat', static::PATH_PREFIX, $i); + $input = Input::createFromData($data); + $s3->putObject($input, $options['bucket'], $uri); + } + } + + public static function testGetAll(Connector $s3, array $options): bool + { + $listing = $s3->getBucket($options['bucket'], static::PATH_PREFIX); + + static::assert(is_array($listing), "The files listing must be an array"); + static::assert(count($listing) === 2100, "I am expecting to see 2100 files"); + + for ($i = 1; $i <= 2100; $i++) + { + $key = sprintf('%stest_%04u.dat', static::PATH_PREFIX, $i); + + static::assert(array_key_exists($key, $listing), sprintf('Results should list object %s', $key)); + } + + return true; + } + + public static function testGetHundred(Connector $s3, array $options): bool + { + $listing = $s3->getBucket($options['bucket'], static::PATH_PREFIX, null, 100); + + static::assert(is_array($listing), "The files listing must be an array"); + static::assert(count($listing) === 100, "I am expecting to see 100 files"); + + for ($i = 1; $i <= 100; $i++) + { + $key = sprintf('%stest_%04u.dat', static::PATH_PREFIX, $i); + + static::assert(array_key_exists($key, $listing), sprintf('Results should list object %s', $key)); + } + + return true; + } + + public static function testGetElevenHundred(Connector $s3, array $options): bool + { + $listing = $s3->getBucket($options['bucket'], static::PATH_PREFIX, null, 1100); + + static::assert(is_array($listing), "The files listing must be an array"); + static::assert(count($listing) === 1100, "I am expecting to see 1100 files"); + + for ($i = 1; $i <= 1100; $i++) + { + $key = sprintf('%stest_%04u.dat', static::PATH_PREFIX, $i); + + static::assert(array_key_exists($key, $listing), sprintf('Results should list object %s', $key)); + } + + return true; + } + + public static function testGetLastHundred(Connector $s3, array $options): bool + { + $listing = $s3->getBucket($options['bucket'], static::PATH_PREFIX . 'test_20', null); + + static::assert(is_array($listing), "The files listing must be an array"); + static::assert(count($listing) === 100, "I am expecting to see 100 files"); + + for ($i = 2000; $i <= 2099; $i++) + { + $key = sprintf('%stest_%04u.dat', static::PATH_PREFIX, $i); + + static::assert(array_key_exists($key, $listing), sprintf('Results should list object %s', $key)); + } + + return true; + } + +} \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/Multipart.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/Multipart.php new file mode 100644 index 0000000000..fc244c6282 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/Multipart.php @@ -0,0 +1,103 @@ +<?php +/** + * Akeeba Engine + * + * @package akeebaengine + * @copyright Copyright (c)2006-2024 Nicholas K. Dionysopoulos / Akeeba Ltd + * @license GNU General Public License version 3, or later + */ + +namespace Akeeba\MiniTest\Test; + + +use Akeeba\S3\Connector; + +class Multipart extends BigFiles +{ + public static function setup(Connector $s3, array $options): void + { + static::$multipart = true; + + parent::setup($s3, $options); + } + + public static function upload5MBString(Connector $s3, array $options): bool + { + $result = parent::upload5MBString($s3, $options); + + $expectedChunks = 1; + static::assert(static::$numberOfChunks === $expectedChunks, sprintf("Expected %s chunks, upload complete in %s chunks", $expectedChunks, static::$numberOfChunks)); + + return $result; + } + + public static function upload6MBString(Connector $s3, array $options): bool + { + $result = parent::upload6MBString($s3, $options); + + $expectedChunks = 2; + static::assert(static::$numberOfChunks === $expectedChunks, sprintf("Expected %s chunks, upload complete in %s chunks", $expectedChunks, static::$numberOfChunks)); + + return $result; + } + + public static function upload10MBString(Connector $s3, array $options): bool + { + $result = parent::upload10MBString($s3, $options); + + $expectedChunks = 2; + static::assert(static::$numberOfChunks === $expectedChunks, sprintf("Expected %s chunks, upload complete in %s chunks", $expectedChunks, static::$numberOfChunks)); + + return $result; + } + + public static function upload11MBString(Connector $s3, array $options): bool + { + $result = parent::upload11MBString($s3, $options); + + $expectedChunks = 3; + static::assert(static::$numberOfChunks === $expectedChunks, sprintf("Expected %s chunks, upload complete in %s chunks", $expectedChunks, static::$numberOfChunks)); + + return $result; + } + + public static function upload5MBFile(Connector $s3, array $options): bool + { + $result = parent::upload5MBFile($s3, $options); + + $expectedChunks = 1; + static::assert(static::$numberOfChunks === $expectedChunks, sprintf("Expected %s chunks, upload complete in %s chunks", $expectedChunks, static::$numberOfChunks)); + + return $result; + } + + public static function upload6MBFile(Connector $s3, array $options): bool + { + $result = parent::upload6MBFile($s3, $options); + + $expectedChunks = 2; + static::assert(static::$numberOfChunks === $expectedChunks, sprintf("Expected %s chunks, upload complete in %s chunks", $expectedChunks, static::$numberOfChunks)); + + return $result; + } + + public static function upload10MBFile(Connector $s3, array $options): bool + { + $result = parent::upload10MBFile($s3, $options); + + $expectedChunks = 2; + static::assert(static::$numberOfChunks === $expectedChunks, sprintf("Expected %s chunks, upload complete in %s chunks", $expectedChunks, static::$numberOfChunks)); + + return $result; + } + + public static function upload11MBFile(Connector $s3, array $options): bool + { + $result = parent::upload11MBFile($s3, $options); + + $expectedChunks = 3; + static::assert(static::$numberOfChunks === $expectedChunks, sprintf("Expected %s chunks, upload complete in %s chunks", $expectedChunks, static::$numberOfChunks)); + + return $result; + } +} \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/SignedURLs.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/SignedURLs.php new file mode 100644 index 0000000000..2b2e1ba60a --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/SignedURLs.php @@ -0,0 +1,78 @@ +<?php +/** + * Akeeba Engine + * + * @package akeebaengine + * @copyright Copyright (c)2006-2024 Nicholas K. Dionysopoulos / Akeeba Ltd + * @license GNU General Public License version 3, or later + */ + +namespace Akeeba\MiniTest\Test; + + +use Akeeba\S3\Acl; +use Akeeba\S3\Connector; +use Akeeba\S3\Input; +use RuntimeException; + +class SignedURLs extends AbstractTest +{ + public static function signedURLPublicObject(Connector $s3, array $options): bool + { + return static::signedURL($s3, $options, Acl::ACL_PUBLIC_READ); + } + + public static function signedURLPublicObjectSpaces(Connector $s3, array $options): bool + { + return static::signedURL($s3, array_merge($options, [ + 'spaces' => true + ]), Acl::ACL_PUBLIC_READ); + } + + public static function signedURLPrivateObject(Connector $s3, array $options): bool + { + return static::signedURL($s3, $options, Acl::ACL_PRIVATE); + } + + public static function signedURLPrivateObjectSpaces(Connector $s3, array $options): bool + { + return static::signedURL($s3, array_merge($options, [ + 'spaces' => true + ]), Acl::ACL_PRIVATE); + } + + private static function signedURL(Connector $s3, array $options, string $aclPrivilege): bool + { + $spaces = isset($options['spaces']) && boolval($options['spaces']); + $tempData = static::getRandomData(AbstractTest::TEN_KB); + $input = Input::createFromData($tempData); + $prefix = $spaces ? 'test file' : 'test'; + $uri = $prefix . '.' . hash('md5', microtime(false)) . '.dat'; + + $s3->putObject($input, $options['bucket'], $uri, $aclPrivilege); + + $downloadURL = $s3->getAuthenticatedURL($options['bucket'], $uri, null, $options['ssl']); + + echo "\n\tDownload URL: $downloadURL\n"; + + $downloadedData = @file_get_contents($downloadURL); + + try + { + $s3->deleteObject($options['bucket'], $uri); + } + catch (\Exception $e) + { + // Ignore deletion errors + } + + if ($downloadedData === false) + { + throw new RuntimeException("Failed to download from signed URL ‘{$downloadURL}′"); + } + + static::assert(static::areStringsEqual($tempData, $downloadedData), "Wrong data received from signed URL ‘{$downloadURL}′"); + + return true; + } +} \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/SingleSmallFile.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/SingleSmallFile.php new file mode 100644 index 0000000000..51716621fb --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/SingleSmallFile.php @@ -0,0 +1,43 @@ +<?php +/** + * Akeeba Engine + * + * @package akeebaengine + * @copyright Copyright (c)2006-2024 Nicholas K. Dionysopoulos / Akeeba Ltd + * @license GNU General Public License version 3, or later + */ + +namespace Akeeba\MiniTest\Test; + +use Akeeba\S3\Connector; +use Akeeba\S3\Input; + +/** + * Upload, download and delete small files (under 1MB) using a string source + * + * @package Akeeba\MiniTest\Test + */ +class SingleSmallFile extends AbstractTest +{ + public static function upload(Connector $s3, array $options): bool + { + $uri = 'test.txt'; + $sourceData = <<< TEXT +This is a small text file. +TEXT; + + + // Upload the data. Throws exception if it fails. + $bucket = $options['bucket']; + $input = Input::createFromData($sourceData); + + $s3->putObject($input, $bucket, $uri); + + $downloadedData = $s3->getObject($bucket, $uri); + $result = static::areStringsEqual($sourceData, $downloadedData); + + $s3->deleteObject($bucket, $uri); + + return $result ?? true; + } +} \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/SmallFiles.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/SmallFiles.php new file mode 100644 index 0000000000..57e2910b36 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/SmallFiles.php @@ -0,0 +1,109 @@ +<?php +/** + * Akeeba Engine + * + * @package akeebaengine + * @copyright Copyright (c)2006-2024 Nicholas K. Dionysopoulos / Akeeba Ltd + * @license GNU General Public License version 3, or later + */ + +namespace Akeeba\MiniTest\Test; + + +use Akeeba\S3\Connector; +use Akeeba\S3\Input; + +/** + * Upload, download and delete small files (under 1MB) using a file source + * + * @package Akeeba\MiniTest\Test + */ +class SmallFiles extends AbstractTest +{ + /** + * Should I download the file after uploading it to test for contents consistency? + * + * @var bool + */ + protected static $downloadAfter = true; + + /** + * Should I delete the uploaded file after the test case is done? + * + * @var bool + */ + protected static $deleteRemote = true; + + public static function upload10KbRoot(Connector $s3, array $options): bool + { + return static::upload($s3, $options, AbstractTest::TEN_KB, 'root_10kb.dat'); + } + + public static function upload10KbRootGreek(Connector $s3, array $options): bool + { + return static::upload($s3, $options, AbstractTest::TEN_KB, 'δοκιμή_10kb.dat'); + } + + public static function upload10KbFolderGreek(Connector $s3, array $options): bool + { + return static::upload($s3, $options, AbstractTest::TEN_KB, 'ο_φάκελός_μου/δοκιμή_10kb.dat'); + } + + public static function upload600KbRoot(Connector $s3, array $options): bool + { + return static::upload($s3, $options, AbstractTest::SIX_HUNDRED_KB, 'root_600kb.dat'); + } + + public static function upload10KbFolder(Connector $s3, array $options): bool + { + return static::upload($s3, $options, AbstractTest::TEN_KB, 'my_folder/10kb.dat'); + } + + public static function upload600KbFolder(Connector $s3, array $options): bool + { + return static::upload($s3, $options, AbstractTest::SIX_HUNDRED_KB, 'my_folder/600kb.dat'); + } + + protected static function upload(Connector $s3, array $options, int $size, string $uri): bool + { + // Randomize the name. Required for archive buckets where you cannot overwrite data. + $dotPos = strrpos($uri, '.'); + $uri = substr($uri, 0, $dotPos) . '.' . hash('md5', microtime(false)) . substr($uri, $dotPos); + + // Create a file with random data + $sourceFile = static::createFile($size); + + // Upload the file. Throws exception if it fails. + $bucket = $options['bucket']; + $input = Input::createFromFile($sourceFile); + + $s3->putObject($input, $bucket, $uri); + + // Tentatively accept that this method succeeded. + $result = true; + + // Should I download the file and compare its contents? + if (static::$downloadAfter) + { + // Donwload the data. Throws exception if it fails. + $downloadedFile = tempnam(static::getTempFolder(), 'as3'); + $s3->getObject($bucket, $uri, $downloadedFile); + + // Compare the file contents. + $result = static::areFilesEqual($sourceFile, $downloadedFile); + } + + // Remove the local files + @unlink($sourceFile); + @unlink($downloadedFile); + + // Should I delete the remotely stored file? + if (static::$deleteRemote) + { + // Delete the remote file. Throws exception if it fails. + $s3->deleteObject($bucket, $uri); + } + + return $result; + } +} \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/SmallFilesNoDelete.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/SmallFilesNoDelete.php new file mode 100644 index 0000000000..fee30e5f97 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/SmallFilesNoDelete.php @@ -0,0 +1,28 @@ +<?php +/** + * Akeeba Engine + * + * @package akeebaengine + * @copyright Copyright (c)2006-2024 Nicholas K. Dionysopoulos / Akeeba Ltd + * @license GNU General Public License version 3, or later + */ + +namespace Akeeba\MiniTest\Test; + + +use Akeeba\S3\Connector; + +/** + * Upload and download small files (under 1MB) using a file source + * + * @package Akeeba\MiniTest\Test + */ +class SmallFilesNoDelete extends SmallFiles +{ + public static function setup(Connector $s3, array $options): void + { + static::$deleteRemote = false; + + parent::setup($s3, $options); + } +} \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/SmallFilesOnlyUpload.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/SmallFilesOnlyUpload.php new file mode 100644 index 0000000000..1d2aa370b3 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/SmallFilesOnlyUpload.php @@ -0,0 +1,31 @@ +<?php +/** + * Akeeba Engine + * + * @package akeebaengine + * @copyright Copyright (c)2006-2024 Nicholas K. Dionysopoulos / Akeeba Ltd + * @license GNU General Public License version 3, or later + */ + +namespace Akeeba\MiniTest\Test; + + +use Akeeba\S3\Connector; + +/** + * Upload small files (under 1MB) using a file source + * + * @package Akeeba\MiniTest\Test + */ +class SmallFilesOnlyUpload extends SmallFiles +{ + public static function setup(Connector $s3, array $options): void + { + static::$deleteRemote = false; + static::$downloadAfter = false; + + parent::setup($s3, $options); + } + + +} \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/SmallInlineFiles.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/SmallInlineFiles.php new file mode 100644 index 0000000000..7119e3695b --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/SmallInlineFiles.php @@ -0,0 +1,57 @@ +<?php +/** + * Akeeba Engine + * + * @package akeebaengine + * @copyright Copyright (c)2006-2024 Nicholas K. Dionysopoulos / Akeeba Ltd + * @license GNU General Public License version 3, or later + */ + +namespace Akeeba\MiniTest\Test; + +use Akeeba\S3\Connector; +use Akeeba\S3\Input; + +/** + * Upload, download and delete small files (under 1MB) using a string source + * + * @package Akeeba\MiniTest\Test + */ +class SmallInlineFiles extends SmallFiles +{ + protected static function upload(Connector $s3, array $options, int $size, string $uri): bool + { + // Randomize the name. Required for archive buckets where you cannot overwrite data. + $dotPos = strrpos($uri, '.'); + $uri = substr($uri, 0, $dotPos) . '.' . hash('md5', microtime(false)) . substr($uri, $dotPos); + + // Create some random data to upload + $sourceData = static::getRandomData($size); + + // Upload the data. Throws exception if it fails. + $bucket = $options['bucket']; + $input = Input::createFromData($sourceData); + + $s3->putObject($input, $bucket, $uri); + + // Tentatively accept that this method succeeded. + $result = true; + + // Should I download the file and compare its contents with my random data? + if (static::$downloadAfter) + { + $downloadedData = $s3->getObject($bucket, $uri); + + $result = static::areStringsEqual($sourceData, $downloadedData); + } + + // Should I delete the remotely stored file? + if (static::$deleteRemote) + { + // Delete the remote file. Throws exception if it fails. + $s3->deleteObject($bucket, $uri); + } + + return $result; + } +} \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/SmallInlineFilesNoDelete.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/SmallInlineFilesNoDelete.php new file mode 100644 index 0000000000..f17f84d9c8 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/SmallInlineFilesNoDelete.php @@ -0,0 +1,28 @@ +<?php +/** + * Akeeba Engine + * + * @package akeebaengine + * @copyright Copyright (c)2006-2024 Nicholas K. Dionysopoulos / Akeeba Ltd + * @license GNU General Public License version 3, or later + */ + +namespace Akeeba\MiniTest\Test; + + +use Akeeba\S3\Connector; + +/** + * Upload and download small files (under 1MB) using a string source + * + * @package Akeeba\MiniTest\Test + */ +class SmallInlineFilesNoDelete extends SmallInlineFiles +{ + public static function setup(Connector $s3, array $options): void + { + static:: $deleteRemote = false; + + parent::setup($s3, $options); + } +} \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/SmallInlineFilesOnlyUpload.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/SmallInlineFilesOnlyUpload.php new file mode 100644 index 0000000000..3d9202e74c --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/SmallInlineFilesOnlyUpload.php @@ -0,0 +1,30 @@ +<?php +/** + * Akeeba Engine + * + * @package akeebaengine + * @copyright Copyright (c)2006-2024 Nicholas K. Dionysopoulos / Akeeba Ltd + * @license GNU General Public License version 3, or later + */ + +namespace Akeeba\MiniTest\Test; + + +use Akeeba\S3\Connector; + +/** + * Upload small files (under 1MB) using a string source + * + * @package Akeeba\MiniTest\Test + */ +class SmallInlineFilesOnlyUpload extends SmallInlineFiles +{ + public static function setup(Connector $s3, array $options): void + { + static::$deleteRemote = false; + static::$downloadAfter = false; + + parent::setup($s3, $options); + } + +} \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/SmallInlineXMLFiles.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/SmallInlineXMLFiles.php new file mode 100644 index 0000000000..57975284d3 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/SmallInlineXMLFiles.php @@ -0,0 +1,131 @@ +<?php +/** + * Akeeba Engine + * + * @package akeebaengine + * @copyright Copyright (c)2006-2024 Nicholas K. Dionysopoulos / Akeeba Ltd + * @license GNU General Public License version 3, or later + */ + +namespace Akeeba\MiniTest\Test; + + +use Akeeba\S3\Connector; +use Akeeba\S3\Input; + +/** + * Upload, download and delete small XML files (under 1MB) using a string source + * + * @package Akeeba\MiniTest\Test + */ +class SmallInlineXMLFiles extends SmallFiles +{ + public static function upload10KbRoot(Connector $s3, array $options): bool + { + return static::upload($s3, $options, AbstractTest::TEN_KB, 'root_10kb.xml'); + } + + public static function upload10KbRootGreek(Connector $s3, array $options): bool + { + return static::upload($s3, $options, AbstractTest::TEN_KB, 'δοκιμή_10kb.xml'); + } + + public static function upload10KbFolderGreek(Connector $s3, array $options): bool + { + return static::upload($s3, $options, AbstractTest::TEN_KB, 'ο_φάκελός_μου/δοκιμή_10kb.xml'); + } + + public static function upload600KbRoot(Connector $s3, array $options): bool + { + return static::upload($s3, $options, AbstractTest::SIX_HUNDRED_KB, 'root_600kb.xml'); + } + + public static function upload10KbFolder(Connector $s3, array $options): bool + { + return static::upload($s3, $options, AbstractTest::TEN_KB, 'my_folder/10kb.xml'); + } + + public static function upload600KbFolder(Connector $s3, array $options): bool + { + return static::upload($s3, $options, AbstractTest::SIX_HUNDRED_KB, 'my_folder/600kb.xml'); + } + + protected static function upload(Connector $s3, array $options, int $size, string $uri): bool + { + // Randomize the name. Required for archive buckets where you cannot overwrite data. + $dotPos = strrpos($uri, '.'); + $uri = substr($uri, 0, $dotPos) . '.' . hash('md5', microtime(false)) . substr($uri, $dotPos); + + // Create some random data to upload + $sourceData = static::createXMLFile($size); + + // Upload the data. Throws exception if it fails. + $bucket = $options['bucket']; + $input = Input::createFromData($sourceData); + + $s3->putObject($input, $bucket, $uri); + + // Tentatively accept that this method succeeded. + $result = true; + + // Should I download the file and compare its contents with my random data? + if (static::$downloadAfter) + { + $downloadedData = $s3->getObject($bucket, $uri); + + $result = static::areStringsEqual($sourceData, $downloadedData); + } + + // Should I delete the remotely stored file? + if (static::$deleteRemote) + { + // Delete the remote file. Throws exception if it fails. + $s3->deleteObject($bucket, $uri); + } + + return $result; + } + + private static function createXMLFile(int $size): string + { + $out = <<< XML +<?xml version="1.0" encoding="utf-8" ?> +<root> +XML; + + $chunks = floor(($size - 55) / 1024); + + for ($i = 1; $i <= $chunks; $i++) + { + $randomBlock = static::genRandomData(1024 - 63); + $out .= <<< XML + <element> + <id>$i</id> + <data><![CDATA[$randomBlock]]></data> + </element> +XML; + + } + + + $out .= <<< XML +</root> +XML; + + return $out; + } + + private static function genRandomData(int $length): string + { + $chars = 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ01234567890'; + $maxLength = strlen($chars) - 1; + $salt = ''; + + for ($i = 0; $i < $length; $i++) + { + $salt .= substr($chars, random_int(0, $maxLength), 1); + } + + return $salt; + } +} \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/StorageClasses.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/StorageClasses.php new file mode 100644 index 0000000000..275967a90e --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/StorageClasses.php @@ -0,0 +1,74 @@ +<?php +/** + * Akeeba Engine + * + * @package akeebaengine + * @copyright Copyright (c)2006-2024 Nicholas K. Dionysopoulos / Akeeba Ltd + * @license GNU General Public License version 3, or later + */ + +namespace Akeeba\MiniTest\Test; + + +use Akeeba\S3\Acl; +use Akeeba\S3\Connector; +use Akeeba\S3\Input; +use Akeeba\S3\StorageClass; + +class StorageClasses extends AbstractTest +{ + protected static $downloadAfter = true; + + protected static $deleteRemote = true; + + public static function uploadRRS(Connector $s3, array $options): bool + { + return static::upload($s3, $options, static::TEN_KB, 'rrs_test_10kb.dat', StorageClass::REDUCED_REDUNDANCY); + } + + public static function uploadIntelligentTiering(Connector $s3, array $options): bool + { + return static::upload($s3, $options, static::TEN_KB, 'rrs_test_10kb.dat', StorageClass::INTELLIGENT_TIERING); + } + + protected static function upload(Connector $s3, array $options, int $size, string $uri, string $storageClass = null) + { + // Randomize the name. Required for archive buckets where you cannot overwrite data. + $dotPos = strrpos($uri, '.'); + $uri = substr($uri, 0, $dotPos) . '.' . hash('md5', microtime(false)) . substr($uri, $dotPos); + + // Create some random data to upload + $sourceData = static::getRandomData($size); + + // Upload the data. Throws exception if it fails. + $bucket = $options['bucket']; + $input = Input::createFromData($sourceData); + + // Get the headers + $headers = []; + StorageClass::setStorageClass($headers, $storageClass); + + $s3->putObject($input, $bucket, $uri, Acl::ACL_PRIVATE, $headers); + + // Tentatively accept that this method succeeded. + $result = true; + + // Should I download the file and compare its contents with my random data? + if (static::$downloadAfter) + { + $downloadedData = $s3->getObject($bucket, $uri); + + $result = static::areStringsEqual($sourceData, $downloadedData); + } + + // Should I delete the remotely stored file? + if (static::$deleteRemote) + { + // Delete the remote file. Throws exception if it fails. + $s3->deleteObject($bucket, $uri); + } + + return $result; + } + +} \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/config.dist.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/config.dist.php new file mode 100644 index 0000000000..f67e521e06 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/config.dist.php @@ -0,0 +1,303 @@ +<?php +/** + * Akeeba Engine + * + * @package akeebaengine + * @copyright Copyright (c)2006-2024 Nicholas K. Dionysopoulos / Akeeba Ltd + * @license GNU General Public License version 3, or later + */ + +// Create the 2100 test files in the bucket? +define('CREATE_2100_FILES', true); + +/** + * Configure the connection options for S3 and S3-compatible services here. Use them in the $testConfigurations array. + */ +$serviceConfigurations = [ + 's3-v4' => [ + 'access' => 'AK0123456789BCDEFGHI', + 'secret' => 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX', + 'region' => 'eu-west-1', + 'bucket' => 'mybucket', + 'signature' => 'v4', + 'dualstack' => false, + 'path_access' => false, + 'ssl' => false, + 'endpoint' => null, + ], + 's3-v2' => [ + 'access' => 'AK0123456789BCDEFGHI', + 'secret' => 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX', + 'region' => 'eu-west-1', + 'bucket' => 'mybucket', + 'signature' => 'v2', + 'dualstack' => false, + 'path_access' => false, + 'ssl' => false, + 'endpoint' => null, + ], + 'localstack-v4' => [ + 'access' => 'KYLOREN', + 'secret' => 'BenSolo', + 'region' => 'us-east-1', + 'bucket' => 'test', + 'signature' => 'v4', + 'dualstack' => false, + 'path_access' => true, + 'ssl' => false, + 'endpoint' => 'localhost.localstack.cloud:4566', + ], + 'localstack-v2' => [ + 'access' => 'KYLOREN', + 'secret' => 'BenSolo', + 'region' => 'us-east-1', + 'bucket' => 'test', + 'signature' => 'v2', + 'dualstack' => false, + 'path_access' => true, + 'ssl' => false, + 'endpoint' => 'localhost.localstack.cloud:4566', + ], +]; + +/** + * Test EVERYTHING. + */ +$allTheTests = [ + 'BucketsList', + 'BucketLocation', + 'HeadObject', + 'ListFiles', + 'SmallFiles', + 'SmallInlineFiles', + 'SmallFilesNoDelete', + 'SmallFilesOnlyUpload', + 'SmallInlineFilesNoDelete', + 'SmallInlineFilesOnlyUpload', + 'SmallInlineXMLFiles', + 'BigFiles', + 'Multipart', + 'StorageClasses', + 'SignedURLs', +]; + +if (CREATE_2100_FILES) +{ + $allTheTests[] = 'ListThousandsOfFiles'; +} + +/** + * Tests for standard key pairs allowing us to read, write and delete + * + * This is the main test suite + */ +$standardTests = [ + 'BucketsList', + 'BucketLocation', + 'HeadObject', + 'ListFiles', + 'SmallFiles', + 'SmallInlineFiles', + 'SmallInlineXMLFiles', + 'BigFiles', + 'Multipart', + 'StorageClasses', + 'SignedURLs', +]; + +/** + * Tests for key pairs or buckets which do NOT allow us to delete, but DO allow us to write and read data + * + * Example: archival buckets + */ +$noDeleteTests = [ + 'SmallFilesNoDelete', + 'SmallInlineFilesNoDelete', +]; + +/** + * Tests for key pairs which do NOT allow us to read, but DO allow us to write/delete + * + * Example: write-only key pairs per my documentation information from 2011 :) + */ +$writeOnlyTests = [ + 'SmallFilesOnlyUpload', + 'SmallInlineFilesOnlyUpload', +]; + +/** + * These are the individual test configurations. + * + * Each configuration consists of two keys: + * + * * **configuration** Overrides to the default configuration. + * * **tests** The names of the test classes to execute. Use the format ['classname', 'method'] to execute + * specific test methods only. + */ +$testConfigurations = [ +// Format of each +// 'Description of this configuration' => array( +// 'configuration' => array( +// // You can skip one or more keys. The defaults will be used. +// 'access' => 'a different access key', +// 'secret' => 'a different secret key', +// 'region' => 'eu-west-1', +// 'bucket' => 'different_example', +// 'signature' => 'v2', +// 'dualstack' => true, +// 'path_access' => true, +// 'ssl' => true, +// // Only if you want to use a custom, non-Amazon endpoint +// 'endpoint' => null, +// ), +// 'tests' => array( +// // Use a start to run all tests +// '*', +// // Alternatively you can define single test classes: +// 'SmallFiles', +// // ..or specific tests: +// array('SmallFiles', 'upload10KbRoot'), +// ) +// ), + /**/ + + /** + * These are the standard tests we run for each region and key pair. + * + * For all available regions please consult https://docs.aws.amazon.com/general/latest/gr/s3.html + * + * It is recommended to run against the following regions: + * - eu-east-1 The original Amazon S3 region, it often has special meaning in APIs. + * - eu-west-1 Ireland. The original EU region for S3, as a test for the non-default region. + * - eu-central-1 Frankfurt. This region –like all newer regions– only allows v4 signatures! + * - cn-north-1 Beijing, China. Requires running it from inside China. + * - NON-AMAZON A custom endpoint for a third party, S3-compatible API. Ideally one for v2 and one for v4. + * + * Further to that test the following: + * - Write-only, bucket-restricted keys + * - Read/write, bucket-restricted keys + * - Buckets with dots + * - Buckets with uppercase letters + * - Buckets with international letters + * - Access from within EC2 + */ + + // Amazon S3, v2 signatures + 'S3, v2, subdomain, single stack' => [ + 'configuration' => array_merge( + $serviceConfigurations['s3-v2'], + [ + 'dualstack' => false, + 'path_access' => false, + ] + ), + 'tests' => $standardTests, + 'skip' => false, + ], + 'S3, v2, subdomain, dual stack' => [ + 'configuration' => array_merge( + $serviceConfigurations['s3-v2'], + [ + 'dualstack' => true, + 'path_access' => false, + ] + ), + 'tests' => $standardTests, + 'skip' => false, + ], + 'S3, v2, path, single stack' => [ + 'configuration' => array_merge( + $serviceConfigurations['s3-v2'], + [ + 'dualstack' => false, + 'path_access' => true, + ] + ), + 'tests' => $standardTests, + 'skip' => false, + ], + 'S3, v2, path, dual stack' => [ + 'configuration' => array_merge( + $serviceConfigurations['s3-v2'], + [ + 'dualstack' => true, + 'path_access' => true, + ] + ), + 'tests' => $standardTests, + 'skip' => false, + ], + + // Amazon S3, v4 signatures + 'S3, v4, subdomain, single stack' => [ + 'configuration' => array_merge( + $serviceConfigurations['s3-v4'], + [ + 'dualstack' => false, + 'path_access' => false, + ] + ), + 'tests' => $standardTests, + 'skip' => false, + ], + 'S3, v4, subdomain, dual stack' => [ + 'configuration' => array_merge( + $serviceConfigurations['s3-v4'], + [ + 'dualstack' => true, + 'path_access' => false, + ] + ), + 'tests' => $standardTests, + 'skip' => false, + ], + 'S3, v4, path, single stack' => [ + 'configuration' => array_merge( + $serviceConfigurations['s3-v4'], + [ + 'dualstack' => false, + 'path_access' => true, + ] + ), + 'tests' => $standardTests, + 'skip' => false, + ], + 'S3, v4, path, dual stack' => [ + 'configuration' => array_merge( + $serviceConfigurations['s3-v4'], + [ + 'dualstack' => true, + 'path_access' => true, + ] + ), + 'tests' => $standardTests, + 'skip' => false, + ], + + // LocalStack + 'LocalStack, V2 (always path access, single stack)' => [ + 'configuration' => $serviceConfigurations['localstack-v2'], + 'tests' => $allTheTests, + 'skip' => false, + ], + + 'LocalStack, V4 (always path access, single stack)' => [ + 'configuration' => $serviceConfigurations['localstack-v4'], + 'tests' => $allTheTests, + 'skip' => false, + ], + + /** + * In the real config file we also have tests running on: + * + * - Wasabi, v2, path-style access. + * - Wasabi, v4, path-style access. + * - Synology C2, subdomain access. + * + * See [[NOTES.md]] for more information. If you have another environment you think we should test with please + * update NOTES.md and make a pull request, along with the reasoning behind it. + * + * There are known failures for some cases, notably LocalStack v4 (something is amiss?) and C2 (necessary flag is + * not yet supported by the minitest framework). + */ +]; \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/minitest.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/minitest.php new file mode 100644 index 0000000000..d465b5d37e --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/minitest.php @@ -0,0 +1,456 @@ +<?php +/** + * Akeeba Engine + * + * @package akeebaengine + * @copyright Copyright (c)2006-2024 Nicholas K. Dionysopoulos / Akeeba Ltd + * @license GNU General Public License version 3, or later + */ + +use Akeeba\S3\Configuration; +use Akeeba\S3\Connector; + +/** + * The Miniature Test Framework For The Akeeba S3 Library + * + * This is a self-contained test-suite runner. Running minitest.php will execute all the tests against all + * configurations set up in the config.php file. When it's decked out with all real world examples this can take many + * hours to complete (it's not as "mini" as its name would like you to believe). + * + * Please read NOTES.md before proceeding and do keep in mind that some tests may fail for reasons outside the control + * of the library such as network conditions, whether PHP has a configured Certification Authority cache etc. + * + * As to why we didn't use Unit Tests: Elementary, dear Watson. Unit Tests are great when testing your code against a + * specification. In this case, the specification would be the Amazon S3 API documentation. Sounds great in theory, but + * not even Amazon itself works according to its own documentation, let alone the third party "S3-compatible" services + * which each one implements its own interpretation of that documentation. Therefore, slow-as-heck integration testing + * is the only way to do any kind of meaningful testing. + */ + +// Necessary for including the library +define('AKEEBAENGINE', 1); + +if (!file_exists(__DIR__ . '/../vendor/autoload.php')) +{ + die ('Please run composer install before running the mini test suite.'); +} + +// Use Composer's autoloader to load the library +/** @var \Composer\Autoload\ClassLoader $autoloader */ +$autoloader = require_once(__DIR__ . '/../vendor/autoload.php'); + +// Add the minitest PSR-4 path map to Composer's autoloader +$autoloader->addPsr4('Akeeba\\MiniTest\\', __DIR__); + +function getAllTestClasses(): array +{ + static $testClasses = []; + + if (!empty($testClasses)) + { + return $testClasses; + } + + $folder = __DIR__ . '/Test'; + $di = new DirectoryIterator($folder); + + foreach ($di as $entry) + { + if ($entry->isDot() || !$entry->isFile()) + { + continue; + } + + $baseName = $entry->getBasename('.php'); + $className = '\\Akeeba\\MiniTest\\Test\\' . $baseName; + + if (!class_exists($className)) + { + continue; + } + + $reflectedClass = new ReflectionClass($className); + + if ($reflectedClass->isAbstract()) + { + continue; + } + + $testClasses[] = $className; + } + + return $testClasses; +} + +function getTestMethods(string $className): array +{ + static $classMethodMap = []; + + if (isset($classMethodMap[$className])) + { + return $classMethodMap[$className]; + } + + $classMethodMap[$className] = []; + + if (!class_exists($className)) + { + return $classMethodMap[$className]; + } + + $reflectedClass = new ReflectionClass($className); + $methods = $reflectedClass->getMethods(ReflectionMethod::IS_PUBLIC | ReflectionMethod::IS_STATIC); + + $classMethodMap[$className] = array_map( + function (ReflectionMethod $refMethod) { + if ($refMethod->isPrivate() || $refMethod->isProtected() || $refMethod->isAbstract()) + { + return null; + } + + if (!$refMethod->isStatic()) + { + return null; + } + + return $refMethod->getName(); + }, $methods + ); + + $classMethodMap[$className] = array_filter( + $classMethodMap[$className], function ($method) { + if (is_null($method)) + { + return false; + } + + if (in_array($method, ['setup', 'teardown'])) + { + return false; + } + + return true; + } + ); + + return $classMethodMap[$className]; +} + +function simplifyClassName(?string $className): string +{ + if (empty($className)) + { + return ''; + } + + $namespace = __NAMESPACE__ . '\\Test\\'; + + if (strpos($className, $namespace) === 0) + { + return substr($className, strlen($namespace)); + } + + return $className; +} + +if (!file_exists(__DIR__ . '/config.php')) +{ + die ('Please rename config.dist.php to config.php and customise it before running the mini test suite.'); +} + +require __DIR__ . '/config.php'; + +global $testConfigurations; + +$total = 0; +$broken = 0; +$failed = 0; +$successful = 0; + +foreach ($testConfigurations as $description => $setup) +{ + echo "▶ " . $description . PHP_EOL; + echo str_repeat('〰', 80) . PHP_EOL . PHP_EOL; + + if ($setup['skip'] ?? false) + { + echo "\t🤡 Skipping\n\n"; + + continue; + } + + // Extract the configuration options + if (!isset($setup['configuration'])) + { + $setup['configuration'] = []; + } + + $configOptions = array_merge( + [ + 'access' => defined('DEFAULT_ACCESS_KEY') ? DEFAULT_ACCESS_KEY : null, + 'secret' => defined('DEFAULT_SECRET_KEY') ? DEFAULT_SECRET_KEY : null, + 'region' => defined('DEFAULT_REGION') ? DEFAULT_REGION : null, + 'bucket' => defined('DEFAULT_BUCKET') ? DEFAULT_BUCKET : null, + 'signature' => defined('DEFAULT_SIGNATURE') ? DEFAULT_SIGNATURE : null, + 'dualstack' => defined('DEFAULT_DUALSTACK') ? DEFAULT_DUALSTACK : null, + 'path_access' => defined('DEFAULT_PATH_ACCESS') ? DEFAULT_PATH_ACCESS : null, + 'ssl' => defined('DEFAULT_SSL') ? DEFAULT_SSL : null, + 'endpoint' => defined('DEFAULT_ENDPOINT') ? constant('DEFAULT_ENDPOINT') : null, + 'alternateDateHeaderFormat' => defined('DEFAULT_ALTERNATE_DATE_FORMAT') ? constant( + 'DEFAULT_ALTERNATE_DATE_FORMAT' + ) : false, + 'useHTTPDateHeader' => defined('DEFAULT_USE_HTTP_HEADER') ? constant('DEFAULT_USE_HTTP_HEADER') + : false, + ], $setup['configuration'] + ); + + // Extract the test classes/methods to run + if (!isset($setup['tests'])) + { + $setup['tests'] = getAllTestClasses(); + } + + $tests = $setup['tests']; + + if (!is_array($tests) || (is_array($tests) && in_array('*', $tests))) + { + $tests = getAllTestClasses(); + } + + // Create the S3 configuration object + $s3Configuration = new Configuration( + $configOptions['access'], $configOptions['secret'], $configOptions['signature'], $configOptions['region'] + ); + $s3Configuration->setRegion($configOptions['region']); + $s3Configuration->setSignatureMethod($configOptions['signature']); + + if (!is_null($configOptions['endpoint'])) + { + $s3Configuration->setEndpoint($configOptions['endpoint']); + // We need to redo this because setting the endpoint may reset these options + $s3Configuration->setRegion($configOptions['region']); + $s3Configuration->setSignatureMethod($configOptions['signature']); + } + + $s3Configuration->setUseDualstackUrl($configOptions['dualstack']); + $s3Configuration->setUseLegacyPathStyle($configOptions['path_access']); + $s3Configuration->setSSL($configOptions['ssl']); + + // Feature flags + if (isset($configOptions['alternateDateHeaderFormat'])) + { + $s3Configuration->setAlternateDateHeaderFormat((bool) $configOptions['alternateDateHeaderFormat']); + } + + if (isset($configOptions['useHTTPDateHeader'])) + { + $s3Configuration->setUseHTTPDateHeader((bool) $configOptions['useHTTPDateHeader']); + } + + if (isset($configOptions['preSignedBucketInURL'])) + { + $s3Configuration->setPreSignedBucketInURL((bool) $configOptions['preSignedBucketInURL']); + } + + // Create the connector object + $s3Connector = new Connector($s3Configuration); + + // Run the tests + foreach ($tests as $testInfo) + { + if (!is_array($testInfo)) + { + $className = $testInfo; + + if (!class_exists($className)) + { + $className = '\\Akeeba\\MiniTest\\Test\\' . $className; + } + + if (!class_exists($className)) + { + $total++; + $broken++; + echo " ⁉️ Test class {$className} not found." . PHP_EOL; + + continue; + } + + $testInfo = array_map( + function ($method) use ($className) { + return [$className, $method]; + }, getTestMethods($className) + ); + } + else + { + [$className, $method] = $testInfo; + + if (!class_exists($className)) + { + $className = '\\Akeeba\\MiniTest\\Test\\' . $className; + } + + if (!class_exists($className)) + { + $total++; + $broken++; + echo " ⁉️ Test class {$className} not found." . PHP_EOL; + + continue; + } + + $testInfo = [ + [$className, $method], + ]; + } + + $firstOne = false; + $className = null; + $callableSetup = null; + $callableTeardown = null; + $simplifiedClassname = simplifyClassName($className); + + if (!empty($testInfo)) + { + $firstOne = array_shift($testInfo); + array_unshift($testInfo, $firstOne); + } + + if ($firstOne) + { + [$className,] = $firstOne; + + if ($className) + { + $callableSetup = [$className, 'setup']; + $callableTeardown = [$className, 'teardown']; + } + } + + if (is_callable($callableSetup)) + { + [$classNameSetup, $method] = $callableSetup; + $simplifiedClassname = simplifyClassName($classNameSetup); + echo " ⏱ Preparing {$simplifiedClassname}:{$method}…"; + call_user_func($callableSetup, $s3Connector, $configOptions); + echo "\r Prepared {$simplifiedClassname} " . PHP_EOL; + } + + foreach ($testInfo as $callable) + { + $total++; + [$className, $method] = $callable; + + if (!class_exists($className)) + { + $broken++; + echo " ⁉️ Test class {$className} not found." . PHP_EOL; + + continue; + } + + if (!method_exists($className, $method)) + { + $broken++; + echo " ⁉️ Method {$method} not found in test class {$className}." . PHP_EOL; + + continue; + } + + echo " ⏱ {$simplifiedClassname}:{$method}…"; + $errorException = null; + + try + { + $result = call_user_func([$className, $method], $s3Connector, $configOptions); + } + catch (Exception $e) + { + $result = false; + $errorException = $e; + } + + echo "\r " . ($result ? '✔' : '🚨') . " {$simplifiedClassname}:{$method} " . PHP_EOL; + + if ($result) + { + $successful++; + continue; + } + + $failed++; + + if (is_null($errorException)) + { + echo " Returned false" . PHP_EOL; + + continue; + } + + echo " {$errorException->getCode()} – {$errorException->getMessage()}" . PHP_EOL; + echo " {$errorException->getFile()}({$errorException->getLine()})" . PHP_EOL . PHP_EOL; + + $errorLines = explode("\n", $errorException->getTraceAsString()); + + foreach ($errorLines as $line) + { + echo " $line" . PHP_EOL; + } + } + + if (is_callable($callableTeardown)) + { + [$className, $method] = $callableSetup; + echo " ⏱ Tearing down {$className}:{$method}…"; + call_user_func($callableTeardown, $s3Connector, $configOptions); + echo "\r Tore down {$className} " . PHP_EOL; + } + } + + echo PHP_EOL; +} + +echo PHP_EOL; +echo str_repeat('⎺', 80) . PHP_EOL; +echo PHP_EOL; + +echo "Summary:" . PHP_EOL; +if ($broken) +{ + echo " Broken : $broken" . PHP_EOL; +} +if ($failed) +{ + echo " Failed : $failed" . PHP_EOL; +} +if ($successful) +{ + echo " Successful : $successful" . PHP_EOL; +} +echo " Total : $total" . PHP_EOL . PHP_EOL; + +echo "Conclusion: " . PHP_EOL . " "; + +if ($failed > 0) +{ + echo "❌ FAILED 😭😭😭" . PHP_EOL; + + exit(1); +} + +if ($successful === 0) +{ + echo "🔥 No tests executed! 🤪" . PHP_EOL; + + exit (3); +} + +if ($broken > 0) +{ + echo "⁉️ SUCCESS but some tests are broken 🤦" . PHP_EOL; + + exit (2); +} + +echo "✅ PASSED" . PHP_EOL; \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Acl.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Acl.php new file mode 100644 index 0000000000..178932a69d --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Acl.php @@ -0,0 +1,31 @@ +<?php +/** + * Akeeba Engine + * + * @package akeebaengine + * @copyright Copyright (c)2006-2024 Nicholas K. Dionysopoulos / Akeeba Ltd + * @license GNU General Public License version 3, or later + */ + +namespace Akeeba\S3; + +// Protection against direct access +defined('AKEEBAENGINE') || die(); + +/** + * Shortcuts to often used access control privileges + */ +class Acl +{ + public const ACL_PRIVATE = 'private'; + + public const ACL_PUBLIC_READ = 'public-read'; + + public const ACL_PUBLIC_READ_WRITE = 'public-read-write'; + + public const ACL_AUTHENTICATED_READ = 'authenticated-read'; + + public const ACL_BUCKET_OWNER_READ = 'bucket-owner-read'; + + public const ACL_BUCKET_OWNER_FULL_CONTROL = 'bucket-owner-full-control'; +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Configuration.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Configuration.php new file mode 100644 index 0000000000..9128ae50c1 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Configuration.php @@ -0,0 +1,447 @@ +<?php +/** + * Akeeba Engine + * + * @package akeebaengine + * @copyright Copyright (c)2006-2024 Nicholas K. Dionysopoulos / Akeeba Ltd + * @license GNU General Public License version 3, or later + */ + +namespace Akeeba\S3; + +// Protection against direct access +defined('AKEEBAENGINE') || die(); + +/** + * Holds the Amazon S3 confiugration credentials + */ +class Configuration +{ + /** + * Access Key + * + * @var string + */ + protected $access = ''; + + /** + * Secret Key + * + * @var string + */ + protected $secret = ''; + + /** + * Security token. This is only required with temporary credentials provisioned by an EC2 instance. + * + * @var string + */ + protected $token = ''; + + /** + * Signature calculation method ('v2' or 'v4') + * + * @var string + */ + protected $signatureMethod = 'v2'; + + /** + * AWS region, used for v4 signatures + * + * @var string + */ + protected $region = 'us-east-1'; + + /** + * Should I use SSL (HTTPS) to communicate to Amazon S3? + * + * @var bool + */ + protected $useSSL = true; + + /** + * Should I use SSL (HTTPS) to communicate to Amazon S3? + * + * @var bool + */ + protected $useDualstackUrl = false; + + /** + * Should I use legacy, path-style access to the bucket? When it's turned off (default) we use virtual hosting style + * paths which are RECOMMENDED BY AMAZON per http://docs.aws.amazon.com/AmazonS3/latest/API/APIRest.html + * + * @var bool + */ + protected $useLegacyPathStyle = false; + + /** + * Amazon S3 endpoint. You can use a custom endpoint with v2 signatures to access third party services which offer + * S3 compatibility, e.g. OwnCloud, Google Storage etc. + * + * @var string + */ + protected $endpoint = 's3.amazonaws.com'; + + /** + * Should I use an alternative date header format (D, d M Y H:i:s T instead of D, d M Y H:i:s O) for non-Amazon, + * S3-compatible services? + * + * This is enabled by default. + * + * @var bool + */ + protected $alternateDateHeaderFormat = true; + + /** + * Should I use the standard HTTP Date header instead of the X-Amz-Date header? + * + * @var bool + */ + protected $useHTTPDateHeader = false; + + /** + * Should pre-signed URLs include the bucket name in the URL? Only applies to v4 signatures. + * + * Amazon S3 and most implementations need this turned off (default). LocalStack seems to not work properly with the + * bucket name as a subdomain, hence the need for this flag. + * + * @var bool + */ + protected $preSignedBucketInURL = false; + + /** + * Public constructor + * + * @param string $access Amazon S3 Access Key + * @param string $secret Amazon S3 Secret Key + * @param string $signatureMethod Signature method (v2 or v4) + * @param string $region Region, only required for v4 signatures + */ + function __construct(string $access, string $secret, string $signatureMethod = 'v2', string $region = '') + { + $this->setAccess($access); + $this->setSecret($secret); + $this->setSignatureMethod($signatureMethod); + $this->setRegion($region); + } + + /** + * Get the Amazon access key + * + * @return string + */ + public function getAccess(): string + { + return $this->access; + } + + /** + * Set the Amazon access key + * + * @param string $access The access key to set + * + * @throws Exception\InvalidAccessKey + */ + public function setAccess(string $access): void + { + if (empty($access)) + { + throw new Exception\InvalidAccessKey; + } + + $this->access = $access; + } + + /** + * Get the Amazon secret key + * + * @return string + */ + public function getSecret(): string + { + return $this->secret; + } + + /** + * Set the Amazon secret key + * + * @param string $secret The secret key to set + * + * @throws Exception\InvalidSecretKey + */ + public function setSecret(string $secret): void + { + if (empty($secret)) + { + throw new Exception\InvalidSecretKey; + } + + $this->secret = $secret; + } + + /** + * Return the security token. Only for temporary credentials provisioned through an EC2 instance. + * + * @return string + */ + public function getToken(): string + { + return $this->token; + } + + /** + * Set the security token. Only for temporary credentials provisioned through an EC2 instance. + * + * @param string $token + */ + public function setToken(string $token): void + { + $this->token = $token; + } + + /** + * Get the signature method to use + * + * @return string + */ + public function getSignatureMethod(): string + { + return $this->signatureMethod; + } + + /** + * Set the signature method to use + * + * @param string $signatureMethod One of v2 or v4 + * + * @throws Exception\InvalidSignatureMethod + */ + public function setSignatureMethod(string $signatureMethod): void + { + $signatureMethod = strtolower($signatureMethod); + $signatureMethod = trim($signatureMethod); + + if (!in_array($signatureMethod, ['v2', 'v4'])) + { + throw new Exception\InvalidSignatureMethod; + } + + $this->signatureMethod = $signatureMethod; + + // If you switch to v2 signatures we unset the region. + if ($signatureMethod == 'v2') + { + $this->setRegion(''); + + /** + * If we are using Amazon S3 proper (not a custom endpoint) we have to set path style access to false. + * Amazon S3 does not support v2 signatures with path style access at all (it returns an error telling + * us to use the virtual hosting endpoint BUCKETNAME.s3.amazonaws.com). + */ + if (strpos($this->endpoint, 'amazonaws.com') !== false) + { + $this->setUseLegacyPathStyle(false); + } + + } + } + + /** + * Get the Amazon S3 region + * + * @return string + */ + public function getRegion(): string + { + return $this->region; + } + + /** + * Set the Amazon S3 region + * + * @param string $region + */ + public function setRegion(string $region): void + { + /** + * You can only leave the region empty if you're using v2 signatures. Anything else gets you an exception. + */ + if (empty($region) && ($this->signatureMethod == 'v4')) + { + throw new Exception\InvalidRegion; + } + + /** + * Setting a Chinese-looking region force-changes the endpoint but ONLY if you were using the original Amazon S3 + * endpoint. If you're using a custom endpoint and provide a region with 'cn-' in its name we don't override + * your custom endpoint. + */ + if (($this->endpoint == 's3.amazonaws.com') && (substr($region, 0, 3) == 'cn-')) + { + $this->setEndpoint('amazonaws.com.cn'); + } + + $this->region = $region; + } + + /** + * Is the connection to be made over HTTPS? + * + * @return bool + */ + public function isSSL(): bool + { + return $this->useSSL; + } + + /** + * Set the connection SSL preference + * + * @param bool $useSSL True to use HTTPS + */ + public function setSSL(bool $useSSL): void + { + $this->useSSL = $useSSL ? true : false; + } + + /** + * Get the Amazon S3 endpoint + * + * @return string + */ + public function getEndpoint(): string + { + return $this->endpoint; + } + + /** + * Set the Amazon S3 endpoint. Do NOT use a protocol + * + * @param string $endpoint Custom endpoint, e.g. 's3.example.com' or 'www.example.com/s3api' + */ + public function setEndpoint(string $endpoint): void + { + if (stristr($endpoint, '://')) + { + throw new Exception\InvalidEndpoint; + } + + /** + * If you set a custom endpoint we have to switch to v2 signatures since our v4 implementation only supports + * Amazon endpoints. + */ + if ((strpos($endpoint, 'amazonaws.com') === false)) + { + $this->setSignatureMethod('v2'); + } + + $this->endpoint = $endpoint; + } + + /** + * Should I use legacy, path-style access to the bucket? You should only use it with custom endpoints. Amazon itself + * is currently deprecating support for path-style access but has extended the migration date to an unknown + * time https://aws.amazon.com/blogs/aws/amazon-s3-path-deprecation-plan-the-rest-of-the-story/ + * + * @return bool + */ + public function getUseLegacyPathStyle(): bool + { + return $this->useLegacyPathStyle; + } + + /** + * Set the flag for using legacy, path-style access to the bucket + * + * @param bool $useLegacyPathStyle + */ + public function setUseLegacyPathStyle(bool $useLegacyPathStyle): void + { + $this->useLegacyPathStyle = $useLegacyPathStyle; + + /** + * If we are using Amazon S3 proper (not a custom endpoint) we have to set path style access to false. + * Amazon S3 does not support v2 signatures with path style access at all (it returns an error telling + * us to use the virtual hosting endpoint BUCKETNAME.s3.amazonaws.com). + */ + if ((strpos($this->endpoint, 'amazonaws.com') !== false) && ($this->signatureMethod == 'v2')) + { + $this->useLegacyPathStyle = false; + } + } + + /** + * Should we use the dualstack URL (which will ship traffic over ipv6 in most cases). For more information on these + * endpoints please read https://docs.aws.amazon.com/AmazonS3/latest/dev/dual-stack-endpoints.html + * + * @return bool + */ + public function getDualstackUrl(): bool + { + return $this->useDualstackUrl; + } + + /** + * Set the flag for using legacy, path-style access to the bucket + * + * @param bool $useDualstackUrl + */ + public function setUseDualstackUrl(bool $useDualstackUrl): void + { + $this->useDualstackUrl = $useDualstackUrl; + } + + /** + * Get the flag for using an alternate date format for non-Amazon, S3-compatible services. + * + * @return bool + */ + public function getAlternateDateHeaderFormat(): bool + { + return $this->alternateDateHeaderFormat; + } + + /** + * Set the flag for using an alternate date format for non-Amazon, S3-compatible services. + * + * @param bool $alternateDateHeaderFormat + * + * @return void + */ + public function setAlternateDateHeaderFormat(bool $alternateDateHeaderFormat): void + { + $this->alternateDateHeaderFormat = $alternateDateHeaderFormat; + } + + /** + * Get the flag indicating whether to use the HTTP Date header + * + * @return bool Flag indicating whether to use the HTTP Date header + */ + public function getUseHTTPDateHeader(): bool + { + return $this->useHTTPDateHeader; + } + + /** + * Set the flag indicating whether to use the HTTP Date header. + * + * @param bool $useHTTPDateHeader Whether to use the HTTP Date header + * + * @return void + */ + public function setUseHTTPDateHeader(bool $useHTTPDateHeader): void + { + $this->useHTTPDateHeader = $useHTTPDateHeader; + } + + public function getPreSignedBucketInURL(): bool + { + return $this->preSignedBucketInURL; + } + + public function setPreSignedBucketInURL(bool $preSignedBucketInURL): void + { + $this->preSignedBucketInURL = $preSignedBucketInURL; + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Connector.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Connector.php new file mode 100644 index 0000000000..e57e710f9a --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Connector.php @@ -0,0 +1,983 @@ +<?php +/** + * Akeeba Engine + * + * @package akeebaengine + * @copyright Copyright (c)2006-2024 Nicholas K. Dionysopoulos / Akeeba Ltd + * @license GNU General Public License version 3, or later + */ + +namespace Akeeba\S3; + +// Protection against direct access +use Akeeba\S3\Exception\CannotDeleteFile; +use Akeeba\S3\Exception\CannotGetBucket; +use Akeeba\S3\Exception\CannotGetFile; +use Akeeba\S3\Exception\CannotListBuckets; +use Akeeba\S3\Exception\CannotOpenFileForWrite; +use Akeeba\S3\Exception\CannotPutFile; +use Akeeba\S3\Response\Error; + +defined('AKEEBAENGINE') || die(); + +class Connector +{ + /** + * Amazon S3 configuration object + * + * @var Configuration + */ + private $configuration = null; + + /** + * Connector constructor. + * + * @param Configuration $configuration The configuration object to use + */ + public function __construct(Configuration $configuration) + { + $this->configuration = $configuration; + } + + /** + * Put an object to Amazon S3, i.e. upload a file. If the object already exists it will be overwritten. + * + * @param Input $input Input object + * @param string $bucket Bucket name. If you're using v4 signatures it MUST be on the region defined. + * @param string $uri Object URI. Think of it as the absolute path of the file in the bucket. + * @param string $acl ACL constant, by default the object is private (visible only to the uploading + * user) + * @param array $requestHeaders Array of request headers + * + * @return void + * + * @throws CannotPutFile If the upload is not possible + */ + public function putObject(Input $input, string $bucket, string $uri, string $acl = Acl::ACL_PRIVATE, array $requestHeaders = []): void + { + $request = new Request('PUT', $bucket, $uri, $this->configuration); + $request->setInput($input); + + // Custom request headers (Content-Type, Content-Disposition, Content-Encoding) + if (count($requestHeaders)) + { + foreach ($requestHeaders as $h => $v) + { + if (strtolower(substr($h, 0, 6)) == 'x-amz-') + { + $request->setAmzHeader(strtolower($h), $v); + } + else + { + $request->setHeader($h, $v); + } + } + } + + if (isset($requestHeaders['Content-Type'])) + { + $input->setType($requestHeaders['Content-Type']); + } + + if (($input->getSize() <= 0) || (($input->getInputType() == Input::INPUT_DATA) && (!strlen($input->getDataReference())))) + { + if (substr($uri, -1) !== '/') + { + throw new CannotPutFile('Missing input parameters', 0); + } + } + + // We need to post with Content-Length and Content-Type, MD5 is optional + $request->setHeader('Content-Type', $input->getType()); + $request->setHeader('Content-Length', $input->getSize()); + + if ($input->getMd5sum()) + { + $request->setHeader('Content-MD5', $input->getMd5sum()); + } + + $request->setAmzHeader('x-amz-acl', $acl); + + $response = $request->getResponse(); + + if ($response->code !== 200) + { + if (!$response->error->isError()) + { + throw new CannotPutFile("Unexpected HTTP status {$response->code}", $response->code); + } + + if (is_object($response->body) && ($response->body instanceof \SimpleXMLElement) && (strpos($input->getSize(), ',') === false)) + { + // For some reason, trying to single part upload files on some hosts comes back with an inexplicable + // error from Amazon that we need to set Content-Length:5242880,5242880 instead of + // Content-Length:5242880 which is AGAINST Amazon's documentation. In this case we pass the header + // 'workaround-braindead-error-from-amazon' and retry. Uh, OK? + if (isset($response->body->CanonicalRequest)) + { + $amazonsCanonicalRequest = (string) $response->body->CanonicalRequest; + $lines = explode("\n", $amazonsCanonicalRequest); + + foreach ($lines as $line) + { + if (substr($line, 0, 15) != 'content-length:') + { + continue; + } + + [$junk, $stupidAmazonDefinedContentLength] = explode(":", $line); + + if (strpos($stupidAmazonDefinedContentLength, ',') !== false) + { + if (!isset($requestHeaders['workaround-braindead-error-from-amazon'])) + { + $requestHeaders['workaround-braindead-error-from-amazon'] = 'you can\'t fix stupid'; + + $this->putObject($input, $bucket, $uri, $acl, $requestHeaders); + + return; + } + } + } + } + } + } + + + if ($response->error->isError()) + { + throw new CannotPutFile( + sprintf(__METHOD__ . "(): [%s] %s\n\nDebug info:\n%s", $response->error->getCode(), $response->error->getMessage(), print_r($response->body, true)) + ); + } + } + + /** + * Get (download) an object + * + * @param string $bucket Bucket name + * @param string $uri Object URI + * @param string|resource|null $saveTo Filename or resource to write to + * @param int|null $from Start of the download range, null to download the entire object + * @param int|null $to End of the download range, null to download the entire object + * + * @return string|null No return if $saveTo is specified; data as string otherwise + * + */ + public function getObject(string $bucket, string $uri, $saveTo = null, ?int $from = null, ?int $to = null): ?string + { + $request = new Request('GET', $bucket, $uri, $this->configuration); + + $fp = null; + + if (!is_resource($saveTo) && is_string($saveTo)) + { + $fp = @fopen($saveTo, 'w'); + + if ($fp === false) + { + throw new CannotOpenFileForWrite($saveTo); + } + } + + if (is_resource($saveTo)) + { + $fp = $saveTo; + } + + if (is_resource($fp)) + { + $request->setFp($fp); + } + + // Set the range header + if ((!empty($from) && !empty($to)) || (!is_null($from) && !empty($to))) + { + $request->setHeader('Range', "bytes=$from-$to"); + } + + $response = $request->getResponse(true); + + if (!$response->error->isError() && (($response->code !== 200) && ($response->code !== 206))) + { + $response->error = new Error( + $response->code, + "Unexpected HTTP status {$response->code}" + ); + } + + if ($response->error->isError()) + { + throw new CannotGetFile( + sprintf( + __METHOD__ . "({%s}, {%s}): [%s] %s\n\nDebug info:\n%s", + $bucket, + $uri, + $response->error->getCode(), + $response->error->getMessage(), + print_r($response->body, true) + ) + ); + } + + if (!is_resource($fp)) + { + return $response->body; + } + + return null; + } + + /** + * Get information about an object. + * + * @param string $bucket Bucket name + * @param string $uri Object URI + * + * @return array The headers returned by Amazon S3 + * + * @throws CannotGetFile If the file does not exist + * @see https://docs.aws.amazon.com/AmazonS3/latest/API/API_HeadObject.html + */ + public function headObject(string $bucket, string $uri): array + { + $request = new Request('HEAD', $bucket, $uri, $this->configuration); + + $response = $request->getResponse(); + + if (!$response->error->isError() && (($response->code !== 200) && ($response->code !== 206))) + { + $response->error = new Error( + $response->code, + "Unexpected HTTP status {$response->code}" + ); + } + + if ($response->error->isError()) + { + throw new CannotGetFile( + sprintf( + __METHOD__ . "({%s}, {%s}): [%s] %s\n\nDebug info:\n%s", + $bucket, + $uri, + $response->error->getCode(), + $response->error->getMessage(), + print_r($response->body, true) + ) + ); + } + + return $response->getHeaders(); + } + + + /** + * Delete an object + * + * @param string $bucket Bucket name + * @param string $uri Object URI + * + * @return void + */ + public function deleteObject(string $bucket, string $uri): void + { + $request = new Request('DELETE', $bucket, $uri, $this->configuration); + $response = $request->getResponse(); + + if (!$response->error->isError() && ($response->code !== 204)) + { + $response->error = new Error( + $response->code, + "Unexpected HTTP status {$response->code}" + ); + } + + if ($response->error->isError()) + { + throw new CannotDeleteFile( + sprintf( + __METHOD__ . "({%s}, {%s}): [%s] %s", + $bucket, + $uri, + $response->error->getCode(), + $response->error->getMessage() + ) + ); + } + } + + /** + * Get a query string authenticated URL + * + * @param string $bucket Bucket name + * @param string $uri Object URI + * @param int|null $lifetime Lifetime in seconds + * @param bool $https Use HTTPS ($hostBucket should be false for SSL verification)? + * + * @return string + */ + public function getAuthenticatedURL(string $bucket, string $uri, ?int $lifetime = null, bool $https = false): string + { + // Get a request from the URI and bucket + $questionmarkPos = strpos($uri, '?'); + $query = ''; + + if ($questionmarkPos !== false) + { + $query = substr($uri, $questionmarkPos + 1); + $uri = substr($uri, 0, $questionmarkPos); + } + + + /** + * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + * !!!! DO NOT TOUCH THIS CODE. YOU WILL BREAK PRE-SIGNED URLS WITH v4 SIGNATURES. !!!! + * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + * + * The following two lines seem weird and possibly extraneous at first glance. However, they are VERY important. + * If you remove them pre-signed URLs for v4 signatures will break! That's because pre-signed URLs with v4 + * signatures follow different rules than with v2 signatures. + * + * Authenticated (pre-signed) URLs are always made against the generic S3 region endpoint, not the bucket's + * virtual-hosting-style domain name. The bucket is always the first component of the path. + * + * For example, given a bucket called foobar, and an object baz.txt in it, we are pre-signing the URL + * https://s3-eu-west-1.amazonaws.com/foobar/baz.txt, not + * https://foobar.s3-eu-west-1.amazonaws.com/foobar/baz.txt (as we'd be doing with v2 signatures). + * + * The problem is that the Request object needs to be created before we can convey the intent (regular request + * or generation of a pre-signed URL). As a result its constructor creates the (immutable) request URI solely + * based on whether the Configuration object's getUseLegacyPathStyle() returns false or not. + * + * Since we want to request URI to contain the bucket name we need to tell the Request object's constructor that + * we are creating a Request object for path-style access, i.e. the useLegacyPathStyle flag in the Configuration + * object is true. Naturally, the default behavior being virtual-hosting-style access to buckets, this flag is + * most likely **false**. + * + * Therefore, we need to clone the Configuration object, set the flag to true and create a Request object using + * the falsified Configuration object. + * + * Note that v2 signatures are not affected. In v2 we are always appending the bucket name to the path, despite + * the fact that we include the bucket name in the domain name. + * + * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + * !!!! DO NOT TOUCH THIS CODE. YOU WILL BREAK PRE-SIGNED URLS WITH v4 SIGNATURES. !!!! + * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + */ + $newConfig = clone $this->configuration; + $newConfig->setUseLegacyPathStyle(true); + + // Create the request object. + $request = new Request('GET', $bucket, $uri, $newConfig); + + if ($query) + { + parse_str($query, $parameters); + + if (count($parameters)) + { + foreach ($parameters as $k => $v) + { + $request->setParameter($k, $v); + } + } + } + + // Get the signed URI from the Request object + return $request->getAuthenticatedURL($lifetime, $https); + } + + /** + * Get the location (region) of a bucket. You need this to use the V4 API on that bucket! + * + * @param string $bucket Bucket name + * + * @return string + */ + public function getBucketLocation(string $bucket): string + { + $request = new Request('GET', $bucket, '', $this->configuration); + $request->setParameter('location', null); + + $response = $request->getResponse(); + + if (!$response->error->isError() && $response->code !== 200) + { + $response->error = new Error( + $response->code, + "Unexpected HTTP status {$response->code}" + ); + } + + if ($response->error->isError()) + { + throw new CannotGetBucket( + sprintf(__METHOD__ . "(): [%s] %s", $response->error->getCode(), $response->error->getMessage()) + ); + } + + $result = 'us-east-1'; + + if ($response->hasBody()) + { + $result = (string) $response->body; + } + + switch ($result) + { + // "EU" is an alias for 'eu-west-1', however the canonical location name you MUST use is 'eu-west-1' + case 'EU': + case 'eu': + $result = 'eu-west-1'; + break; + + // If the bucket location is 'us-east-1' you get an empty string. @#$%^&*()!! + case '': + $result = 'us-east-1'; + break; + } + + return $result; + } + + /** + * Get the contents of a bucket + * + * If maxKeys is null this method will loop through truncated result sets + * + * @param string $bucket Bucket name + * @param string|null $prefix Prefix (directory) + * @param string|null $marker Marker (last file listed) + * @param int|null $maxKeys Maximum number of keys ("files" and "directories") to return + * @param string $delimiter Delimiter, typically "/" + * @param bool $returnCommonPrefixes Set to true to return CommonPrefixes + * + * @return array + */ + public function getBucket(string $bucket, ?string $prefix = null, ?string $marker = null, ?int $maxKeys = null, string $delimiter = '/', bool $returnCommonPrefixes = false): array + { + $internalResult = $this->internalGetBucket($bucket, $prefix, $marker, $maxKeys, $delimiter, $returnCommonPrefixes); + + /** + * @var array $objects + * @var ?string $nextMarker + */ + extract($internalResult); + unset($internalResult); + + // Loop through truncated results if maxKeys isn't specified or we don't have enough object records yet. + if ($nextMarker !== null && ($maxKeys === null || count($objects) < $maxKeys)) + { + do + { + $internalResult = $this->internalGetBucket($bucket, $prefix, $nextMarker, $maxKeys, $delimiter, $returnCommonPrefixes); + + $nextMarker = $internalResult['nextMarker']; + $objects = array_merge($objects, $internalResult['objects']); + + unset($internalResult); + + // If the last call did not return a nextMarker I am done iterating. + if ($nextMarker === null) + { + break; + } + + // If we have maxKeys AND the number of objects is at least this many I am done iterating. + if ($maxKeys !== null && count($objects) >= $maxKeys) + { + break; + } + } while (true); + } + + if ($maxKeys !== null) + { + return array_splice($objects, 0, $maxKeys); + } + + return $objects; + } + + /** + * Get a list of buckets + * + * @param bool $detailed Returns detailed bucket list when true + * + * @return array + */ + public function listBuckets(bool $detailed = false): array + { + // When listing buckets with the AWSv4 signature method we MUST set the region to us-east-1. Don't ask... + $configuration = clone $this->configuration; + $configuration->setRegion('us-east-1'); + + $request = new Request('GET', '', '', $configuration); + $response = $request->getResponse(); + + if (!$response->error->isError() && (($response->code !== 200))) + { + $response->error = new Error( + $response->code, + "Unexpected HTTP status {$response->code}" + ); + } + + if ($response->error->isError()) + { + throw new CannotListBuckets( + sprintf(__METHOD__ . "(): [%s] %s", $response->error->getCode(), $response->error->getMessage()) + ); + } + + $results = []; + + if (!isset($response->body->Buckets)) + { + return $results; + } + + if ($detailed) + { + if (isset($response->body->Owner, $response->body->Owner->ID, $response->body->Owner->DisplayName)) + { + $results['owner'] = [ + 'id' => (string) $response->body->Owner->ID, + 'name' => (string) $response->body->Owner->DisplayName, + ]; + } + + $results['buckets'] = []; + + foreach ($response->body->Buckets->Bucket as $b) + { + $results['buckets'][] = [ + 'name' => (string) $b->Name, + 'time' => strtotime((string) $b->CreationDate), + ]; + } + } + else + { + foreach ($response->body->Buckets->Bucket as $b) + { + $results[] = (string) $b->Name; + } + } + + return $results; + } + + /** + * Start a multipart upload of an object + * + * @param Input $input Input data + * @param string $bucket Bucket name + * @param string $uri Object URI + * @param string $acl ACL constant + * @param array $requestHeaders Array of request headers + * + * @return string The upload session ID (UploadId) + */ + public function startMultipart(Input $input, string $bucket, string $uri, string $acl = Acl::ACL_PRIVATE, array $requestHeaders = []): string + { + $request = new Request('POST', $bucket, $uri, $this->configuration); + $request->setParameter('uploads', ''); + + // Custom request headers (Content-Type, Content-Disposition, Content-Encoding) + if (is_array($requestHeaders)) + { + foreach ($requestHeaders as $h => $v) + { + if (strtolower(substr($h, 0, 6)) == 'x-amz-') + { + $request->setAmzHeader(strtolower($h), $v); + } + else + { + $request->setHeader($h, $v); + } + } + } + + $request->setAmzHeader('x-amz-acl', $acl); + + if (isset($requestHeaders['Content-Type'])) + { + $input->setType($requestHeaders['Content-Type']); + } + + $request->setHeader('Content-Type', $input->getType()); + + $response = $request->getResponse(); + + if (!$response->error->isError() && ($response->code !== 200)) + { + $response->error = new Error( + $response->code, + "Unexpected HTTP status {$response->code}" + ); + } + + if ($response->error->isError()) + { + throw new CannotPutFile( + sprintf( + __METHOD__ . "(): [%s] %s\n\nDebug info:\n%s", + $response->error->getCode(), + $response->error->getMessage(), + print_r($response->body, true) + ) + ); + } + + return (string) $response->body->UploadId; + } + + /** + * Uploads a part of a multipart object upload + * + * @param Input $input Input data. You MUST specify the UploadID and PartNumber + * @param string $bucket Bucket name + * @param string $uri Object URI + * @param array $requestHeaders Array of request headers or content type as a string + * @param int $chunkSize Size of each upload chunk, in bytes. It cannot be less than 5242880 bytes (5Mb) + * + * @return null|string The ETag of the upload part of null if we have ran out of parts to upload + */ + public function uploadMultipart(Input $input, string $bucket, string $uri, array $requestHeaders = [], int $chunkSize = 5242880): ?string + { + if ($chunkSize < 5242880) + { + $chunkSize = 5242880; + } + + // We need a valid UploadID and PartNumber + $UploadID = $input->getUploadID(); + $PartNumber = $input->getPartNumber(); + + if (empty($UploadID)) + { + throw new CannotPutFile( + __METHOD__ . '(): No UploadID specified' + ); + } + + if (empty($PartNumber)) + { + throw new CannotPutFile( + __METHOD__ . '(): No PartNumber specified' + ); + } + + $UploadID = urlencode($UploadID); + $PartNumber = (int) $PartNumber; + + $request = new Request('PUT', $bucket, $uri, $this->configuration); + $request->setParameter('partNumber', $PartNumber); + $request->setParameter('uploadId', $UploadID); + $request->setInput($input); + + // Full data length + $totalSize = $input->getSize(); + + // No Content-Type for multipart uploads + $input->setType(null); + + // Calculate part offset + $partOffset = $chunkSize * ($PartNumber - 1); + + if ($partOffset > $totalSize) + { + // This is to signify that we ran out of parts ;) + return null; + } + + // How many parts are there? + $totalParts = floor($totalSize / $chunkSize); + + if ($totalParts * $chunkSize < $totalSize) + { + $totalParts++; + } + + // Calculate Content-Length + $size = $chunkSize; + + if ($PartNumber >= $totalParts) + { + $size = $totalSize - ($PartNumber - 1) * $chunkSize; + } + + if ($size <= 0) + { + // This is to signify that we ran out of parts ;) + return null; + } + + $input->setSize($size); + + switch ($input->getInputType()) + { + case Input::INPUT_DATA: + $input->setData(substr($input->getData(), ($PartNumber - 1) * $chunkSize, $input->getSize())); + break; + + case Input::INPUT_FILE: + case Input::INPUT_RESOURCE: + $fp = $input->getFp(); + fseek($fp, ($PartNumber - 1) * $chunkSize); + break; + } + + // Custom request headers (Content-Type, Content-Disposition, Content-Encoding) + if (is_array($requestHeaders)) + { + foreach ($requestHeaders as $h => $v) + { + if (strtolower(substr($h, 0, 6)) == 'x-amz-') + { + $request->setAmzHeader(strtolower($h), $v); + } + else + { + $request->setHeader($h, $v); + } + } + } + + $request->setHeader('Content-Length', $input->getSize()); + + if ($input->getInputType() === Input::INPUT_DATA) + { + $request->setHeader('Content-Type', "application/x-www-form-urlencoded"); + } + + $response = $request->getResponse(); + + if ($response->code !== 200) + { + if (!$response->error->isError()) + { + $response->error = new Error( + $response->code, + "Unexpected HTTP status {$response->code}" + ); + } + + if (is_object($response->body) && ($response->body instanceof \SimpleXMLElement) && (strpos($input->getSize(), ',') === false)) + { + // For some moronic reason, trying to multipart upload files on some hosts comes back with a crazy + // error from Amazon that we need to set Content-Length:5242880,5242880 instead of + // Content-Length:5242880 which is AGAINST Amazon's documentation. In this case we pass the header + // 'workaround-broken-content-length' and retry. Whatever. + if (isset($response->body->CanonicalRequest)) + { + $amazonsCanonicalRequest = (string) $response->body->CanonicalRequest; + $lines = explode("\n", $amazonsCanonicalRequest); + + foreach ($lines as $line) + { + if (substr($line, 0, 15) != 'content-length:') + { + continue; + } + + [$junk, $stupidAmazonDefinedContentLength] = explode(":", $line); + + if (strpos($stupidAmazonDefinedContentLength, ',') !== false) + { + if (!isset($requestHeaders['workaround-broken-content-length'])) + { + $requestHeaders['workaround-broken-content-length'] = true; + + // This is required to reset the input size to its default value. If you don't do that + // only one part will ever be uploaded. Oops! + $input->setSize(-1); + + return $this->uploadMultipart($input, $bucket, $uri, $requestHeaders, $chunkSize); + } + } + } + } + + } + + throw new CannotPutFile( + sprintf(__METHOD__ . "(): [%s] %s\n\nDebug info:\n%s", $response->error->getCode(), $response->error->getMessage(), print_r($response->body, true)) + ); + } + + // Return the ETag header + return $response->headers['hash']; + } + + /** + * Finalizes the multi-part upload. The $input object should contain two keys, etags an array of ETags of the + * uploaded parts and UploadID the multipart upload ID. + * + * @param Input $input The array of input elements + * @param string $bucket The bucket where the object is being stored + * @param string $uri The key (path) to the object + * + * @return void + */ + public function finalizeMultipart(Input $input, string $bucket, string $uri): void + { + $etags = $input->getEtags(); + $UploadID = $input->getUploadID(); + + if (empty($etags)) + { + throw new CannotPutFile( + __METHOD__ . '(): No ETags array specified' + ); + } + + if (empty($UploadID)) + { + throw new CannotPutFile( + __METHOD__ . '(): No UploadID specified' + ); + } + + // Create the message + $message = "<CompleteMultipartUpload>\n"; + $part = 0; + + foreach ($etags as $etag) + { + $part++; + $message .= "\t<Part>\n\t\t<PartNumber>$part</PartNumber>\n\t\t<ETag>\"$etag\"</ETag>\n\t</Part>\n"; + } + + $message .= "</CompleteMultipartUpload>"; + + // Get a request query + $reqInput = Input::createFromData($message); + + $request = new Request('POST', $bucket, $uri, $this->configuration); + $request->setParameter('uploadId', $UploadID); + $request->setInput($reqInput); + + // Do post + $request->setHeader('Content-Type', 'application/xml'); // Even though the Amazon API doc doesn't mention it, it's required... :( + $response = $request->getResponse(); + + if (!$response->error->isError() && ($response->code != 200)) + { + $response->error = new Error( + $response->code, + "Unexpected HTTP status {$response->code}" + ); + } + + if ($response->error->isError()) + { + if ($response->error->getCode() == 'RequestTimeout') + { + return; + } + + throw new CannotPutFile( + sprintf(__METHOD__ . "(): [%s] %s\n\nDebug info:\n%s", $response->error->getCode(), $response->error->getMessage(), print_r($response->body, true)) + ); + } + } + + /** + * Returns the configuration object + * + * @return Configuration + */ + public function getConfiguration(): Configuration + { + return $this->configuration; + } + + private function internalGetBucket(string $bucket, ?string $prefix = null, ?string $marker = null, ?int $maxKeys = null, string $delimiter = '/', bool $returnCommonPrefixes = false): array + { + $request = new Request('GET', $bucket, '', $this->configuration); + + if (!empty($prefix)) + { + $request->setParameter('prefix', $prefix); + } + + if (!empty($marker)) + { + $request->setParameter('marker', $marker); + } + + if (!empty($maxKeys)) + { + $request->setParameter('max-keys', $maxKeys); + } + + if (!empty($delimiter)) + { + $request->setParameter('delimiter', $delimiter); + } + + $response = $request->getResponse(); + + if (!$response->error->isError() && $response->code !== 200) + { + $response->error = new Error( + $response->code, + "Unexpected HTTP status {$response->code}" + ); + } + + if ($response->error->isError()) + { + throw new CannotGetBucket( + sprintf(__METHOD__ . "(): [%s] %s", $response->error->getCode(), $response->error->getMessage()) + ); + } + + $results = [ + 'objects' => [], + 'nextMarker' => null, + ]; + + if ($response->hasBody() && isset($response->body->Contents)) + { + foreach ($response->body->Contents as $c) + { + $results['objects'][(string) $c->Key] = [ + 'name' => (string) $c->Key, + 'time' => strtotime((string) $c->LastModified), + 'size' => (int) $c->Size, + 'hash' => substr((string) $c->ETag, 1, -1), + ]; + + $results['nextMarker'] = (string) $c->Key; + } + } + + if ($returnCommonPrefixes && $response->hasBody() && isset($response->body->CommonPrefixes)) + { + foreach ($response->body->CommonPrefixes as $c) + { + $results['objects'][(string) $c->Prefix] = ['prefix' => (string) $c->Prefix]; + } + } + + if ($response->hasBody() && isset($response->body->IsTruncated) && + ((string) $response->body->IsTruncated == 'false') + ) + { + $results['nextMarker'] = null; + + return $results; + } + + if ($response->hasBody() && isset($response->body->NextMarker)) + { + $results['nextMarker'] = (string) $response->body->NextMarker; + } + + return $results; + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Exception/CannotDeleteFile.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Exception/CannotDeleteFile.php new file mode 100644 index 0000000000..7bb4703518 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Exception/CannotDeleteFile.php @@ -0,0 +1,19 @@ +<?php +/** + * Akeeba Engine + * + * @package akeebaengine + * @copyright Copyright (c)2006-2024 Nicholas K. Dionysopoulos / Akeeba Ltd + * @license GNU General Public License version 3, or later + */ + +namespace Akeeba\S3\Exception; + +// Protection against direct access +defined('AKEEBAENGINE') || die(); + +use RuntimeException; + +class CannotDeleteFile extends RuntimeException +{ +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Exception/CannotGetBucket.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Exception/CannotGetBucket.php new file mode 100644 index 0000000000..0910fb61b5 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Exception/CannotGetBucket.php @@ -0,0 +1,19 @@ +<?php +/** + * Akeeba Engine + * + * @package akeebaengine + * @copyright Copyright (c)2006-2024 Nicholas K. Dionysopoulos / Akeeba Ltd + * @license GNU General Public License version 3, or later + */ + +namespace Akeeba\S3\Exception; + +// Protection against direct access +defined('AKEEBAENGINE') || die(); + +use RuntimeException; + +class CannotGetBucket extends RuntimeException +{ +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Exception/CannotGetFile.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Exception/CannotGetFile.php new file mode 100644 index 0000000000..3582cea1d7 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Exception/CannotGetFile.php @@ -0,0 +1,19 @@ +<?php +/** + * Akeeba Engine + * + * @package akeebaengine + * @copyright Copyright (c)2006-2024 Nicholas K. Dionysopoulos / Akeeba Ltd + * @license GNU General Public License version 3, or later + */ + +namespace Akeeba\S3\Exception; + +// Protection against direct access +defined('AKEEBAENGINE') || die(); + +use RuntimeException; + +class CannotGetFile extends RuntimeException +{ +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Exception/CannotListBuckets.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Exception/CannotListBuckets.php new file mode 100644 index 0000000000..86799275f3 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Exception/CannotListBuckets.php @@ -0,0 +1,19 @@ +<?php +/** + * Akeeba Engine + * + * @package akeebaengine + * @copyright Copyright (c)2006-2024 Nicholas K. Dionysopoulos / Akeeba Ltd + * @license GNU General Public License version 3, or later + */ + +namespace Akeeba\S3\Exception; + +// Protection against direct access +defined('AKEEBAENGINE') || die(); + +use RuntimeException; + +class CannotListBuckets extends RuntimeException +{ +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Exception/CannotOpenFileForRead.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Exception/CannotOpenFileForRead.php new file mode 100644 index 0000000000..ea8c729e53 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Exception/CannotOpenFileForRead.php @@ -0,0 +1,27 @@ +<?php +/** + * Akeeba Engine + * + * @package akeebaengine + * @copyright Copyright (c)2006-2024 Nicholas K. Dionysopoulos / Akeeba Ltd + * @license GNU General Public License version 3, or later + */ + +namespace Akeeba\S3\Exception; + +// Protection against direct access +defined('AKEEBAENGINE') || die(); + +use Exception; +use RuntimeException; + +class CannotOpenFileForRead extends RuntimeException +{ + public function __construct(string $file = "", int $code = 0, Exception $previous = null) + { + $message = "Cannot open $file for reading"; + + parent::__construct($message, $code, $previous); + } + +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Exception/CannotOpenFileForWrite.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Exception/CannotOpenFileForWrite.php new file mode 100644 index 0000000000..9a7fcde93f --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Exception/CannotOpenFileForWrite.php @@ -0,0 +1,27 @@ +<?php +/** + * Akeeba Engine + * + * @package akeebaengine + * @copyright Copyright (c)2006-2024 Nicholas K. Dionysopoulos / Akeeba Ltd + * @license GNU General Public License version 3, or later + */ + +namespace Akeeba\S3\Exception; + +// Protection against direct access +defined('AKEEBAENGINE') || die(); + +use Exception; +use RuntimeException; + +class CannotOpenFileForWrite extends RuntimeException +{ + public function __construct(string $file = "", int $code = 0, Exception $previous = null) + { + $message = "Cannot open $file for writing"; + + parent::__construct($message, $code, $previous); + } + +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Exception/CannotPutFile.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Exception/CannotPutFile.php new file mode 100644 index 0000000000..2656eeae4e --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Exception/CannotPutFile.php @@ -0,0 +1,19 @@ +<?php +/** + * Akeeba Engine + * + * @package akeebaengine + * @copyright Copyright (c)2006-2024 Nicholas K. Dionysopoulos / Akeeba Ltd + * @license GNU General Public License version 3, or later + */ + +namespace Akeeba\S3\Exception; + +// Protection against direct access +defined('AKEEBAENGINE') || die(); + +use RuntimeException; + +class CannotPutFile extends RuntimeException +{ +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Exception/ConfigurationError.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Exception/ConfigurationError.php new file mode 100644 index 0000000000..f478968759 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Exception/ConfigurationError.php @@ -0,0 +1,23 @@ +<?php +/** + * Akeeba Engine + * + * @package akeebaengine + * @copyright Copyright (c)2006-2024 Nicholas K. Dionysopoulos / Akeeba Ltd + * @license GNU General Public License version 3, or later + */ + +namespace Akeeba\S3\Exception; + +// Protection against direct access +defined('AKEEBAENGINE') || die(); + +use RuntimeException; + +/** + * Configuration error + */ +abstract class ConfigurationError extends RuntimeException +{ + +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Exception/InvalidAccessKey.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Exception/InvalidAccessKey.php new file mode 100644 index 0000000000..d8e7afe7f9 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Exception/InvalidAccessKey.php @@ -0,0 +1,32 @@ +<?php +/** + * Akeeba Engine + * + * @package akeebaengine + * @copyright Copyright (c)2006-2024 Nicholas K. Dionysopoulos / Akeeba Ltd + * @license GNU General Public License version 3, or later + */ + +namespace Akeeba\S3\Exception; + +// Protection against direct access +defined('AKEEBAENGINE') || die(); + +use Exception; + +/** + * Invalid Amazon S3 access key + */ +class InvalidAccessKey extends ConfigurationError +{ + public function __construct(string $message = "", int $code = 0, Exception $previous = null) + { + if (empty($message)) + { + $message = 'The Amazon S3 Access Key provided is invalid'; + } + + parent::__construct($message, $code, $previous); + } + +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Exception/InvalidBody.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Exception/InvalidBody.php new file mode 100644 index 0000000000..4971a468e4 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Exception/InvalidBody.php @@ -0,0 +1,33 @@ +<?php +/** + * Akeeba Engine + * + * @package akeebaengine + * @copyright Copyright (c)2006-2024 Nicholas K. Dionysopoulos / Akeeba Ltd + * @license GNU General Public License version 3, or later + */ + +namespace Akeeba\S3\Exception; + +// Protection against direct access +defined('AKEEBAENGINE') || die(); + +use Exception; +use RuntimeException; + +/** + * Invalid response body type + */ +class InvalidBody extends RuntimeException +{ + public function __construct(string $message = "", int $code = 0, Exception $previous = null) + { + if (empty($message)) + { + $message = 'Invalid response body type'; + } + + parent::__construct($message, $code, $previous); + } + +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Exception/InvalidEndpoint.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Exception/InvalidEndpoint.php new file mode 100644 index 0000000000..0ef7a3fee6 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Exception/InvalidEndpoint.php @@ -0,0 +1,32 @@ +<?php +/** + * Akeeba Engine + * + * @package akeebaengine + * @copyright Copyright (c)2006-2024 Nicholas K. Dionysopoulos / Akeeba Ltd + * @license GNU General Public License version 3, or later + */ + +namespace Akeeba\S3\Exception; + +// Protection against direct access +defined('AKEEBAENGINE') || die(); + +use Exception; + +/** + * Invalid Amazon S3 endpoint + */ +class InvalidEndpoint extends ConfigurationError +{ + public function __construct(string $message = "", int $code = 0, Exception $previous = null) + { + if (empty($message)) + { + $message = 'The custom S3 endpoint provided is invalid. Do NOT include the protocol (http:// or https://). Valid examples are s3.example.com and www.example.com/s3Api'; + } + + parent::__construct($message, $code, $previous); + } + +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Exception/InvalidFilePointer.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Exception/InvalidFilePointer.php new file mode 100644 index 0000000000..4b6bc1c46c --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Exception/InvalidFilePointer.php @@ -0,0 +1,30 @@ +<?php +/** + * Akeeba Engine + * + * @package akeebaengine + * @copyright Copyright (c)2006-2024 Nicholas K. Dionysopoulos / Akeeba Ltd + * @license GNU General Public License version 3, or later + */ + +namespace Akeeba\S3\Exception; + +// Protection against direct access +defined('AKEEBAENGINE') || die(); + +use Exception; +use InvalidArgumentException; + +class InvalidFilePointer extends InvalidArgumentException +{ + public function __construct(string $message = "", int $code = 0, Exception $previous = null) + { + if (empty($message)) + { + $message = 'The specified file pointer is not a valid stream resource'; + } + + parent::__construct($message, $code, $previous); + } + +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Exception/InvalidRegion.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Exception/InvalidRegion.php new file mode 100644 index 0000000000..6fd7a9eb25 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Exception/InvalidRegion.php @@ -0,0 +1,32 @@ +<?php +/** + * Akeeba Engine + * + * @package akeebaengine + * @copyright Copyright (c)2006-2024 Nicholas K. Dionysopoulos / Akeeba Ltd + * @license GNU General Public License version 3, or later + */ + +namespace Akeeba\S3\Exception; + +// Protection against direct access +defined('AKEEBAENGINE') || die(); + +use Exception; + +/** + * Invalid Amazon S3 region + */ +class InvalidRegion extends ConfigurationError +{ + public function __construct(string $message = "", int $code = 0, Exception $previous = null) + { + if (empty($message)) + { + $message = 'The Amazon S3 region provided is invalid.'; + } + + parent::__construct($message, $code, $previous); + } + +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Exception/InvalidSecretKey.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Exception/InvalidSecretKey.php new file mode 100644 index 0000000000..31e964efc2 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Exception/InvalidSecretKey.php @@ -0,0 +1,32 @@ +<?php +/** + * Akeeba Engine + * + * @package akeebaengine + * @copyright Copyright (c)2006-2024 Nicholas K. Dionysopoulos / Akeeba Ltd + * @license GNU General Public License version 3, or later + */ + +namespace Akeeba\S3\Exception; + +// Protection against direct access +defined('AKEEBAENGINE') || die(); + +use Exception; + +/** + * Invalid Amazon S3 secret key + */ +class InvalidSecretKey extends ConfigurationError +{ + public function __construct(string $message = "", int $code = 0, Exception $previous = null) + { + if (empty($message)) + { + $message = 'The Amazon S3 Secret Key provided is invalid'; + } + + parent::__construct($message, $code, $previous); + } + +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Exception/InvalidSignatureMethod.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Exception/InvalidSignatureMethod.php new file mode 100644 index 0000000000..44b8b5c73e --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Exception/InvalidSignatureMethod.php @@ -0,0 +1,32 @@ +<?php +/** + * Akeeba Engine + * + * @package akeebaengine + * @copyright Copyright (c)2006-2024 Nicholas K. Dionysopoulos / Akeeba Ltd + * @license GNU General Public License version 3, or later + */ + +namespace Akeeba\S3\Exception; + +// Protection against direct access +defined('AKEEBAENGINE') || die(); + +use Exception; + +/** + * Invalid Amazon S3 signature method + */ +class InvalidSignatureMethod extends ConfigurationError +{ + public function __construct(string $message = "", int $code = 0, Exception $previous = null) + { + if (empty($message)) + { + $message = 'The Amazon S3 signature method provided is invalid. Only v2 and v4 signatures are supported.'; + } + + parent::__construct($message, $code, $previous); + } + +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Exception/PropertyNotFound.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Exception/PropertyNotFound.php new file mode 100644 index 0000000000..58eb775556 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Exception/PropertyNotFound.php @@ -0,0 +1,22 @@ +<?php +/** + * Akeeba Engine + * + * @package akeebaengine + * @copyright Copyright (c)2006-2024 Nicholas K. Dionysopoulos / Akeeba Ltd + * @license GNU General Public License version 3, or later + */ + +namespace Akeeba\S3\Exception; + +// Protection against direct access +defined('AKEEBAENGINE') || die(); + +use LogicException; + +/** + * Invalid magic property name + */ +class PropertyNotFound extends LogicException +{ +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Input.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Input.php new file mode 100644 index 0000000000..cdc50921ae --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Input.php @@ -0,0 +1,766 @@ +<?php +/** + * Akeeba Engine + * + * @package akeebaengine + * @copyright Copyright (c)2006-2024 Nicholas K. Dionysopoulos / Akeeba Ltd + * @license GNU General Public License version 3, or later + */ + +namespace Akeeba\S3; + +// Protection against direct access +defined('AKEEBAENGINE') || die(); + +/** + * Defines an input source for PUT/POST requests to Amazon S3 + */ +class Input +{ + /** + * Input type: resource + */ + public const INPUT_RESOURCE = 1; + + /** + * Input type: file + */ + public const INPUT_FILE = 2; + + /** + * Input type: raw data + */ + public const INPUT_DATA = 3; + + /** + * File pointer, in case we have a resource + * + * @var resource + */ + private $fp = null; + + /** + * Absolute filename to the file + * + * @var string + */ + private $file = null; + + /** + * Data to upload, as a string + * + * @var string + */ + private $data = null; + + /** + * Length of the data to upload + * + * @var int + */ + private $size = -1; + + /** + * Content type (MIME type) + * + * @var string|null + */ + private $type = ''; + + /** + * MD5 sum of the data to upload, as base64 encoded string. If it's false no MD5 sum will be returned. + * + * @var string|null + */ + private $md5sum = null; + + /** + * SHA-256 sum of the data to upload, as lowercase hex string. + * + * @var string|null + */ + private $sha256 = null; + + /** + * The Upload Session ID used for multipart uploads + * + * @var string|null + */ + private $UploadID = null; + + /** + * The part number used in multipart uploads + * + * @var int|null + */ + private $PartNumber = null; + + /** + * The list of ETags used when finalising a multipart upload + * + * @var string[] + */ + private $etags = []; + + /** + * Create an input object from a file (also: any valid URL wrapper) + * + * @param string $file Absolute file path or any valid URL fopen() wrapper + * @param null|string $md5sum The MD5 sum. null to auto calculate, empty string to never calculate. + * @param null|string $sha256sum The SHA256 sum. null to auto calculate. + * + * @return Input + */ + public static function createFromFile(string $file, ?string $md5sum = null, ?string $sha256sum = null): self + { + $input = new Input(); + + $input->setFile($file); + $input->setMd5sum($md5sum); + $input->setSha256($sha256sum); + + return $input; + } + + /** + * Create an input object from a stream resource / file pointer. + * + * Please note that the contentLength cannot be calculated automatically unless you have a seekable stream resource. + * + * @param resource $resource The file pointer or stream resource + * @param int $contentLength The length of the content in bytes. Set to -1 for auto calculation. + * @param null|string $md5sum The MD5 sum. null to auto calculate, empty string to never calculate. + * @param null|string $sha256sum The SHA256 sum. null to auto calculate. + * + * @return Input + */ + public static function createFromResource(&$resource, int $contentLength, ?string $md5sum = null, ?string $sha256sum = null): self + { + $input = new Input(); + + $input->setFp($resource); + $input->setSize($contentLength); + $input->setMd5sum($md5sum); + $input->setSha256($sha256sum); + + return $input; + } + + /** + * Create an input object from raw data. + * + * Please bear in mind that the data is being duplicated in memory. Therefore you'll need at least 2xstrlen($data) + * of free memory when you are using this method. You can instantiate an object and use assignData to work around + * this limitation when handling large amounts of data which may cause memory outages (typically: over 10Mb). + * + * @param string $data The data to use. + * @param null|string $md5sum The MD5 sum. null to auto calculate, empty string to never calculate. + * @param null|string $sha256sum The SHA256 sum. null to auto calculate. + * + * @return Input + */ + public static function createFromData(string &$data, ?string $md5sum = null, ?string $sha256sum = null): self + { + $input = new Input(); + + $input->setData($data); + $input->setMd5sum($md5sum); + $input->setSha256($sha256sum); + + return $input; + } + + /** + * Destructor. + */ + function __destruct() + { + if (is_resource($this->fp)) + { + try + { + @fclose($this->fp); + } + catch (\Throwable $e) + { + } + } + } + + /** + * Returns the input type (resource, file or data) + * + * @return int + */ + public function getInputType(): int + { + if (!empty($this->file)) + { + return self::INPUT_FILE; + } + + if (!empty($this->fp)) + { + return self::INPUT_RESOURCE; + } + + return self::INPUT_DATA; + } + + /** + * Return the file pointer to the data, or null if this is not a resource input + * + * @return resource|null + */ + public function getFp() + { + if (!is_resource($this->fp)) + { + return null; + } + + return $this->fp; + } + + /** + * Set the file pointer (or, generally, stream resource) + * + * @param resource $fp + */ + public function setFp($fp): void + { + if (!is_resource($fp)) + { + throw new Exception\InvalidFilePointer('$fp is not a file resource'); + } + + $this->fp = $fp; + } + + /** + * Get the absolute path to the input file, or null if this is not a file input + * + * @return string|null + */ + public function getFile(): ?string + { + if (empty($this->file)) + { + return null; + } + + return $this->file; + } + + /** + * Set the absolute path to the input file + * + * @param string $file + */ + public function setFile(string $file): void + { + $this->file = $file; + $this->data = null; + + if (is_resource($this->fp)) + { + try + { + @fclose($this->fp); + } + catch (\Throwable $e) + { + } + } + + $this->fp = @fopen($file, 'r'); + + if ($this->fp === false) + { + throw new Exception\CannotOpenFileForRead($file); + } + } + + /** + * Return the raw input data, or null if this is a file or stream input + * + * @return string|null + */ + public function getData(): ?string + { + if (empty($this->data) && ($this->getInputType() != self::INPUT_DATA)) + { + return null; + } + + return $this->data; + } + + /** + * Set the raw input data + * + * @param string $data + */ + public function setData(string $data): void + { + $this->data = $data; + + if (is_resource($this->fp)) + { + try + { + @fclose($this->fp); + } + catch (\Throwable $e) + { + } + } + + $this->file = null; + $this->fp = null; + } + + /** + * Return a reference to the raw input data + * + * @return string|null + */ + public function &getDataReference(): ?string + { + if (empty($this->data) && ($this->getInputType() != self::INPUT_DATA)) + { + $this->data = null; + } + + return $this->data; + } + + /** + * Set the raw input data by doing an assignment instead of memory copy. While this conserves memory you cannot use + * this with hardcoded strings, method results etc without going through a variable first. + * + * @param string $data + */ + public function assignData(string &$data): void + { + $this->data = $data; + + if (is_resource($this->fp)) + { + try + { + @fclose($this->fp); + } + catch (\Throwable $e) + { + } + } + + $this->file = null; + $this->fp = null; + } + + /** + * Returns the size of the data to be uploaded, in bytes. If it's not already specified it will try to guess. + * + * @return int + */ + public function getSize(): int + { + if ($this->size < 0) + { + $this->size = $this->getInputSize(); + } + + return $this->size; + } + + /** + * Set the size of the data to be uploaded. + * + * @param int $size + */ + public function setSize(int $size) + { + $this->size = $size; + } + + /** + * Get the MIME type of the data + * + * @return string|null + */ + public function getType(): ?string + { + if (empty($this->type)) + { + $this->type = 'application/octet-stream'; + + if ($this->getInputType() == self::INPUT_FILE) + { + $this->type = $this->getMimeType($this->file); + } + } + + return $this->type; + } + + /** + * Set the MIME type of the data + * + * @param string|null $type + */ + public function setType(?string $type) + { + $this->type = $type; + } + + /** + * Get the MD5 sum of the content + * + * @return null|string + */ + public function getMd5sum(): ?string + { + if ($this->md5sum === '') + { + return null; + } + + if (is_null($this->md5sum)) + { + $this->md5sum = $this->calculateMd5(); + } + + return $this->md5sum; + } + + /** + * Set the MD5 sum of the content as a base64 encoded string of the raw MD5 binary value. + * + * WARNING: Do not set a binary MD5 sum or a hex-encoded MD5 sum, it will result in an invalid signature error! + * + * Set to null to automatically calculate it from the raw data. Set to an empty string to force it to never be + * calculated and no value for it set either. + * + * @param string|null $md5sum + */ + public function setMd5sum(?string $md5sum): void + { + $this->md5sum = $md5sum; + } + + /** + * Get the SHA-256 hash of the content + * + * @return string + */ + public function getSha256(): string + { + if (empty($this->sha256)) + { + $this->sha256 = $this->calculateSha256(); + } + + return $this->sha256; + } + + /** + * Set the SHA-256 sum of the content. It must be a lowercase hexadecimal encoded string. + * + * Set to null to automatically calculate it from the raw data. + * + * @param string|null $sha256 + */ + public function setSha256(?string $sha256): void + { + $this->sha256 = is_null($sha256) ? null : strtolower($sha256); + } + + /** + * Get the Upload Session ID for multipart uploads + * + * @return string|null + */ + public function getUploadID(): ?string + { + return $this->UploadID; + } + + /** + * Set the Upload Session ID for multipart uploads + * + * @param string|null $UploadID + */ + public function setUploadID(?string $UploadID): void + { + $this->UploadID = $UploadID; + } + + /** + * Get the part number for multipart uploads. + * + * Returns null if the part number has not been set yet. + * + * @return int|null + */ + public function getPartNumber(): ?int + { + return $this->PartNumber; + } + + /** + * Set the part number for multipart uploads + * + * @param int $PartNumber + */ + public function setPartNumber(int $PartNumber): void + { + // Clamp the part number to integers greater than zero. + $this->PartNumber = max(1, (int) $PartNumber); + } + + /** + * Get the list of ETags for multipart uploads + * + * @return string[] + */ + public function getEtags(): array + { + return $this->etags; + } + + /** + * Set the list of ETags for multipart uploads + * + * @param string[] $etags + */ + public function setEtags(array $etags): void + { + $this->etags = $etags; + } + + /** + * Calculates the upload size from the input source. For data it's the entire raw string length. For a file resource + * it's the entire file's length. For seekable stream resources it's the remaining data from the current seek + * position to EOF. + * + * WARNING: You should never try to specify files or resources over 2Gb minus 1 byte otherwise 32-bit versions of + * PHP (anything except Linux x64 builds) will fail in unpredictable ways: the internal int representation in PHP + * depends on the target platform and is typically a signed 32-bit integer. + * + * @return int + */ + private function getInputSize(): int + { + switch ($this->getInputType()) + { + case self::INPUT_DATA: + return function_exists('mb_strlen') ? mb_strlen($this->data ?? '', '8bit') : strlen($this->data ?? ''); + break; + + case self::INPUT_FILE: + clearstatcache(true, $this->file); + + $filesize = @filesize($this->file); + + return ($filesize === false) ? 0 : $filesize; + break; + + case self::INPUT_RESOURCE: + $meta = stream_get_meta_data($this->fp); + + if ($meta['seekable']) + { + $pos = ftell($this->fp); + $endPos = fseek($this->fp, 0, SEEK_END); + fseek($this->fp, $pos, SEEK_SET); + + return $endPos - $pos + 1; + } + + break; + } + + return 0; + } + + /** + * Get the MIME type of a file + * + * @param string $file The absolute path to the file for which we want to get the MIME type + * + * @return string The MIME type of the file + */ + private function getMimeType(string $file): string + { + $type = false; + + // Fileinfo documentation says fileinfo_open() will use the + // MAGIC env var for the magic file + if (extension_loaded('fileinfo') && isset($_ENV['MAGIC']) && + ($finfo = finfo_open(FILEINFO_MIME, $_ENV['MAGIC'])) !== false + ) + { + if (($type = finfo_file($finfo, $file)) !== false) + { + // Remove the charset and grab the last content-type + $type = explode(' ', str_replace('; charset=', ';charset=', $type)); + $type = array_pop($type); + $type = explode(';', $type); + $type = trim(array_shift($type)); + } + + finfo_close($finfo); + } + elseif (function_exists('mime_content_type')) + { + $type = trim(mime_content_type($file)); + } + + if ($type !== false && strlen($type) > 0) + { + return $type; + } + + // Otherwise do it the old fashioned way + static $exts = [ + 'jpg' => 'image/jpeg', + 'gif' => 'image/gif', + 'png' => 'image/png', + 'tif' => 'image/tiff', + 'tiff' => 'image/tiff', + 'ico' => 'image/x-icon', + 'swf' => 'application/x-shockwave-flash', + 'pdf' => 'application/pdf', + 'zip' => 'application/zip', + 'gz' => 'application/x-gzip', + 'tar' => 'application/x-tar', + 'bz' => 'application/x-bzip', + 'bz2' => 'application/x-bzip2', + 'txt' => 'text/plain', + 'asc' => 'text/plain', + 'htm' => 'text/html', + 'html' => 'text/html', + 'css' => 'text/css', + 'js' => 'text/javascript', + 'xml' => 'text/xml', + 'xsl' => 'application/xsl+xml', + 'ogg' => 'application/ogg', + 'mp3' => 'audio/mpeg', + 'wav' => 'audio/x-wav', + 'avi' => 'video/x-msvideo', + 'mpg' => 'video/mpeg', + 'mpeg' => 'video/mpeg', + 'mov' => 'video/quicktime', + 'flv' => 'video/x-flv', + 'php' => 'text/x-php', + ]; + + $ext = strtolower(pathInfo($file, PATHINFO_EXTENSION)); + + return $exts[$ext] ?? 'application/octet-stream'; + } + + /** + * Calculate the MD5 sum of the input data + * + * @return string Base-64 encoded MD5 sum + */ + private function calculateMd5(): string + { + switch ($this->getInputType()) + { + case self::INPUT_DATA: + return base64_encode( + function_exists('hash') + ? hash('md5', $this->data, true) + : md5($this->data, true) + ); + break; + + case self::INPUT_FILE: + return base64_encode( + function_exists('hash_file') + ? hash_file('md5', $this->file, true) + : md5_file($this->file, true) + ); + break; + + case self::INPUT_RESOURCE: + $ctx = hash_init('md5'); + $pos = ftell($this->fp); + $size = $this->getSize(); + $done = 0; + $batch = min(1048576, $size); + + while ($done < $size) + { + $toRead = min($batch, $done - $size); + $data = @fread($this->fp, $toRead); + hash_update($ctx, $data); + unset($data); + } + + fseek($this->fp, $pos, SEEK_SET); + + return base64_encode(hash_final($ctx, true)); + + break; + } + + return ''; + } + + /** + * Calcualte the SHA256 data of the input data + * + * @return string Lowercase hex representation of the SHA-256 sum + */ + private function calculateSha256(): string + { + $inputType = $this->getInputType(); + switch ($inputType) + { + case self::INPUT_DATA: + return hash('sha256', $this->data, false); + break; + + case self::INPUT_FILE: + case self::INPUT_RESOURCE: + if ($inputType == self::INPUT_FILE) + { + $filesize = @filesize($this->file); + $fPos = @ftell($this->fp); + + if (($filesize == $this->getSize()) && ($fPos === 0)) + { + return hash_file('sha256', $this->file, false); + } + } + + $ctx = hash_init('sha256'); + $pos = ftell($this->fp); + $size = $this->getSize(); + $done = 0; + $batch = min(1048576, $size); + + while ($done < $size) + { + $toRead = min($batch, $size - $done); + $data = @fread($this->fp, $toRead); + $done += $toRead; + hash_update($ctx, $data); + unset($data); + } + + fseek($this->fp, $pos, SEEK_SET); + + return hash_final($ctx, false); + + break; + } + + return ''; + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Request.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Request.php new file mode 100644 index 0000000000..d9b1833a40 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Request.php @@ -0,0 +1,823 @@ +<?php +/** + * Akeeba Engine + * + * @package akeebaengine + * @copyright Copyright (c)2006-2024 Nicholas K. Dionysopoulos / Akeeba Ltd + * @license GNU General Public License version 3, or later + */ + +namespace Akeeba\S3; + +use Akeeba\S3\Response\Error; + +// Protection against direct access +defined('AKEEBAENGINE') || die(); + + +class Request +{ + /** + * The HTTP verb to use + * + * @var string + */ + private $verb = 'GET'; + + /** + * The bucket we are using + * + * @var string + */ + private $bucket = ''; + + /** + * The object URI, relative to the bucket's root + * + * @var string + */ + private $uri = ''; + + /** + * The remote resource we are querying + * + * @var string + */ + private $resource = ''; + + /** + * Query string parameters + * + * @var array + */ + private $parameters = []; + + /** + * Amazon-specific headers to pass to the request + * + * @var array + */ + private $amzHeaders = []; + + /** + * Regular HTTP headers to send in the request + * + * @var array + */ + private $headers = [ + 'Host' => '', + 'Date' => '', + 'Content-MD5' => '', + 'Content-Type' => '', + ]; + + /** + * Input data for the request + * + * @var Input + */ + private $input = null; + + /** + * The file resource we are writing data to + * + * @var resource|null + */ + private $fp = null; + + /** + * The Amazon S3 configuration object + * + * @var Configuration + */ + private $configuration = null; + + /** + * The response object + * + * @var Response + */ + private $response = null; + + /** + * The location of the CA certificate cache. It can be a file or a directory. If it's not specified, the location + * set in AKEEBA_CACERT_PEM will be used + * + * @var string|null + */ + private $caCertLocation = null; + + /** + * Constructor + * + * @param string $verb HTTP verb, e.g. 'POST' + * @param string $bucket Bucket name, e.g. 'example-bucket' + * @param string $uri Object URI + * @param Configuration $configuration The Amazon S3 configuration object to use + * + * @return void + */ + function __construct(string $verb, string $bucket, string $uri, Configuration $configuration) + { + $this->verb = $verb; + $this->bucket = $bucket; + $this->uri = '/'; + $this->configuration = $configuration; + + if (!empty($uri)) + { + $this->uri = '/' . str_replace('%2F', '/', rawurlencode($uri)); + } + + $this->headers['Host'] = $this->getHostName($configuration, $this->bucket); + $this->resource = $this->uri; + + if (($this->bucket !== '') && $configuration->getUseLegacyPathStyle()) + { + $this->resource = '/' . $this->bucket . $this->uri; + + $this->uri = $this->resource; + } + + // The date must always be added as a header + $this->headers['Date'] = gmdate('D, d M Y H:i:s O'); + + // S3-"compatible" services use a different date format. Because why not? + if ($this->configuration->getAlternateDateHeaderFormat() && strpos($this->headers['Host'], '.amazonaws.com') === false) + { + $this->headers['Date'] = gmdate('D, d M Y H:i:s T'); + } + + // If there is a security token we need to set up the X-Amz-Security-Token header + $token = $this->configuration->getToken(); + + if (!empty($token)) + { + $this->setAmzHeader('x-amz-security-token', $token); + } + + // Initialize the response object + $this->response = new Response(); + } + + /** + * Get the input object + * + * @return Input|null + */ + public function getInput(): ?Input + { + return $this->input; + } + + /** + * Set the input object + * + * @param Input $input + * + * @return void + */ + public function setInput(Input $input): void + { + $this->input = $input; + } + + /** + * Set a request parameter + * + * @param string $key The parameter name + * @param string|null $value The parameter value + * + * @return void + */ + public function setParameter(string $key, ?string $value): void + { + $this->parameters[$key] = $value; + } + + /** + * Set a request header + * + * @param string $key The header name + * @param string $value The header value + * + * @return void + */ + public function setHeader(string $key, string $value): void + { + $this->headers[$key] = $value; + } + + /** + * Set an x-amz-meta-* header + * + * @param string $key The header name + * @param string $value The header value + * + * @return void + */ + public function setAmzHeader(string $key, string $value): void + { + $this->amzHeaders[$key] = $value; + } + + /** + * Get the HTTP verb of this request + * + * @return string + */ + public function getVerb(): string + { + return $this->verb; + } + + /** + * Get the S3 bucket's name + * + * @return string + */ + public function getBucket(): string + { + return $this->bucket; + } + + /** + * Get the absolute URI of the resource we're accessing + * + * @return string + */ + public function getResource(): string + { + return $this->resource; + } + + /** + * Get the parameters array + * + * @return array + */ + public function getParameters(): array + { + return $this->parameters; + } + + /** + * Get the Amazon headers array + * + * @return array + */ + public function getAmzHeaders(): array + { + return $this->amzHeaders; + } + + /** + * Get the other headers array + * + * @return array + */ + public function getHeaders(): array + { + return $this->headers; + } + + /** + * Get a reference to the Amazon configuration object + * + * @return Configuration + */ + public function getConfiguration(): Configuration + { + return $this->configuration; + } + + /** + * Get the file pointer resource (for PUT and POST requests) + * + * @return resource|null + */ + public function &getFp() + { + return $this->fp; + } + + /** + * Set the data resource as a file pointer + * + * @param resource $fp + */ + public function setFp($fp): void + { + $this->fp = $fp; + } + + /** + * Get the certificate authority location + * + * @return string|null + */ + public function getCaCertLocation(): ?string + { + if (!empty($this->caCertLocation)) + { + return $this->caCertLocation; + } + + if (defined('AKEEBA_CACERT_PEM')) + { + return AKEEBA_CACERT_PEM; + } + + return null; + } + + /** + * @param null|string $caCertLocation + */ + public function setCaCertLocation(?string $caCertLocation): void + { + if (empty($caCertLocation)) + { + $caCertLocation = null; + } + + if (!is_null($caCertLocation) && !is_file($caCertLocation) && !is_dir($caCertLocation)) + { + $caCertLocation = null; + } + + $this->caCertLocation = $caCertLocation; + } + + /** + * Get a pre-signed URL for the request. + * + * Typically used to pre-sign GET requests to objects, i.e. give shareable pre-authorized URLs for downloading + * private or otherwise inaccessible files from S3. + * + * @param int|null $lifetime Lifetime in seconds + * @param bool $https Use HTTPS ($hostBucket should be false for SSL verification)? + * + * @return string The authenticated URL, complete with signature + */ + public function getAuthenticatedURL(?int $lifetime = null, bool $https = false): string + { + $this->processParametersIntoResource(); + $signer = Signature::getSignatureObject($this, $this->configuration->getSignatureMethod()); + + return $signer->getAuthenticatedURL($lifetime, $https); + } + + /** + * Get the S3 response + * + * @return Response + */ + public function getResponse(bool $rawResponse = false): Response + { + $this->processParametersIntoResource(); + + $schema = 'http://'; + + if ($this->configuration->isSSL()) + { + $schema = 'https://'; + } + + // Very special case. IF the URI ends in /?location AND the region is us-east-1 (Host is + // s3-external-1.amazonaws.com) THEN the host MUST become s3.amazonaws.com for the request to work. This is case + // of us not knowing the region of the bucket, therefore having to use a special endpoint which lets us query + // the region of the bucket without knowing its region. See + // http://stackoverflow.com/questions/27091816/retrieve-buckets-objects-without-knowing-buckets-region-with-aws-s3-rest-api + if ((substr($this->uri, -10) == '/?location') && ($this->headers['Host'] == 's3-external-1.amazonaws.com')) + { + $this->headers['Host'] = 's3.amazonaws.com'; + } + + $url = $schema . $this->headers['Host'] . $this->uri; + + // Basic setup + $curl = curl_init(); + curl_setopt($curl, CURLOPT_USERAGENT, 'AkeebaBackupProfessional/S3PostProcessor'); + + if ($this->configuration->isSSL()) + { + // Set the CA certificate cache location + $caCert = $this->getCaCertLocation(); + + if (!empty($caCert)) + { + if (is_dir($caCert)) + { + @curl_setopt($curl, CURLOPT_CAPATH, $caCert); + } + else + { + @curl_setopt($curl, CURLOPT_CAINFO, $caCert); + } + } + + /** + * Verify the host name in the certificate and the certificate itself. + * + * Caveat: if your bucket contains dots in the name we have to turn off host verification due to the way the + * S3 SSL certificates are set up. + */ + $isAmazonS3 = (substr($this->headers['Host'], -14) == '.amazonaws.com') + || substr( + $this->headers['Host'], -16 + ) == 'amazonaws.com.cn'; + $tooManyDots = substr_count($this->headers['Host'], '.') > 4; + + $verifyHost = ($isAmazonS3 && $tooManyDots) ? 0 : 2; + + curl_setopt($curl, CURLOPT_SSL_VERIFYHOST, $verifyHost); + curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, true); + } + + curl_setopt($curl, CURLOPT_URL, $url); + + /** + * Set the optional x-amz-date header instead of the standard HTTP Date header. + * + * Amazon S3 proper expects to get the date from the Date header. It also allows you to instead use the optional + * X-Amz-Date header as a means to resolve situations where your HTTP library does not let you control the + * standard Date header. In other words, it accepts both, it encourages the standard Date header, but it will + * give priority to the X-Amz-Date header to help you get out of a sticky situation. + * + * Unfortunately, third party services which claim to be "S3-compatible" are written by people with poor reading + * skills or, more likely, under unrealistic time constraints to deliver working code. They are implementing the + * date handling behaviout wrong. Instead of using the Date header unless the X-Amz-Date header is set, they + * **expect** to only ever see the X-Amz-Date header. If it's missing, they do not fall back to the standard + * Date header; they just spit out a message about the signature being wrong. Wasabi and ExoScale are two prime + * examples of that, and only when using v2 signatures. + * + * To avoid this problem, we are now defaulting to always using the X-Amz-Date header everywhere. If you want to + * revert to using the Date header with S3 proper please use setUseHTTPDateHeader(true) to your configuration + * object. In this case DO NOT set the X-Amz-Date header yourself, or you're going to have a *really* bad time. + */ + if (!$this->configuration->getUseHTTPDateHeader()) + { + $this->amzHeaders['x-amz-date'] = (new \DateTime($this->headers['Date']))->format('Ymd\THis\Z'); + + unset ($this->headers['Date']); + } + + /** + * Remove empty headers. + * + * While Amazon S3 proper and most third party implementations have no problem with that, there a few of them + * (such as Synology C2) which choke on empty headers. + */ + $this->headers = array_filter($this->headers); + + // Get the request signature + $signer = Signature::getSignatureObject($this, $this->configuration->getSignatureMethod()); + $signer->preProcessHeaders($this->headers, $this->amzHeaders); + + // Headers + $headers = []; + + foreach ($this->amzHeaders as $header => $value) + { + if (strlen($value) > 0) + { + $headers[] = $header . ': ' . $value; + } + } + + foreach ($this->headers as $header => $value) + { + if (strlen($value) > 0) + { + $headers[] = $header . ': ' . $value; + } + } + + $headers[] = 'Authorization: ' . $signer->getAuthorizationHeader(); + + curl_setopt($curl, CURLOPT_HTTPHEADER, $headers); + curl_setopt($curl, CURLOPT_HEADER, false); + curl_setopt($curl, CURLOPT_RETURNTRANSFER, false); + curl_setopt($curl, CURLOPT_WRITEFUNCTION, [$this, '__responseWriteCallback']); + curl_setopt($curl, CURLOPT_HEADERFUNCTION, [$this, '__responseHeaderCallback']); + curl_setopt($curl, CURLOPT_FOLLOWLOCATION, true); + + // Request types + switch ($this->verb) + { + case 'GET': + break; + + case 'PUT': + case 'POST': + if (!is_object($this->input) || !($this->input instanceof Input)) + { + $this->input = new Input(); + } + + $size = $this->input->getSize(); + $type = $this->input->getInputType(); + + if ($type == Input::INPUT_DATA) + { + curl_setopt($curl, CURLOPT_CUSTOMREQUEST, $this->verb); + + $data = $this->input->getDataReference(); + + if (strlen($data ?? '')) + { + curl_setopt($curl, CURLOPT_POSTFIELDS, $data); + } + + if ($size > 0) + { + curl_setopt($curl, CURLOPT_BUFFERSIZE, $size); + } + } + else + { + curl_setopt($curl, CURLOPT_PUT, true); + curl_setopt($curl, CURLOPT_INFILE, $this->input->getFp()); + + if ($size > 0) + { + curl_setopt($curl, CURLOPT_INFILESIZE, $size); + } + } + + + break; + + case 'HEAD': + curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'HEAD'); + curl_setopt($curl, CURLOPT_NOBODY, true); + break; + + case 'DELETE': + curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'DELETE'); + break; + + default: + break; + } + + // Execute, grab errors + $this->response->resetBody(); + + if (curl_exec($curl)) + { + $this->response->code = curl_getinfo($curl, CURLINFO_HTTP_CODE); + } + else + { + $this->response->error = new Error( + curl_errno($curl), + curl_error($curl), + $this->resource + ); + } + + @curl_close($curl); + + // Set the body data + $this->response->finaliseBody($rawResponse); + + // Clean up file resources + if (!is_null($this->fp) && is_resource($this->fp)) + { + try + { + @fclose($this->fp); + } + catch (\Throwable $e) + { + } + } + + return $this->response; + } + + + /** + * cURL write callback + * + * @param resource &$curl cURL resource + * @param string &$data Data + * + * @return int Length in bytes + */ + protected function __responseWriteCallback($curl, string $data): int + { + if (in_array($this->response->code, [0, 200, 206]) && !is_null($this->fp) && is_resource($this->fp)) + { + return fwrite($this->fp, $data); + } + + $this->response->addToBody($data); + + return strlen($data); + } + + /** + * cURL header callback + * + * @param resource $curl cURL resource + * @param string &$data Data + * + * @return int Length in bytes + */ + protected function __responseHeaderCallback($curl, string $data): int + { + if (($strlen = strlen($data)) <= 2) + { + return $strlen; + } + + if (substr($data, 0, 4) == 'HTTP') + { + $this->response->code = (int) substr($data, 9, 3); + + return $strlen; + } + + // Ignore malformed headers without a value. + if (strpos($data, ':') === false) + { + return $strlen; + } + + [$header, $value] = explode(':', trim($data), 2); + $header = trim($header ?? ''); + $value = trim($value ?? ''); + + switch (strtolower($header)) + { + case 'last-modified': + $this->response->setHeader('time', strtotime($value)); + break; + + case 'content-length': + $this->response->setHeader('size', (int) $value); + break; + + case 'content-type': + $this->response->setHeader('type', $value); + break; + + case 'etag': + $this->response->setHeader('hash', trim($value, '"')); + break; + + default: + $this->response->setHeader(strtolower($header), is_numeric($value) ? (int) $value : $value); + + if (preg_match('/^x-amz-meta-.*$/', $header)) + { + $this->setHeader($header, is_numeric($value) ? (int) $value : $value); + } + break; + } + + return $strlen; + } + + /** + * Processes $this->parameters as a query string into $this->resource + * + * @return void + */ + private function processParametersIntoResource(): void + { + if (count($this->parameters)) + { + $query = substr($this->uri, -1) !== '?' ? '?' : '&'; + + ksort($this->parameters); + + foreach ($this->parameters as $var => $value) + { + if ($value == null || $value == '') + { + $query .= $var . '&'; + } + else + { + // Parameters must be URL-encoded + $query .= $var . '=' . rawurlencode($value) . '&'; + } + } + + $query = substr($query, 0, -1); + $this->uri .= $query; + + if (array_key_exists('acl', $this->parameters) || array_key_exists('location', $this->parameters) + || array_key_exists('torrent', $this->parameters) + || array_key_exists('logging', $this->parameters) + || array_key_exists('uploads', $this->parameters) + || array_key_exists('uploadId', $this->parameters) + || array_key_exists('partNumber', $this->parameters) + ) + { + $this->resource .= $query; + } + } + } + + /** + * Get the region-specific hostname for an operation given a configuration and a bucket name. This ensures we can + * always use an HTTPS connection, even with buckets containing dots in their names, without SSL certificate host + * name validation issues. + * + * Please note that this requires the pathStyle flag to be set in Configuration because Amazon RECOMMENDS using the + * virtual-hosted style request where applicable. See http://docs.aws.amazon.com/AmazonS3/latest/API/APIRest.html + * Quoting this documentation: + * "Although the path-style is still supported for legacy applications, we recommend using the virtual-hosted style + * where applicable." + * + * @param Configuration $configuration + * @param string $bucket + * + * @return string + */ + private function getHostName(Configuration $configuration, string $bucket): string + { + // http://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region + $endpoint = $configuration->getEndpoint(); + $region = $configuration->getRegion(); + + // If it's a bucket in China we need to use a different endpoint + if (($endpoint == 's3.amazonaws.com') && (substr($region, 0, 3) == 'cn-')) + { + $endpoint = 'amazonaws.com.cn'; + } + + /** + * If there is no bucket we use the default endpoint, whatever it is. For Amazon S3 this format is only used + * when we are making account-level, cross-region requests, e.g. list all buckets. For S3-compatible APIs it + * depends on the API, but generally it's just for listing available buckets. + */ + if (empty($bucket)) + { + return $endpoint; + } + + /** + * Are we using v2 signatures? In this case we use the endpoint defined by the user without translating it. + */ + if ($configuration->getSignatureMethod() != 'v4') + { + // Legacy path style: the hostname is the endpoint + if ($configuration->getUseLegacyPathStyle()) + { + return $endpoint; + } + + // Virtual hosting style: the hostname is the bucket, dot and endpoint. + return $bucket . '.' . $endpoint; + } + + /** + * Only applies to Amazon S3 proper. + * + * When using the Amazon S3 with the v4 signature API we have to use a different hostname per region. The + * mapping can be found in https://docs.aws.amazon.com/general/latest/gr/s3.html#s3_region + * + * This means changing the endpoint to s3.REGION.amazonaws.com with the following exceptions: + * For China: s3.REGION.amazonaws.com.cn + * + * v4 signing does NOT support non-Amazon endpoints. + */ + if (in_array($endpoint, ['s3.amazonaws.com', 'amazonaws.com.cn'])) + { + // Most endpoints: s3-REGION.amazonaws.com + $regionalEndpoint = $region . '.amazonaws.com'; + + // Exception: China + if (substr($region, 0, 3) == 'cn-') + { + // Chinese endpoint, e.g.: s3.cn-north-1.amazonaws.com.cn + $regionalEndpoint = $regionalEndpoint . '.cn'; + } + + // If dual-stack URLs are enabled then prepend the endpoint + if ($configuration->getDualstackUrl()) + { + $endpoint = 's3.dualstack.' . $regionalEndpoint; + } + else + { + $endpoint = 's3.' . $regionalEndpoint; + } + } + + // Legacy path style access: return just the endpoint + if ($configuration->getUseLegacyPathStyle()) + { + return $endpoint; + } + + // Recommended virtual hosting access: bucket, dot, endpoint. + return $bucket . '.' . $endpoint; + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Response.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Response.php new file mode 100644 index 0000000000..56bb5d834f --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Response.php @@ -0,0 +1,351 @@ +<?php +/** + * Akeeba Engine + * + * @package akeebaengine + * @copyright Copyright (c)2006-2024 Nicholas K. Dionysopoulos / Akeeba Ltd + * @license GNU General Public License version 3, or later + */ + +namespace Akeeba\S3; + +use Akeeba\S3\Exception\PropertyNotFound; +use Akeeba\S3\Response\Error; +use SimpleXMLElement; + +// Protection against direct access +defined('AKEEBAENGINE') || die(); + +/** + * Amazon S3 API response object + * + * @property Error $error Response error object + * @property string|SimpleXMLElement|null $body Body data + * @property int $code Response code + * @property array $headers Any headers we may have + */ +class Response +{ + /** + * Error object + * + * @var Error + */ + private $error = null; + + /** + * Response body + * + * @var string|SimpleXMLElement|null + */ + private $body = null; + + /** + * Status code of the response, e.g. 200 for OK, 403 for Forbidden etc + * + * @var int + */ + private $code = 0; + + /** + * Response headers + * + * @var array + */ + private $headers = []; + + /** + * Response constructor. + */ + public function __construct() + { + $this->error = new Error(); + } + + /** + * Is this an error response? + * + * @return bool + */ + public function isError(): bool + { + return is_null($this->error) || $this->error->isError(); + } + + /** + * Does this response have a body? + * + * @return bool + */ + public function hasBody(): bool + { + return !empty($this->body); + } + + /** + * Get the response error object + * + * @return Error + */ + public function getError(): Error + { + return $this->error; + } + + /** + * Set the response error object + * + * @param Error $error + */ + public function setError(Error $error): void + { + $this->error = $error; + } + + /** + * Get the response body + * + * If there is no body set up you get NULL. + * + * If the body is binary data (e.g. downloading a file) or other non-XML data you get a string. + * + * If the body was an XML string – the standard Amazon S3 REST API response type – you get a SimpleXMLElement + * object. + * + * @return string|SimpleXMLElement|null + */ + public function getBody() + { + return $this->body; + } + + /** + * Set the response body. If it's a string we'll try to parse it as XML. + * + * @param string|SimpleXMLElement|null $body + */ + public function setBody($body, bool $rawResponse = false): void + { + $this->body = null; + + if (empty($body)) + { + return; + } + + $this->body = $body; + + $this->finaliseBody($rawResponse); + } + + public function resetBody(): void + { + $this->body = null; + } + + public function addToBody(string $data): void + { + if (empty($this->body)) + { + $this->body = ''; + } + + $this->body .= $data; + } + + public function finaliseBody(bool $rawResponse = false): void + { + if (!$this->hasBody()) + { + return; + } + + if (!isset($this->headers['type'])) + { + $this->headers['type'] = 'text/plain'; + } + + if ( + !$rawResponse + && is_string($this->body) + && + ( + ($this->headers['type'] == 'application/xml') + || (substr($this->body, 0, 5) == '<?xml') + ) + ) + { + $this->body = simplexml_load_string($this->body); + } + + if (is_object($this->body) && ($this->body instanceof SimpleXMLElement)) + { + $this->parseBody(); + } + } + + /** + * Returns the status code of the response + * + * @return int + */ + public function getCode(): int + { + return $this->code; + } + + /** + * Sets the status code of the response + * + * @param int $code + */ + public function setCode(int $code): void + { + $this->code = $code; + } + + /** + * Get the response headers + * + * @return array + */ + public function getHeaders(): array + { + return $this->headers; + } + + /** + * Set the response headers + * + * @param array $headers + */ + public function setHeaders(array $headers): void + { + $this->headers = $headers; + } + + /** + * Set a single header + * + * @param string $name The header name + * @param string $value The header value + * + * @return void + */ + public function setHeader(string $name, string $value): void + { + $this->headers[$name] = $value; + } + + /** + * Does a header by this name exist? + * + * @param string $name The header to look for + * + * @return bool True if it exists + */ + public function hasHeader(string $name): bool + { + return array_key_exists($name, $this->headers); + } + + /** + * Unset a response header + * + * @param string $name The header to unset + * + * @return void + */ + public function unsetHeader(string $name): void + { + if ($this->hasHeader($name)) + { + unset ($this->headers[$name]); + } + } + + /** + * Magic getter for the protected properties + * + * @param string $name + * + * @return mixed + */ + public function __get(string $name) + { + switch ($name) + { + case 'error': + return $this->getError(); + break; + + case 'body': + return $this->getBody(); + break; + + case 'code': + return $this->getCode(); + break; + + case 'headers': + return $this->getHeaders(); + break; + } + + throw new PropertyNotFound("Property $name not found in " . get_class($this)); + } + + /** + * Magic setter for the protected properties + * + * @param string $name The name of the property + * @param mixed $value The value of the property + * + * @return void + */ + public function __set(string $name, $value): void + { + switch ($name) + { + case 'error': + $this->setError($value); + break; + + case 'body': + $this->setBody($value); + break; + + case 'code': + $this->setCode($value); + break; + + case 'headers': + $this->setHeaders($value); + break; + + default: + throw new PropertyNotFound("Property $name not found in " . get_class($this)); + } + } + + /** + * Scans the SimpleXMLElement body for errors and propagates them to the Error object + */ + protected function parseBody(): void + { + if (!in_array($this->code, [200, 204]) && + isset($this->body->Code, $this->body->Message) + ) + { + $this->error = new Error( + 500, + (string) $this->body->Code . ':' . (string) $this->body->Message + ); + + if (isset($this->body->Resource)) + { + $this->error->setResource((string) $this->body->Resource); + } + } + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Response/Error.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Response/Error.php new file mode 100644 index 0000000000..f316b6ae09 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Response/Error.php @@ -0,0 +1,139 @@ +<?php +/** + * Akeeba Engine + * + * @package akeebaengine + * @copyright Copyright (c)2006-2024 Nicholas K. Dionysopoulos / Akeeba Ltd + * @license GNU General Public License version 3, or later + */ + +namespace Akeeba\S3\Response; + +// Protection against direct access +defined('AKEEBAENGINE') || die(); + +/** + * S3 response error object + */ +class Error +{ + /** + * Error code + * + * @var int + */ + private $code = 0; + + /** + * Error message + * + * @var string + */ + private $message = ''; + + /** + * URI to the resource that throws the error + * + * @var string + */ + private $resource = ''; + + /** + * Create a new error object + * + * @param int $code The error code + * @param string $message The error message + * @param string $resource The URI to the resource throwing the error + * + * @return void + */ + function __construct($code = 0, $message = '', $resource = '') + { + $this->setCode($code); + $this->setMessage($message); + $this->setResource($resource); + } + + /** + * Get the error code + * + * @return int + */ + public function getCode(): int + { + return $this->code; + } + + /** + * Set the error code + * + * @param int $code Set to zeroo or a negative value to clear errors + * + * @return void + */ + public function setCode(int $code): void + { + if ($code <= 0) + { + $code = 0; + $this->setMessage(''); + $this->setResource(''); + } + + $this->code = $code; + } + + /** + * Get the error message + * + * @return string + */ + public function getMessage(): string + { + return $this->message; + } + + /** + * Set the error message + * + * @param string $message The error message to set + * + * @return void + */ + public function setMessage(string $message): void + { + $this->message = $message; + } + + /** + * Get the URI of the resource throwing the error + * + * @return string + */ + public function getResource(): string + { + return $this->resource; + } + + /** + * Set the URI of the resource throwing the error + * + * @param string $resource + * + * @return void + */ + public function setResource(string $resource): void + { + $this->resource = $resource; + } + + /** + * Do we actually have an error? + * + * @return bool + */ + public function isError(): bool + { + return ($this->code > 0) || !empty($this->message); + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Signature.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Signature.php new file mode 100644 index 0000000000..a1def56cdd --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Signature.php @@ -0,0 +1,80 @@ +<?php +/** + * Akeeba Engine + * + * @package akeebaengine + * @copyright Copyright (c)2006-2024 Nicholas K. Dionysopoulos / Akeeba Ltd + * @license GNU General Public License version 3, or later + */ + +namespace Akeeba\S3; + +// Protection against direct access +defined('AKEEBAENGINE') || die(); + +/** + * Base class for request signing objects. + */ +abstract class Signature +{ + /** + * The request we will be signing + * + * @var Request + */ + protected $request = null; + + /** + * Signature constructor. + * + * @param Request $request The request we will be signing + */ + public function __construct(Request $request) + { + $this->request = $request; + } + + /** + * Get a signature object for the request + * + * @param Request $request The request which needs signing + * @param string $method The signature method, "v2" or "v4" + * + * @return Signature + */ + public static function getSignatureObject(Request $request, string $method = 'v2'): self + { + $className = __NAMESPACE__ . '\\Signature\\' . ucfirst($method); + + return new $className($request); + } + + /** + * Returns the authorization header for the request + * + * @return string + */ + abstract public function getAuthorizationHeader(): string; + + /** + * Pre-process the request headers before we convert them to cURL-compatible format. Used by signature engines to + * add custom headers, e.g. x-amz-content-sha256 + * + * @param array $headers The associative array of headers to process + * @param array $amzHeaders The associative array of amz-* headers to process + * + * @return void + */ + abstract public function preProcessHeaders(array &$headers, array &$amzHeaders): void; + + /** + * Get a pre-signed URL for the request. Typically used to pre-sign GET requests to objects, i.e. give shareable + * pre-authorized URLs for downloading files from S3. + * + * @param integer|null $lifetime Lifetime in seconds. NULL for default lifetime. + * @param bool $https Use HTTPS ($hostBucket should be false for SSL verification)? + * + * @return string The authenticated URL, complete with signature + */ + abstract public function getAuthenticatedURL(?int $lifetime = null, bool $https = false): string; +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Signature/V2.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Signature/V2.php new file mode 100644 index 0000000000..ef7e7daad0 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Signature/V2.php @@ -0,0 +1,218 @@ +<?php +/** + * Akeeba Engine + * + * @package akeebaengine + * @copyright Copyright (c)2006-2024 Nicholas K. Dionysopoulos / Akeeba Ltd + * @license GNU General Public License version 3, or later + */ + +namespace Akeeba\S3\Signature; + +// Protection against direct access +defined('AKEEBAENGINE') || die(); + +use Akeeba\S3\Signature; + +/** + * Implements the Amazon AWS v2 signatures + * + * @see http://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html + */ +class V2 extends Signature +{ + /** + * Pre-process the request headers before we convert them to cURL-compatible format. Used by signature engines to + * add custom headers, e.g. x-amz-content-sha256 + * + * @param array $headers The associative array of headers to process + * @param array $amzHeaders The associative array of amz-* headers to process + * + * @return void + */ + public function preProcessHeaders(array &$headers, array &$amzHeaders): void + { + // No pre-processing required for V2 signatures + } + + /** + * Get a pre-signed URL for the request. Typically used to pre-sign GET requests to objects, i.e. give shareable + * pre-authorized URLs for downloading files from S3. + * + * @param integer|null $lifetime Lifetime in seconds. NULL for default lifetime. + * @param bool $https Use HTTPS ($hostBucket should be false for SSL verification)? + * + * @return string The presigned URL + */ + public function getAuthenticatedURL(?int $lifetime = null, bool $https = false): string + { + // Set the Expires header + if (is_null($lifetime)) + { + $lifetime = 10; + } + + $expires = time() + $lifetime; + $this->request->setHeader('Expires', $expires); + + $bucket = $this->request->getBucket(); + $uri = $this->request->getResource(); + $headers = $this->request->getHeaders(); + $accessKey = $this->request->getConfiguration()->getAccess(); + $protocol = $https ? 'https' : 'http'; + $signature = $this->getAuthorizationHeader(); + + $search = '/' . $bucket; + + // This does not look right... The bucket name must be included in the URL. +// if (strpos($uri, $search) === 0) +// { +// $uri = substr($uri, strlen($search)); +// } + + $queryParameters = array_merge($this->request->getParameters(), [ + 'AWSAccessKeyId' => $accessKey, + 'Expires' => sprintf('%u', $expires), + 'Signature' => $signature, + ]); + + $query = http_build_query($queryParameters); + + // fix authenticated url for Google Cloud Storage - https://cloud.google.com/storage/docs/access-control/create-signed-urls-program + if ($this->request->getConfiguration()->getEndpoint() === "storage.googleapis.com") + { + // replace host with endpoint + $headers['Host'] = 'storage.googleapis.com'; + // replace "AWSAccessKeyId" with "GoogleAccessId" + $query = str_replace('AWSAccessKeyId', 'GoogleAccessId', $query); + // add bucket to url + $uri = '/' . $bucket . $uri; + } + + $url = $protocol . '://' . $headers['Host'] . $uri; + $url .= (strpos($uri, '?') !== false) ? '&' : '?'; + $url .= $query; + + return $url; + } + + /** + * Returns the authorization header for the request + * + * @return string + */ + public function getAuthorizationHeader(): string + { + $verb = strtoupper($this->request->getVerb()); + $resourcePath = $this->request->getResource(); + $headers = $this->request->getHeaders(); + $amzHeaders = $this->request->getAmzHeaders(); + $parameters = $this->request->getParameters(); + $bucket = $this->request->getBucket(); + $isPresignedURL = false; + + $amz = []; + $amzString = ''; + + // Collect AMZ headers for signature + foreach ($amzHeaders as $header => $value) + { + if (strlen($value) > 0) + { + $amz[] = strtolower($header) . ':' . $value; + } + } + + // AMZ headers must be sorted and sent as separate lines + if (count($amz) > 0) + { + sort($amz); + $amzString = "\n" . implode("\n", $amz); + } + + // If the Expires query string parameter is set up we're pre-signing a download URL. The string to sign is a bit + // different in this case; it does not include the Date, it includes the Expires. + // See http://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html#RESTAuthenticationQueryStringAuth + if (isset($headers['Expires'])) + { + if (isset($headers['Date'])) + { + $headers['Date'] = $headers['Expires']; + } + else + { + $amzHeaders['x-amz-date'] = $headers['Expires']; + } + + unset ($headers['Expires']); + + $isPresignedURL = true; + } + + /** + * The resource path in S3 V2 signatures must ALWAYS contain the bucket name if a bucket is defined, even if we + * are not using path-style access to the resource + */ + if (!empty($bucket) && !$this->request->getConfiguration()->getUseLegacyPathStyle()) + { + $resourcePath = '/' . $bucket . $resourcePath; + } + + $stringToSign = $verb . "\n" . + ($headers['Content-MD5'] ?? '') . "\n" . + ($headers['Content-Type'] ?? '') . "\n" . + ($headers['Date'] ?? '') . + $amzString . "\n" . + $resourcePath; + + // CloudFront only requires a date to be signed + if ($headers['Host'] == 'cloudfront.amazonaws.com') + { + $stringToSign = $headers['Date'] ?? $amzHeaders['x-amz-date'] ?? ''; + } + + $amazonV2Hash = $this->amazonV2Hash($stringToSign); + + // For presigned URLs we only return the Base64-encoded signature without the AWS format specifier and the + // public access key. + if ($isPresignedURL) + { + return $amazonV2Hash; + } + + return 'AWS ' . + $this->request->getConfiguration()->getAccess() . ':' . + $amazonV2Hash; + } + + /** + * Creates a HMAC-SHA1 hash. Uses the hash extension if present, otherwise falls back to slower, manual calculation. + * + * @param string $stringToSign String to sign + * + * @return string + */ + private function amazonV2Hash(string $stringToSign): string + { + $secret = $this->request->getConfiguration()->getSecret(); + + if (extension_loaded('hash')) + { + $raw = hash_hmac('sha1', $stringToSign, $secret, true); + + return base64_encode($raw); + } + + $raw = pack('H*', sha1( + (str_pad($secret, 64, chr(0x00)) ^ (str_repeat(chr(0x5c), 64))) . + pack('H*', sha1( + (str_pad($secret, 64, chr(0x00)) ^ (str_repeat(chr(0x36), 64))) . $stringToSign + ) + ) + ) + ); + + return base64_encode($raw); + } + +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Signature/V4.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Signature/V4.php new file mode 100644 index 0000000000..daf27afc15 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Signature/V4.php @@ -0,0 +1,539 @@ +<?php +/** + * Akeeba Engine + * + * @package akeebaengine + * @copyright Copyright (c)2006-2024 Nicholas K. Dionysopoulos / Akeeba Ltd + * @license GNU General Public License version 3, or later + */ + +namespace Akeeba\S3\Signature; + +// Protection against direct access +defined('AKEEBAENGINE') || die(); + +use Akeeba\S3\Signature; +use DateTime; + +/** + * Implements the Amazon AWS v4 signatures + * + * @see http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html + */ +class V4 extends Signature +{ + /** + * Pre-process the request headers before we convert them to cURL-compatible format. Used by signature engines to + * add custom headers, e.g. x-amz-content-sha256 + * + * @param array $headers The associative array of headers to process + * @param array $amzHeaders The associative array of amz-* headers to process + * + * @return void + */ + public function preProcessHeaders(array &$headers, array &$amzHeaders): void + { + // Do we already have an SHA-256 payload hash? + if (isset($amzHeaders['x-amz-content-sha256'])) + { + return; + } + + // Set the payload hash header + $input = $this->request->getInput(); + + if (is_object($input)) + { + $requestPayloadHash = $input->getSha256(); + } + else + { + $requestPayloadHash = hash('sha256', '', false); + } + + $amzHeaders['x-amz-content-sha256'] = $requestPayloadHash; + } + + /** + * Get a pre-signed URL for the request. Typically used to pre-sign GET requests to objects, i.e. give shareable + * pre-authorized URLs for downloading files from S3. + * + * @param integer|null $lifetime Lifetime in seconds. NULL for default lifetime. + * @param bool $https Use HTTPS ($hostBucket should be false for SSL verification)? + * + * @return string The presigned URL + */ + public function getAuthenticatedURL(?int $lifetime = null, bool $https = false): string + { + // Set the Expires header + if (is_null($lifetime)) + { + $lifetime = 10; + } + + /** + * Authenticated URLs must always go through the generic regional endpoint, not the virtual hosting-style domain + * name. This means that if you have a bucket "example" in the EU West 1 (Ireland) region we have to go through + * http://s3-eu-west-1.amazonaws.com/example instead of http://example.amazonaws.com/ for all authenticated URLs + */ + $region = $this->request->getConfiguration()->getRegion(); + $bucket = $this->request->getBucket(); + $hostname = $this->getPresignedHostnameForRegion($region); + + if (!$this->request->getConfiguration()->getPreSignedBucketInURL() && $this->isValidBucketName($bucket)) + { + $hostname = $bucket . '.' . $hostname; + } + + $this->request->setHeader('Host', $hostname); + + // Set the expiration time in seconds + $this->request->setHeader('Expires', (int) $lifetime); + + // Get the query parameters, including the calculated signature + $uri = $this->request->getResource(); + $headers = $this->request->getHeaders(); + $protocol = $https ? 'https' : 'http'; + $serialisedParams = $this->getAuthorizationHeader(); + + // The query parameters are returned serialized; unserialize them, then build and return the URL. + $queryParameters = unserialize($serialisedParams); + + // This should be toggleable + if ( + !$this->request->getConfiguration()->getPreSignedBucketInURL() + && $this->isValidBucketName($bucket) + && strpos($uri, '/' . $bucket) === 0) + { + $uri = substr($uri, strlen($bucket) + 1); + } + + $query = http_build_query($queryParameters); + + $url = $protocol . '://' . $headers['Host'] . $uri; + $url .= (strpos($uri, '?') !== false) ? '&' : '?'; + $url .= $query; + + return $url; + } + + /** + * Returns the authorization header for the request + * + * @return string + */ + public function getAuthorizationHeader(): string + { + $verb = strtoupper($this->request->getVerb()); + $resourcePath = $this->request->getResource(); + $headers = $this->request->getHeaders(); + $amzHeaders = $this->request->getAmzHeaders(); + $parameters = $this->request->getParameters(); + $bucket = $this->request->getBucket(); + $isPresignedURL = false; + + // See the Connector class for the explanation behind this ugly workaround + $amazonIsBraindead = isset($headers['workaround-braindead-error-from-amazon']); + + if ($amazonIsBraindead) + { + unset ($headers['workaround-braindead-error-from-amazon']); + } + + // Get the credentials scope + $signatureDate = new DateTime($headers['Date'] ?? $amzHeaders['x-amz-date']); + + $credentialScope = $signatureDate->format('Ymd') . '/' . + $this->request->getConfiguration()->getRegion() . '/' . + 's3/aws4_request'; + + /** + * If the Expires header is set up we're pre-signing a download URL. The string to sign is a bit + * different in this case and we have to pass certain headers as query string parameters. + * + * @see http://docs.aws.amazon.com/general/latest/gr/sigv4-create-string-to-sign.html + */ + if (isset($headers['Expires'])) + { + $gmtDate = clone $signatureDate; + $gmtDate->setTimezone(new \DateTimeZone('GMT')); + + $parameters['X-Amz-Algorithm'] = "AWS4-HMAC-SHA256"; + $parameters['X-Amz-Credential'] = $this->request->getConfiguration()->getAccess() . '/' . $credentialScope; + $parameters['X-Amz-Date'] = $gmtDate->format('Ymd\THis\Z'); + $parameters['X-Amz-Expires'] = sprintf('%u', $headers['Expires']); + $token = $this->request->getConfiguration()->getToken(); + + if (!empty($token)) + { + $parameters['x-amz-security-token'] = $token; + } + + unset($headers['Expires']); + unset($headers['Date']); + unset($headers['Content-MD5']); + unset($headers['Content-Type']); + + $isPresignedURL = true; + } + + // ========== Step 1: Create a canonical request ========== + // See http://docs.aws.amazon.com/general/latest/gr/sigv4-create-canonical-request.html + + $canonicalHeaders = ""; + $signedHeadersArray = []; + + // Calculate the canonical headers and the signed headers + if ($isPresignedURL) + { + // Presigned URLs use UNSIGNED-PAYLOAD instead + unset($amzHeaders['x-amz-content-sha256']); + } + + $allHeaders = array_merge($headers, $amzHeaders); + ksort($allHeaders); + + foreach ($allHeaders as $k => $v) + { + $lowercaseHeaderName = strtolower($k); + + if ($amazonIsBraindead && ($lowercaseHeaderName == 'content-length')) + { + /** + * I know it looks crazy. It is. Somehow Amazon requires me to do this and only on _some_ servers, mind + * you. This is something undocumented and which is not covered by their official SDK. I had to write + * my own library because of that and the official SDK's inability to upload large files without using + * at least as much memory as the file itself (which doesn't fly well for files around 2Gb, let me tell + * you that!). + */ + $v = "$v,$v"; + } + + $canonicalHeaders .= $lowercaseHeaderName . ':' . trim($v) . "\n"; + $signedHeadersArray[] = $lowercaseHeaderName; + } + + $signedHeaders = implode(';', $signedHeadersArray); + + if ($isPresignedURL) + { + $parameters['X-Amz-SignedHeaders'] = $signedHeaders; + } + + // The canonical URI is the resource path + $canonicalURI = $resourcePath; + $bucketResource = '/' . $bucket . '/'; + $regionalHostname = ($headers['Host'] != 's3.amazonaws.com') + && ($headers['Host'] != $bucket . '.s3.amazonaws.com'); + + /** + * Yet another special case for third party, S3-compatible services, when using pre-signed URLs. + * + * Given a bucket `example` and filepath `foo/bar.txt` the canonical URI to sign is supposed to be + * /example/foo/bar.txt regardless of whether we are using path style or subdomain hosting style access to the + * bucket. + * + * When calculating a pre-signed URL, the URL we will be accessing will be something to the tune of + * example.endpoint.com/foo/bar.txt. Amazon S3 proper allows us to use EITHER the nominal canonical URI + * /foo/bar.txt OR the /example/foo/bar.txt canonical URI for consistency. Some third party providers, like + * Wasabi, will choke on the former and complain about the signature being invalid. + * + * To address this issue we check if all the following conditions are met: + * - We are calculating a signature for a pre-signed URL. + * - The service is NOT Amazon S3 proper. + * - The domain name starts with the bucket name. + * In this case, and this case only, we set $regionalHostname to false. This triggers an if-block further down + * which strips the `/bucketName/` prefix from the canonical URI, converting it to `/`. Therefore, the canonical + * URI in the signature becomes the nominal URI we will be accessing in the bucket, solving the problem with + * those third party services. + */ + // Figuring out whether it's a regional hostname DOES NOT work above if it's not AWS S3 proper. Let's fix that. + if ($isPresignedURL && strpos($headers['Host'], 'amazonaws.com') === false && !strpos($headers['Host'], $bucket . '.')) + { + $regionalHostname = false; + } + + // Special case: if the canonical URI ends in /?location the bucket name DOES count as part of the canonical URL + // even though the Host is s3.amazonaws.com (in which case it normally shouldn't count). Yeah, I know, it makes + // no sense!!! + if (!$regionalHostname && ($headers['Host'] == 's3.amazonaws.com') + && (substr($canonicalURI, -10) == '/?location')) + { + $regionalHostname = true; + } + + if (!$regionalHostname && (strpos($canonicalURI, $bucketResource) === 0 || strpos($canonicalURI, substr($bucketResource, 0, -1)) === 0)) + { + if ($canonicalURI === substr($bucketResource, 0, -1)) + { + $canonicalURI = '/'; + } + else + { + $canonicalURI = substr($canonicalURI, strlen($bucketResource) - 1); + } + } + + // If the resource path has a query yank it and parse it into the parameters array + $questionMarkPos = strpos($canonicalURI, '?'); + + if ($questionMarkPos !== false) + { + $canonicalURI = substr($canonicalURI, 0, $questionMarkPos); + $queryString = @substr($canonicalURI, $questionMarkPos + 1); + @parse_str($queryString, $extraQuery); + + if (count($extraQuery)) + { + $parameters = array_merge($parameters, $extraQuery); + } + } + + // The canonical query string is the string representation of $parameters, alpha sorted by key + ksort($parameters); + + // We build the query the hard way because http_build_query in PHP 5.3 does NOT have the fourth parameter + // (encoding type), defaulting to RFC 1738 encoding whereas S3 expects RFC 3986 encoding + $canonicalQueryString = ''; + + if (!empty($parameters)) + { + $temp = []; + + foreach ($parameters as $k => $v) + { + $temp[] = $this->urlencode($k) . '=' . $this->urlencode($v); + } + + $canonicalQueryString = implode('&', $temp); + } + + // Get the payload hash + $requestPayloadHash = 'UNSIGNED-PAYLOAD'; + + if (isset($amzHeaders['x-amz-content-sha256'])) + { + $requestPayloadHash = $amzHeaders['x-amz-content-sha256']; + } + + // Calculate the canonical request + $canonicalRequest = $verb . "\n" . + $canonicalURI . "\n" . + $canonicalQueryString . "\n" . + $canonicalHeaders . "\n" . + $signedHeaders . "\n" . + $requestPayloadHash; + + $hashedCanonicalRequest = hash('sha256', $canonicalRequest); + + // ========== Step 2: Create a string to sign ========== + // See http://docs.aws.amazon.com/general/latest/gr/sigv4-create-string-to-sign.html + + if (!isset($headers['Date'])) + { + $headers['Date'] = ''; + } + + /** + * The Date in the String-to-Sign is a messy situation. + * + * Amazon's documentation says it must be in ISO 8601 format: `Ymd\THis\Z`. Unfortunately, Amazon's + * documentation is actually wrong :troll_face: The actual Amazon S3 service expects the date to be formatted as + * per RFC1123. + * + * Most third party implementations have caught up to the fact that Amazon has documented the v4 signatures + * wrongly (naughty AWS!) and accept either format. + * + * Some other third party implementations, which never bothered to validate their implementations against Amazon + * S3 proper, only expect what Amazon has documented as "ISO 8601". Therefore, we detect third party services + * and switch to the as-documented date format. + * + * Some other third party services, like Wasabi, are broken in yet a different way. They will only use the date + * from the x-amz-date header, WITHOUT falling back to the Date header if the former is not present. This is + * the opposite of Amazon S3 proper which does expect the Date header. That's why the Request class sets both + * headers if the request is made to a service _other_ than Amazon S3 proper. + */ + $dateToSignFor = strpos($headers['Host'], '.amazonaws.com') !== false + ? (($headers['Date'] ?? null) ?: ($amzHeaders['x-amz-date'] ?? null) ?: $signatureDate->format('Ymd\THis\Z')) + : $signatureDate->format('Ymd\THis\Z'); + + $stringToSign = "AWS4-HMAC-SHA256\n" . + $dateToSignFor . "\n" . + $credentialScope . "\n" . + $hashedCanonicalRequest; + + if ($isPresignedURL) + { + $stringToSign = "AWS4-HMAC-SHA256\n" . + $parameters['X-Amz-Date'] . "\n" . + $credentialScope . "\n" . + $hashedCanonicalRequest; + } + + // ========== Step 3: Calculate the signature ========== + // See http://docs.aws.amazon.com/general/latest/gr/sigv4-calculate-signature.html + $kSigning = $this->getSigningKey($signatureDate); + + $signature = hash_hmac('sha256', $stringToSign, $kSigning, false); + + // ========== Step 4: Add the signing information to the Request ========== + // See http://docs.aws.amazon.com/general/latest/gr/sigv4-add-signature-to-request.html + + $authorization = 'AWS4-HMAC-SHA256 Credential=' . + $this->request->getConfiguration()->getAccess() . '/' . $credentialScope . ', ' . + 'SignedHeaders=' . $signedHeaders . ', ' . + 'Signature=' . $signature; + + // For presigned URLs we only return the Base64-encoded signature without the AWS format specifier and the + // public access key. + if ($isPresignedURL) + { + $parameters['X-Amz-Signature'] = $signature; + + return serialize($parameters); + } + + return $authorization; + } + + /** + * Calculate the AWS4 signing key + * + * @param DateTime $signatureDate The date the signing key is good for + * + * @return string + */ + private function getSigningKey(DateTime $signatureDate): string + { + $kSecret = $this->request->getConfiguration()->getSecret(); + $kDate = hash_hmac('sha256', $signatureDate->format('Ymd'), 'AWS4' . $kSecret, true); + $kRegion = hash_hmac('sha256', $this->request->getConfiguration()->getRegion(), $kDate, true); + $kService = hash_hmac('sha256', 's3', $kRegion, true); + $kSigning = hash_hmac('sha256', 'aws4_request', $kService, true); + + return $kSigning; + } + + private function urlencode(?string $toEncode): string + { + if (empty($toEncode)) + { + return ''; + } + + return str_replace('+', '%20', urlencode($toEncode)); + } + + /** + * Get the correct hostname for the given AWS region + * + * @param string $region + * + * @return string + */ + private function getPresignedHostnameForRegion(string $region): string + { + $config = $this->request->getConfiguration(); + $endpoint = $config->getEndpoint(); + + if (empty($endpoint)) + { + $endpoint = 's3.' . $region . '.amazonaws.com'; + } + + // As of October 2023, AWS does not consider DualStack signed URLs as valid. Whatever. + $dualstackEnabled = false && $this->request->getConfiguration()->getDualstackUrl(); + + // If dual-stack URLs are enabled then prepend the endpoint + if ($dualstackEnabled) + { + $endpoint = 's3.dualstack.' . $region . '.amazonaws.com'; + } + + if ($region == 'cn-north-1') + { + return $endpoint . '.cn'; + } + + return $endpoint; + } + + /** + * Is this a valid bucket name? + * + * @param string $bucketName The bucket name to check + * @param bool $asSubdomain Should I put additional restrictions for use as a subdomain? + * + * @return bool + * @since 2.3.1 + * + * @see https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html + */ + private function isValidBucketName(string $bucketName, bool $asSubdomain = true): bool + { + /** + * If there are dots in the bucket name I can't use it as a subdomain. + * + * "If you include dots in a bucket's name, you can't use virtual-host-style addressing over HTTPS, unless you + * perform your own certificate validation. This is because the security certificates used for virtual hosting + * of buckets don't work for buckets with dots in their names." + */ + if ($asSubdomain && strpos($bucketName, '.') !== false) + { + return false; + } + + /** + * - Bucket names must be between 3 (min) and 63 (max) characters long. + * - Bucket names can consist only of lowercase letters, numbers, dots (.), and hyphens (-). + */ + if (!preg_match('/^[a-z0-9\-.]{3,63}$/', $bucketName)) + { + return false; + } + + // Bucket names must begin and end with a letter or number. + if (!preg_match('/^[a-z0-9].*[a-z0-9]$/', $bucketName)) + { + return false; + } + + // Bucket names must not contain two adjacent periods. + if (preg_match('/\.\./', $bucketName)) + { + return false; + } + + // Bucket names must not be formatted as an IP address (for example, 192.168.5.4). + if (preg_match('/^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$/', $bucketName)) + { + return false; + } + + // Bucket names must not start with the prefix xn--. + if (strpos($bucketName, 'xn--') === 0) + { + return false; + } + + // Bucket names must not start with the prefix sthree- and the prefix sthree-configurator. + if (strpos($bucketName, 'sthree-') === 0) + { + return false; + } + + // Bucket names must not end with the suffix -s3alias. + if (substr($bucketName, -8) === '-s3alias') + { + return false; + } + + // Bucket names must not end with the suffix --ol-s3. + if (substr($bucketName, -7) === '--ol-s3') + { + return false; + } + + return true; + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/StorageClass.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/StorageClass.php new file mode 100644 index 0000000000..91f9bb84a2 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/StorageClass.php @@ -0,0 +1,98 @@ +<?php +/** + * Akeeba Engine + * + * @package akeebaengine + * @copyright Copyright (c)2006-2024 Nicholas K. Dionysopoulos / Akeeba Ltd + * @license GNU General Public License version 3, or later + */ + +namespace Akeeba\S3; + +/** + * Amazon S3 Storage Classes + * + * When you want to override the default storage class of the bucket pass + * array('X-Amz-Storage-Class' => StorageClass::STANDARD) + * in the $headers array of Connector::putObject(). + * + * Alternatively, run the $headers array through setStorageClass(), e.g. + * $headers = array(); // You can put your stuff here + * StorageClass::setStorageClass($headers, StorageClass::STANDARD); + * $connector->putObject($myInput, 'bucketname', 'path/to/object.dat', Acl::PRIVATE, $headers) + * + * @see https://aws.amazon.com/s3/storage-classes/ + */ +class StorageClass +{ + /** + * Amazon S3 Standard (S3 Standard) + */ + public const STANDARD = 'STANDARD'; + + /** + * Reduced redundancy storage + * + * Not recommended anymore. Use INTELLIGENT_TIERING instead. + */ + public const REDUCED_REDUNDANCY = 'REDUCED_REDUNDANCY'; + + /** + * Amazon S3 Intelligent-Tiering (S3 Intelligent-Tiering) + */ + public const INTELLIGENT_TIERING = 'INTELLIGENT_TIERING'; + + /** + * Amazon S3 Standard-Infrequent Access (S3 Standard-IA) + */ + public const STANDARD_IA = 'STANDARD_IA'; + + /** + * Amazon S3 One Zone-Infrequent Access (S3 One Zone-IA) + */ + public const ONEZONE_IA = 'ONEZONE_IA'; + + /** + * Amazon S3 Glacier (S3 Glacier) + */ + public const GLACIER = 'GLACIER'; + + /** + * Amazon S3 Glacier Deep Archive (S3 Glacier Deep Archive) + */ + public const DEEP_ARCHIVE = 'DEEP_ARCHIVE'; + + /** + * Manipulate the $headers array, setting the X-Amz-Storage-Class header for the requested storage class. + * + * This method will automatically remove any previously set X-Amz-Storage-Class header, case-insensitive. The reason + * for that is that Amazon headers **are** case-insensitive and you could easily end up having two separate headers + * with competing storage classes. This would mess up the signature and your request would promptly fail. + * + * @param array $headers + * @param string $storageClass + * + * @return void + */ + public static function setStorageClass(array &$headers, string $storageClass): void + { + // Remove all previously set X-Amz-Storage-Class headers (case-insensitive) + $killList = []; + + foreach ($headers as $key => $value) + { + if (strtolower($key) === 'x-amz-storage-class') + { + $killList[] = $key; + } + } + + foreach ($killList as $key) + { + unset($headers[$key]); + } + + // Add the new X-Amz-Storage-Class header + $headers['X-Amz-Storage-Class'] = $storageClass; + } +} \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/aliasing.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/aliasing.php new file mode 100644 index 0000000000..f5a1189797 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/aliasing.php @@ -0,0 +1,35 @@ +<?php +/** + * Akeeba Engine + * + * @package akeebaengine + * @copyright Copyright (c)2006-2024 Nicholas K. Dionysopoulos / Akeeba Ltd + * @license GNU General Public License version 3, or later + */ + +/** + * Automatic aliasing of the old namespace to the new, as you use each old class. + */ +spl_autoload_register( + static function (string $className) + { + $oldNS = 'Akeeba\Engine\Postproc\Connector\S3v4'; + $newNS = 'Akeeba\S3'; + + $className = trim($className, '\\'); + + if (strpos($className, $oldNS) !== 0) + { + return false; + } + + $newClassName = $newNS . '\\' . trim(substr($className, strlen($oldNS)), '\\'); + + if (class_exists($newClassName, true)) + { + class_alias($newClassName, $className, false); + } + + return true; + } +); diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/autoload.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/autoload.php new file mode 100644 index 0000000000..bab64e642c --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/autoload.php @@ -0,0 +1,7 @@ +<?php + +// autoload.php @generated by Composer + +require_once __DIR__ . '/composer/autoload_real.php'; + +return ComposerAutoloaderInit03a8066c470486be30535b543d47f96a::getLoader(); diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/bin/lessc b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/bin/lessc new file mode 100755 index 0000000000..8def1ea729 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/bin/lessc @@ -0,0 +1,200 @@ +#!/usr/bin/env php +<?php + +require_once __DIR__ . '/../lib/Less/Autoloader.php'; +Less_Autoloader::register(); + +// Create our environment +$env = array('compress' => false, 'relativeUrls' => false); +$silent = false; +$watch = false; +$rootpath = ''; + +// Check for arguments +array_shift($argv); +if (!count($argv)) { + $argv[] = '-h'; +} + +// parse arguments +foreach ($argv as $key => $arg) { + if (preg_match('/^--?([a-z][0-9a-z-]*)(?:=([^\s]+))?$/i', $arg, $matches)) { + $option = $matches[1]; + $value = isset($matches[2]) ? $matches[2] : false; + unset($argv[$key]); + + switch ($option) { + case 'h': + case 'help': + echo <<<EOD +Usage: lessc [options] sources [destination] + + -h, --help Print help (this message) and exit. + -s, --silent Suppress output of error messages. + -v, --version Print version number and exit. + -x, --compress Compress output by removing some whitespaces. + --include-path=PATHS Set include paths. Separated by `:'. Use `;' on Windows. + --strict-imports Force evaluation of imports. + -m=, --math= + always Less will eagerly perform math operations always. + parens-division Math performed except for division (/) operator + parens | strict Math only performed inside parentheses'); + -su=on|off Allow mixed units, e.g. 1px+1em or 1px*1px which have units + --strict-units=on|off that cannot be represented. + -ru, --relative-urls re-write relative urls to the base less file. + -rp, --rootpath=URL Set rootpath for url rewriting in relative imports and urls. + Works with or without the relative-urls option. + -w, --watch Watch input files for changes. + -------------------------- Deprecated ---------------- + -sm=on|off Legacy parens-only math. Use --math instead. + --strict-math=on|off + +EOD; + exit; + case 's': + case 'silent': + $silent = true; + break; + + case 'w': + case 'watch': + $watch = true; + break; + + case 'v': + case 'version': + echo "lessc " . Less_Version::version . " (less.php)\n\n"; + exit; + + case 'rp': + case 'rootpath': + $rootpath = $value; + break; + + + //parser options + case 'compress': + $env['compress'] = true; + break; + + case 'ru': + case 'relative-urls': + $env['relativeUrls'] = true; + break; + + case 'su': + case 'strict-units': + $env['strictUnits'] = ($value === 'on'); + break; + + case 'sm': + case 'strict-math': + fwrite( STDERR, "lessc: The --strict-math option has been deprecated. Use --math=parens\n" ); + $env['strictMath'] = ( $value === "on" ); + break; + + case 'm': + case 'math': + $env['math'] = $value; + break; + + case 'x': + case 'include-path': + $env['import_dirs'] = preg_split('#;|\:#', $value); + break; + + } + } +} + +if (count($argv) > 1) { + $output = array_pop($argv); + $inputs = $argv; +} +else { + $inputs = $argv; + $output = false; +} + +if (!count($inputs)) { + echo("lessc: no input files\n"); + exit; +} + +if ($watch) { + if (!$output) { + echo("lessc: you must specify the output file if --watch is given\n"); + exit; + } + + $lastAction = 0; + + echo("lessc: watching input files\n"); + + while (1) { + clearstatcache(); + + $updated = false; + foreach ($inputs as $input) { + if ($input == '-') { + if (count($inputs) == 1) { + echo("lessc: during watching files is not possible to watch stdin\n"); + exit; + } + else { + continue; + } + } + + if (filemtime($input) > $lastAction) { + $updated = true; + break; + } + } + + if ($updated) { + $lastAction = time(); + $parser = new Less_Parser($env); + foreach ($inputs as $input) { + try { + $parser->parseFile($input, $rootpath); + } + catch (Exception $e) { + echo("lessc: " . $e->getMessage() . " \n"); + continue; // Invalid processing + } + } + + file_put_contents($output, $parser->getCss()); + echo("lessc: output file recompiled\n"); + } + + sleep(1); + } +} +else { + $parser = new Less_Parser($env); + foreach ($inputs as $input) { + if ($input == '-') { + $content = file_get_contents('php://stdin'); + $parser->parse($content); + } + else { + try { + $parser->parseFile($input); + } + catch (Exception $e) { + if (!$silent) { + echo("lessc: " . ((string)$e) . " \n"); + } + } + } + } + + if ($output) { + file_put_contents($output, $parser->getCss()); + } + else { + echo $parser->getCss(); + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Exceptions/APIError.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Exceptions/APIError.php new file mode 100644 index 0000000000..b7be26d86f --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Exceptions/APIError.php @@ -0,0 +1,74 @@ +<?php + +namespace ChargeBee\ChargeBee\Exceptions; + +use Exception; + +class APIError extends Exception +{ + private $httpStatusCode; + private $jsonObject; + private $type; + private $apiErrorCode; + private $param; + private $headers; + public function __construct($httpStatusCode, $jsonObject, $responseHeaders) + { + parent::__construct($jsonObject['message']); + + $this->jsonObject = $jsonObject; + $this->type = isset($jsonObject['type']) ? $jsonObject['type'] : null; + $this->apiErrorCode = $jsonObject['api_error_code']; + $this->param = isset($jsonObject['param']) ? $jsonObject['param'] : null; + $this->httpStatusCode = $httpStatusCode; + $this->headers = $responseHeaders; + } + + public function getHttpStatusCode() + { + return $this->httpStatusCode; + } + + public function getType() + { + return $this->type; + } + + public function getApiErrorCode() + { + return $this->apiErrorCode; + } + + public function getParam() + { + return $this->param; + } + + /** + * This function has been deprecated. Use getHttpStatusCode. + * @deprecated + */ + public function getHttpCode() + { + return $this->httpStatusCode; + } + + /** + * This function has been deprecated. There IO errors are now thrown as + * IOException. + * @deprecated + */ + public function getErrorNo() + { + return 0; + } + + public function getJsonObject() + { + return $this->jsonObject; + } + public function getHeaders() + { + return $this->headers; + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Exceptions/InvalidRequestException.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Exceptions/InvalidRequestException.php new file mode 100644 index 0000000000..a8e7e22bfd --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Exceptions/InvalidRequestException.php @@ -0,0 +1,13 @@ +<?php + +namespace ChargeBee\ChargeBee\Exceptions; + +use ChargeBee\ChargeBee\Exceptions\APIError; + +class InvalidRequestException extends APIError +{ + public function __construct($httpStatusCode, $jsonObject, $responseHeaders) + { + parent::__construct($httpStatusCode, $jsonObject, $responseHeaders); + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Exceptions/OperationFailedException.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Exceptions/OperationFailedException.php new file mode 100644 index 0000000000..872d48f3fd --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Exceptions/OperationFailedException.php @@ -0,0 +1,13 @@ +<?php + +namespace ChargeBee\ChargeBee\Exceptions; + +use ChargeBee\ChargeBee\Exceptions\APIError; + +class OperationFailedException extends APIError +{ + public function __construct($httpStatusCode, $jsonObject, $responseHeaders) + { + parent::__construct($httpStatusCode, $jsonObject, $responseHeaders); + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Exceptions/PaymentException.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Exceptions/PaymentException.php new file mode 100644 index 0000000000..825f8d3e71 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Exceptions/PaymentException.php @@ -0,0 +1,13 @@ +<?php + +namespace ChargeBee\ChargeBee\Exceptions; + +use ChargeBee\ChargeBee\Exceptions\APIError; + +class PaymentException extends APIError +{ + public function __construct($httpStatusCode, $jsonObject, $responseHeaders) + { + parent::__construct($httpStatusCode, $jsonObject, $responseHeaders); + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Guzzle.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Guzzle.php new file mode 100644 index 0000000000..1709bc32e7 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Guzzle.php @@ -0,0 +1,152 @@ +<?php + + +namespace ChargeBee\ChargeBee; + +use ChargeBee\ChargeBee; +use ChargeBee\ChargeBee\Exceptions\IOException; +use ChargeBee\ChargeBee\Exceptions\PaymentException; +use ChargeBee\ChargeBee\Exceptions\OperationFailedException; +use ChargeBee\ChargeBee\Exceptions\InvalidRequestException; +use ChargeBee\ChargeBee\Exceptions\APIError; +use Exception; +use GuzzleHttp\Client; +use GuzzleHttp\Exception\RequestException; + +class Guzzle +{ + public static function utf8($value) { + if (is_string($value)) + return mb_convert_encoding($value, "UTF-8"); + else + return $value; + } + + public static function doRequest($meth, $url, $env, $params = array(), $headers = array()) { + list($response, $httpCode, $responseHeaders) = self::request($meth, $url, $env, $params, $headers); + $respJson = self::processResponse($response, $httpCode, $responseHeaders); + $response = new Response($respJson, $responseHeaders); + return $response; + } + + public static function request($meth, $url, $env, $params, $headers) { + $client = new Client(); + + $opts = array( + 'connect_timeout' => Environment::$connectTimeoutInSecs, + 'timeout' => Environment::$requestTimeoutInSecs, + 'allow_redirects' => true, + 'http_errors' => false + ); + if ($meth == Request::GET) { + if (count($params) > 0) { + $opts['query'] = $params; + } + } else if ($meth == Request::POST) { + $opts['form_params'] = $params; + } else { + throw new Exception("Invalid http method $meth"); + } + $url = self::utf8($env->apiUrl($url)); + + $userAgent = "Chargebee-PHP-Client" . " v" . Version::VERSION; + $httpHeaders = array_merge($headers, ['Accept' => 'application/json', 'User-Agent' => $userAgent, 'Lang-Version' => phpversion() , 'OS-Version' => PHP_OS]); + + $opts['headers'] = $httpHeaders; + $opts['auth'] = [$env->getApiKey(), '']; + + // Specifying a CA bundle results in the following error when running in Google App Engine: + // "Unsupported SSL context options are set. The following options are present, but have been ignored: allow_self_signed, cafile" + // https://cloud.google.com/appengine/docs/php/outbound-requests#secure_connections_and_https + $opts['verify'] = ChargeBee::getVerifyCaCerts() && !self::isAppEngine() ? ChargeBee::getCaCertPath() : false; + + $response = null; + try { + $response = $client->request($meth, $url, $opts); + } catch (RequestException $e) { + $errno = $e->getCode(); + $guzzleMsg = $e->getMessage(); + $message = "IO exception occurred when trying to connect to " . $url . " . Reason : " . $guzzleMsg; + throw new IOException($message, $errno); + } + $responseHeaders = $response->getHeaders(); + $httpCode = $response->getStatusCode(); + return array((string)$response->getBody(), $httpCode, $responseHeaders); + } + + /** + * Recommended way to check if script is running in Google App Engine: + * https://github.com/google/google-api-php-client/blob/master/src/Google/Client.php#L799 + * + * @return bool Returns true if running in Google App Engine + */ + private static function isAppEngine() { + return (isset($_SERVER['SERVER_SOFTWARE']) && strpos($_SERVER['SERVER_SOFTWARE'], 'Google App Engine') !== false); + } + + /** + * @param $response + * @param $httpCode + * + * @return mixed + * @throws APIError + * @throws InvalidRequestException + * @throws OperationFailedException + * @throws PaymentException + */ + public static function processResponse($response, $httpCode, $responseHeaders){ + $respJson = json_decode($response, true); + if(!$respJson){ + if (strpos($response, '503') !== false) + throw new Exception("Sorry, the server is currently unable to handle the request due to a temporary overload or scheduled maintenance. Please retry after sometime. \n type: internal_temporary_error, \n http_status_code: 503, \n error_code: internal_temporary_error"); + else if (strpos($response, '504') !== false) + throw new Exception("The server did not receive a timely response from an upstream server, request aborted. If this problem persists, contact us at support@chargebee.com. \n type: gateway_timeout, \n http_status_code: 504, \n error_code: gateway_timeout"); + else + throw new Exception("Sorry, something went wrong when trying to process the request. If this problem persists, contact us at support@chargebee.com. \n type: internal_error, \n http_status_code: 500, \n error_code: internal_error "); + } + if ($httpCode < 200 || $httpCode > 299) { + self::handleAPIRespError($httpCode, $respJson, $response, $responseHeaders); + } + return $respJson; + } + + /** + * @param $httpCode + * @param $respJson + * @param $response + * + * @throws APIError + * @throws InvalidRequestException + * @throws OperationFailedException + * @throws PaymentException + */ + public static function handleAPIRespError($httpCode, $respJson, $response, $responseHeaders){ + if (!isset($respJson['api_error_code'])) { + throw new Exception("No api_error_code attribute in content. Probably not a ChargeBee's error response. The content is \n " . $response); + } + $type = "unknown"; + if (isset($respJson['type'])) { + $type = $respJson['type']; + } + if ($type == "payment") { + throw new PaymentException($httpCode, $respJson, $responseHeaders); + } elseif ($type == "operation_failed") { + throw new OperationFailedException($httpCode, $respJson, $responseHeaders); + } elseif ($type == "invalid_request") { + throw new InvalidRequestException($httpCode, $respJson, $responseHeaders); + } else { + throw new APIError($httpCode, $respJson, $responseHeaders); + } + } + +} + +class Response { + public $data; + public $headers; + + public function __construct($data, $headers) { + $this->data = $data; + $this->headers = $headers; + } +} \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/Addon.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/Addon.php new file mode 100644 index 0000000000..1cd2628f15 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/Addon.php @@ -0,0 +1,101 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; +use ChargeBee\ChargeBee\Request; +use ChargeBee\ChargeBee\Util; + +class Addon extends Model +{ + + protected $allowed = [ + 'id', + 'name', + 'invoiceName', + 'description', + 'pricingModel', + 'type', + 'chargeType', + 'price', + 'currencyCode', + 'period', + 'periodUnit', + 'unit', + 'status', + 'archivedAt', + 'enabledInPortal', + 'taxCode', + 'hsnCode', + 'taxjarProductCode', + 'avalaraSaleType', + 'avalaraTransactionType', + 'avalaraServiceType', + 'sku', + 'accountingCode', + 'accountingCategory1', + 'accountingCategory2', + 'accountingCategory3', + 'accountingCategory4', + 'isShippable', + 'shippingFrequencyPeriod', + 'shippingFrequencyPeriodUnit', + 'resourceVersion', + 'updatedAt', + 'priceInDecimal', + 'includedInMrr', + 'channel', + 'prorationType', + 'invoiceNotes', + 'taxable', + 'taxProfileId', + 'metaData', + 'tiers', + 'taxProvidersFields', + 'showDescriptionInInvoices', + 'showDescriptionInQuotes', + ]; + + + + # OPERATIONS + #----------- + + public static function create($params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("addons"), $params, $env, $headers); + } + + public static function update($id, $params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("addons",$id), $params, $env, $headers); + } + + public static function all($params = array(), $env = null, $headers = array()) + { + return Request::sendListRequest(Request::GET, Util::encodeURIPath("addons"), $params, $env, $headers); + } + + public static function retrieve($id, $env = null, $headers = array()) + { + return Request::send(Request::GET, Util::encodeURIPath("addons",$id), array(), $env, $headers); + } + + public static function delete($id, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("addons",$id,"delete"), array(), $env, $headers); + } + + public static function copy($params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("addons","copy"), $params, $env, $headers); + } + + public static function unarchive($id, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("addons",$id,"unarchive"), array(), $env, $headers); + } + + } + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/AddonTaxProvidersField.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/AddonTaxProvidersField.php new file mode 100644 index 0000000000..28149b6f2d --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/AddonTaxProvidersField.php @@ -0,0 +1,17 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; + +class AddonTaxProvidersField extends Model +{ + protected $allowed = [ + 'providerName', + 'fieldId', + 'fieldValue', + ]; + +} + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/Attribute.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/Attribute.php new file mode 100644 index 0000000000..24dc2fa040 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/Attribute.php @@ -0,0 +1,24 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; +use ChargeBee\ChargeBee\Request; +use ChargeBee\ChargeBee\Util; + +class Attribute extends Model +{ + + protected $allowed = [ + 'name', + 'value', + ]; + + + + # OPERATIONS + #----------- + + } + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/BusinessEntity.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/BusinessEntity.php new file mode 100644 index 0000000000..3203181391 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/BusinessEntity.php @@ -0,0 +1,39 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; +use ChargeBee\ChargeBee\Request; +use ChargeBee\ChargeBee\Util; + +class BusinessEntity extends Model +{ + + protected $allowed = [ + 'id', + 'name', + 'status', + 'deleted', + 'createdAt', + 'resourceVersion', + 'updatedAt', + ]; + + + + # OPERATIONS + #----------- + + public static function createTransfers($params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("business_entities","transfers"), $params, $env, $headers); + } + + public static function getTransfers($params = array(), $env = null, $headers = array()) + { + return Request::send(Request::GET, Util::encodeURIPath("business_entities","transfers"), $params, $env, $headers); + } + + } + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/BusinessEntityTransfer.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/BusinessEntityTransfer.php new file mode 100644 index 0000000000..a26c9d146b --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/BusinessEntityTransfer.php @@ -0,0 +1,30 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; +use ChargeBee\ChargeBee\Request; +use ChargeBee\ChargeBee\Util; + +class BusinessEntityTransfer extends Model +{ + + protected $allowed = [ + 'id', + 'resourceType', + 'resourceId', + 'activeResourceId', + 'destinationBusinessEntityId', + 'sourceBusinessEntityId', + 'reasonCode', + 'createdAt', + ]; + + + + # OPERATIONS + #----------- + + } + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/CreditNote.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/CreditNote.php new file mode 100644 index 0000000000..6188bd030f --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/CreditNote.php @@ -0,0 +1,138 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; +use ChargeBee\ChargeBee\Request; +use ChargeBee\ChargeBee\Util; + +class CreditNote extends Model +{ + + protected $allowed = [ + 'id', + 'customerId', + 'subscriptionId', + 'referenceInvoiceId', + 'type', + 'reasonCode', + 'status', + 'vatNumber', + 'date', + 'priceType', + 'currencyCode', + 'total', + 'amountAllocated', + 'amountRefunded', + 'amountAvailable', + 'refundedAt', + 'voidedAt', + 'generatedAt', + 'resourceVersion', + 'updatedAt', + 'channel', + 'einvoice', + 'subTotal', + 'subTotalInLocalCurrency', + 'totalInLocalCurrency', + 'localCurrencyCode', + 'roundOffAmount', + 'fractionalCorrection', + 'lineItems', + 'discounts', + 'lineItemDiscounts', + 'lineItemTiers', + 'taxes', + 'lineItemTaxes', + 'linkedRefunds', + 'allocations', + 'deleted', + 'taxCategory', + 'localCurrencyExchangeRate', + 'createReasonCode', + 'vatNumberPrefix', + 'businessEntityId', + 'shippingAddress', + 'billingAddress', + 'siteDetailsAtCreation', + 'taxOrigin', + ]; + + + + # OPERATIONS + #----------- + + public static function create($params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("credit_notes"), $params, $env, $headers); + } + + public static function retrieve($id, $env = null, $headers = array()) + { + return Request::send(Request::GET, Util::encodeURIPath("credit_notes",$id), array(), $env, $headers); + } + + public static function pdf($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("credit_notes",$id,"pdf"), $params, $env, $headers); + } + + public static function downloadEinvoice($id, $env = null, $headers = array()) + { + return Request::send(Request::GET, Util::encodeURIPath("credit_notes",$id,"download_einvoice"), array(), $env, $headers); + } + + public static function refund($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("credit_notes",$id,"refund"), $params, $env, $headers); + } + + public static function recordRefund($id, $params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("credit_notes",$id,"record_refund"), $params, $env, $headers); + } + + public static function voidCreditNote($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("credit_notes",$id,"void"), $params, $env, $headers); + } + + public static function all($params = array(), $env = null, $headers = array()) + { + return Request::sendListRequest(Request::GET, Util::encodeURIPath("credit_notes"), $params, $env, $headers); + } + + public static function creditNotesForCustomer($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::GET, Util::encodeURIPath("customers",$id,"credit_notes"), $params, $env, $headers); + } + + public static function delete($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("credit_notes",$id,"delete"), $params, $env, $headers); + } + + public static function removeTaxWithheldRefund($id, $params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("credit_notes",$id,"remove_tax_withheld_refund"), $params, $env, $headers); + } + + public static function resendEinvoice($id, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("credit_notes",$id,"resend_einvoice"), array(), $env, $headers); + } + + public static function sendEinvoice($id, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("credit_notes",$id,"send_einvoice"), array(), $env, $headers); + } + + public static function importCreditNote($params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("credit_notes","import_credit_note"), $params, $env, $headers); + } + + } + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/CreditNoteEstimateLineItem.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/CreditNoteEstimateLineItem.php new file mode 100644 index 0000000000..faf6a7ccf7 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/CreditNoteEstimateLineItem.php @@ -0,0 +1,38 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; + +class CreditNoteEstimateLineItem extends Model +{ + protected $allowed = [ + 'id', + 'subscriptionId', + 'dateFrom', + 'dateTo', + 'unitAmount', + 'quantity', + 'amount', + 'pricingModel', + 'isTaxed', + 'taxAmount', + 'taxRate', + 'unitAmountInDecimal', + 'quantityInDecimal', + 'amountInDecimal', + 'discountAmount', + 'itemLevelDiscountAmount', + 'usagePercentage', + 'referenceLineItemId', + 'description', + 'entityDescription', + 'entityType', + 'taxExemptReason', + 'entityId', + 'customerId', + ]; + +} + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/CreditNoteEstimateLineItemTax.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/CreditNoteEstimateLineItemTax.php new file mode 100644 index 0000000000..764a6af278 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/CreditNoteEstimateLineItemTax.php @@ -0,0 +1,29 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; + +class CreditNoteEstimateLineItemTax extends Model +{ + protected $allowed = [ + 'lineItemId', + 'taxName', + 'taxRate', + 'dateTo', + 'dateFrom', + 'proratedTaxableAmount', + 'isPartialTaxApplied', + 'isNonComplianceTax', + 'taxableAmount', + 'taxAmount', + 'taxJurisType', + 'taxJurisName', + 'taxJurisCode', + 'taxAmountInLocalCurrency', + 'localCurrencyCode', + ]; + +} + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/CreditNoteLineItem.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/CreditNoteLineItem.php new file mode 100644 index 0000000000..10483fd4bc --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/CreditNoteLineItem.php @@ -0,0 +1,38 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; + +class CreditNoteLineItem extends Model +{ + protected $allowed = [ + 'id', + 'subscriptionId', + 'dateFrom', + 'dateTo', + 'unitAmount', + 'quantity', + 'amount', + 'pricingModel', + 'isTaxed', + 'taxAmount', + 'taxRate', + 'unitAmountInDecimal', + 'quantityInDecimal', + 'amountInDecimal', + 'discountAmount', + 'itemLevelDiscountAmount', + 'usagePercentage', + 'referenceLineItemId', + 'description', + 'entityDescription', + 'entityType', + 'taxExemptReason', + 'entityId', + 'customerId', + ]; + +} + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/CreditNoteLineItemTax.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/CreditNoteLineItemTax.php new file mode 100644 index 0000000000..d5b5e006f4 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/CreditNoteLineItemTax.php @@ -0,0 +1,29 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; + +class CreditNoteLineItemTax extends Model +{ + protected $allowed = [ + 'lineItemId', + 'taxName', + 'taxRate', + 'dateTo', + 'dateFrom', + 'proratedTaxableAmount', + 'isPartialTaxApplied', + 'isNonComplianceTax', + 'taxableAmount', + 'taxAmount', + 'taxJurisType', + 'taxJurisName', + 'taxJurisCode', + 'taxAmountInLocalCurrency', + 'localCurrencyCode', + ]; + +} + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/CreditNoteSiteDetailsAtCreation.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/CreditNoteSiteDetailsAtCreation.php new file mode 100644 index 0000000000..d24d4c0ca3 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/CreditNoteSiteDetailsAtCreation.php @@ -0,0 +1,16 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; + +class CreditNoteSiteDetailsAtCreation extends Model +{ + protected $allowed = [ + 'timezone', + 'organizationAddress', + ]; + +} + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/CreditNoteTaxOrigin.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/CreditNoteTaxOrigin.php new file mode 100644 index 0000000000..27e4d92352 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/CreditNoteTaxOrigin.php @@ -0,0 +1,16 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; + +class CreditNoteTaxOrigin extends Model +{ + protected $allowed = [ + 'country', + 'registrationNumber', + ]; + +} + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/Currency.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/Currency.php new file mode 100644 index 0000000000..ffb2d47523 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/Currency.php @@ -0,0 +1,58 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; +use ChargeBee\ChargeBee\Request; +use ChargeBee\ChargeBee\Util; + +class Currency extends Model +{ + + protected $allowed = [ + 'id', + 'enabled', + 'forexType', + 'currencyCode', + 'isBaseCurrency', + 'manualExchangeRate', + ]; + + + + # OPERATIONS + #----------- + + public static function all($env = null, $headers = array()) + { + return Request::sendListRequest(Request::GET, Util::encodeURIPath("currencies","list"), array(), $env, $headers); + } + + public static function retrieve($id, $env = null, $headers = array()) + { + return Request::send(Request::GET, Util::encodeURIPath("currencies",$id), array(), $env, $headers); + } + + public static function create($params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("currencies"), $params, $env, $headers); + } + + public static function update($id, $params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("currencies",$id), $params, $env, $headers); + } + + public static function addSchedule($id, $params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("currencies",$id,"add_schedule"), $params, $env, $headers); + } + + public static function removeSchedule($id, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("currencies",$id,"remove_schedule"), array(), $env, $headers); + } + + } + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/Customer.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/Customer.php new file mode 100644 index 0000000000..d4c3732bbe --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/Customer.php @@ -0,0 +1,213 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; +use ChargeBee\ChargeBee\Request; +use ChargeBee\ChargeBee\Util; + +class Customer extends Model +{ + + protected $allowed = [ + 'id', + 'firstName', + 'lastName', + 'email', + 'phone', + 'company', + 'vatNumber', + 'autoCollection', + 'offlinePaymentMethod', + 'netTermDays', + 'vatNumberValidatedTime', + 'vatNumberStatus', + 'allowDirectDebit', + 'isLocationValid', + 'createdAt', + 'createdFromIp', + 'exemptionDetails', + 'taxability', + 'entityCode', + 'exemptNumber', + 'resourceVersion', + 'updatedAt', + 'locale', + 'billingDate', + 'billingMonth', + 'billingDateMode', + 'billingDayOfWeek', + 'billingDayOfWeekMode', + 'piiCleared', + 'autoCloseInvoices', + 'channel', + 'activeId', + 'cardStatus', + 'fraudFlag', + 'primaryPaymentSourceId', + 'backupPaymentSourceId', + 'billingAddress', + 'referralUrls', + 'contacts', + 'paymentMethod', + 'invoiceNotes', + 'businessEntityId', + 'preferredCurrencyCode', + 'promotionalCredits', + 'unbilledCharges', + 'refundableCredits', + 'excessPayments', + 'balances', + 'entityIdentifiers', + 'taxProvidersFields', + 'isEinvoiceEnabled', + 'einvoicingMethod', + 'metaData', + 'deleted', + 'registeredForGst', + 'consolidatedInvoicing', + 'customerType', + 'businessCustomerWithoutVatNumber', + 'clientProfileId', + 'relationship', + 'useDefaultHierarchySettings', + 'parentAccountAccess', + 'childAccountAccess', + 'vatNumberPrefix', + 'entityIdentifierScheme', + 'entityIdentifierStandard', + ]; + + + + # OPERATIONS + #----------- + + public static function create($params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("customers"), $params, $env, $headers); + } + + public static function all($params = array(), $env = null, $headers = array()) + { + return Request::sendListRequest(Request::GET, Util::encodeURIPath("customers"), $params, $env, $headers); + } + + public static function retrieve($id, $env = null, $headers = array()) + { + return Request::send(Request::GET, Util::encodeURIPath("customers",$id), array(), $env, $headers); + } + + public static function update($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("customers",$id), $params, $env, $headers); + } + + public static function updatePaymentMethod($id, $params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("customers",$id,"update_payment_method"), $params, $env, $headers); + } + + public static function updateBillingInfo($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("customers",$id,"update_billing_info"), $params, $env, $headers); + } + + public static function contactsForCustomer($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::GET, Util::encodeURIPath("customers",$id,"contacts"), $params, $env, $headers); + } + + public static function assignPaymentRole($id, $params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("customers",$id,"assign_payment_role"), $params, $env, $headers); + } + + public static function addContact($id, $params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("customers",$id,"add_contact"), $params, $env, $headers); + } + + public static function updateContact($id, $params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("customers",$id,"update_contact"), $params, $env, $headers); + } + + public static function deleteContact($id, $params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("customers",$id,"delete_contact"), $params, $env, $headers); + } + + public static function addPromotionalCredits($id, $params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("customers",$id,"add_promotional_credits"), $params, $env, $headers); + } + + public static function deductPromotionalCredits($id, $params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("customers",$id,"deduct_promotional_credits"), $params, $env, $headers); + } + + public static function setPromotionalCredits($id, $params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("customers",$id,"set_promotional_credits"), $params, $env, $headers); + } + + public static function recordExcessPayment($id, $params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("customers",$id,"record_excess_payment"), $params, $env, $headers); + } + + public static function collectPayment($id, $params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("customers",$id,"collect_payment"), $params, $env, $headers); + } + + public static function delete($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("customers",$id,"delete"), $params, $env, $headers); + } + + public static function move($params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("customers","move"), $params, $env, $headers); + } + + public static function changeBillingDate($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("customers",$id,"change_billing_date"), $params, $env, $headers); + } + + public static function merge($params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("customers","merge"), $params, $env, $headers); + } + + public static function clearPersonalData($id, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("customers",$id,"clear_personal_data"), array(), $env, $headers); + } + + public static function relationships($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("customers",$id,"relationships"), $params, $env, $headers); + } + + public static function deleteRelationship($id, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("customers",$id,"delete_relationship"), array(), $env, $headers); + } + + public static function hierarchy($id, $params, $env = null, $headers = array()) + { + return Request::send(Request::GET, Util::encodeURIPath("customers",$id,"hierarchy"), $params, $env, $headers); + } + + public static function updateHierarchySettings($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("customers",$id,"update_hierarchy_settings"), $params, $env, $headers); + } + + } + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/CustomerEntitlement.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/CustomerEntitlement.php new file mode 100644 index 0000000000..47f0ddc424 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/CustomerEntitlement.php @@ -0,0 +1,33 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; +use ChargeBee\ChargeBee\Request; +use ChargeBee\ChargeBee\Util; + +class CustomerEntitlement extends Model +{ + + protected $allowed = [ + 'customerId', + 'subscriptionId', + 'featureId', + 'value', + 'name', + 'isEnabled', + ]; + + + + # OPERATIONS + #----------- + + public static function entitlementsForCustomer($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::GET, Util::encodeURIPath("customers",$id,"customer_entitlements"), $params, $env, $headers); + } + + } + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/CustomerTaxProvidersField.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/CustomerTaxProvidersField.php new file mode 100644 index 0000000000..23867547d5 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/CustomerTaxProvidersField.php @@ -0,0 +1,17 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; + +class CustomerTaxProvidersField extends Model +{ + protected $allowed = [ + 'providerName', + 'fieldId', + 'fieldValue', + ]; + +} + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/Entitlement.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/Entitlement.php new file mode 100644 index 0000000000..be9456477d --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/Entitlement.php @@ -0,0 +1,39 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; +use ChargeBee\ChargeBee\Request; +use ChargeBee\ChargeBee\Util; + +class Entitlement extends Model +{ + + protected $allowed = [ + 'id', + 'entityId', + 'entityType', + 'featureId', + 'featureName', + 'value', + 'name', + ]; + + + + # OPERATIONS + #----------- + + public static function all($params = array(), $env = null, $headers = array()) + { + return Request::sendListRequest(Request::GET, Util::encodeURIPath("entitlements"), $params, $env, $headers); + } + + public static function create($params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("entitlements"), $params, $env, $headers); + } + + } + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/EntitlementOverride.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/EntitlementOverride.php new file mode 100644 index 0000000000..b901ae4983 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/EntitlementOverride.php @@ -0,0 +1,42 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; +use ChargeBee\ChargeBee\Request; +use ChargeBee\ChargeBee\Util; + +class EntitlementOverride extends Model +{ + + protected $allowed = [ + 'id', + 'entityId', + 'entityType', + 'featureId', + 'featureName', + 'value', + 'name', + 'expiresAt', + 'effectiveFrom', + 'scheduleStatus', + ]; + + + + # OPERATIONS + #----------- + + public static function addEntitlementOverrideForSubscription($id, $params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("subscriptions",$id,"entitlement_overrides"), $params, $env, $headers); + } + + public static function listEntitlementOverrideForSubscription($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::GET, Util::encodeURIPath("subscriptions",$id,"entitlement_overrides"), $params, $env, $headers); + } + + } + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/Event.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/Event.php new file mode 100644 index 0000000000..d30a501ebe --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/Event.php @@ -0,0 +1,69 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; +use ChargeBee\ChargeBee\Request; +use ChargeBee\ChargeBee\Util; +use ChargeBee\ChargeBee\Environment; +use Exception; +use RuntimeException; + +class Event extends Model +{ + + protected $allowed = [ + 'id', + 'occurredAt', + 'source', + 'user', + 'webhookStatus', + 'webhookFailureReason', + 'webhooks', + 'eventType', + 'apiVersion', + 'originUser', + ]; + + public function content() + { + return new Content($this->_values['content']); + } + + public static function deserialize($json) + { + $webhookData = json_decode($json, true); + if(!$webhookData) { + throw new Exception("Response not in JSON format. Might not be a ChargeBee webhook call."); + } + if($webhookData != null) + { + if( isset($webhookData['api_version']) ) { + $apiVersion = strtoupper($webhookData['api_version']); + if($apiVersion != null && strcasecmp($apiVersion, Environment::API_VERSION) != 0){ + throw new RuntimeException("API version [".$apiVersion."] in response does not match " + ."with client library API version [".strtoupper(Environment::API_VERSION)."]"); + } + } + return new self($webhookData); + } + return null; + } + + + # OPERATIONS + #----------- + + public static function all($params = array(), $env = null, $headers = array()) + { + return Request::sendListRequest(Request::GET, Util::encodeURIPath("events"), $params, $env, $headers); + } + + public static function retrieve($id, $env = null, $headers = array()) + { + return Request::send(Request::GET, Util::encodeURIPath("events",$id), array(), $env, $headers); + } + + } + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/Export.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/Export.php new file mode 100644 index 0000000000..79a9c9d24d --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/Export.php @@ -0,0 +1,131 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; +use ChargeBee\ChargeBee\Request; +use ChargeBee\ChargeBee\Util; +use ChargeBee\ChargeBee\Environment; + +class Export extends Model +{ + + protected $allowed = [ + 'id', + 'operationType', + 'mimeType', + 'status', + 'createdAt', + 'download', + ]; + +public function waitForExportCompletion($env = null, $headers = array()) { + $count = 0; + while($this->status == "in_process") { + if( $count++ > 50) { + throw new RuntimeException("Export is taking too long"); + } + sleep(Environment::$exportWaitInSecs); + $this->_values = self::retrieve($this->id, $env, $headers)->export()->getValues(); + $this->_load(); + } + return $this; +} + + + # OPERATIONS + #----------- + + public static function retrieve($id, $env = null, $headers = array()) + { + return Request::send(Request::GET, Util::encodeURIPath("exports",$id), array(), $env, $headers); + } + + public static function revenueRecognition($params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("exports","revenue_recognition"), $params, $env, $headers); + } + + public static function deferredRevenue($params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("exports","deferred_revenue"), $params, $env, $headers); + } + + public static function plans($params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("exports","plans"), $params, $env, $headers); + } + + public static function addons($params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("exports","addons"), $params, $env, $headers); + } + + public static function coupons($params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("exports","coupons"), $params, $env, $headers); + } + + public static function customers($params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("exports","customers"), $params, $env, $headers); + } + + public static function subscriptions($params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("exports","subscriptions"), $params, $env, $headers); + } + + public static function invoices($params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("exports","invoices"), $params, $env, $headers); + } + + public static function creditNotes($params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("exports","credit_notes"), $params, $env, $headers); + } + + public static function transactions($params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("exports","transactions"), $params, $env, $headers); + } + + public static function orders($params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("exports","orders"), $params, $env, $headers); + } + + public static function itemFamilies($params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("exports","item_families"), $params, $env, $headers); + } + + public static function items($params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("exports","items"), $params, $env, $headers); + } + + public static function itemPrices($params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("exports","item_prices"), $params, $env, $headers); + } + + public static function attachedItems($params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("exports","attached_items"), $params, $env, $headers); + } + + public static function differentialPrices($params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("exports","differential_prices"), $params, $env, $headers); + } + + public static function priceVariants($params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("exports","price_variants"), $params, $env, $headers); + } + + } + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/GatewayErrorDetail.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/GatewayErrorDetail.php new file mode 100644 index 0000000000..6d2e9ec564 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/GatewayErrorDetail.php @@ -0,0 +1,35 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; +use ChargeBee\ChargeBee\Request; +use ChargeBee\ChargeBee\Util; + +class GatewayErrorDetail extends Model +{ + + protected $allowed = [ + 'requestId', + 'errorCategory', + 'errorCode', + 'errorMessage', + 'declineCode', + 'declineMessage', + 'networkErrorCode', + 'networkErrorMessage', + 'errorField', + 'recommendationCode', + 'recommendationMessage', + 'processorErrorCode', + 'processorErrorMessage', + ]; + + + + # OPERATIONS + #----------- + + } + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/ImpactedItemPrice.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/ImpactedItemPrice.php new file mode 100644 index 0000000000..d36aa669c3 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/ImpactedItemPrice.php @@ -0,0 +1,25 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; +use ChargeBee\ChargeBee\Request; +use ChargeBee\ChargeBee\Util; + +class ImpactedItemPrice extends Model +{ + + protected $allowed = [ + 'count', + 'download', + 'itemPrices', + ]; + + + + # OPERATIONS + #----------- + + } + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/ImpactedItemPriceDownload.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/ImpactedItemPriceDownload.php new file mode 100644 index 0000000000..57137b6242 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/ImpactedItemPriceDownload.php @@ -0,0 +1,17 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; + +class ImpactedItemPriceDownload extends Model +{ + protected $allowed = [ + 'downloadUrl', + 'validTill', + 'mimeType', + ]; + +} + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/Installment.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/Installment.php new file mode 100644 index 0000000000..3dfedee14a --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/Installment.php @@ -0,0 +1,40 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; +use ChargeBee\ChargeBee\Request; +use ChargeBee\ChargeBee\Util; + +class Installment extends Model +{ + + protected $allowed = [ + 'id', + 'invoiceId', + 'date', + 'amount', + 'status', + 'createdAt', + 'resourceVersion', + 'updatedAt', + ]; + + + + # OPERATIONS + #----------- + + public static function retrieve($id, $env = null, $headers = array()) + { + return Request::send(Request::GET, Util::encodeURIPath("installments",$id), array(), $env, $headers); + } + + public static function all($params, $env = null, $headers = array()) + { + return Request::sendListRequest(Request::GET, Util::encodeURIPath("installments"), $params, $env, $headers); + } + + } + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/InstallmentConfig.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/InstallmentConfig.php new file mode 100644 index 0000000000..13d4149989 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/InstallmentConfig.php @@ -0,0 +1,47 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; +use ChargeBee\ChargeBee\Request; +use ChargeBee\ChargeBee\Util; + +class InstallmentConfig extends Model +{ + + protected $allowed = [ + 'id', + 'description', + 'numberOfInstallments', + 'periodUnit', + 'period', + 'preferredDay', + 'createdAt', + 'resourceVersion', + 'updatedAt', + 'installments', + ]; + + + + # OPERATIONS + #----------- + + public static function create($params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("installment_configs"), $params, $env, $headers); + } + + public static function retrieve($id, $env = null, $headers = array()) + { + return Request::send(Request::GET, Util::encodeURIPath("installment_configs",$id), array(), $env, $headers); + } + + public static function delete($id, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("installment_configs",$id,"delete"), array(), $env, $headers); + } + + } + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/InstallmentConfigInstallment.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/InstallmentConfigInstallment.php new file mode 100644 index 0000000000..af54eee2e6 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/InstallmentConfigInstallment.php @@ -0,0 +1,16 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; + +class InstallmentConfigInstallment extends Model +{ + protected $allowed = [ + 'period', + 'amountPercentage', + ]; + +} + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/InstallmentDetail.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/InstallmentDetail.php new file mode 100644 index 0000000000..d5f79e756d --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/InstallmentDetail.php @@ -0,0 +1,26 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; +use ChargeBee\ChargeBee\Request; +use ChargeBee\ChargeBee\Util; + +class InstallmentDetail extends Model +{ + + protected $allowed = [ + 'id', + 'invoiceId', + 'amount', + 'installments', + ]; + + + + # OPERATIONS + #----------- + + } + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/InstallmentDetailInstallment.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/InstallmentDetailInstallment.php new file mode 100644 index 0000000000..85ef16f977 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/InstallmentDetailInstallment.php @@ -0,0 +1,22 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; + +class InstallmentDetailInstallment extends Model +{ + protected $allowed = [ + 'id', + 'invoiceId', + 'date', + 'amount', + 'status', + 'createdAt', + 'resourceVersion', + 'updatedAt', + ]; + +} + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/Invoice.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/Invoice.php new file mode 100644 index 0000000000..f3bf0708e7 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/Invoice.php @@ -0,0 +1,273 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; +use ChargeBee\ChargeBee\Request; +use ChargeBee\ChargeBee\Util; + +class Invoice extends Model +{ + + protected $allowed = [ + 'id', + 'poNumber', + 'customerId', + 'subscriptionId', + 'recurring', + 'status', + 'vatNumber', + 'priceType', + 'date', + 'dueDate', + 'netTermDays', + 'exchangeRate', + 'currencyCode', + 'total', + 'amountPaid', + 'amountAdjusted', + 'writeOffAmount', + 'creditsApplied', + 'amountDue', + 'paidAt', + 'dunningStatus', + 'nextRetryAt', + 'voidedAt', + 'resourceVersion', + 'updatedAt', + 'subTotal', + 'subTotalInLocalCurrency', + 'totalInLocalCurrency', + 'localCurrencyCode', + 'tax', + 'localCurrencyExchangeRate', + 'firstInvoice', + 'newSalesAmount', + 'hasAdvanceCharges', + 'termFinalized', + 'isGifted', + 'generatedAt', + 'expectedPaymentDate', + 'amountToCollect', + 'roundOffAmount', + 'lineItems', + 'discounts', + 'lineItemDiscounts', + 'taxes', + 'lineItemTaxes', + 'lineItemTiers', + 'linkedPayments', + 'dunningAttempts', + 'appliedCredits', + 'adjustmentCreditNotes', + 'issuedCreditNotes', + 'linkedOrders', + 'notes', + 'shippingAddress', + 'statementDescriptor', + 'billingAddress', + 'einvoice', + 'paymentOwner', + 'voidReasonCode', + 'deleted', + 'taxCategory', + 'vatNumberPrefix', + 'channel', + 'businessEntityId', + 'siteDetailsAtCreation', + 'taxOrigin', + ]; + + + + # OPERATIONS + #----------- + + public static function create($params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("invoices"), $params, $env, $headers); + } + + public static function createForChargeItemsAndCharges($params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("invoices","create_for_charge_items_and_charges"), $params, $env, $headers); + } + + public static function charge($params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("invoices","charge"), $params, $env, $headers); + } + + public static function chargeAddon($params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("invoices","charge_addon"), $params, $env, $headers); + } + + public static function createForChargeItem($params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("invoices","create_for_charge_item"), $params, $env, $headers); + } + + public static function stopDunning($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("invoices",$id,"stop_dunning"), $params, $env, $headers); + } + + public static function importInvoice($params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("invoices","import_invoice"), $params, $env, $headers); + } + + public static function applyPayments($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("invoices",$id,"apply_payments"), $params, $env, $headers); + } + + public static function syncUsages($id, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("invoices",$id,"sync_usages"), array(), $env, $headers); + } + + public static function deleteLineItems($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("invoices",$id,"delete_line_items"), $params, $env, $headers); + } + + public static function applyCredits($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("invoices",$id,"apply_credits"), $params, $env, $headers); + } + + public static function all($params = array(), $env = null, $headers = array()) + { + return Request::sendListRequest(Request::GET, Util::encodeURIPath("invoices"), $params, $env, $headers); + } + + public static function invoicesForCustomer($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::GET, Util::encodeURIPath("customers",$id,"invoices"), $params, $env, $headers); + } + + public static function invoicesForSubscription($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::GET, Util::encodeURIPath("subscriptions",$id,"invoices"), $params, $env, $headers); + } + + public static function retrieve($id, $env = null, $headers = array()) + { + return Request::send(Request::GET, Util::encodeURIPath("invoices",$id), array(), $env, $headers); + } + + public static function pdf($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("invoices",$id,"pdf"), $params, $env, $headers); + } + + public static function downloadEinvoice($id, $env = null, $headers = array()) + { + return Request::send(Request::GET, Util::encodeURIPath("invoices",$id,"download_einvoice"), array(), $env, $headers); + } + + public static function listPaymentReferenceNumbers($params = array(), $env = null, $headers = array()) + { + return Request::send(Request::GET, Util::encodeURIPath("invoices","payment_reference_numbers"), $params, $env, $headers); + } + + public static function addCharge($id, $params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("invoices",$id,"add_charge"), $params, $env, $headers); + } + + public static function addAddonCharge($id, $params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("invoices",$id,"add_addon_charge"), $params, $env, $headers); + } + + public static function addChargeItem($id, $params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("invoices",$id,"add_charge_item"), $params, $env, $headers); + } + + public static function close($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("invoices",$id,"close"), $params, $env, $headers); + } + + public static function collectPayment($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("invoices",$id,"collect_payment"), $params, $env, $headers); + } + + public static function recordPayment($id, $params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("invoices",$id,"record_payment"), $params, $env, $headers); + } + + public static function recordTaxWithheld($id, $params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("invoices",$id,"record_tax_withheld"), $params, $env, $headers); + } + + public static function removeTaxWithheld($id, $params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("invoices",$id,"remove_tax_withheld"), $params, $env, $headers); + } + + public static function refund($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("invoices",$id,"refund"), $params, $env, $headers); + } + + public static function recordRefund($id, $params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("invoices",$id,"record_refund"), $params, $env, $headers); + } + + public static function removePayment($id, $params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("invoices",$id,"remove_payment"), $params, $env, $headers); + } + + public static function removeCreditNote($id, $params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("invoices",$id,"remove_credit_note"), $params, $env, $headers); + } + + public static function voidInvoice($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("invoices",$id,"void"), $params, $env, $headers); + } + + public static function writeOff($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("invoices",$id,"write_off"), $params, $env, $headers); + } + + public static function delete($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("invoices",$id,"delete"), $params, $env, $headers); + } + + public static function updateDetails($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("invoices",$id,"update_details"), $params, $env, $headers); + } + + public static function installments($id, $params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("invoices",$id,"installments"), $params, $env, $headers); + } + + public static function resendEinvoice($id, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("invoices",$id,"resend_einvoice"), array(), $env, $headers); + } + + public static function sendEinvoice($id, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("invoices",$id,"send_einvoice"), array(), $env, $headers); + } + + } + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/InvoiceEstimateLineItem.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/InvoiceEstimateLineItem.php new file mode 100644 index 0000000000..f7e564e5bb --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/InvoiceEstimateLineItem.php @@ -0,0 +1,38 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; + +class InvoiceEstimateLineItem extends Model +{ + protected $allowed = [ + 'id', + 'subscriptionId', + 'dateFrom', + 'dateTo', + 'unitAmount', + 'quantity', + 'amount', + 'pricingModel', + 'isTaxed', + 'taxAmount', + 'taxRate', + 'unitAmountInDecimal', + 'quantityInDecimal', + 'amountInDecimal', + 'discountAmount', + 'itemLevelDiscountAmount', + 'usagePercentage', + 'referenceLineItemId', + 'description', + 'entityDescription', + 'entityType', + 'taxExemptReason', + 'entityId', + 'customerId', + ]; + +} + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/InvoiceEstimateLineItemTax.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/InvoiceEstimateLineItemTax.php new file mode 100644 index 0000000000..2b2d311872 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/InvoiceEstimateLineItemTax.php @@ -0,0 +1,29 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; + +class InvoiceEstimateLineItemTax extends Model +{ + protected $allowed = [ + 'lineItemId', + 'taxName', + 'taxRate', + 'dateTo', + 'dateFrom', + 'proratedTaxableAmount', + 'isPartialTaxApplied', + 'isNonComplianceTax', + 'taxableAmount', + 'taxAmount', + 'taxJurisType', + 'taxJurisName', + 'taxJurisCode', + 'taxAmountInLocalCurrency', + 'localCurrencyCode', + ]; + +} + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/InvoiceLineItem.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/InvoiceLineItem.php new file mode 100644 index 0000000000..1ce80e0297 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/InvoiceLineItem.php @@ -0,0 +1,38 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; + +class InvoiceLineItem extends Model +{ + protected $allowed = [ + 'id', + 'subscriptionId', + 'dateFrom', + 'dateTo', + 'unitAmount', + 'quantity', + 'amount', + 'pricingModel', + 'isTaxed', + 'taxAmount', + 'taxRate', + 'unitAmountInDecimal', + 'quantityInDecimal', + 'amountInDecimal', + 'discountAmount', + 'itemLevelDiscountAmount', + 'usagePercentage', + 'referenceLineItemId', + 'description', + 'entityDescription', + 'entityType', + 'taxExemptReason', + 'entityId', + 'customerId', + ]; + +} + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/InvoiceLineItemTax.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/InvoiceLineItemTax.php new file mode 100644 index 0000000000..fb3252c2e5 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/InvoiceLineItemTax.php @@ -0,0 +1,29 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; + +class InvoiceLineItemTax extends Model +{ + protected $allowed = [ + 'lineItemId', + 'taxName', + 'taxRate', + 'dateTo', + 'dateFrom', + 'proratedTaxableAmount', + 'isPartialTaxApplied', + 'isNonComplianceTax', + 'taxableAmount', + 'taxAmount', + 'taxJurisType', + 'taxJurisName', + 'taxJurisCode', + 'taxAmountInLocalCurrency', + 'localCurrencyCode', + ]; + +} + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/InvoiceSiteDetailsAtCreation.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/InvoiceSiteDetailsAtCreation.php new file mode 100644 index 0000000000..5388fc6a30 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/InvoiceSiteDetailsAtCreation.php @@ -0,0 +1,16 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; + +class InvoiceSiteDetailsAtCreation extends Model +{ + protected $allowed = [ + 'timezone', + 'organizationAddress', + ]; + +} + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/InvoiceStatementDescriptor.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/InvoiceStatementDescriptor.php new file mode 100644 index 0000000000..f8171a2e81 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/InvoiceStatementDescriptor.php @@ -0,0 +1,16 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; + +class InvoiceStatementDescriptor extends Model +{ + protected $allowed = [ + 'id', + 'descriptor', + ]; + +} + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/InvoiceTaxOrigin.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/InvoiceTaxOrigin.php new file mode 100644 index 0000000000..44b1beb75c --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/InvoiceTaxOrigin.php @@ -0,0 +1,16 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; + +class InvoiceTaxOrigin extends Model +{ + protected $allowed = [ + 'country', + 'registrationNumber', + ]; + +} + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/ItemPrice.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/ItemPrice.php new file mode 100644 index 0000000000..1b4d8e6f4f --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/ItemPrice.php @@ -0,0 +1,97 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; +use ChargeBee\ChargeBee\Request; +use ChargeBee\ChargeBee\Util; + +class ItemPrice extends Model +{ + + protected $allowed = [ + 'id', + 'name', + 'itemFamilyId', + 'itemId', + 'description', + 'status', + 'externalName', + 'priceVariantId', + 'prorationType', + 'pricingModel', + 'price', + 'priceInDecimal', + 'period', + 'currencyCode', + 'periodUnit', + 'trialPeriod', + 'trialPeriodUnit', + 'trialEndAction', + 'shippingPeriod', + 'shippingPeriodUnit', + 'billingCycles', + 'freeQuantity', + 'freeQuantityInDecimal', + 'channel', + 'resourceVersion', + 'updatedAt', + 'createdAt', + 'archivedAt', + 'invoiceNotes', + 'tiers', + 'isTaxable', + 'taxDetail', + 'taxProvidersFields', + 'accountingDetail', + 'metadata', + 'itemType', + 'archivable', + 'parentItemId', + 'showDescriptionInInvoices', + 'showDescriptionInQuotes', + ]; + + + + # OPERATIONS + #----------- + + public static function create($params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("item_prices"), $params, $env, $headers); + } + + public static function retrieve($id, $env = null, $headers = array()) + { + return Request::send(Request::GET, Util::encodeURIPath("item_prices",$id), array(), $env, $headers); + } + + public static function update($id, $params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("item_prices",$id), $params, $env, $headers); + } + + public static function all($params = array(), $env = null, $headers = array()) + { + return Request::sendListRequest(Request::GET, Util::encodeURIPath("item_prices"), $params, $env, $headers); + } + + public static function delete($id, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("item_prices",$id,"delete"), array(), $env, $headers); + } + + public static function findApplicableItems($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::GET, Util::encodeURIPath("item_prices",$id,"applicable_items"), $params, $env, $headers); + } + + public static function findApplicableItemPrices($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::GET, Util::encodeURIPath("item_prices",$id,"applicable_item_prices"), $params, $env, $headers); + } + + } + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/ItemPriceTaxProvidersField.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/ItemPriceTaxProvidersField.php new file mode 100644 index 0000000000..deba803f74 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/ItemPriceTaxProvidersField.php @@ -0,0 +1,17 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; + +class ItemPriceTaxProvidersField extends Model +{ + protected $allowed = [ + 'providerName', + 'fieldId', + 'fieldValue', + ]; + +} + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/Metadata.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/Metadata.php new file mode 100644 index 0000000000..28f870fd1f --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/Metadata.php @@ -0,0 +1,23 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; +use ChargeBee\ChargeBee\Request; +use ChargeBee\ChargeBee\Util; + +class Metadata extends Model +{ + + protected $allowed = [ + 'changeType', + ]; + + + + # OPERATIONS + #----------- + + } + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/OrderLineItemTax.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/OrderLineItemTax.php new file mode 100644 index 0000000000..fa7ac659a3 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/OrderLineItemTax.php @@ -0,0 +1,29 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; + +class OrderLineItemTax extends Model +{ + protected $allowed = [ + 'lineItemId', + 'taxName', + 'taxRate', + 'dateTo', + 'dateFrom', + 'proratedTaxableAmount', + 'isPartialTaxApplied', + 'isNonComplianceTax', + 'taxableAmount', + 'taxAmount', + 'taxJurisType', + 'taxJurisName', + 'taxJurisCode', + 'taxAmountInLocalCurrency', + 'localCurrencyCode', + ]; + +} + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/PaymentIntentPaymentAttempt.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/PaymentIntentPaymentAttempt.php new file mode 100644 index 0000000000..d56728868d --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/PaymentIntentPaymentAttempt.php @@ -0,0 +1,23 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; + +class PaymentIntentPaymentAttempt extends Model +{ + protected $allowed = [ + 'id', + 'status', + 'paymentMethodType', + 'idAtGateway', + 'errorCode', + 'errorText', + 'createdAt', + 'modifiedAt', + 'errorDetail', + ]; + +} + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/PaymentSource.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/PaymentSource.php new file mode 100644 index 0000000000..e62465f6df --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/PaymentSource.php @@ -0,0 +1,126 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; +use ChargeBee\ChargeBee\Request; +use ChargeBee\ChargeBee\Util; + +class PaymentSource extends Model +{ + + protected $allowed = [ + 'id', + 'resourceVersion', + 'updatedAt', + 'createdAt', + 'customerId', + 'type', + 'referenceId', + 'status', + 'gateway', + 'gatewayAccountId', + 'ipAddress', + 'issuingCountry', + 'card', + 'bankAccount', + 'boleto', + 'billingAddress', + 'amazonPayment', + 'upi', + 'paypal', + 'venmo', + 'klarnaPayNow', + 'mandates', + 'deleted', + 'businessEntityId', + ]; + + + + # OPERATIONS + #----------- + + public static function createUsingTempToken($params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("payment_sources","create_using_temp_token"), $params, $env, $headers); + } + + public static function createUsingPermanentToken($params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("payment_sources","create_using_permanent_token"), $params, $env, $headers); + } + + public static function createUsingToken($params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("payment_sources","create_using_token"), $params, $env, $headers); + } + + public static function createUsingPaymentIntent($params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("payment_sources","create_using_payment_intent"), $params, $env, $headers); + } + + public static function createVoucherPaymentSource($params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("payment_sources","create_voucher_payment_source"), $params, $env, $headers); + } + + public static function createCard($params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("payment_sources","create_card"), $params, $env, $headers); + } + + public static function createBankAccount($params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("payment_sources","create_bank_account"), $params, $env, $headers); + } + + public static function updateCard($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("payment_sources",$id,"update_card"), $params, $env, $headers); + } + + public static function updateBankAccount($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("payment_sources",$id,"update_bank_account"), $params, $env, $headers); + } + + public static function verifyBankAccount($id, $params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("payment_sources",$id,"verify_bank_account"), $params, $env, $headers); + } + + public static function retrieve($id, $env = null, $headers = array()) + { + return Request::send(Request::GET, Util::encodeURIPath("payment_sources",$id), array(), $env, $headers); + } + + public static function all($params = array(), $env = null, $headers = array()) + { + return Request::sendListRequest(Request::GET, Util::encodeURIPath("payment_sources"), $params, $env, $headers); + } + + public static function switchGatewayAccount($id, $params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("payment_sources",$id,"switch_gateway_account"), $params, $env, $headers); + } + + public static function exportPaymentSource($id, $params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("payment_sources",$id,"export_payment_source"), $params, $env, $headers); + } + + public static function delete($id, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("payment_sources",$id,"delete"), array(), $env, $headers); + } + + public static function deleteLocal($id, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("payment_sources",$id,"delete_local"), array(), $env, $headers); + } + + } + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/PaymentSourceKlarnaPayNow.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/PaymentSourceKlarnaPayNow.php new file mode 100644 index 0000000000..10f027af02 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/PaymentSourceKlarnaPayNow.php @@ -0,0 +1,15 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; + +class PaymentSourceKlarnaPayNow extends Model +{ + protected $allowed = [ + 'email', + ]; + +} + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/Plan.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/Plan.php new file mode 100644 index 0000000000..cad1c17712 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/Plan.php @@ -0,0 +1,113 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; +use ChargeBee\ChargeBee\Request; +use ChargeBee\ChargeBee\Util; + +class Plan extends Model +{ + + protected $allowed = [ + 'id', + 'name', + 'invoiceName', + 'description', + 'price', + 'currencyCode', + 'period', + 'periodUnit', + 'trialPeriod', + 'trialPeriodUnit', + 'trialEndAction', + 'pricingModel', + 'chargeModel', + 'freeQuantity', + 'setupCost', + 'downgradePenalty', + 'status', + 'archivedAt', + 'billingCycles', + 'redirectUrl', + 'enabledInHostedPages', + 'enabledInPortal', + 'addonApplicability', + 'taxCode', + 'hsnCode', + 'taxjarProductCode', + 'avalaraSaleType', + 'avalaraTransactionType', + 'avalaraServiceType', + 'sku', + 'accountingCode', + 'accountingCategory1', + 'accountingCategory2', + 'accountingCategory3', + 'accountingCategory4', + 'isShippable', + 'shippingFrequencyPeriod', + 'shippingFrequencyPeriodUnit', + 'resourceVersion', + 'updatedAt', + 'giftable', + 'claimUrl', + 'freeQuantityInDecimal', + 'priceInDecimal', + 'channel', + 'invoiceNotes', + 'taxable', + 'taxProfileId', + 'metaData', + 'tiers', + 'taxProvidersFields', + 'applicableAddons', + 'attachedAddons', + 'eventBasedAddons', + 'showDescriptionInInvoices', + 'showDescriptionInQuotes', + ]; + + + + # OPERATIONS + #----------- + + public static function create($params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("plans"), $params, $env, $headers); + } + + public static function update($id, $params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("plans",$id), $params, $env, $headers); + } + + public static function all($params = array(), $env = null, $headers = array()) + { + return Request::sendListRequest(Request::GET, Util::encodeURIPath("plans"), $params, $env, $headers); + } + + public static function retrieve($id, $env = null, $headers = array()) + { + return Request::send(Request::GET, Util::encodeURIPath("plans",$id), array(), $env, $headers); + } + + public static function delete($id, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("plans",$id,"delete"), array(), $env, $headers); + } + + public static function copy($params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("plans","copy"), $params, $env, $headers); + } + + public static function unarchive($id, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("plans",$id,"unarchive"), array(), $env, $headers); + } + + } + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/PlanTaxProvidersField.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/PlanTaxProvidersField.php new file mode 100644 index 0000000000..8ab267da2e --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/PlanTaxProvidersField.php @@ -0,0 +1,17 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; + +class PlanTaxProvidersField extends Model +{ + protected $allowed = [ + 'providerName', + 'fieldId', + 'fieldValue', + ]; + +} + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/PriceVariant.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/PriceVariant.php new file mode 100644 index 0000000000..dd668643c3 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/PriceVariant.php @@ -0,0 +1,58 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; +use ChargeBee\ChargeBee\Request; +use ChargeBee\ChargeBee\Util; + +class PriceVariant extends Model +{ + + protected $allowed = [ + 'id', + 'name', + 'externalName', + 'variantGroup', + 'description', + 'status', + 'createdAt', + 'resourceVersion', + 'updatedAt', + 'archivedAt', + 'attributes', + ]; + + + + # OPERATIONS + #----------- + + public static function create($params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("price_variants"), $params, $env, $headers); + } + + public static function retrieve($id, $env = null, $headers = array()) + { + return Request::send(Request::GET, Util::encodeURIPath("price_variants",$id), array(), $env, $headers); + } + + public static function update($id, $params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("price_variants",$id), $params, $env, $headers); + } + + public static function delete($id, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("price_variants",$id,"delete"), array(), $env, $headers); + } + + public static function all($params = array(), $env = null, $headers = array()) + { + return Request::sendListRequest(Request::GET, Util::encodeURIPath("price_variants"), $params, $env, $headers); + } + + } + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/PriceVariantAttribute.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/PriceVariantAttribute.php new file mode 100644 index 0000000000..a4ebd9db83 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/PriceVariantAttribute.php @@ -0,0 +1,16 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; + +class PriceVariantAttribute extends Model +{ + protected $allowed = [ + 'name', + 'value', + ]; + +} + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/PricingPageSession.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/PricingPageSession.php new file mode 100644 index 0000000000..bbdc3c00ca --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/PricingPageSession.php @@ -0,0 +1,36 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; +use ChargeBee\ChargeBee\Request; +use ChargeBee\ChargeBee\Util; + +class PricingPageSession extends Model +{ + + protected $allowed = [ + 'id', + 'url', + 'createdAt', + 'expiresAt', + ]; + + + + # OPERATIONS + #----------- + + public static function createForNewSubscription($params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("pricing_page_sessions","create_for_new_subscription"), $params, $env, $headers); + } + + public static function createForExistingSubscription($params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("pricing_page_sessions","create_for_existing_subscription"), $params, $env, $headers); + } + + } + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/QuoteLineGroupLineItem.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/QuoteLineGroupLineItem.php new file mode 100644 index 0000000000..ad485ffeac --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/QuoteLineGroupLineItem.php @@ -0,0 +1,38 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; + +class QuoteLineGroupLineItem extends Model +{ + protected $allowed = [ + 'id', + 'subscriptionId', + 'dateFrom', + 'dateTo', + 'unitAmount', + 'quantity', + 'amount', + 'pricingModel', + 'isTaxed', + 'taxAmount', + 'taxRate', + 'unitAmountInDecimal', + 'quantityInDecimal', + 'amountInDecimal', + 'discountAmount', + 'itemLevelDiscountAmount', + 'usagePercentage', + 'referenceLineItemId', + 'description', + 'entityDescription', + 'entityType', + 'taxExemptReason', + 'entityId', + 'customerId', + ]; + +} + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/QuoteLineGroupLineItemTax.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/QuoteLineGroupLineItemTax.php new file mode 100644 index 0000000000..a6b982064b --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/QuoteLineGroupLineItemTax.php @@ -0,0 +1,29 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; + +class QuoteLineGroupLineItemTax extends Model +{ + protected $allowed = [ + 'lineItemId', + 'taxName', + 'taxRate', + 'dateTo', + 'dateFrom', + 'proratedTaxableAmount', + 'isPartialTaxApplied', + 'isNonComplianceTax', + 'taxableAmount', + 'taxAmount', + 'taxJurisType', + 'taxJurisName', + 'taxJurisCode', + 'taxAmountInLocalCurrency', + 'localCurrencyCode', + ]; + +} + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/QuoteLineItem.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/QuoteLineItem.php new file mode 100644 index 0000000000..f7f70d1733 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/QuoteLineItem.php @@ -0,0 +1,38 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; + +class QuoteLineItem extends Model +{ + protected $allowed = [ + 'id', + 'subscriptionId', + 'dateFrom', + 'dateTo', + 'unitAmount', + 'quantity', + 'amount', + 'pricingModel', + 'isTaxed', + 'taxAmount', + 'taxRate', + 'unitAmountInDecimal', + 'quantityInDecimal', + 'amountInDecimal', + 'discountAmount', + 'itemLevelDiscountAmount', + 'usagePercentage', + 'referenceLineItemId', + 'description', + 'entityDescription', + 'entityType', + 'taxExemptReason', + 'entityId', + 'customerId', + ]; + +} + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/QuoteLineItemTax.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/QuoteLineItemTax.php new file mode 100644 index 0000000000..5164ab758a --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/QuoteLineItemTax.php @@ -0,0 +1,29 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; + +class QuoteLineItemTax extends Model +{ + protected $allowed = [ + 'lineItemId', + 'taxName', + 'taxRate', + 'dateTo', + 'dateFrom', + 'proratedTaxableAmount', + 'isPartialTaxApplied', + 'isNonComplianceTax', + 'taxableAmount', + 'taxAmount', + 'taxJurisType', + 'taxJurisName', + 'taxJurisCode', + 'taxAmountInLocalCurrency', + 'localCurrencyCode', + ]; + +} + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/QuotedSubscriptionSubscriptionItem.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/QuotedSubscriptionSubscriptionItem.php new file mode 100644 index 0000000000..e6ccfd50ae --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/QuotedSubscriptionSubscriptionItem.php @@ -0,0 +1,35 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; + +class QuotedSubscriptionSubscriptionItem extends Model +{ + protected $allowed = [ + 'itemPriceId', + 'itemType', + 'quantity', + 'quantityInDecimal', + 'meteredQuantity', + 'lastCalculatedAt', + 'unitPrice', + 'unitPriceInDecimal', + 'amount', + 'amountInDecimal', + 'billingPeriod', + 'billingPeriodUnit', + 'freeQuantity', + 'freeQuantityInDecimal', + 'trialEnd', + 'billingCycles', + 'servicePeriodDays', + 'chargeOnEvent', + 'chargeOnce', + 'chargeOnOption', + 'prorationType', + ]; + +} + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/Ramp.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/Ramp.php new file mode 100644 index 0000000000..ce9cfe9957 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/Ramp.php @@ -0,0 +1,65 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; +use ChargeBee\ChargeBee\Request; +use ChargeBee\ChargeBee\Util; + +class Ramp extends Model +{ + + protected $allowed = [ + 'id', + 'description', + 'subscriptionId', + 'effectiveFrom', + 'status', + 'createdAt', + 'resourceVersion', + 'updatedAt', + 'itemsToAdd', + 'itemsToUpdate', + 'couponsToAdd', + 'discountsToAdd', + 'itemTiers', + 'itemsToRemove', + 'couponsToRemove', + 'discountsToRemove', + 'deleted', + 'statusTransitionReason', + ]; + + + + # OPERATIONS + #----------- + + public static function createForSubscription($id, $params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("subscriptions",$id,"create_ramp"), $params, $env, $headers); + } + + public static function update($id, $params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("ramps",$id,"update"), $params, $env, $headers); + } + + public static function retrieve($id, $env = null, $headers = array()) + { + return Request::send(Request::GET, Util::encodeURIPath("ramps",$id), array(), $env, $headers); + } + + public static function delete($id, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("ramps",$id,"delete"), array(), $env, $headers); + } + + public static function all($params, $env = null, $headers = array()) + { + return Request::sendListRequest(Request::GET, Util::encodeURIPath("ramps"), $params, $env, $headers); + } + + } + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/RampCouponsToAdd.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/RampCouponsToAdd.php new file mode 100644 index 0000000000..3f9dba1b58 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/RampCouponsToAdd.php @@ -0,0 +1,16 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; + +class RampCouponsToAdd extends Model +{ + protected $allowed = [ + 'couponId', + 'applyTill', + ]; + +} + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/RampDiscountsToAdd.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/RampDiscountsToAdd.php new file mode 100644 index 0000000000..3714462afd --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/RampDiscountsToAdd.php @@ -0,0 +1,26 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; + +class RampDiscountsToAdd extends Model +{ + protected $allowed = [ + 'id', + 'invoiceName', + 'type', + 'percentage', + 'amount', + 'durationType', + 'period', + 'periodUnit', + 'includedInMrr', + 'applyOn', + 'itemPriceId', + 'createdAt', + ]; + +} + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/RampItemTier.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/RampItemTier.php new file mode 100644 index 0000000000..8adc0a826a --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/RampItemTier.php @@ -0,0 +1,22 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; + +class RampItemTier extends Model +{ + protected $allowed = [ + 'itemPriceId', + 'startingUnit', + 'endingUnit', + 'price', + 'startingUnitInDecimal', + 'endingUnitInDecimal', + 'priceInDecimal', + 'index', + ]; + +} + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/RampItemsToAdd.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/RampItemsToAdd.php new file mode 100644 index 0000000000..a9e50e0bb9 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/RampItemsToAdd.php @@ -0,0 +1,27 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; + +class RampItemsToAdd extends Model +{ + protected $allowed = [ + 'itemPriceId', + 'itemType', + 'quantity', + 'quantityInDecimal', + 'unitPrice', + 'unitPriceInDecimal', + 'amount', + 'amountInDecimal', + 'freeQuantity', + 'freeQuantityInDecimal', + 'billingCycles', + 'servicePeriodDays', + 'meteredQuantity', + ]; + +} + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/RampItemsToUpdate.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/RampItemsToUpdate.php new file mode 100644 index 0000000000..d93ad59e92 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/RampItemsToUpdate.php @@ -0,0 +1,27 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; + +class RampItemsToUpdate extends Model +{ + protected $allowed = [ + 'itemPriceId', + 'itemType', + 'quantity', + 'quantityInDecimal', + 'unitPrice', + 'unitPriceInDecimal', + 'amount', + 'amountInDecimal', + 'freeQuantity', + 'freeQuantityInDecimal', + 'billingCycles', + 'servicePeriodDays', + 'meteredQuantity', + ]; + +} + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/RampStatusTransitionReason.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/RampStatusTransitionReason.php new file mode 100644 index 0000000000..695452950f --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/RampStatusTransitionReason.php @@ -0,0 +1,16 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; + +class RampStatusTransitionReason extends Model +{ + protected $allowed = [ + 'code', + 'message', + ]; + +} + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/Subscription.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/Subscription.php new file mode 100644 index 0000000000..4b6ba2d8b6 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/Subscription.php @@ -0,0 +1,285 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; +use ChargeBee\ChargeBee\Request; +use ChargeBee\ChargeBee\Util; + +class Subscription extends Model +{ + + protected $allowed = [ + 'id', + 'currencyCode', + 'planId', + 'planQuantity', + 'planUnitPrice', + 'setupFee', + 'billingPeriod', + 'billingPeriodUnit', + 'startDate', + 'trialEnd', + 'remainingBillingCycles', + 'poNumber', + 'autoCollection', + 'planQuantityInDecimal', + 'planUnitPriceInDecimal', + 'customerId', + 'planAmount', + 'planFreeQuantity', + 'status', + 'trialStart', + 'trialEndAction', + 'currentTermStart', + 'currentTermEnd', + 'nextBillingAt', + 'createdAt', + 'startedAt', + 'activatedAt', + 'giftId', + 'contractTermBillingCycleOnRenewal', + 'overrideRelationship', + 'pauseDate', + 'resumeDate', + 'cancelledAt', + 'cancelReason', + 'affiliateToken', + 'createdFromIp', + 'resourceVersion', + 'updatedAt', + 'hasScheduledAdvanceInvoices', + 'hasScheduledChanges', + 'paymentSourceId', + 'planFreeQuantityInDecimal', + 'planAmountInDecimal', + 'cancelScheduleCreatedAt', + 'offlinePaymentMethod', + 'channel', + 'netTermDays', + 'activeId', + 'subscriptionItems', + 'itemTiers', + 'chargedItems', + 'dueInvoicesCount', + 'dueSince', + 'totalDues', + 'mrr', + 'arr', + 'exchangeRate', + 'baseCurrencyCode', + 'addons', + 'eventBasedAddons', + 'chargedEventBasedAddons', + 'coupon', + 'coupons', + 'shippingAddress', + 'referralInfo', + 'invoiceNotes', + 'metaData', + 'metadata', + 'deleted', + 'changesScheduledAt', + 'contractTerm', + 'cancelReasonCode', + 'freePeriod', + 'freePeriodUnit', + 'createPendingInvoices', + 'autoCloseInvoices', + 'discounts', + 'businessEntityId', + ]; + + + + # OPERATIONS + #----------- + + public static function create($params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("subscriptions"), $params, $env, $headers); + } + + public static function createForCustomer($id, $params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("customers",$id,"subscriptions"), $params, $env, $headers); + } + + public static function createWithItems($id, $params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("customers",$id,"subscription_for_items"), $params, $env, $headers); + } + + public static function all($params = array(), $env = null, $headers = array()) + { + return Request::sendListRequest(Request::GET, Util::encodeURIPath("subscriptions"), $params, $env, $headers); + } + + public static function subscriptionsForCustomer($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::GET, Util::encodeURIPath("customers",$id,"subscriptions"), $params, $env, $headers); + } + + public static function contractTermsForSubscription($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::GET, Util::encodeURIPath("subscriptions",$id,"contract_terms"), $params, $env, $headers); + } + + public static function listDiscounts($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::GET, Util::encodeURIPath("subscriptions",$id,"discounts"), $params, $env, $headers); + } + + public static function retrieve($id, $env = null, $headers = array()) + { + return Request::send(Request::GET, Util::encodeURIPath("subscriptions",$id), array(), $env, $headers); + } + + public static function retrieveWithScheduledChanges($id, $env = null, $headers = array()) + { + return Request::send(Request::GET, Util::encodeURIPath("subscriptions",$id,"retrieve_with_scheduled_changes"), array(), $env, $headers); + } + + public static function removeScheduledChanges($id, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("subscriptions",$id,"remove_scheduled_changes"), array(), $env, $headers); + } + + public static function removeScheduledCancellation($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("subscriptions",$id,"remove_scheduled_cancellation"), $params, $env, $headers); + } + + public static function removeCoupons($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("subscriptions",$id,"remove_coupons"), $params, $env, $headers); + } + + public static function update($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("subscriptions",$id), $params, $env, $headers); + } + + public static function updateForItems($id, $params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("subscriptions",$id,"update_for_items"), $params, $env, $headers); + } + + public static function changeTermEnd($id, $params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("subscriptions",$id,"change_term_end"), $params, $env, $headers); + } + + public static function reactivate($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("subscriptions",$id,"reactivate"), $params, $env, $headers); + } + + public static function addChargeAtTermEnd($id, $params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("subscriptions",$id,"add_charge_at_term_end"), $params, $env, $headers); + } + + public static function chargeAddonAtTermEnd($id, $params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("subscriptions",$id,"charge_addon_at_term_end"), $params, $env, $headers); + } + + public static function chargeFutureRenewals($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("subscriptions",$id,"charge_future_renewals"), $params, $env, $headers); + } + + public static function editAdvanceInvoiceSchedule($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("subscriptions",$id,"edit_advance_invoice_schedule"), $params, $env, $headers); + } + + public static function retrieveAdvanceInvoiceSchedule($id, $env = null, $headers = array()) + { + return Request::send(Request::GET, Util::encodeURIPath("subscriptions",$id,"retrieve_advance_invoice_schedule"), array(), $env, $headers); + } + + public static function removeAdvanceInvoiceSchedule($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("subscriptions",$id,"remove_advance_invoice_schedule"), $params, $env, $headers); + } + + public static function regenerateInvoice($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("subscriptions",$id,"regenerate_invoice"), $params, $env, $headers); + } + + public static function importSubscription($params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("subscriptions","import_subscription"), $params, $env, $headers); + } + + public static function importForCustomer($id, $params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("customers",$id,"import_subscription"), $params, $env, $headers); + } + + public static function importContractTerm($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("subscriptions",$id,"import_contract_term"), $params, $env, $headers); + } + + public static function importUnbilledCharges($id, $params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("subscriptions",$id,"import_unbilled_charges"), $params, $env, $headers); + } + + public static function importForItems($id, $params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("customers",$id,"import_for_items"), $params, $env, $headers); + } + + public static function overrideBillingProfile($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("subscriptions",$id,"override_billing_profile"), $params, $env, $headers); + } + + public static function delete($id, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("subscriptions",$id,"delete"), array(), $env, $headers); + } + + public static function pause($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("subscriptions",$id,"pause"), $params, $env, $headers); + } + + public static function cancel($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("subscriptions",$id,"cancel"), $params, $env, $headers); + } + + public static function cancelForItems($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("subscriptions",$id,"cancel_for_items"), $params, $env, $headers); + } + + public static function resume($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("subscriptions",$id,"resume"), $params, $env, $headers); + } + + public static function removeScheduledPause($id, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("subscriptions",$id,"remove_scheduled_pause"), array(), $env, $headers); + } + + public static function removeScheduledResumption($id, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("subscriptions",$id,"remove_scheduled_resumption"), array(), $env, $headers); + } + + public static function move($id, $params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("subscriptions",$id,"move"), $params, $env, $headers); + } + + } + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/SubscriptionEntitlement.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/SubscriptionEntitlement.php new file mode 100644 index 0000000000..1f8098dac6 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/SubscriptionEntitlement.php @@ -0,0 +1,45 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; +use ChargeBee\ChargeBee\Request; +use ChargeBee\ChargeBee\Util; + +class SubscriptionEntitlement extends Model +{ + + protected $allowed = [ + 'subscriptionId', + 'featureId', + 'featureName', + 'featureUnit', + 'featureType', + 'value', + 'name', + 'isOverridden', + 'isEnabled', + 'effectiveFrom', + 'scheduleStatus', + 'expiresAt', + 'components', + ]; + + + + # OPERATIONS + #----------- + + public static function subscriptionEntitlementsForSubscription($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::GET, Util::encodeURIPath("subscriptions",$id,"subscription_entitlements"), $params, $env, $headers); + } + + public static function setSubscriptionEntitlementAvailability($id, $params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("subscriptions",$id,"subscription_entitlements/set_availability"), $params, $env, $headers); + } + + } + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/SubscriptionSubscriptionItem.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/SubscriptionSubscriptionItem.php new file mode 100644 index 0000000000..48d55790ca --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/SubscriptionSubscriptionItem.php @@ -0,0 +1,35 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; + +class SubscriptionSubscriptionItem extends Model +{ + protected $allowed = [ + 'itemPriceId', + 'itemType', + 'quantity', + 'quantityInDecimal', + 'meteredQuantity', + 'lastCalculatedAt', + 'unitPrice', + 'unitPriceInDecimal', + 'amount', + 'amountInDecimal', + 'billingPeriod', + 'billingPeriodUnit', + 'freeQuantity', + 'freeQuantityInDecimal', + 'trialEnd', + 'billingCycles', + 'servicePeriodDays', + 'chargeOnEvent', + 'chargeOnce', + 'chargeOnOption', + 'prorationType', + ]; + +} + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/Transaction.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/Transaction.php new file mode 100644 index 0000000000..ea33283dca --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/Transaction.php @@ -0,0 +1,123 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; +use ChargeBee\ChargeBee\Request; +use ChargeBee\ChargeBee\Util; + +class Transaction extends Model +{ + + protected $allowed = [ + 'id', + 'customerId', + 'subscriptionId', + 'gatewayAccountId', + 'paymentSourceId', + 'paymentMethod', + 'referenceNumber', + 'gateway', + 'type', + 'date', + 'settledAt', + 'exchangeRate', + 'currencyCode', + 'amount', + 'idAtGateway', + 'status', + 'fraudFlag', + 'initiatorType', + 'threeDSecure', + 'authorizationReason', + 'errorCode', + 'errorText', + 'voidedAt', + 'resourceVersion', + 'updatedAt', + 'fraudReason', + 'customPaymentMethodId', + 'amountUnused', + 'maskedCardNumber', + 'referenceTransactionId', + 'refundedTxnId', + 'referenceAuthorizationId', + 'amountCapturable', + 'reversalTransactionId', + 'linkedInvoices', + 'linkedCreditNotes', + 'linkedRefunds', + 'linkedPayments', + 'deleted', + 'iin', + 'last4', + 'merchantReferenceId', + 'businessEntityId', + 'paymentMethodDetails', + 'errorDetail', + 'customPaymentMethodName', + ]; + + + + # OPERATIONS + #----------- + + public static function createAuthorization($params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("transactions","create_authorization"), $params, $env, $headers); + } + + public static function voidTransaction($id, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("transactions",$id,"void"), array(), $env, $headers); + } + + public static function recordRefund($id, $params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("transactions",$id,"record_refund"), $params, $env, $headers); + } + + public static function reconcile($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("transactions",$id,"reconcile"), $params, $env, $headers); + } + + public static function refund($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("transactions",$id,"refund"), $params, $env, $headers); + } + + public static function all($params = array(), $env = null, $headers = array()) + { + return Request::sendListRequest(Request::GET, Util::encodeURIPath("transactions"), $params, $env, $headers); + } + + public static function transactionsForCustomer($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::GET, Util::encodeURIPath("customers",$id,"transactions"), $params, $env, $headers); + } + + public static function transactionsForSubscription($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::GET, Util::encodeURIPath("subscriptions",$id,"transactions"), $params, $env, $headers); + } + + public static function paymentsForInvoice($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::GET, Util::encodeURIPath("invoices",$id,"payments"), $params, $env, $headers); + } + + public static function retrieve($id, $env = null, $headers = array()) + { + return Request::send(Request::GET, Util::encodeURIPath("transactions",$id), array(), $env, $headers); + } + + public static function deleteOfflineTransaction($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("transactions",$id,"delete_offline_transaction"), $params, $env, $headers); + } + + } + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/TransactionGatewayErrorDetail.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/TransactionGatewayErrorDetail.php new file mode 100644 index 0000000000..6dd3224924 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/TransactionGatewayErrorDetail.php @@ -0,0 +1,27 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; + +class TransactionGatewayErrorDetail extends Model +{ + protected $allowed = [ + 'requestId', + 'errorCategory', + 'errorCode', + 'errorMessage', + 'declineCode', + 'declineMessage', + 'networkErrorCode', + 'networkErrorMessage', + 'errorField', + 'recommendationCode', + 'recommendationMessage', + 'processorErrorCode', + 'processorErrorMessage', + ]; + +} + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/UnbilledCharge.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/UnbilledCharge.php new file mode 100644 index 0000000000..924751f4d8 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/UnbilledCharge.php @@ -0,0 +1,76 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; +use ChargeBee\ChargeBee\Request; +use ChargeBee\ChargeBee\Util; + +class UnbilledCharge extends Model +{ + + protected $allowed = [ + 'id', + 'customerId', + 'subscriptionId', + 'dateFrom', + 'dateTo', + 'unitAmount', + 'pricingModel', + 'quantity', + 'amount', + 'currencyCode', + 'discountAmount', + 'description', + 'entityType', + 'entityId', + 'isVoided', + 'voidedAt', + 'unitAmountInDecimal', + 'quantityInDecimal', + 'amountInDecimal', + 'updatedAt', + 'tiers', + 'isAdvanceCharge', + 'businessEntityId', + 'deleted', + ]; + + + + # OPERATIONS + #----------- + + public static function createUnbilledCharge($params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("unbilled_charges","create"), $params, $env, $headers); + } + + public static function create($params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("unbilled_charges"), $params, $env, $headers); + } + + public static function invoiceUnbilledCharges($params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("unbilled_charges","invoice_unbilled_charges"), $params, $env, $headers); + } + + public static function delete($id, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("unbilled_charges",$id,"delete"), array(), $env, $headers); + } + + public static function all($params = array(), $env = null, $headers = array()) + { + return Request::sendListRequest(Request::GET, Util::encodeURIPath("unbilled_charges"), $params, $env, $headers); + } + + public static function invoiceNowEstimate($params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("unbilled_charges","invoice_now_estimate"), $params, $env, $headers); + } + + } + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/Usage.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/Usage.php new file mode 100644 index 0000000000..71c7bb71fd --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/Usage.php @@ -0,0 +1,59 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; +use ChargeBee\ChargeBee\Request; +use ChargeBee\ChargeBee\Util; + +class Usage extends Model +{ + + protected $allowed = [ + 'id', + 'usageDate', + 'subscriptionId', + 'itemPriceId', + 'invoiceId', + 'lineItemId', + 'quantity', + 'source', + 'note', + 'resourceVersion', + 'updatedAt', + 'createdAt', + ]; + + + + # OPERATIONS + #----------- + + public static function create($id, $params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("subscriptions",$id,"usages"), $params, $env, $headers); + } + + public static function retrieve($id, $params, $env = null, $headers = array()) + { + return Request::send(Request::GET, Util::encodeURIPath("subscriptions",$id,"usages"), $params, $env, $headers); + } + + public static function delete($id, $params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("subscriptions",$id,"delete_usage"), $params, $env, $headers); + } + + public static function all($params = array(), $env = null, $headers = array()) + { + return Request::sendListRequest(Request::GET, Util::encodeURIPath("usages"), $params, $env, $headers); + } + + public static function pdf($params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("usages","pdf"), $params, $env, $headers); + } + + } + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Result.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Result.php new file mode 100644 index 0000000000..818369e1d6 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Result.php @@ -0,0 +1,888 @@ +<?php + +namespace ChargeBee\ChargeBee; + +use ChargeBee\ChargeBee\Models; + +define('IDEMPOTENCY_REPLAY_HEADER', 'chargebee-idempotency-replayed'); + +class Result +{ + private $_response; + private $_responseHeaders; + private $_responseObj; + + public function __construct($_response, $_responseHeaders = null) + { + $this->_response = $_response; + $this->_responseHeaders = $_responseHeaders; + $this->_responseObj = array(); + } + + public function getResponseHeaders() + { + return $this->_responseHeaders; + } + + public function isIdempotencyReplayed() + { + $headers = $this->getResponseHeaders(); + if (isset($headers[IDEMPOTENCY_REPLAY_HEADER])) { + $value = $headers[IDEMPOTENCY_REPLAY_HEADER][0]; + return boolval($value); + } + return false; + } + + public function subscription() + { + $subscription = $this->_get('subscription', Models\Subscription::class, + array( + 'subscription_items' => Models\SubscriptionSubscriptionItem::class, + 'item_tiers' => Models\SubscriptionItemTier::class, + 'charged_items' => Models\SubscriptionChargedItem::class, + 'addons' => Models\SubscriptionAddon::class, + 'event_based_addons' => Models\SubscriptionEventBasedAddon::class, + 'charged_event_based_addons' => Models\SubscriptionChargedEventBasedAddon::class, + 'coupons' => Models\SubscriptionCoupon::class, + 'shipping_address' => Models\SubscriptionShippingAddress::class, + 'referral_info' => Models\SubscriptionReferralInfo::class, + 'contract_term' => Models\SubscriptionContractTerm::class, + 'discounts' => Models\SubscriptionDiscount::class + )); + return $subscription; + } + + public function contractTerm() + { + $contract_term = $this->_get('contract_term', Models\ContractTerm::class); + return $contract_term; + } + + public function discount() + { + $discount = $this->_get('discount', Models\Discount::class); + return $discount; + } + + public function advanceInvoiceSchedule() + { + $advance_invoice_schedule = $this->_get('advance_invoice_schedule', Models\AdvanceInvoiceSchedule::class, + array( + 'fixed_interval_schedule' => Models\AdvanceInvoiceScheduleFixedIntervalSchedule::class, + 'specific_dates_schedule' => Models\AdvanceInvoiceScheduleSpecificDatesSchedule::class + )); + return $advance_invoice_schedule; + } + + public function customer() + { + $customer = $this->_get('customer', Models\Customer::class, + array( + 'billing_address' => Models\CustomerBillingAddress::class, + 'referral_urls' => Models\CustomerReferralUrl::class, + 'contacts' => Models\CustomerContact::class, + 'payment_method' => Models\CustomerPaymentMethod::class, + 'balances' => Models\CustomerBalance::class, + 'entity_identifiers' => Models\CustomerEntityIdentifier::class, + 'tax_providers_fields' => Models\CustomerTaxProvidersField::class, + 'relationship' => Models\CustomerRelationship::class, + 'parent_account_access' => Models\CustomerParentAccountAccess::class, + 'child_account_access' => Models\CustomerChildAccountAccess::class + )); + return $customer; + } + + public function hierarchy() + { + $hierarchy = $this->_get('hierarchy', Models\Hierarchy::class); + return $hierarchy; + } + + public function contact() + { + $contact = $this->_get('contact', Models\Contact::class); + return $contact; + } + + public function businessEntityTransfer() + { + $business_entity_transfer = $this->_get('business_entity_transfer', Models\BusinessEntityTransfer::class); + return $business_entity_transfer; + } + + public function token() + { + $token = $this->_get('token', Models\Token::class); + return $token; + } + + public function paymentSource() + { + $payment_source = $this->_get('payment_source', Models\PaymentSource::class, + array( + 'card' => Models\PaymentSourceCard::class, + 'bank_account' => Models\PaymentSourceBankAccount::class, + 'cust_voucher_source' => Models\PaymentSourceCustVoucherSource::class, + 'billing_address' => Models\PaymentSourceBillingAddress::class, + 'amazon_payment' => Models\PaymentSourceAmazonPayment::class, + 'upi' => Models\PaymentSourceUpi::class, + 'paypal' => Models\PaymentSourcePaypal::class, + 'venmo' => Models\PaymentSourceVenmo::class, + 'klarna_pay_now' => Models\PaymentSourceKlarnaPayNow::class, + 'mandates' => Models\PaymentSourceMandate::class + )); + return $payment_source; + } + + public function thirdPartyPaymentMethod() + { + $third_party_payment_method = $this->_get('third_party_payment_method', Models\ThirdPartyPaymentMethod::class); + return $third_party_payment_method; + } + + public function virtualBankAccount() + { + $virtual_bank_account = $this->_get('virtual_bank_account', Models\VirtualBankAccount::class); + return $virtual_bank_account; + } + + public function card() + { + $card = $this->_get('card', Models\Card::class); + return $card; + } + + public function promotionalCredit() + { + $promotional_credit = $this->_get('promotional_credit', Models\PromotionalCredit::class); + return $promotional_credit; + } + + public function invoice() + { + $invoice = $this->_get('invoice', Models\Invoice::class, + array( + 'line_items' => Models\InvoiceLineItem::class, + 'discounts' => Models\InvoiceDiscount::class, + 'line_item_discounts' => Models\InvoiceLineItemDiscount::class, + 'taxes' => Models\InvoiceTax::class, + 'line_item_taxes' => Models\InvoiceLineItemTax::class, + 'line_item_tiers' => Models\InvoiceLineItemTier::class, + 'linked_payments' => Models\InvoiceLinkedPayment::class, + 'dunning_attempts' => Models\InvoiceDunningAttempt::class, + 'applied_credits' => Models\InvoiceAppliedCredit::class, + 'adjustment_credit_notes' => Models\InvoiceAdjustmentCreditNote::class, + 'issued_credit_notes' => Models\InvoiceIssuedCreditNote::class, + 'linked_orders' => Models\InvoiceLinkedOrder::class, + 'notes' => Models\InvoiceNote::class, + 'shipping_address' => Models\InvoiceShippingAddress::class, + 'statement_descriptor' => Models\InvoiceStatementDescriptor::class, + 'billing_address' => Models\InvoiceBillingAddress::class, + 'einvoice' => Models\InvoiceEinvoice::class, + 'site_details_at_creation' => Models\InvoiceSiteDetailsAtCreation::class, + 'tax_origin' => Models\InvoiceTaxOrigin::class + )); + return $invoice; + } + + public function paymentReferenceNumber() + { + $payment_reference_number = $this->_get('payment_reference_number', Models\PaymentReferenceNumber::class); + return $payment_reference_number; + } + + public function taxWithheld() + { + $tax_withheld = $this->_get('tax_withheld', Models\TaxWithheld::class); + return $tax_withheld; + } + + public function creditNote() + { + $credit_note = $this->_get('credit_note', Models\CreditNote::class, + array( + 'einvoice' => Models\CreditNoteEinvoice::class, + 'line_items' => Models\CreditNoteLineItem::class, + 'discounts' => Models\CreditNoteDiscount::class, + 'line_item_discounts' => Models\CreditNoteLineItemDiscount::class, + 'line_item_tiers' => Models\CreditNoteLineItemTier::class, + 'taxes' => Models\CreditNoteTax::class, + 'line_item_taxes' => Models\CreditNoteLineItemTax::class, + 'linked_refunds' => Models\CreditNoteLinkedRefund::class, + 'allocations' => Models\CreditNoteAllocation::class, + 'shipping_address' => Models\CreditNoteShippingAddress::class, + 'billing_address' => Models\CreditNoteBillingAddress::class, + 'site_details_at_creation' => Models\CreditNoteSiteDetailsAtCreation::class, + 'tax_origin' => Models\CreditNoteTaxOrigin::class + )); + return $credit_note; + } + + public function unbilledCharge() + { + $unbilled_charge = $this->_get('unbilled_charge', Models\UnbilledCharge::class, + array( + 'tiers' => Models\UnbilledChargeTier::class + )); + return $unbilled_charge; + } + + public function order() + { + $order = $this->_get('order', Models\Order::class, + array( + 'order_line_items' => Models\OrderOrderLineItem::class, + 'shipping_address' => Models\OrderShippingAddress::class, + 'billing_address' => Models\OrderBillingAddress::class, + 'line_item_taxes' => Models\OrderLineItemTax::class, + 'line_item_discounts' => Models\OrderLineItemDiscount::class, + 'linked_credit_notes' => Models\OrderLinkedCreditNote::class, + 'resent_orders' => Models\OrderResentOrder::class + )); + return $order; + } + + public function gift() + { + $gift = $this->_get('gift', Models\Gift::class, + array( + 'gifter' => Models\GiftGifter::class, + 'gift_receiver' => Models\GiftGiftReceiver::class, + 'gift_timelines' => Models\GiftGiftTimeline::class + )); + return $gift; + } + + public function transaction() + { + $transaction = $this->_get('transaction', Models\Transaction::class, + array( + 'linked_invoices' => Models\TransactionLinkedInvoice::class, + 'linked_credit_notes' => Models\TransactionLinkedCreditNote::class, + 'linked_refunds' => Models\TransactionLinkedRefund::class, + 'linked_payments' => Models\TransactionLinkedPayment::class, + 'gateway_error_detail' => Models\TransactionGatewayErrorDetail::class + )); + return $transaction; + } + + public function hostedPage() + { + $hosted_page = $this->_get('hosted_page', Models\HostedPage::class); + return $hosted_page; + } + + public function estimate() + { + $estimate = $this->_get('estimate', Models\Estimate::class, array(), + array( + 'subscription_estimate' => Models\SubscriptionEstimate::class, + 'subscription_estimates' => Models\SubscriptionEstimate::class, + 'invoice_estimate' => Models\InvoiceEstimate::class, + 'invoice_estimates' => Models\InvoiceEstimate::class, + 'next_invoice_estimate' => Models\InvoiceEstimate::class, + 'credit_note_estimates' => Models\CreditNoteEstimate::class, + 'unbilled_charge_estimates' => Models\UnbilledCharge::class + )); + $estimate->_initDependant($this->_response['estimate'], 'subscription_estimate', + array( + 'shipping_address' => Models\SubscriptionEstimateShippingAddress::class, + 'contract_term' => Models\SubscriptionEstimateContractTerm::class + )); + $estimate->_initDependant($this->_response['estimate'], 'invoice_estimate', + array( + 'line_items' => Models\InvoiceEstimateLineItem::class, + 'discounts' => Models\InvoiceEstimateDiscount::class, + 'taxes' => Models\InvoiceEstimateTax::class, + 'line_item_taxes' => Models\InvoiceEstimateLineItemTax::class, + 'line_item_tiers' => Models\InvoiceEstimateLineItemTier::class, + 'line_item_discounts' => Models\InvoiceEstimateLineItemDiscount::class + )); + $estimate->_initDependant($this->_response['estimate'], 'next_invoice_estimate', + array( + 'line_items' => Models\InvoiceEstimateLineItem::class, + 'discounts' => Models\InvoiceEstimateDiscount::class, + 'taxes' => Models\InvoiceEstimateTax::class, + 'line_item_taxes' => Models\InvoiceEstimateLineItemTax::class, + 'line_item_tiers' => Models\InvoiceEstimateLineItemTier::class, + 'line_item_discounts' => Models\InvoiceEstimateLineItemDiscount::class + )); + $estimate->_initDependantList($this->_response['estimate'], 'subscription_estimates', + array( + 'shipping_address' => Models\SubscriptionEstimateShippingAddress::class, + 'contract_term' => Models\SubscriptionEstimateContractTerm::class + )); + $estimate->_initDependantList($this->_response['estimate'], 'invoice_estimates', + array( + 'line_items' => Models\InvoiceEstimateLineItem::class, + 'discounts' => Models\InvoiceEstimateDiscount::class, + 'taxes' => Models\InvoiceEstimateTax::class, + 'line_item_taxes' => Models\InvoiceEstimateLineItemTax::class, + 'line_item_tiers' => Models\InvoiceEstimateLineItemTier::class, + 'line_item_discounts' => Models\InvoiceEstimateLineItemDiscount::class + )); + $estimate->_initDependantList($this->_response['estimate'], 'credit_note_estimates', + array( + 'line_items' => Models\CreditNoteEstimateLineItem::class, + 'discounts' => Models\CreditNoteEstimateDiscount::class, + 'taxes' => Models\CreditNoteEstimateTax::class, + 'line_item_taxes' => Models\CreditNoteEstimateLineItemTax::class, + 'line_item_discounts' => Models\CreditNoteEstimateLineItemDiscount::class, + 'line_item_tiers' => Models\CreditNoteEstimateLineItemTier::class + )); + $estimate->_initDependantList($this->_response['estimate'], 'unbilled_charge_estimates', + array( + 'tiers' => Models\UnbilledChargeTier::class + )); + return $estimate; + } + + public function quote() + { + $quote = $this->_get('quote', Models\Quote::class, + array( + 'line_items' => Models\QuoteLineItem::class, + 'discounts' => Models\QuoteDiscount::class, + 'line_item_discounts' => Models\QuoteLineItemDiscount::class, + 'taxes' => Models\QuoteTax::class, + 'line_item_taxes' => Models\QuoteLineItemTax::class, + 'line_item_tiers' => Models\QuoteLineItemTier::class, + 'shipping_address' => Models\QuoteShippingAddress::class, + 'billing_address' => Models\QuoteBillingAddress::class + )); + return $quote; + } + + public function quotedSubscription() + { + $quoted_subscription = $this->_get('quoted_subscription', Models\QuotedSubscription::class, + array( + 'addons' => Models\QuotedSubscriptionAddon::class, + 'event_based_addons' => Models\QuotedSubscriptionEventBasedAddon::class, + 'coupons' => Models\QuotedSubscriptionCoupon::class, + 'subscription_items' => Models\QuotedSubscriptionSubscriptionItem::class, + 'item_tiers' => Models\QuotedSubscriptionItemTier::class, + 'quoted_contract_term' => Models\QuotedSubscriptionQuotedContractTerm::class + )); + return $quoted_subscription; + } + + public function quotedCharge() + { + $quoted_charge = $this->_get('quoted_charge', Models\QuotedCharge::class, + array( + 'charges' => Models\QuotedChargeCharge::class, + 'addons' => Models\QuotedChargeAddon::class, + 'invoice_items' => Models\QuotedChargeInvoiceItem::class, + 'item_tiers' => Models\QuotedChargeItemTier::class, + 'coupons' => Models\QuotedChargeCoupon::class + )); + return $quoted_charge; + } + + public function quoteLineGroup() + { + $quote_line_group = $this->_get('quote_line_group', Models\QuoteLineGroup::class, + array( + 'line_items' => Models\QuoteLineGroupLineItem::class, + 'discounts' => Models\QuoteLineGroupDiscount::class, + 'line_item_discounts' => Models\QuoteLineGroupLineItemDiscount::class, + 'taxes' => Models\QuoteLineGroupTax::class, + 'line_item_taxes' => Models\QuoteLineGroupLineItemTax::class + )); + return $quote_line_group; + } + + public function plan() + { + $plan = $this->_get('plan', Models\Plan::class, + array( + 'tiers' => Models\PlanTier::class, + 'tax_providers_fields' => Models\PlanTaxProvidersField::class, + 'applicable_addons' => Models\PlanApplicableAddon::class, + 'attached_addons' => Models\PlanAttachedAddon::class, + 'event_based_addons' => Models\PlanEventBasedAddon::class + )); + return $plan; + } + + public function addon() + { + $addon = $this->_get('addon', Models\Addon::class, + array( + 'tiers' => Models\AddonTier::class, + 'tax_providers_fields' => Models\AddonTaxProvidersField::class + )); + return $addon; + } + + public function coupon() + { + $coupon = $this->_get('coupon', Models\Coupon::class, + array( + 'item_constraints' => Models\CouponItemConstraint::class, + 'item_constraint_criteria' => Models\CouponItemConstraintCriteria::class, + 'coupon_constraints' => Models\CouponCouponConstraint::class + )); + return $coupon; + } + + public function couponSet() + { + $coupon_set = $this->_get('coupon_set', Models\CouponSet::class); + return $coupon_set; + } + + public function couponCode() + { + $coupon_code = $this->_get('coupon_code', Models\CouponCode::class); + return $coupon_code; + } + + public function address() + { + $address = $this->_get('address', Models\Address::class); + return $address; + } + + public function usage() + { + $usage = $this->_get('usage', Models\Usage::class); + return $usage; + } + + public function event() + { + $event = $this->_get('event', Models\Event::class, + array( + 'webhooks' => Models\EventWebhook::class + )); + return $event; + } + + public function comment() + { + $comment = $this->_get('comment', Models\Comment::class); + return $comment; + } + + public function download() + { + $download = $this->_get('download', Models\Download::class); + return $download; + } + + public function portalSession() + { + $portal_session = $this->_get('portal_session', Models\PortalSession::class, + array( + 'linked_customers' => Models\PortalSessionLinkedCustomer::class + )); + return $portal_session; + } + + public function siteMigrationDetail() + { + $site_migration_detail = $this->_get('site_migration_detail', Models\SiteMigrationDetail::class); + return $site_migration_detail; + } + + public function resourceMigration() + { + $resource_migration = $this->_get('resource_migration', Models\ResourceMigration::class); + return $resource_migration; + } + + public function timeMachine() + { + $time_machine = $this->_get('time_machine', Models\TimeMachine::class); + return $time_machine; + } + + public function export() + { + $export = $this->_get('export', Models\Export::class, + array( + 'download' => Models\ExportDownload::class + )); + return $export; + } + + public function paymentIntent() + { + $payment_intent = $this->_get('payment_intent', Models\PaymentIntent::class, + array( + 'payment_attempt' => Models\PaymentIntentPaymentAttempt::class + )); + return $payment_intent; + } + + public function gatewayErrorDetail() + { + $gateway_error_detail = $this->_get('gateway_error_detail', Models\GatewayErrorDetail::class); + return $gateway_error_detail; + } + + public function itemFamily() + { + $item_family = $this->_get('item_family', Models\ItemFamily::class); + return $item_family; + } + + public function item() + { + $item = $this->_get('item', Models\Item::class, + array( + 'applicable_items' => Models\ItemApplicableItem::class + )); + return $item; + } + + public function priceVariant() + { + $price_variant = $this->_get('price_variant', Models\PriceVariant::class, + array( + 'attributes' => Models\PriceVariantAttribute::class + )); + return $price_variant; + } + + public function attribute() + { + $attribute = $this->_get('attribute', Models\Attribute::class); + return $attribute; + } + + public function itemPrice() + { + $item_price = $this->_get('item_price', Models\ItemPrice::class, + array( + 'tiers' => Models\ItemPriceTier::class, + 'tax_detail' => Models\ItemPriceTaxDetail::class, + 'tax_providers_fields' => Models\ItemPriceTaxProvidersField::class, + 'accounting_detail' => Models\ItemPriceAccountingDetail::class + )); + return $item_price; + } + + public function attachedItem() + { + $attached_item = $this->_get('attached_item', Models\AttachedItem::class); + return $attached_item; + } + + public function differentialPrice() + { + $differential_price = $this->_get('differential_price', Models\DifferentialPrice::class, + array( + 'tiers' => Models\DifferentialPriceTier::class, + 'parent_periods' => Models\DifferentialPriceParentPeriod::class + )); + return $differential_price; + } + + public function feature() + { + $feature = $this->_get('feature', Models\Feature::class, + array( + 'levels' => Models\FeatureLevel::class + )); + return $feature; + } + + public function impactedSubscription() + { + $impacted_subscription = $this->_get('impacted_subscription', Models\ImpactedSubscription::class, + array( + 'download' => Models\ImpactedSubscriptionDownload::class + )); + return $impacted_subscription; + } + + public function impactedItem() + { + $impacted_item = $this->_get('impacted_item', Models\ImpactedItem::class, + array( + 'download' => Models\ImpactedItemDownload::class + )); + return $impacted_item; + } + + public function impactedItemPrice() + { + $impacted_item_price = $this->_get('impacted_item_price', Models\ImpactedItemPrice::class, + array( + 'download' => Models\ImpactedItemPriceDownload::class + )); + return $impacted_item_price; + } + + public function metadata() + { + $metadata = $this->_get('metadata', Models\Metadata::class); + return $metadata; + } + + public function subscriptionEntitlement() + { + $subscription_entitlement = $this->_get('subscription_entitlement', Models\SubscriptionEntitlement::class, + array( + 'component' => Models\SubscriptionEntitlementComponent::class + )); + return $subscription_entitlement; + } + + public function customerEntitlement() + { + $customer_entitlement = $this->_get('customer_entitlement', Models\CustomerEntitlement::class); + return $customer_entitlement; + } + + public function itemEntitlement() + { + $item_entitlement = $this->_get('item_entitlement', Models\ItemEntitlement::class); + return $item_entitlement; + } + + public function entitlement() + { + $entitlement = $this->_get('entitlement', Models\Entitlement::class); + return $entitlement; + } + + public function inAppSubscription() + { + $in_app_subscription = $this->_get('in_app_subscription', Models\InAppSubscription::class); + return $in_app_subscription; + } + + public function nonSubscription() + { + $non_subscription = $this->_get('non_subscription', Models\NonSubscription::class); + return $non_subscription; + } + + public function entitlementOverride() + { + $entitlement_override = $this->_get('entitlement_override', Models\EntitlementOverride::class); + return $entitlement_override; + } + + public function businessEntity() + { + $business_entity = $this->_get('business_entity', Models\BusinessEntity::class); + return $business_entity; + } + + public function purchase() + { + $purchase = $this->_get('purchase', Models\Purchase::class); + return $purchase; + } + + public function paymentVoucher() + { + $payment_voucher = $this->_get('payment_voucher', Models\PaymentVoucher::class, + array( + 'linked_invoices' => Models\PaymentVoucherLinkedInvoice::class + )); + return $payment_voucher; + } + + public function currency() + { + $currency = $this->_get('currency', Models\Currency::class); + return $currency; + } + + public function ramp() + { + $ramp = $this->_get('ramp', Models\Ramp::class, + array( + 'items_to_add' => Models\RampItemsToAdd::class, + 'items_to_update' => Models\RampItemsToUpdate::class, + 'coupons_to_add' => Models\RampCouponsToAdd::class, + 'discounts_to_add' => Models\RampDiscountsToAdd::class, + 'item_tiers' => Models\RampItemTier::class, + 'status_transition_reason' => Models\RampStatusTransitionReason::class + )); + return $ramp; + } + + public function installmentConfig() + { + $installment_config = $this->_get('installment_config', Models\InstallmentConfig::class, + array( + 'installments' => Models\InstallmentConfigInstallment::class + )); + return $installment_config; + } + + public function installment() + { + $installment = $this->_get('installment', Models\Installment::class); + return $installment; + } + + public function installmentDetail() + { + $installment_detail = $this->_get('installment_detail', Models\InstallmentDetail::class, + array( + 'installments' => Models\InstallmentDetailInstallment::class + )); + return $installment_detail; + } + + public function pricingPageSession() + { + $pricing_page_session = $this->_get('pricing_page_session', Models\PricingPageSession::class); + return $pricing_page_session; + } + + public function advanceInvoiceSchedules() + { + $advance_invoice_schedules = $this->_getList('advance_invoice_schedules', Models\AdvanceInvoiceSchedule::class, + array( + 'fixed_interval_schedule' => Models\AdvanceInvoiceScheduleFixedIntervalSchedule::class, + 'specific_dates_schedule' => Models\AdvanceInvoiceScheduleSpecificDatesSchedule::class + )); + return $advance_invoice_schedules; + } + + public function hierarchies() + { + $hierarchies = $this->_getList('hierarchies', Models\Hierarchy::class, + array( + )); + return $hierarchies; + } + + public function invoices() + { + $invoices = $this->_getList('invoices', Models\Invoice::class, + array( + 'line_items' => Models\InvoiceLineItem::class, + 'discounts' => Models\InvoiceDiscount::class, + 'line_item_discounts' => Models\InvoiceLineItemDiscount::class, + 'taxes' => Models\InvoiceTax::class, + 'line_item_taxes' => Models\InvoiceLineItemTax::class, + 'line_item_tiers' => Models\InvoiceLineItemTier::class, + 'linked_payments' => Models\InvoiceLinkedPayment::class, + 'dunning_attempts' => Models\InvoiceDunningAttempt::class, + 'applied_credits' => Models\InvoiceAppliedCredit::class, + 'adjustment_credit_notes' => Models\InvoiceAdjustmentCreditNote::class, + 'issued_credit_notes' => Models\InvoiceIssuedCreditNote::class, + 'linked_orders' => Models\InvoiceLinkedOrder::class, + 'notes' => Models\InvoiceNote::class, + 'shipping_address' => Models\InvoiceShippingAddress::class, + 'statement_descriptor' => Models\InvoiceStatementDescriptor::class, + 'billing_address' => Models\InvoiceBillingAddress::class, + 'einvoice' => Models\InvoiceEinvoice::class, + 'site_details_at_creation' => Models\InvoiceSiteDetailsAtCreation::class, + 'tax_origin' => Models\InvoiceTaxOrigin::class + )); + return $invoices; + } + + public function differentialPrices() + { + $differential_prices = $this->_getList('differential_prices', Models\DifferentialPrice::class, + array( + 'tiers' => Models\DifferentialPriceTier::class, + 'parent_periods' => Models\DifferentialPriceParentPeriod::class + )); + return $differential_prices; + } + + public function creditNotes() + { + $credit_notes = $this->_getList('credit_notes', Models\CreditNote::class, + array( + 'einvoice' => Models\CreditNoteEinvoice::class, + 'line_items' => Models\CreditNoteLineItem::class, + 'discounts' => Models\CreditNoteDiscount::class, + 'line_item_discounts' => Models\CreditNoteLineItemDiscount::class, + 'line_item_tiers' => Models\CreditNoteLineItemTier::class, + 'taxes' => Models\CreditNoteTax::class, + 'line_item_taxes' => Models\CreditNoteLineItemTax::class, + 'linked_refunds' => Models\CreditNoteLinkedRefund::class, + 'allocations' => Models\CreditNoteAllocation::class, + 'shipping_address' => Models\CreditNoteShippingAddress::class, + 'billing_address' => Models\CreditNoteBillingAddress::class, + 'site_details_at_creation' => Models\CreditNoteSiteDetailsAtCreation::class, + 'tax_origin' => Models\CreditNoteTaxOrigin::class + )); + return $credit_notes; + } + + public function unbilledCharges() + { + $unbilled_charges = $this->_getList('unbilled_charges', Models\UnbilledCharge::class, + array( + 'tiers' => Models\UnbilledChargeTier::class + )); + return $unbilled_charges; + } + + public function downloads() + { + $downloads = $this->_getList('downloads', Models\Download::class, + array( + )); + return $downloads; + } + + public function inAppSubscriptions() + { + $in_app_subscriptions = $this->_getList('in_app_subscriptions', Models\InAppSubscription::class, + array( + )); + return $in_app_subscriptions; + } + + + public function toJson() + { + return json_encode($this->_response); + } + + private function _getList($type, $class, $subTypes = array(), $dependantTypes = array(), $dependantSubTypes = array()) + { + if(!array_key_exists($type, $this->_response)) + { + return null; + } + if(!array_key_exists($type, $this->_responseObj)) + { + $setVal = array(); + foreach($this->_response[$type] as $stV) + { + $obj = new $class($stV, $subTypes, $dependantTypes); + foreach($dependantSubTypes as $k => $v) + { + $obj->_initDependant($stV, $k, $v); + } + array_push($setVal, $obj); + } + $this->_responseObj[$type] = $setVal; + } + return $this->_responseObj[$type]; + } + + private function _get($type, $class, $subTypes = array(), $dependantTypes = array()) + { + if(!array_key_exists($type, $this->_response)) + { + return null; + } + if(!array_key_exists($type, $this->_responseObj)) + { + $this->_responseObj[$type] = new $class($this->_response[$type], $subTypes, $dependantTypes); + } + return $this->_responseObj[$type]; + } + +} + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Util.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Util.php new file mode 100644 index 0000000000..11d8d74955 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Util.php @@ -0,0 +1,80 @@ +<?php + +namespace ChargeBee\ChargeBee; + +use Exception; + +class Util +{ + public static function toCamelCaseFromUnderscore($str) + { + $func = function ($c) { + return strtoupper($c[1]); + }; + + return preg_replace_callback('/_([a-z])/', $func, $str); + } + + public static function toUnderscoreFromCamelCase($str) + { + $func = function ($c) { + return "_" . strtolower($c[1]); + }; + + if (preg_match('/_/', $str)) { + return $str; + } + + return preg_replace_callback('/([A-Z])/', $func, $str); + } + + public static function serialize($value, $prefix = null, $idx = null) + { + if ($value && !is_array($value)) { + throw new Exception("only arrays are allowed as value"); + } + + $serialized = []; + foreach ($value as $k => $v) { + if (is_array($v) && !is_int($k)) { + $serialized = array_merge($serialized, self::serialize($v, self::toUnderscoreFromCamelCase($k))); + } elseif (is_array($v) && is_int($k)) { + $serialized = array_merge($serialized, self::serialize($v, $prefix, $k)); + } else { + $usK = self::toUnderscoreFromCamelCase($k); + $key = (!is_null($prefix)?$prefix:'').(!is_null($prefix)?'['.$usK.']':$usK).(!is_null($idx)?'['.$idx.']':''); + $serialized[$key] = self::asString($v); + } + } + + return $serialized; + } + + public static function asString($value) + { + if (is_null($value)) { + return ''; + } elseif (is_bool($value)) { + return ($value) ? 'true' : 'false'; + } else { + return (string)$value; + } + } + + public static function encodeURIPath() + { + $uriPaths = ""; + + foreach (func_get_args() as $arg) { + $arg = trim($arg); + + if ($arg == null || strlen($arg) < 1) { + throw new Exception("Id cannot be null or empty"); + } + + $uriPaths .= "/" . implode('/', array_map('rawurlencode', explode('/', $arg))); + } + + return $uriPaths; + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Version.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Version.php new file mode 100644 index 0000000000..da54e44282 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Version.php @@ -0,0 +1,10 @@ +<?php + +namespace ChargeBee\ChargeBee; + +final class Version +{ + const VERSION = '3.33.0'; +} + +?> diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/init.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/init.php new file mode 100644 index 0000000000..846c80e75b --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/init.php @@ -0,0 +1,257 @@ +<?php + + +require(dirname(__FILE__) . '/AbstractChargeBee.php'); +require(dirname(__FILE__) . '/ChargeBee.php'); +require(dirname(__FILE__) . '/ChargeBee/Version.php'); +require(dirname(__FILE__) . '/ChargeBee/Environment.php'); +require(dirname(__FILE__) . '/ChargeBee/Util.php'); + +require(dirname(__FILE__) . '/ChargeBee/Exceptions/IOException.php'); +require(dirname(__FILE__) . '/ChargeBee/Exceptions/APIError.php'); +require(dirname(__FILE__) . '/ChargeBee/Exceptions/PaymentException.php'); +require(dirname(__FILE__) . '/ChargeBee/Exceptions/OperationFailedException.php'); +require(dirname(__FILE__) . '/ChargeBee/Exceptions/InvalidRequestException.php'); + +require(dirname(__FILE__) . '/ChargeBee/Request.php'); +require(dirname(__FILE__) . '/ChargeBee/Guzzle.php'); + +require(dirname(__FILE__) . '/ChargeBee/Result.php'); +require(dirname(__FILE__) . '/ChargeBee/ListResult.php'); + +require(dirname(__FILE__) . '/ChargeBee/Model.php'); + +require(dirname(__FILE__) . '/ChargeBee/Models/Addon.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/AddonTaxProvidersField.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/AddonTier.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/Address.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/AdvanceInvoiceSchedule.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/AdvanceInvoiceScheduleFixedIntervalSchedule.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/AdvanceInvoiceScheduleSpecificDatesSchedule.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/AttachedItem.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/Attribute.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/BusinessEntity.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/BusinessEntityTransfer.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/Card.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/Comment.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/Contact.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/ContractTerm.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/Coupon.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/CouponCode.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/CouponCouponConstraint.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/CouponItemConstraint.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/CouponItemConstraintCriteria.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/CouponSet.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/CreditNote.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/CreditNoteAllocation.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/CreditNoteBillingAddress.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/CreditNoteDiscount.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/CreditNoteEinvoice.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/CreditNoteEstimate.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/CreditNoteEstimateDiscount.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/CreditNoteEstimateLineItem.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/CreditNoteEstimateLineItemDiscount.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/CreditNoteEstimateLineItemTax.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/CreditNoteEstimateLineItemTier.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/CreditNoteEstimateTax.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/CreditNoteLineItem.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/CreditNoteLineItemDiscount.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/CreditNoteLineItemTax.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/CreditNoteLineItemTier.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/CreditNoteLinkedRefund.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/CreditNoteShippingAddress.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/CreditNoteSiteDetailsAtCreation.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/CreditNoteTax.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/CreditNoteTaxOrigin.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/Currency.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/Customer.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/CustomerBalance.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/CustomerBillingAddress.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/CustomerChildAccountAccess.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/CustomerContact.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/CustomerEntitlement.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/CustomerEntityIdentifier.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/CustomerParentAccountAccess.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/CustomerPaymentMethod.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/CustomerReferralUrl.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/CustomerRelationship.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/CustomerTaxProvidersField.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/DifferentialPrice.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/DifferentialPriceParentPeriod.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/DifferentialPriceTier.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/Discount.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/Download.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/Entitlement.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/EntitlementOverride.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/Estimate.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/Event.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/EventWebhook.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/Export.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/ExportDownload.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/Feature.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/FeatureLevel.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/GatewayErrorDetail.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/Gift.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/GiftGiftReceiver.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/GiftGiftTimeline.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/GiftGifter.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/Hierarchy.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/HostedPage.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/ImpactedItem.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/ImpactedItemDownload.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/ImpactedItemPrice.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/ImpactedItemPriceDownload.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/ImpactedSubscription.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/ImpactedSubscriptionDownload.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/InAppSubscription.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/Installment.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/InstallmentConfig.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/InstallmentConfigInstallment.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/InstallmentDetail.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/InstallmentDetailInstallment.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/Invoice.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/InvoiceAdjustmentCreditNote.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/InvoiceAppliedCredit.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/InvoiceBillingAddress.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/InvoiceDiscount.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/InvoiceDunningAttempt.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/InvoiceEinvoice.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/InvoiceEstimate.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/InvoiceEstimateDiscount.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/InvoiceEstimateLineItem.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/InvoiceEstimateLineItemDiscount.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/InvoiceEstimateLineItemTax.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/InvoiceEstimateLineItemTier.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/InvoiceEstimateTax.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/InvoiceIssuedCreditNote.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/InvoiceLineItem.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/InvoiceLineItemDiscount.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/InvoiceLineItemTax.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/InvoiceLineItemTier.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/InvoiceLinkedOrder.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/InvoiceLinkedPayment.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/InvoiceNote.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/InvoiceShippingAddress.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/InvoiceSiteDetailsAtCreation.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/InvoiceStatementDescriptor.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/InvoiceTax.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/InvoiceTaxOrigin.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/Item.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/ItemApplicableItem.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/ItemEntitlement.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/ItemFamily.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/ItemPrice.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/ItemPriceAccountingDetail.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/ItemPriceTaxDetail.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/ItemPriceTaxProvidersField.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/ItemPriceTier.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/Metadata.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/NonSubscription.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/Order.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/OrderBillingAddress.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/OrderLineItemDiscount.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/OrderLineItemTax.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/OrderLinkedCreditNote.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/OrderOrderLineItem.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/OrderResentOrder.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/OrderShippingAddress.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/PaymentIntent.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/PaymentIntentPaymentAttempt.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/PaymentReferenceNumber.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/PaymentSource.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/PaymentSourceAmazonPayment.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/PaymentSourceBankAccount.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/PaymentSourceBillingAddress.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/PaymentSourceCard.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/PaymentSourceCustVoucherSource.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/PaymentSourceKlarnaPayNow.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/PaymentSourceMandate.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/PaymentSourcePaypal.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/PaymentSourceUpi.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/PaymentSourceVenmo.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/PaymentVoucher.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/PaymentVoucherLinkedInvoice.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/Plan.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/PlanApplicableAddon.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/PlanAttachedAddon.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/PlanEventBasedAddon.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/PlanTaxProvidersField.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/PlanTier.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/PortalSession.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/PortalSessionLinkedCustomer.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/PriceVariant.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/PriceVariantAttribute.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/PricingPageSession.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/PromotionalCredit.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/Purchase.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/Quote.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/QuoteBillingAddress.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/QuoteDiscount.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/QuoteLineGroup.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/QuoteLineGroupDiscount.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/QuoteLineGroupLineItem.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/QuoteLineGroupLineItemDiscount.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/QuoteLineGroupLineItemTax.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/QuoteLineGroupTax.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/QuoteLineItem.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/QuoteLineItemDiscount.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/QuoteLineItemTax.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/QuoteLineItemTier.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/QuoteShippingAddress.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/QuoteTax.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/QuotedCharge.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/QuotedChargeAddon.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/QuotedChargeCharge.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/QuotedChargeCoupon.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/QuotedChargeInvoiceItem.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/QuotedChargeItemTier.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/QuotedSubscription.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/QuotedSubscriptionAddon.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/QuotedSubscriptionCoupon.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/QuotedSubscriptionEventBasedAddon.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/QuotedSubscriptionItemTier.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/QuotedSubscriptionQuotedContractTerm.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/QuotedSubscriptionSubscriptionItem.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/Ramp.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/RampCouponsToAdd.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/RampDiscountsToAdd.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/RampItemTier.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/RampItemsToAdd.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/RampItemsToUpdate.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/RampStatusTransitionReason.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/ResourceMigration.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/SiteMigrationDetail.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/Subscription.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/SubscriptionAddon.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/SubscriptionChargedEventBasedAddon.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/SubscriptionChargedItem.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/SubscriptionContractTerm.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/SubscriptionCoupon.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/SubscriptionDiscount.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/SubscriptionEntitlement.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/SubscriptionEntitlementComponent.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/SubscriptionEstimate.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/SubscriptionEstimateContractTerm.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/SubscriptionEstimateShippingAddress.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/SubscriptionEventBasedAddon.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/SubscriptionItemTier.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/SubscriptionReferralInfo.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/SubscriptionShippingAddress.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/SubscriptionSubscriptionItem.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/TaxWithheld.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/ThirdPartyPaymentMethod.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/TimeMachine.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/Token.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/Transaction.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/TransactionGatewayErrorDetail.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/TransactionLinkedCreditNote.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/TransactionLinkedInvoice.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/TransactionLinkedPayment.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/TransactionLinkedRefund.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/UnbilledCharge.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/UnbilledChargeTier.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/Usage.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/VirtualBankAccount.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/Content.php'); + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/composer/autoload_psr4.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/composer/autoload_psr4.php new file mode 100644 index 0000000000..3701d2bea3 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/composer/autoload_psr4.php @@ -0,0 +1,31 @@ +<?php + +// autoload_psr4.php @generated by Composer + +$vendorDir = dirname(dirname(__FILE__)); +$baseDir = dirname($vendorDir); + +return array( + 'Twilio\\' => array($vendorDir . '/twilio/sdk/src/Twilio'), + 'Stripe\\' => array($vendorDir . '/stripe/stripe-php/lib'), + 'Spatie\\CalendarLinks\\' => array($vendorDir . '/spatie/calendar-links/src'), + 'Snipe\\BanBuilder\\' => array($vendorDir . '/snipe/banbuilder/src'), + 'Sample\\' => array($vendorDir . '/paypal/paypal-checkout-sdk/samples'), + 'Pusher\\' => array($vendorDir . '/pusher/pusher-php-server/src'), + 'Psr\\Log\\' => array($vendorDir . '/psr/log/src'), + 'Psr\\Http\\Message\\' => array($vendorDir . '/psr/http-message/src', $vendorDir . '/psr/http-factory/src'), + 'Psr\\Http\\Client\\' => array($vendorDir . '/psr/http-client/src'), + 'PayPalHttp\\' => array($vendorDir . '/paypal/paypalhttp/lib/PayPalHttp'), + 'PayPalCheckoutSdk\\' => array($vendorDir . '/paypal/paypal-checkout-sdk/lib/PayPalCheckoutSdk'), + 'PHPMailer\\PHPMailer\\' => array($vendorDir . '/phpmailer/phpmailer/src'), + 'MatthiasMullie\\PathConverter\\' => array($vendorDir . '/matthiasmullie/path-converter/src'), + 'MatthiasMullie\\Minify\\' => array($vendorDir . '/matthiasmullie/minify/src'), + 'Intervention\\Image\\' => array($vendorDir . '/intervention/image/src/Intervention/Image'), + 'GuzzleHttp\\Psr7\\' => array($vendorDir . '/guzzlehttp/psr7/src'), + 'GuzzleHttp\\Promise\\' => array($vendorDir . '/guzzlehttp/promises/src'), + 'GuzzleHttp\\' => array($vendorDir . '/guzzlehttp/guzzle/src'), + 'Embera\\' => array($vendorDir . '/mpratt/embera/src/Embera'), + 'ChargeBee\\' => array($vendorDir . '/chargebee/chargebee-php/lib'), + 'AvtoDev\\Composer\\Cleanup\\' => array($vendorDir . '/avto-dev/composer-cleanup-plugin/src'), + 'Akeeba\\S3\\' => array($vendorDir . '/akeeba/s3/src'), +); diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/composer/autoload_real.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/composer/autoload_real.php new file mode 100644 index 0000000000..32ca225926 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/composer/autoload_real.php @@ -0,0 +1,75 @@ +<?php + +// autoload_real.php @generated by Composer + +class ComposerAutoloaderInit03a8066c470486be30535b543d47f96a +{ + private static $loader; + + public static function loadClassLoader($class) + { + if ('Composer\Autoload\ClassLoader' === $class) { + require __DIR__ . '/ClassLoader.php'; + } + } + + /** + * @return \Composer\Autoload\ClassLoader + */ + public static function getLoader() + { + if (null !== self::$loader) { + return self::$loader; + } + + require __DIR__ . '/platform_check.php'; + + spl_autoload_register(array('ComposerAutoloaderInit03a8066c470486be30535b543d47f96a', 'loadClassLoader'), true, true); + self::$loader = $loader = new \Composer\Autoload\ClassLoader(\dirname(\dirname(__FILE__))); + spl_autoload_unregister(array('ComposerAutoloaderInit03a8066c470486be30535b543d47f96a', 'loadClassLoader')); + + $useStaticLoader = PHP_VERSION_ID >= 50600 && !defined('HHVM_VERSION') && (!function_exists('zend_loader_file_encoded') || !zend_loader_file_encoded()); + if ($useStaticLoader) { + require __DIR__ . '/autoload_static.php'; + + call_user_func(\Composer\Autoload\ComposerStaticInit03a8066c470486be30535b543d47f96a::getInitializer($loader)); + } else { + $map = require __DIR__ . '/autoload_namespaces.php'; + foreach ($map as $namespace => $path) { + $loader->set($namespace, $path); + } + + $map = require __DIR__ . '/autoload_psr4.php'; + foreach ($map as $namespace => $path) { + $loader->setPsr4($namespace, $path); + } + + $classMap = require __DIR__ . '/autoload_classmap.php'; + if ($classMap) { + $loader->addClassMap($classMap); + } + } + + $loader->register(true); + + if ($useStaticLoader) { + $includeFiles = Composer\Autoload\ComposerStaticInit03a8066c470486be30535b543d47f96a::$files; + } else { + $includeFiles = require __DIR__ . '/autoload_files.php'; + } + foreach ($includeFiles as $fileIdentifier => $file) { + composerRequire03a8066c470486be30535b543d47f96a($fileIdentifier, $file); + } + + return $loader; + } +} + +function composerRequire03a8066c470486be30535b543d47f96a($fileIdentifier, $file) +{ + if (empty($GLOBALS['__composer_autoload_files'][$fileIdentifier])) { + require $file; + + $GLOBALS['__composer_autoload_files'][$fileIdentifier] = true; + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/composer/autoload_static.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/composer/autoload_static.php new file mode 100644 index 0000000000..141228e601 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/composer/autoload_static.php @@ -0,0 +1,226 @@ +<?php + +// autoload_static.php @generated by Composer + +namespace Composer\Autoload; + +class ComposerStaticInit03a8066c470486be30535b543d47f96a +{ + public static $files = array ( + '7b11c4dc42b3b3023073cb14e519683c' => __DIR__ . '/..' . '/ralouphie/getallheaders/src/getallheaders.php', + '6e3fae29631ef280660b3cdad06f25a8' => __DIR__ . '/..' . '/symfony/deprecation-contracts/function.php', + '37a3dc5111fe8f707ab4c132ef1dbc62' => __DIR__ . '/..' . '/guzzlehttp/guzzle/src/functions_include.php', + '3109cb1a231dcd04bee1f9f620d46975' => __DIR__ . '/..' . '/paragonie/sodium_compat/autoload.php', + '714ccd4b330431237faf946f71c4c9a4' => __DIR__ . '/..' . '/akeeba/s3/src/aliasing.php', + '2cffec82183ee1cea088009cef9a6fc3' => __DIR__ . '/..' . '/ezyang/htmlpurifier/library/HTMLPurifier.composer.php', + ); + + public static $prefixLengthsPsr4 = array ( + 'T' => + array ( + 'Twilio\\' => 7, + ), + 'S' => + array ( + 'Stripe\\' => 7, + 'Spatie\\CalendarLinks\\' => 21, + 'Snipe\\BanBuilder\\' => 17, + 'Sample\\' => 7, + ), + 'P' => + array ( + 'Pusher\\' => 7, + 'Psr\\Log\\' => 8, + 'Psr\\Http\\Message\\' => 17, + 'Psr\\Http\\Client\\' => 16, + 'PayPalHttp\\' => 11, + 'PayPalCheckoutSdk\\' => 18, + 'PHPMailer\\PHPMailer\\' => 20, + ), + 'M' => + array ( + 'MatthiasMullie\\PathConverter\\' => 29, + 'MatthiasMullie\\Minify\\' => 22, + ), + 'I' => + array ( + 'Intervention\\Image\\' => 19, + ), + 'G' => + array ( + 'GuzzleHttp\\Psr7\\' => 16, + 'GuzzleHttp\\Promise\\' => 19, + 'GuzzleHttp\\' => 11, + ), + 'E' => + array ( + 'Embera\\' => 7, + ), + 'C' => + array ( + 'ChargeBee\\' => 10, + ), + 'A' => + array ( + 'AvtoDev\\Composer\\Cleanup\\' => 25, + 'Akeeba\\S3\\' => 10, + ), + ); + + public static $prefixDirsPsr4 = array ( + 'Twilio\\' => + array ( + 0 => __DIR__ . '/..' . '/twilio/sdk/src/Twilio', + ), + 'Stripe\\' => + array ( + 0 => __DIR__ . '/..' . '/stripe/stripe-php/lib', + ), + 'Spatie\\CalendarLinks\\' => + array ( + 0 => __DIR__ . '/..' . '/spatie/calendar-links/src', + ), + 'Snipe\\BanBuilder\\' => + array ( + 0 => __DIR__ . '/..' . '/snipe/banbuilder/src', + ), + 'Sample\\' => + array ( + 0 => __DIR__ . '/..' . '/paypal/paypal-checkout-sdk/samples', + ), + 'Pusher\\' => + array ( + 0 => __DIR__ . '/..' . '/pusher/pusher-php-server/src', + ), + 'Psr\\Log\\' => + array ( + 0 => __DIR__ . '/..' . '/psr/log/src', + ), + 'Psr\\Http\\Message\\' => + array ( + 0 => __DIR__ . '/..' . '/psr/http-message/src', + 1 => __DIR__ . '/..' . '/psr/http-factory/src', + ), + 'Psr\\Http\\Client\\' => + array ( + 0 => __DIR__ . '/..' . '/psr/http-client/src', + ), + 'PayPalHttp\\' => + array ( + 0 => __DIR__ . '/..' . '/paypal/paypalhttp/lib/PayPalHttp', + ), + 'PayPalCheckoutSdk\\' => + array ( + 0 => __DIR__ . '/..' . '/paypal/paypal-checkout-sdk/lib/PayPalCheckoutSdk', + ), + 'PHPMailer\\PHPMailer\\' => + array ( + 0 => __DIR__ . '/..' . '/phpmailer/phpmailer/src', + ), + 'MatthiasMullie\\PathConverter\\' => + array ( + 0 => __DIR__ . '/..' . '/matthiasmullie/path-converter/src', + ), + 'MatthiasMullie\\Minify\\' => + array ( + 0 => __DIR__ . '/..' . '/matthiasmullie/minify/src', + ), + 'Intervention\\Image\\' => + array ( + 0 => __DIR__ . '/..' . '/intervention/image/src/Intervention/Image', + ), + 'GuzzleHttp\\Psr7\\' => + array ( + 0 => __DIR__ . '/..' . '/guzzlehttp/psr7/src', + ), + 'GuzzleHttp\\Promise\\' => + array ( + 0 => __DIR__ . '/..' . '/guzzlehttp/promises/src', + ), + 'GuzzleHttp\\' => + array ( + 0 => __DIR__ . '/..' . '/guzzlehttp/guzzle/src', + ), + 'Embera\\' => + array ( + 0 => __DIR__ . '/..' . '/mpratt/embera/src/Embera', + ), + 'ChargeBee\\' => + array ( + 0 => __DIR__ . '/..' . '/chargebee/chargebee-php/lib', + ), + 'AvtoDev\\Composer\\Cleanup\\' => + array ( + 0 => __DIR__ . '/..' . '/avto-dev/composer-cleanup-plugin/src', + ), + 'Akeeba\\S3\\' => + array ( + 0 => __DIR__ . '/..' . '/akeeba/s3/src', + ), + ); + + public static $prefixesPsr0 = array ( + 'P' => + array ( + 'Parsedown' => + array ( + 0 => __DIR__ . '/..' . '/erusev/parsedown', + ), + ), + 'O' => + array ( + 'OAuth\\Unit' => + array ( + 0 => __DIR__ . '/..' . '/lusitanian/oauth/tests', + ), + 'OAuth2' => + array ( + 0 => __DIR__ . '/..' . '/bshaffer/oauth2-server-php/src', + ), + 'OAuth' => + array ( + 0 => __DIR__ . '/..' . '/lusitanian/oauth/src', + ), + ), + 'L' => + array ( + 'Less' => + array ( + 0 => __DIR__ . '/..' . '/wikimedia/less.php/lib', + ), + ), + 'H' => + array ( + 'HTMLPurifier' => + array ( + 0 => __DIR__ . '/..' . '/ezyang/htmlpurifier/library', + ), + ), + 'C' => + array ( + 'ChargeBee' => + array ( + 0 => __DIR__ . '/..' . '/chargebee/chargebee-php/lib', + ), + ), + ); + + public static $classMap = array ( + 'Composer\\InstalledVersions' => __DIR__ . '/..' . '/composer/InstalledVersions.php', + 'S3v4\\S3' => __DIR__ . '/..' . '/tpyo/amazon-s3-php-class/S3.php', + 'S3v4\\S3Exception' => __DIR__ . '/..' . '/tpyo/amazon-s3-php-class/S3.php', + 'S3v4\\S3Request' => __DIR__ . '/..' . '/tpyo/amazon-s3-php-class/S3.php', + 'lessc' => __DIR__ . '/..' . '/wikimedia/less.php/lessc.inc.php', + ); + + public static function getInitializer(ClassLoader $loader) + { + return \Closure::bind(function () use ($loader) { + $loader->prefixLengthsPsr4 = ComposerStaticInit03a8066c470486be30535b543d47f96a::$prefixLengthsPsr4; + $loader->prefixDirsPsr4 = ComposerStaticInit03a8066c470486be30535b543d47f96a::$prefixDirsPsr4; + $loader->prefixesPsr0 = ComposerStaticInit03a8066c470486be30535b543d47f96a::$prefixesPsr0; + $loader->classMap = ComposerStaticInit03a8066c470486be30535b543d47f96a::$classMap; + + }, null, ClassLoader::class); + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/composer/installed.json b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/composer/installed.json new file mode 100644 index 0000000000..95e2ca682d --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/composer/installed.json @@ -0,0 +1,2220 @@ +{ + "packages": [ + { + "name": "achingbrain/php5-akismet", + "version": "0.5", + "version_normalized": "0.5.0.0", + "source": { + "type": "git", + "url": "https://github.com/achingbrain/php5-akismet", + "reference": "master" + }, + "type": "library", + "installation-source": "source", + "install-path": "../achingbrain/php5-akismet" + }, + { + "name": "akeeba/s3", + "version": "dev-development", + "version_normalized": "dev-development", + "source": { + "type": "git", + "url": "https://github.com/akeeba/s3.git", + "reference": "850dbfad69afcf43a4f0da29d93101fbb53422fb" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/akeeba/s3/zipball/850dbfad69afcf43a4f0da29d93101fbb53422fb", + "reference": "850dbfad69afcf43a4f0da29d93101fbb53422fb", + "shasum": "" + }, + "require": { + "ext-curl": "*", + "ext-simplexml": "*", + "php": ">=7.1.0 <8.4" + }, + "time": "2024-08-29T12:53:26+00:00", + "default-branch": true, + "type": "library", + "installation-source": "dist", + "autoload": { + "files": [ + "src/aliasing.php" + ], + "psr-4": { + "Akeeba\\S3\\": "src" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "GPL-3.0-or-later" + ], + "authors": [ + { + "name": "Nicholas K. Dionysopoulos", + "email": "nicholas_NO_SPAM_PLEASE@akeeba.com", + "homepage": "http://www.dionysopoulos.me", + "role": "Lead Developer" + } + ], + "description": "A compact, dependency-less Amazon S3 API client implementing the most commonly used features", + "homepage": "https://github.com/akeeba/s3", + "keywords": [ + "s3" + ], + "support": { + "issues": "https://github.com/akeeba/s3/issues", + "source": "https://github.com/akeeba/s3/tree/development" + }, + "install-path": "../akeeba/s3" + }, + { + "name": "avto-dev/composer-cleanup-plugin", + "version": "dev-master", + "version_normalized": "dev-master", + "source": { + "type": "git", + "url": "https://github.com/unacms/composer-cleanup-plugin.git", + "reference": "75187ca4854265174021765e3b67cb973dc37723" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/unacms/composer-cleanup-plugin/zipball/75187ca4854265174021765e3b67cb973dc37723", + "reference": "75187ca4854265174021765e3b67cb973dc37723", + "shasum": "" + }, + "require": { + "composer-plugin-api": "^1.0 || ^2.0", + "php": "^7.2 || ^8.0" + }, + "require-dev": { + "composer/composer": "^1.8.6 || ^2.0", + "phpstan/phpstan": "~0.12.34", + "phpunit/phpunit": "^8.5.4 || ^9.3" + }, + "time": "2021-09-04T13:12:22+00:00", + "default-branch": true, + "type": "composer-plugin", + "extra": { + "class": "AvtoDev\\Composer\\Cleanup\\Plugin" + }, + "installation-source": "dist", + "autoload": { + "psr-4": { + "AvtoDev\\Composer\\Cleanup\\": "src/" + } + }, + "autoload-dev": { + "psr-4": { + "AvtoDev\\Composer\\Cleanup\\Tests\\": "tests/" + } + }, + "scripts": { + "post-update-cmd": [ + "AvtoDev\\Composer\\Cleanup\\Plugin::cleanupAllPackages" + ], + "post-install-cmd": [ + "AvtoDev\\Composer\\Cleanup\\Plugin::cleanupAllPackages" + ], + "phpunit": [ + "@php ./vendor/bin/phpunit --no-coverage --colors=always" + ], + "phpunit-cover": [ + "@php ./vendor/bin/phpunit --coverage-html='./coverage/html'" + ], + "phpstan": [ + "@php ./vendor/bin/phpstan analyze -c ./phpstan.neon.dist --no-progress --ansi" + ], + "test": [ + "@phpstan", + "@phpunit" + ], + "test-cover": [ + "@phpstan", + "@phpunit-cover" + ] + }, + "license": [ + "MIT" + ], + "authors": [ + { + "name": "avto-dev", + "homepage": "https://github.com/avto-dev" + }, + { + "name": "Barry vd. Heuvel", + "email": "barryvdh@gmail.com" + } + ], + "description": "A composer cleanup plugin, to remove tests and documentation to save space", + "support": { + "issues": "https://github.com/avto-dev/composer-cleanup-plugin/issues", + "source": "https://github.com/avto-dev/composer-cleanup-plugin" + }, + "install-path": "../avto-dev/composer-cleanup-plugin" + }, + { + "name": "bshaffer/oauth2-server-php", + "version": "v1.14.1", + "version_normalized": "1.14.1.0", + "source": { + "type": "git", + "url": "https://github.com/bshaffer/oauth2-server-php.git", + "reference": "096db2c86a7d67a2ba45e72be7d208c342694542" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/bshaffer/oauth2-server-php/zipball/096db2c86a7d67a2ba45e72be7d208c342694542", + "reference": "096db2c86a7d67a2ba45e72be7d208c342694542", + "shasum": "" + }, + "require": { + "php": ">=7.2" + }, + "require-dev": { + "aws/aws-sdk-php": "^2.8", + "firebase/php-jwt": "^6.4", + "phpunit/phpunit": "^7.5||^8.0", + "predis/predis": "^1.1", + "thobbs/phpcassa": "dev-master", + "yoast/phpunit-polyfills": "^1.0" + }, + "suggest": { + "aws/aws-sdk-php": "~2.8 is required to use DynamoDB storage", + "firebase/php-jwt": "~v6.4 is required to use JWT features", + "mongodb/mongodb": "^1.1 is required to use MongoDB storage", + "predis/predis": "Required to use Redis storage", + "thobbs/phpcassa": "Required to use Cassandra storage" + }, + "time": "2023-07-07T17:53:54+00:00", + "type": "library", + "installation-source": "dist", + "autoload": { + "psr-0": { + "OAuth2": "src/" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Brent Shaffer", + "email": "bshafs@gmail.com", + "homepage": "http://brentertainment.com" + } + ], + "description": "OAuth2 Server for PHP", + "homepage": "http://github.com/bshaffer/oauth2-server-php", + "keywords": [ + "auth", + "oauth", + "oauth2" + ], + "support": { + "issues": "https://github.com/bshaffer/oauth2-server-php/issues", + "source": "https://github.com/bshaffer/oauth2-server-php/tree/v1.14.1" + }, + "install-path": "../bshaffer/oauth2-server-php" + }, + { + "name": "chargebee/chargebee-php", + "version": "v3.33.0", + "version_normalized": "3.33.0.0", + "source": { + "type": "git", + "url": "https://github.com/chargebee/chargebee-php.git", + "reference": "9423e1bbf8d1f8c48e40347fb1dfe711b817dbf0" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/chargebee/chargebee-php/zipball/9423e1bbf8d1f8c48e40347fb1dfe711b817dbf0", + "reference": "9423e1bbf8d1f8c48e40347fb1dfe711b817dbf0", + "shasum": "" + }, + "require": { + "ext-curl": "*", + "guzzlehttp/guzzle": ">=6.5", + "php": ">=5.6.0" + }, + "require-dev": { + "simpletest/simpletest": "^1.1" + }, + "time": "2024-08-29T06:59:27+00:00", + "type": "library", + "installation-source": "dist", + "autoload": { + "psr-0": { + "ChargeBee": "lib/" + }, + "psr-4": { + "ChargeBee\\": "lib/" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "description": "ChargeBee API client implementation for PHP", + "homepage": "https://github.com/chargebee/chargebee-php", + "keywords": [ + "chargebee", + "payments", + "recurring billing", + "subscription billing" + ], + "support": { + "issues": "https://github.com/chargebee/chargebee-php/issues", + "source": "https://github.com/chargebee/chargebee-php/tree/v3.33.0" + }, + "install-path": "../chargebee/chargebee-php" + }, + { + "name": "curl/cacert", + "version": "0.0.1", + "version_normalized": "0.0.1.0", + "dist": { + "type": "file", + "url": "https://curl.se/ca/cacert.pem" + }, + "type": "library", + "installation-source": "dist", + "install-path": "../curl/cacert" + }, + { + "name": "erusev/parsedown", + "version": "dev-master", + "version_normalized": "dev-master", + "source": { + "type": "git", + "url": "https://github.com/erusev/parsedown.git", + "reference": "26cfde9dbffa43a77bfd45c87b0394df0dfcba85" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/erusev/parsedown/zipball/26cfde9dbffa43a77bfd45c87b0394df0dfcba85", + "reference": "26cfde9dbffa43a77bfd45c87b0394df0dfcba85", + "shasum": "" + }, + "require": { + "ext-mbstring": "*", + "php": ">=5.3.0" + }, + "require-dev": { + "phpunit/phpunit": "^4.8.35" + }, + "time": "2024-07-09T06:15:45+00:00", + "default-branch": true, + "type": "library", + "installation-source": "dist", + "autoload": { + "psr-0": { + "Parsedown": "" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Emanuil Rusev", + "email": "hello@erusev.com", + "homepage": "http://erusev.com" + } + ], + "description": "Parser for Markdown.", + "homepage": "http://parsedown.org", + "keywords": [ + "markdown", + "parser" + ], + "support": { + "issues": "https://github.com/erusev/parsedown/issues", + "source": "https://github.com/erusev/parsedown/tree/master" + }, + "install-path": "../erusev/parsedown" + }, + { + "name": "ezyang/htmlpurifier", + "version": "v4.17.0", + "version_normalized": "4.17.0.0", + "source": { + "type": "git", + "url": "https://github.com/ezyang/htmlpurifier.git", + "reference": "bbc513d79acf6691fa9cf10f192c90dd2957f18c" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/ezyang/htmlpurifier/zipball/bbc513d79acf6691fa9cf10f192c90dd2957f18c", + "reference": "bbc513d79acf6691fa9cf10f192c90dd2957f18c", + "shasum": "" + }, + "require": { + "php": "~5.6.0 || ~7.0.0 || ~7.1.0 || ~7.2.0 || ~7.3.0 || ~7.4.0 || ~8.0.0 || ~8.1.0 || ~8.2.0 || ~8.3.0" + }, + "require-dev": { + "cerdic/css-tidy": "^1.7 || ^2.0", + "simpletest/simpletest": "dev-master" + }, + "suggest": { + "cerdic/css-tidy": "If you want to use the filter 'Filter.ExtractStyleBlocks'.", + "ext-bcmath": "Used for unit conversion and imagecrash protection", + "ext-iconv": "Converts text to and from non-UTF-8 encodings", + "ext-tidy": "Used for pretty-printing HTML" + }, + "time": "2023-11-17T15:01:25+00:00", + "type": "library", + "installation-source": "dist", + "autoload": { + "files": [ + "library/HTMLPurifier.composer.php" + ], + "psr-0": { + "HTMLPurifier": "library/" + }, + "exclude-from-classmap": [ + "/library/HTMLPurifier/Language/" + ] + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "LGPL-2.1-or-later" + ], + "authors": [ + { + "name": "Edward Z. Yang", + "email": "admin@htmlpurifier.org", + "homepage": "http://ezyang.com" + } + ], + "description": "Standards compliant HTML filter written in PHP", + "homepage": "http://htmlpurifier.org/", + "keywords": [ + "html" + ], + "support": { + "issues": "https://github.com/ezyang/htmlpurifier/issues", + "source": "https://github.com/ezyang/htmlpurifier/tree/v4.17.0" + }, + "install-path": "../ezyang/htmlpurifier" + }, + { + "name": "ffmpeg/ffmpeg", + "version": "4.4.0", + "version_normalized": "4.4.0.0", + "dist": { + "type": "file", + "url": "https://github.com/eugeneware/ffmpeg-static/releases/download/b4.4/linux-x64" + }, + "type": "library", + "installation-source": "dist", + "install-path": "../ffmpeg/ffmpeg" + }, + { + "name": "guzzlehttp/guzzle", + "version": "7.9.2", + "version_normalized": "7.9.2.0", + "source": { + "type": "git", + "url": "https://github.com/guzzle/guzzle.git", + "reference": "d281ed313b989f213357e3be1a179f02196ac99b" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/guzzle/guzzle/zipball/d281ed313b989f213357e3be1a179f02196ac99b", + "reference": "d281ed313b989f213357e3be1a179f02196ac99b", + "shasum": "" + }, + "require": { + "ext-json": "*", + "guzzlehttp/promises": "^1.5.3 || ^2.0.3", + "guzzlehttp/psr7": "^2.7.0", + "php": "^7.2.5 || ^8.0", + "psr/http-client": "^1.0", + "symfony/deprecation-contracts": "^2.2 || ^3.0" + }, + "provide": { + "psr/http-client-implementation": "1.0" + }, + "require-dev": { + "bamarni/composer-bin-plugin": "^1.8.2", + "ext-curl": "*", + "guzzle/client-integration-tests": "3.0.2", + "php-http/message-factory": "^1.1", + "phpunit/phpunit": "^8.5.39 || ^9.6.20", + "psr/log": "^1.1 || ^2.0 || ^3.0" + }, + "suggest": { + "ext-curl": "Required for CURL handler support", + "ext-intl": "Required for Internationalized Domain Name (IDN) support", + "psr/log": "Required for using the Log middleware" + }, + "time": "2024-07-24T11:22:20+00:00", + "type": "library", + "extra": { + "bamarni-bin": { + "bin-links": true, + "forward-command": false + } + }, + "installation-source": "dist", + "autoload": { + "files": [ + "src/functions_include.php" + ], + "psr-4": { + "GuzzleHttp\\": "src/" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Graham Campbell", + "email": "hello@gjcampbell.co.uk", + "homepage": "https://github.com/GrahamCampbell" + }, + { + "name": "Michael Dowling", + "email": "mtdowling@gmail.com", + "homepage": "https://github.com/mtdowling" + }, + { + "name": "Jeremy Lindblom", + "email": "jeremeamia@gmail.com", + "homepage": "https://github.com/jeremeamia" + }, + { + "name": "George Mponos", + "email": "gmponos@gmail.com", + "homepage": "https://github.com/gmponos" + }, + { + "name": "Tobias Nyholm", + "email": "tobias.nyholm@gmail.com", + "homepage": "https://github.com/Nyholm" + }, + { + "name": "Márk Sági-Kazár", + "email": "mark.sagikazar@gmail.com", + "homepage": "https://github.com/sagikazarmark" + }, + { + "name": "Tobias Schultze", + "email": "webmaster@tubo-world.de", + "homepage": "https://github.com/Tobion" + } + ], + "description": "Guzzle is a PHP HTTP client library", + "keywords": [ + "client", + "curl", + "framework", + "http", + "http client", + "psr-18", + "psr-7", + "rest", + "web service" + ], + "support": { + "issues": "https://github.com/guzzle/guzzle/issues", + "source": "https://github.com/guzzle/guzzle/tree/7.9.2" + }, + "funding": [ + { + "url": "https://github.com/GrahamCampbell", + "type": "github" + }, + { + "url": "https://github.com/Nyholm", + "type": "github" + }, + { + "url": "https://tidelift.com/funding/github/packagist/guzzlehttp/guzzle", + "type": "tidelift" + } + ], + "install-path": "../guzzlehttp/guzzle" + }, + { + "name": "guzzlehttp/promises", + "version": "2.0.3", + "version_normalized": "2.0.3.0", + "source": { + "type": "git", + "url": "https://github.com/guzzle/promises.git", + "reference": "6ea8dd08867a2a42619d65c3deb2c0fcbf81c8f8" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/guzzle/promises/zipball/6ea8dd08867a2a42619d65c3deb2c0fcbf81c8f8", + "reference": "6ea8dd08867a2a42619d65c3deb2c0fcbf81c8f8", + "shasum": "" + }, + "require": { + "php": "^7.2.5 || ^8.0" + }, + "require-dev": { + "bamarni/composer-bin-plugin": "^1.8.2", + "phpunit/phpunit": "^8.5.39 || ^9.6.20" + }, + "time": "2024-07-18T10:29:17+00:00", + "type": "library", + "extra": { + "bamarni-bin": { + "bin-links": true, + "forward-command": false + } + }, + "installation-source": "dist", + "autoload": { + "psr-4": { + "GuzzleHttp\\Promise\\": "src/" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Graham Campbell", + "email": "hello@gjcampbell.co.uk", + "homepage": "https://github.com/GrahamCampbell" + }, + { + "name": "Michael Dowling", + "email": "mtdowling@gmail.com", + "homepage": "https://github.com/mtdowling" + }, + { + "name": "Tobias Nyholm", + "email": "tobias.nyholm@gmail.com", + "homepage": "https://github.com/Nyholm" + }, + { + "name": "Tobias Schultze", + "email": "webmaster@tubo-world.de", + "homepage": "https://github.com/Tobion" + } + ], + "description": "Guzzle promises library", + "keywords": [ + "promise" + ], + "support": { + "issues": "https://github.com/guzzle/promises/issues", + "source": "https://github.com/guzzle/promises/tree/2.0.3" + }, + "funding": [ + { + "url": "https://github.com/GrahamCampbell", + "type": "github" + }, + { + "url": "https://github.com/Nyholm", + "type": "github" + }, + { + "url": "https://tidelift.com/funding/github/packagist/guzzlehttp/promises", + "type": "tidelift" + } + ], + "install-path": "../guzzlehttp/promises" + }, + { + "name": "guzzlehttp/psr7", + "version": "2.7.0", + "version_normalized": "2.7.0.0", + "source": { + "type": "git", + "url": "https://github.com/guzzle/psr7.git", + "reference": "a70f5c95fb43bc83f07c9c948baa0dc1829bf201" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/guzzle/psr7/zipball/a70f5c95fb43bc83f07c9c948baa0dc1829bf201", + "reference": "a70f5c95fb43bc83f07c9c948baa0dc1829bf201", + "shasum": "" + }, + "require": { + "php": "^7.2.5 || ^8.0", + "psr/http-factory": "^1.0", + "psr/http-message": "^1.1 || ^2.0", + "ralouphie/getallheaders": "^3.0" + }, + "provide": { + "psr/http-factory-implementation": "1.0", + "psr/http-message-implementation": "1.0" + }, + "require-dev": { + "bamarni/composer-bin-plugin": "^1.8.2", + "http-interop/http-factory-tests": "0.9.0", + "phpunit/phpunit": "^8.5.39 || ^9.6.20" + }, + "suggest": { + "laminas/laminas-httphandlerrunner": "Emit PSR-7 responses" + }, + "time": "2024-07-18T11:15:46+00:00", + "type": "library", + "extra": { + "bamarni-bin": { + "bin-links": true, + "forward-command": false + } + }, + "installation-source": "dist", + "autoload": { + "psr-4": { + "GuzzleHttp\\Psr7\\": "src/" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Graham Campbell", + "email": "hello@gjcampbell.co.uk", + "homepage": "https://github.com/GrahamCampbell" + }, + { + "name": "Michael Dowling", + "email": "mtdowling@gmail.com", + "homepage": "https://github.com/mtdowling" + }, + { + "name": "George Mponos", + "email": "gmponos@gmail.com", + "homepage": "https://github.com/gmponos" + }, + { + "name": "Tobias Nyholm", + "email": "tobias.nyholm@gmail.com", + "homepage": "https://github.com/Nyholm" + }, + { + "name": "Márk Sági-Kazár", + "email": "mark.sagikazar@gmail.com", + "homepage": "https://github.com/sagikazarmark" + }, + { + "name": "Tobias Schultze", + "email": "webmaster@tubo-world.de", + "homepage": "https://github.com/Tobion" + }, + { + "name": "Márk Sági-Kazár", + "email": "mark.sagikazar@gmail.com", + "homepage": "https://sagikazarmark.hu" + } + ], + "description": "PSR-7 message implementation that also provides common utility methods", + "keywords": [ + "http", + "message", + "psr-7", + "request", + "response", + "stream", + "uri", + "url" + ], + "support": { + "issues": "https://github.com/guzzle/psr7/issues", + "source": "https://github.com/guzzle/psr7/tree/2.7.0" + }, + "funding": [ + { + "url": "https://github.com/GrahamCampbell", + "type": "github" + }, + { + "url": "https://github.com/Nyholm", + "type": "github" + }, + { + "url": "https://tidelift.com/funding/github/packagist/guzzlehttp/psr7", + "type": "tidelift" + } + ], + "install-path": "../guzzlehttp/psr7" + }, + { + "name": "intervention/image", + "version": "2.7.2", + "version_normalized": "2.7.2.0", + "source": { + "type": "git", + "url": "https://github.com/Intervention/image.git", + "reference": "04be355f8d6734c826045d02a1079ad658322dad" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/Intervention/image/zipball/04be355f8d6734c826045d02a1079ad658322dad", + "reference": "04be355f8d6734c826045d02a1079ad658322dad", + "shasum": "" + }, + "require": { + "ext-fileinfo": "*", + "guzzlehttp/psr7": "~1.1 || ^2.0", + "php": ">=5.4.0" + }, + "require-dev": { + "mockery/mockery": "~0.9.2", + "phpunit/phpunit": "^4.8 || ^5.7 || ^7.5.15" + }, + "suggest": { + "ext-gd": "to use GD library based image processing.", + "ext-imagick": "to use Imagick based image processing.", + "intervention/imagecache": "Caching extension for the Intervention Image library" + }, + "time": "2022-05-21T17:30:32+00:00", + "type": "library", + "extra": { + "branch-alias": { + "dev-master": "2.4-dev" + }, + "laravel": { + "providers": [ + "Intervention\\Image\\ImageServiceProvider" + ], + "aliases": { + "Image": "Intervention\\Image\\Facades\\Image" + } + } + }, + "installation-source": "dist", + "autoload": { + "psr-4": { + "Intervention\\Image\\": "src/Intervention/Image" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Oliver Vogel", + "email": "oliver@intervention.io", + "homepage": "https://intervention.io/" + } + ], + "description": "Image handling and manipulation library with support for Laravel integration", + "homepage": "http://image.intervention.io/", + "keywords": [ + "gd", + "image", + "imagick", + "laravel", + "thumbnail", + "watermark" + ], + "support": { + "issues": "https://github.com/Intervention/image/issues", + "source": "https://github.com/Intervention/image/tree/2.7.2" + }, + "funding": [ + { + "url": "https://paypal.me/interventionio", + "type": "custom" + }, + { + "url": "https://github.com/Intervention", + "type": "github" + } + ], + "install-path": "../intervention/image" + }, + { + "name": "lusitanian/oauth", + "version": "v0.8.11", + "version_normalized": "0.8.11.0", + "source": { + "type": "git", + "url": "https://github.com/Lusitanian/PHPoAuthLib.git", + "reference": "fc11a53db4b66da555a6a11fce294f574a8374f9" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/Lusitanian/PHPoAuthLib/zipball/fc11a53db4b66da555a6a11fce294f574a8374f9", + "reference": "fc11a53db4b66da555a6a11fce294f574a8374f9", + "shasum": "" + }, + "require": { + "php": ">=5.3.0" + }, + "require-dev": { + "phpunit/phpunit": "3.7.*", + "predis/predis": "0.8.*@dev", + "squizlabs/php_codesniffer": "2.*", + "symfony/http-foundation": "~2.1" + }, + "suggest": { + "ext-openssl": "Allows for usage of secure connections with the stream-based HTTP client.", + "predis/predis": "Allows using the Redis storage backend.", + "symfony/http-foundation": "Allows using the Symfony Session storage backend." + }, + "time": "2018-02-14T22:37:14+00:00", + "type": "library", + "extra": { + "branch-alias": { + "dev-master": "0.1-dev" + } + }, + "installation-source": "dist", + "autoload": { + "psr-0": { + "OAuth": "src", + "OAuth\\Unit": "tests" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "David Desberg", + "email": "david@daviddesberg.com" + }, + { + "name": "Elliot Chance", + "email": "elliotchance@gmail.com" + }, + { + "name": "Pieter Hordijk", + "email": "info@pieterhordijk.com" + } + ], + "description": "PHP 5.3+ oAuth 1/2 Library", + "keywords": [ + "Authentication", + "authorization", + "oauth", + "security" + ], + "support": { + "issues": "https://github.com/Lusitanian/PHPoAuthLib/issues", + "source": "https://github.com/Lusitanian/PHPoAuthLib/tree/master" + }, + "install-path": "../lusitanian/oauth" + }, + { + "name": "matthiasmullie/minify", + "version": "1.3.73", + "version_normalized": "1.3.73.0", + "source": { + "type": "git", + "url": "https://github.com/matthiasmullie/minify.git", + "reference": "cb7a9297b4ab070909cefade30ee95054d4ae87a" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/matthiasmullie/minify/zipball/cb7a9297b4ab070909cefade30ee95054d4ae87a", + "reference": "cb7a9297b4ab070909cefade30ee95054d4ae87a", + "shasum": "" + }, + "require": { + "ext-pcre": "*", + "matthiasmullie/path-converter": "~1.1", + "php": ">=5.3.0" + }, + "require-dev": { + "friendsofphp/php-cs-fixer": ">=2.0", + "matthiasmullie/scrapbook": ">=1.3", + "phpunit/phpunit": ">=4.8", + "squizlabs/php_codesniffer": ">=3.0" + }, + "suggest": { + "psr/cache-implementation": "Cache implementation to use with Minify::cache" + }, + "time": "2024-03-15T10:27:10+00:00", + "bin": [ + "bin/minifycss", + "bin/minifyjs" + ], + "type": "library", + "installation-source": "dist", + "autoload": { + "psr-4": { + "MatthiasMullie\\Minify\\": "src/" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Matthias Mullie", + "email": "minify@mullie.eu", + "homepage": "https://www.mullie.eu", + "role": "Developer" + } + ], + "description": "CSS & JavaScript minifier, in PHP. Removes whitespace, strips comments, combines files (incl. @import statements and small assets in CSS files), and optimizes/shortens a few common programming patterns.", + "homepage": "https://github.com/matthiasmullie/minify", + "keywords": [ + "JS", + "css", + "javascript", + "minifier", + "minify" + ], + "support": { + "issues": "https://github.com/matthiasmullie/minify/issues", + "source": "https://github.com/matthiasmullie/minify/tree/1.3.73" + }, + "funding": [ + { + "url": "https://github.com/matthiasmullie", + "type": "github" + } + ], + "install-path": "../matthiasmullie/minify" + }, + { + "name": "matthiasmullie/path-converter", + "version": "1.1.3", + "version_normalized": "1.1.3.0", + "source": { + "type": "git", + "url": "https://github.com/matthiasmullie/path-converter.git", + "reference": "e7d13b2c7e2f2268e1424aaed02085518afa02d9" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/matthiasmullie/path-converter/zipball/e7d13b2c7e2f2268e1424aaed02085518afa02d9", + "reference": "e7d13b2c7e2f2268e1424aaed02085518afa02d9", + "shasum": "" + }, + "require": { + "ext-pcre": "*", + "php": ">=5.3.0" + }, + "require-dev": { + "phpunit/phpunit": "~4.8" + }, + "time": "2019-02-05T23:41:09+00:00", + "type": "library", + "installation-source": "dist", + "autoload": { + "psr-4": { + "MatthiasMullie\\PathConverter\\": "src/" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Matthias Mullie", + "email": "pathconverter@mullie.eu", + "homepage": "http://www.mullie.eu", + "role": "Developer" + } + ], + "description": "Relative path converter", + "homepage": "http://github.com/matthiasmullie/path-converter", + "keywords": [ + "converter", + "path", + "paths", + "relative" + ], + "support": { + "issues": "https://github.com/matthiasmullie/path-converter/issues", + "source": "https://github.com/matthiasmullie/path-converter/tree/1.1.3" + }, + "install-path": "../matthiasmullie/path-converter" + }, + { + "name": "mpratt/embera", + "version": "2.0.41", + "version_normalized": "2.0.41.0", + "source": { + "type": "git", + "url": "https://github.com/mpratt/Embera.git", + "reference": "069305b9252a428ba4ae6eb58d3dc8c6d9be5cd0" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/mpratt/Embera/zipball/069305b9252a428ba4ae6eb58d3dc8c6d9be5cd0", + "reference": "069305b9252a428ba4ae6eb58d3dc8c6d9be5cd0", + "shasum": "" + }, + "require": { + "ext-json": "*", + "php": ">=5.6" + }, + "require-dev": { + "phpstan/phpstan": "^1.4", + "phpunit/phpunit": "^9.0" + }, + "suggest": { + "ext-curl": "Fetch data using curl instead of using file_get_contents" + }, + "time": "2024-08-17T04:27:29+00:00", + "type": "library", + "installation-source": "dist", + "autoload": { + "psr-4": { + "Embera\\": "src/Embera" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Michael Pratt", + "email": "yo@michael-pratt.com", + "homepage": "http://www.michael-pratt.com", + "role": "Author/Developer" + } + ], + "description": "Oembed consumer library. Converts urls into their html embed code. Supports 150+ sites, such as Youtube, Twitter, vimeo, Instagram etc.", + "homepage": "https://github.com/mpratt/Embera", + "keywords": [ + "Auto embed", + "Embed Text", + "Responsive Embeds", + "Url Embed", + "embed", + "instagram", + "oembed", + "twitter", + "vimeo", + "vine", + "youtube" + ], + "support": { + "issues": "https://github.com/mpratt/Embera/issues", + "source": "https://github.com/mpratt/Embera/tree/2.0.41" + }, + "funding": [ + { + "url": "https://paypal.me/mtpratt", + "type": "paypal" + } + ], + "install-path": "../mpratt/embera" + }, + { + "name": "paragonie/random_compat", + "version": "v9.99.100", + "version_normalized": "9.99.100.0", + "source": { + "type": "git", + "url": "https://github.com/paragonie/random_compat.git", + "reference": "996434e5492cb4c3edcb9168db6fbb1359ef965a" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/paragonie/random_compat/zipball/996434e5492cb4c3edcb9168db6fbb1359ef965a", + "reference": "996434e5492cb4c3edcb9168db6fbb1359ef965a", + "shasum": "" + }, + "require": { + "php": ">= 7" + }, + "require-dev": { + "phpunit/phpunit": "4.*|5.*", + "vimeo/psalm": "^1" + }, + "suggest": { + "ext-libsodium": "Provides a modern crypto API that can be used to generate random bytes." + }, + "time": "2020-10-15T08:29:30+00:00", + "type": "library", + "installation-source": "dist", + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Paragon Initiative Enterprises", + "email": "security@paragonie.com", + "homepage": "https://paragonie.com" + } + ], + "description": "PHP 5.x polyfill for random_bytes() and random_int() from PHP 7", + "keywords": [ + "csprng", + "polyfill", + "pseudorandom", + "random" + ], + "support": { + "email": "info@paragonie.com", + "issues": "https://github.com/paragonie/random_compat/issues", + "source": "https://github.com/paragonie/random_compat" + }, + "install-path": "../paragonie/random_compat" + }, + { + "name": "paragonie/sodium_compat", + "version": "v1.21.1", + "version_normalized": "1.21.1.0", + "source": { + "type": "git", + "url": "https://github.com/paragonie/sodium_compat.git", + "reference": "bb312875dcdd20680419564fe42ba1d9564b9e37" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/paragonie/sodium_compat/zipball/bb312875dcdd20680419564fe42ba1d9564b9e37", + "reference": "bb312875dcdd20680419564fe42ba1d9564b9e37", + "shasum": "" + }, + "require": { + "paragonie/random_compat": ">=1", + "php": "^5.2.4|^5.3|^5.4|^5.5|^5.6|^7|^8" + }, + "require-dev": { + "phpunit/phpunit": "^3|^4|^5|^6|^7|^8|^9" + }, + "suggest": { + "ext-libsodium": "PHP < 7.0: Better performance, password hashing (Argon2i), secure memory management (memzero), and better security.", + "ext-sodium": "PHP >= 7.0: Better performance, password hashing (Argon2i), secure memory management (memzero), and better security." + }, + "time": "2024-04-22T22:05:04+00:00", + "type": "library", + "installation-source": "dist", + "autoload": { + "files": [ + "autoload.php" + ] + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "ISC" + ], + "authors": [ + { + "name": "Paragon Initiative Enterprises", + "email": "security@paragonie.com" + }, + { + "name": "Frank Denis", + "email": "jedisct1@pureftpd.org" + } + ], + "description": "Pure PHP implementation of libsodium; uses the PHP extension if it exists", + "keywords": [ + "Authentication", + "BLAKE2b", + "ChaCha20", + "ChaCha20-Poly1305", + "Chapoly", + "Curve25519", + "Ed25519", + "EdDSA", + "Edwards-curve Digital Signature Algorithm", + "Elliptic Curve Diffie-Hellman", + "Poly1305", + "Pure-PHP cryptography", + "RFC 7748", + "RFC 8032", + "Salpoly", + "Salsa20", + "X25519", + "XChaCha20-Poly1305", + "XSalsa20-Poly1305", + "Xchacha20", + "Xsalsa20", + "aead", + "cryptography", + "ecdh", + "elliptic curve", + "elliptic curve cryptography", + "encryption", + "libsodium", + "php", + "public-key cryptography", + "secret-key cryptography", + "side-channel resistant" + ], + "support": { + "issues": "https://github.com/paragonie/sodium_compat/issues", + "source": "https://github.com/paragonie/sodium_compat/tree/v1.21.1" + }, + "install-path": "../paragonie/sodium_compat" + }, + { + "name": "paypal/paypal-checkout-sdk", + "version": "1.0.2", + "version_normalized": "1.0.2.0", + "source": { + "type": "git", + "url": "https://github.com/paypal/Checkout-PHP-SDK.git", + "reference": "19992ce7051ff9e47e643f28abb8cc1b3e5f1812" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/paypal/Checkout-PHP-SDK/zipball/19992ce7051ff9e47e643f28abb8cc1b3e5f1812", + "reference": "19992ce7051ff9e47e643f28abb8cc1b3e5f1812", + "shasum": "" + }, + "require": { + "paypal/paypalhttp": "1.0.1" + }, + "require-dev": { + "phpunit/phpunit": "^5.7" + }, + "time": "2021-09-21T20:57:38+00:00", + "type": "library", + "installation-source": "dist", + "autoload": { + "psr-4": { + "Sample\\": "samples/", + "PayPalCheckoutSdk\\": "lib/PayPalCheckoutSdk" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "https://github.com/paypal/Checkout-PHP-SDK/blob/master/LICENSE" + ], + "authors": [ + { + "name": "PayPal", + "homepage": "https://github.com/paypal/Checkout-PHP-SDK/contributors" + } + ], + "description": "PayPal's PHP SDK for Checkout REST APIs", + "homepage": "http://github.com/paypal/Checkout-PHP-SDK/", + "keywords": [ + "checkout", + "orders", + "payments", + "paypal", + "rest", + "sdk" + ], + "support": { + "source": "https://github.com/paypal/Checkout-PHP-SDK/tree/1.0.2" + }, + "abandoned": true, + "install-path": "../paypal/paypal-checkout-sdk" + }, + { + "name": "paypal/paypalhttp", + "version": "1.0.1", + "version_normalized": "1.0.1.0", + "source": { + "type": "git", + "url": "https://github.com/paypal/paypalhttp_php.git", + "reference": "7b09c89c80828e842c79230e7f156b61fbb68d25" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/paypal/paypalhttp_php/zipball/7b09c89c80828e842c79230e7f156b61fbb68d25", + "reference": "7b09c89c80828e842c79230e7f156b61fbb68d25", + "shasum": "" + }, + "require": { + "ext-curl": "*" + }, + "require-dev": { + "phpunit/phpunit": "^5.7", + "wiremock-php/wiremock-php": "1.43.2" + }, + "time": "2021-09-14T21:35:26+00:00", + "type": "library", + "installation-source": "dist", + "autoload": { + "psr-4": { + "PayPalHttp\\": "lib/PayPalHttp" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "PayPal", + "homepage": "https://github.com/paypal/paypalhttp_php/contributors" + } + ], + "support": { + "issues": "https://github.com/paypal/paypalhttp_php/issues", + "source": "https://github.com/paypal/paypalhttp_php/tree/1.0.1" + }, + "install-path": "../paypal/paypalhttp" + }, + { + "name": "phpmailer/phpmailer", + "version": "v6.9.1", + "version_normalized": "6.9.1.0", + "source": { + "type": "git", + "url": "https://github.com/PHPMailer/PHPMailer.git", + "reference": "039de174cd9c17a8389754d3b877a2ed22743e18" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/PHPMailer/PHPMailer/zipball/039de174cd9c17a8389754d3b877a2ed22743e18", + "reference": "039de174cd9c17a8389754d3b877a2ed22743e18", + "shasum": "" + }, + "require": { + "ext-ctype": "*", + "ext-filter": "*", + "ext-hash": "*", + "php": ">=5.5.0" + }, + "require-dev": { + "dealerdirect/phpcodesniffer-composer-installer": "^1.0", + "doctrine/annotations": "^1.2.6 || ^1.13.3", + "php-parallel-lint/php-console-highlighter": "^1.0.0", + "php-parallel-lint/php-parallel-lint": "^1.3.2", + "phpcompatibility/php-compatibility": "^9.3.5", + "roave/security-advisories": "dev-latest", + "squizlabs/php_codesniffer": "^3.7.2", + "yoast/phpunit-polyfills": "^1.0.4" + }, + "suggest": { + "decomplexity/SendOauth2": "Adapter for using XOAUTH2 authentication", + "ext-mbstring": "Needed to send email in multibyte encoding charset or decode encoded addresses", + "ext-openssl": "Needed for secure SMTP sending and DKIM signing", + "greew/oauth2-azure-provider": "Needed for Microsoft Azure XOAUTH2 authentication", + "hayageek/oauth2-yahoo": "Needed for Yahoo XOAUTH2 authentication", + "league/oauth2-google": "Needed for Google XOAUTH2 authentication", + "psr/log": "For optional PSR-3 debug logging", + "symfony/polyfill-mbstring": "To support UTF-8 if the Mbstring PHP extension is not enabled (^1.2)", + "thenetworg/oauth2-azure": "Needed for Microsoft XOAUTH2 authentication" + }, + "time": "2023-11-25T22:23:28+00:00", + "type": "library", + "installation-source": "dist", + "autoload": { + "psr-4": { + "PHPMailer\\PHPMailer\\": "src/" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "LGPL-2.1-only" + ], + "authors": [ + { + "name": "Marcus Bointon", + "email": "phpmailer@synchromedia.co.uk" + }, + { + "name": "Jim Jagielski", + "email": "jimjag@gmail.com" + }, + { + "name": "Andy Prevost", + "email": "codeworxtech@users.sourceforge.net" + }, + { + "name": "Brent R. Matzelle" + } + ], + "description": "PHPMailer is a full-featured email creation and transfer class for PHP", + "support": { + "issues": "https://github.com/PHPMailer/PHPMailer/issues", + "source": "https://github.com/PHPMailer/PHPMailer/tree/v6.9.1" + }, + "funding": [ + { + "url": "https://github.com/Synchro", + "type": "github" + } + ], + "install-path": "../phpmailer/phpmailer" + }, + { + "name": "psr/http-client", + "version": "1.0.3", + "version_normalized": "1.0.3.0", + "source": { + "type": "git", + "url": "https://github.com/php-fig/http-client.git", + "reference": "bb5906edc1c324c9a05aa0873d40117941e5fa90" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/php-fig/http-client/zipball/bb5906edc1c324c9a05aa0873d40117941e5fa90", + "reference": "bb5906edc1c324c9a05aa0873d40117941e5fa90", + "shasum": "" + }, + "require": { + "php": "^7.0 || ^8.0", + "psr/http-message": "^1.0 || ^2.0" + }, + "time": "2023-09-23T14:17:50+00:00", + "type": "library", + "extra": { + "branch-alias": { + "dev-master": "1.0.x-dev" + } + }, + "installation-source": "dist", + "autoload": { + "psr-4": { + "Psr\\Http\\Client\\": "src/" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "PHP-FIG", + "homepage": "https://www.php-fig.org/" + } + ], + "description": "Common interface for HTTP clients", + "homepage": "https://github.com/php-fig/http-client", + "keywords": [ + "http", + "http-client", + "psr", + "psr-18" + ], + "support": { + "source": "https://github.com/php-fig/http-client" + }, + "install-path": "../psr/http-client" + }, + { + "name": "psr/http-factory", + "version": "1.1.0", + "version_normalized": "1.1.0.0", + "source": { + "type": "git", + "url": "https://github.com/php-fig/http-factory.git", + "reference": "2b4765fddfe3b508ac62f829e852b1501d3f6e8a" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/php-fig/http-factory/zipball/2b4765fddfe3b508ac62f829e852b1501d3f6e8a", + "reference": "2b4765fddfe3b508ac62f829e852b1501d3f6e8a", + "shasum": "" + }, + "require": { + "php": ">=7.1", + "psr/http-message": "^1.0 || ^2.0" + }, + "time": "2024-04-15T12:06:14+00:00", + "type": "library", + "extra": { + "branch-alias": { + "dev-master": "1.0.x-dev" + } + }, + "installation-source": "dist", + "autoload": { + "psr-4": { + "Psr\\Http\\Message\\": "src/" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "PHP-FIG", + "homepage": "https://www.php-fig.org/" + } + ], + "description": "PSR-17: Common interfaces for PSR-7 HTTP message factories", + "keywords": [ + "factory", + "http", + "message", + "psr", + "psr-17", + "psr-7", + "request", + "response" + ], + "support": { + "source": "https://github.com/php-fig/http-factory" + }, + "install-path": "../psr/http-factory" + }, + { + "name": "psr/http-message", + "version": "2.0", + "version_normalized": "2.0.0.0", + "source": { + "type": "git", + "url": "https://github.com/php-fig/http-message.git", + "reference": "402d35bcb92c70c026d1a6a9883f06b2ead23d71" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/php-fig/http-message/zipball/402d35bcb92c70c026d1a6a9883f06b2ead23d71", + "reference": "402d35bcb92c70c026d1a6a9883f06b2ead23d71", + "shasum": "" + }, + "require": { + "php": "^7.2 || ^8.0" + }, + "time": "2023-04-04T09:54:51+00:00", + "type": "library", + "extra": { + "branch-alias": { + "dev-master": "2.0.x-dev" + } + }, + "installation-source": "dist", + "autoload": { + "psr-4": { + "Psr\\Http\\Message\\": "src/" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "PHP-FIG", + "homepage": "https://www.php-fig.org/" + } + ], + "description": "Common interface for HTTP messages", + "homepage": "https://github.com/php-fig/http-message", + "keywords": [ + "http", + "http-message", + "psr", + "psr-7", + "request", + "response" + ], + "support": { + "source": "https://github.com/php-fig/http-message/tree/2.0" + }, + "install-path": "../psr/http-message" + }, + { + "name": "psr/log", + "version": "3.0.1", + "version_normalized": "3.0.1.0", + "source": { + "type": "git", + "url": "https://github.com/php-fig/log.git", + "reference": "79dff0b268932c640297f5208d6298f71855c03e" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/php-fig/log/zipball/79dff0b268932c640297f5208d6298f71855c03e", + "reference": "79dff0b268932c640297f5208d6298f71855c03e", + "shasum": "" + }, + "require": { + "php": ">=8.0.0" + }, + "time": "2024-08-21T13:31:24+00:00", + "type": "library", + "extra": { + "branch-alias": { + "dev-master": "3.x-dev" + } + }, + "installation-source": "dist", + "autoload": { + "psr-4": { + "Psr\\Log\\": "src" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "PHP-FIG", + "homepage": "https://www.php-fig.org/" + } + ], + "description": "Common interface for logging libraries", + "homepage": "https://github.com/php-fig/log", + "keywords": [ + "log", + "psr", + "psr-3" + ], + "support": { + "source": "https://github.com/php-fig/log/tree/3.0.1" + }, + "install-path": "../psr/log" + }, + { + "name": "pusher/pusher-php-server", + "version": "7.2.4", + "version_normalized": "7.2.4.0", + "source": { + "type": "git", + "url": "https://github.com/pusher/pusher-http-php.git", + "reference": "de2f72296808f9cafa6a4462b15a768ff130cddb" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/pusher/pusher-http-php/zipball/de2f72296808f9cafa6a4462b15a768ff130cddb", + "reference": "de2f72296808f9cafa6a4462b15a768ff130cddb", + "shasum": "" + }, + "require": { + "ext-curl": "*", + "ext-json": "*", + "guzzlehttp/guzzle": "^7.2", + "paragonie/sodium_compat": "^1.6", + "php": "^7.3|^8.0", + "psr/log": "^1.0|^2.0|^3.0" + }, + "require-dev": { + "overtrue/phplint": "^2.3", + "phpunit/phpunit": "^9.3" + }, + "time": "2023-12-15T10:58:53+00:00", + "type": "library", + "extra": { + "branch-alias": { + "dev-master": "5.0-dev" + } + }, + "installation-source": "dist", + "autoload": { + "psr-4": { + "Pusher\\": "src/" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "description": "Library for interacting with the Pusher REST API", + "keywords": [ + "events", + "messaging", + "php-pusher-server", + "publish", + "push", + "pusher", + "real time", + "real-time", + "realtime", + "rest", + "trigger" + ], + "support": { + "issues": "https://github.com/pusher/pusher-http-php/issues", + "source": "https://github.com/pusher/pusher-http-php/tree/7.2.4" + }, + "install-path": "../pusher/pusher-php-server" + }, + { + "name": "ralouphie/getallheaders", + "version": "3.0.3", + "version_normalized": "3.0.3.0", + "source": { + "type": "git", + "url": "https://github.com/ralouphie/getallheaders.git", + "reference": "120b605dfeb996808c31b6477290a714d356e822" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/ralouphie/getallheaders/zipball/120b605dfeb996808c31b6477290a714d356e822", + "reference": "120b605dfeb996808c31b6477290a714d356e822", + "shasum": "" + }, + "require": { + "php": ">=5.6" + }, + "require-dev": { + "php-coveralls/php-coveralls": "^2.1", + "phpunit/phpunit": "^5 || ^6.5" + }, + "time": "2019-03-08T08:55:37+00:00", + "type": "library", + "installation-source": "dist", + "autoload": { + "files": [ + "src/getallheaders.php" + ] + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Ralph Khattar", + "email": "ralph.khattar@gmail.com" + } + ], + "description": "A polyfill for getallheaders.", + "support": { + "issues": "https://github.com/ralouphie/getallheaders/issues", + "source": "https://github.com/ralouphie/getallheaders/tree/develop" + }, + "install-path": "../ralouphie/getallheaders" + }, + { + "name": "snipe/banbuilder", + "version": "dev-master", + "version_normalized": "dev-master", + "source": { + "type": "git", + "url": "https://github.com/snipe/banbuilder.git", + "reference": "5e76a97b3ff80e2beaae75ac140c38573ea027a0" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/snipe/banbuilder/zipball/5e76a97b3ff80e2beaae75ac140c38573ea027a0", + "reference": "5e76a97b3ff80e2beaae75ac140c38573ea027a0", + "shasum": "" + }, + "require": { + "php": ">=5.6.0" + }, + "require-dev": { + "phpunit/phpunit": "^5.7.0" + }, + "time": "2023-12-06T20:33:58+00:00", + "default-branch": true, + "type": "library", + "installation-source": "dist", + "autoload": { + "psr-4": { + "Snipe\\BanBuilder\\": "src/" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "AGPL-3.0" + ], + "authors": [ + { + "name": "snipe", + "email": "snipe@snipe.net", + "role": "Creator & Developer" + } + ], + "description": "Library to easily handle profanity filtering in PHP projects.", + "homepage": "http://banbuilder.com", + "keywords": [ + "filter", + "language", + "profanity", + "strings", + "swear" + ], + "support": { + "issues": "https://github.com/snipe/banbuilder/issues", + "source": "https://github.com/snipe/banbuilder/tree/master" + }, + "install-path": "../snipe/banbuilder" + }, + { + "name": "spatie/calendar-links", + "version": "1.11.0", + "version_normalized": "1.11.0.0", + "source": { + "type": "git", + "url": "https://github.com/spatie/calendar-links.git", + "reference": "da41e7edae84859d3d598b0b3ce3233c843c3e46" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/spatie/calendar-links/zipball/da41e7edae84859d3d598b0b3ce3233c843c3e46", + "reference": "da41e7edae84859d3d598b0b3ce3233c843c3e46", + "shasum": "" + }, + "require": { + "php": "^8.1" + }, + "require-dev": { + "friendsofphp/php-cs-fixer": "^3.48", + "phpunit/phpunit": "^10.1", + "spatie/phpunit-snapshot-assertions": "^5.1", + "vimeo/psalm": "^5.20" + }, + "time": "2024-02-19T05:59:13+00:00", + "type": "library", + "installation-source": "dist", + "autoload": { + "psr-4": { + "Spatie\\CalendarLinks\\": "src" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Sebastian De Deyne", + "email": "sebastian@spatie.be", + "homepage": "https://spatie.be", + "role": "Developer" + } + ], + "description": "Generate add to calendar links for Google, iCal and other calendar systems", + "homepage": "https://github.com/spatie/calendar-links", + "keywords": [ + "calendar-links", + "spatie" + ], + "support": { + "issues": "https://github.com/spatie/calendar-links/issues", + "source": "https://github.com/spatie/calendar-links/tree/1.11.0" + }, + "funding": [ + { + "url": "https://spatie.be/open-source/support-us", + "type": "custom" + } + ], + "install-path": "../spatie/calendar-links" + }, + { + "name": "stripe/stripe-php", + "version": "v7.128.0", + "version_normalized": "7.128.0.0", + "source": { + "type": "git", + "url": "https://github.com/stripe/stripe-php.git", + "reference": "c704949c49b72985c76cc61063aa26fefbd2724e" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/stripe/stripe-php/zipball/c704949c49b72985c76cc61063aa26fefbd2724e", + "reference": "c704949c49b72985c76cc61063aa26fefbd2724e", + "shasum": "" + }, + "require": { + "ext-curl": "*", + "ext-json": "*", + "ext-mbstring": "*", + "php": ">=5.6.0" + }, + "require-dev": { + "friendsofphp/php-cs-fixer": "3.5.0", + "phpstan/phpstan": "^1.2", + "phpunit/phpunit": "^5.7 || ^9.0", + "squizlabs/php_codesniffer": "^3.3" + }, + "time": "2022-05-05T17:18:02+00:00", + "type": "library", + "extra": { + "branch-alias": { + "dev-master": "2.0-dev" + } + }, + "installation-source": "dist", + "autoload": { + "psr-4": { + "Stripe\\": "lib/" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Stripe and contributors", + "homepage": "https://github.com/stripe/stripe-php/contributors" + } + ], + "description": "Stripe PHP Library", + "homepage": "https://stripe.com/", + "keywords": [ + "api", + "payment processing", + "stripe" + ], + "support": { + "issues": "https://github.com/stripe/stripe-php/issues", + "source": "https://github.com/stripe/stripe-php/tree/v7.128.0" + }, + "install-path": "../stripe/stripe-php" + }, + { + "name": "symfony/deprecation-contracts", + "version": "v3.5.0", + "version_normalized": "3.5.0.0", + "source": { + "type": "git", + "url": "https://github.com/symfony/deprecation-contracts.git", + "reference": "0e0d29ce1f20deffb4ab1b016a7257c4f1e789a1" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/symfony/deprecation-contracts/zipball/0e0d29ce1f20deffb4ab1b016a7257c4f1e789a1", + "reference": "0e0d29ce1f20deffb4ab1b016a7257c4f1e789a1", + "shasum": "" + }, + "require": { + "php": ">=8.1" + }, + "time": "2024-04-18T09:32:20+00:00", + "type": "library", + "extra": { + "branch-alias": { + "dev-main": "3.5-dev" + }, + "thanks": { + "name": "symfony/contracts", + "url": "https://github.com/symfony/contracts" + } + }, + "installation-source": "dist", + "autoload": { + "files": [ + "function.php" + ] + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Nicolas Grekas", + "email": "p@tchwork.com" + }, + { + "name": "Symfony Community", + "homepage": "https://symfony.com/contributors" + } + ], + "description": "A generic function and convention to trigger deprecation notices", + "homepage": "https://symfony.com", + "support": { + "source": "https://github.com/symfony/deprecation-contracts/tree/v3.5.0" + }, + "funding": [ + { + "url": "https://symfony.com/sponsor", + "type": "custom" + }, + { + "url": "https://github.com/fabpot", + "type": "github" + }, + { + "url": "https://tidelift.com/funding/github/packagist/symfony/symfony", + "type": "tidelift" + } + ], + "install-path": "../symfony/deprecation-contracts" + }, + { + "name": "tpyo/amazon-s3-php-class", + "version": "dev-master", + "version_normalized": "dev-master", + "source": { + "type": "git", + "url": "https://github.com/unacms/amazon-s3-php-class.git", + "reference": "7c62b0e9b7d956a04e377ca236979a78dbac4e66" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/unacms/amazon-s3-php-class/zipball/7c62b0e9b7d956a04e377ca236979a78dbac4e66", + "reference": "7c62b0e9b7d956a04e377ca236979a78dbac4e66", + "shasum": "" + }, + "require": { + "php": ">=5.2.0" + }, + "time": "2022-06-30T03:20:34+00:00", + "default-branch": true, + "type": "library", + "installation-source": "dist", + "autoload": { + "classmap": [ + "S3.php" + ] + }, + "license": [ + "BSD-2-Clause" + ], + "authors": [ + { + "name": "Donovan Schönknecht", + "email": "don@tpyo.net" + } + ], + "description": "A standalone Amazon S3 (REST) client for PHP 5.2.x using CURL that does not require PEAR.", + "homepage": "https://github.com/tpyo/amazon-s3-php-class", + "support": { + "source": "https://github.com/unacms/amazon-s3-php-class/tree/master" + }, + "install-path": "../tpyo/amazon-s3-php-class" + }, + { + "name": "twilio/sdk", + "version": "5.42.2", + "version_normalized": "5.42.2.0", + "source": { + "type": "git", + "url": "https://github.com/twilio/twilio-php.git", + "reference": "0cfcb871b18a9c427dd9e8f0ed7458d43009b48a" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/twilio/twilio-php/zipball/0cfcb871b18a9c427dd9e8f0ed7458d43009b48a", + "reference": "0cfcb871b18a9c427dd9e8f0ed7458d43009b48a", + "shasum": "" + }, + "require": { + "php": ">=5.5.0" + }, + "require-dev": { + "apigen/apigen": "^4.1", + "guzzlehttp/guzzle": "^6.3", + "phpunit/phpunit": ">=4.5" + }, + "suggest": { + "guzzlehttp/guzzle": "An HTTP client to execute the API requests" + }, + "time": "2020-02-05T19:55:13+00:00", + "type": "library", + "installation-source": "dist", + "autoload": { + "psr-4": { + "Twilio\\": "src/Twilio/" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Twilio API Team", + "email": "api@twilio.com" + } + ], + "description": "A PHP wrapper for Twilio's API", + "homepage": "http://github.com/twilio/twilio-php", + "keywords": [ + "api", + "sms", + "twilio" + ], + "support": { + "issues": "https://github.com/twilio/twilio-php/issues", + "source": "https://github.com/twilio/twilio-php/tree/5.42.2" + }, + "install-path": "../twilio/sdk" + }, + { + "name": "unaio/amazon-s3-php-class-hmac-v2", + "version": "0.6", + "version_normalized": "0.6.0.0", + "source": { + "type": "git", + "url": "https://github.com/unaio/amazon-s3-php-class-hmac-v2", + "reference": "3687dec0af7be2cb11f21828aa4b12d20c4c5935" + }, + "type": "library", + "installation-source": "source", + "install-path": "../unaio/amazon-s3-php-class-hmac-v2" + }, + { + "name": "wikimedia/less.php", + "version": "v5.1.1", + "version_normalized": "5.1.1.0", + "source": { + "type": "git", + "url": "https://github.com/wikimedia/less.php.git", + "reference": "29e14517d40b321bdbf8823eae1c327fc6b227f5" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/wikimedia/less.php/zipball/29e14517d40b321bdbf8823eae1c327fc6b227f5", + "reference": "29e14517d40b321bdbf8823eae1c327fc6b227f5", + "shasum": "" + }, + "require": { + "php": ">=7.4.3" + }, + "require-dev": { + "mediawiki/mediawiki-codesniffer": "43.0.0", + "mediawiki/mediawiki-phan-config": "0.14.0", + "mediawiki/minus-x": "1.1.3", + "php-parallel-lint/php-console-highlighter": "1.0.0", + "php-parallel-lint/php-parallel-lint": "1.4.0", + "phpunit/phpunit": "9.6.16" + }, + "time": "2024-08-09T13:59:17+00:00", + "bin": [ + "bin/lessc" + ], + "type": "library", + "installation-source": "dist", + "autoload": { + "psr-0": { + "Less": "lib/" + }, + "classmap": [ + "lessc.inc.php" + ] + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "Apache-2.0" + ], + "authors": [ + { + "name": "Timo Tijhof", + "homepage": "https://timotijhof.net" + }, + { + "name": "Josh Schmidt", + "homepage": "https://github.com/oyejorge" + }, + { + "name": "Matt Agar", + "homepage": "https://github.com/agar" + }, + { + "name": "Martin Jantošovič", + "homepage": "https://github.com/Mordred" + } + ], + "description": "PHP port of the LESS processor", + "homepage": "https://gerrit.wikimedia.org/g/mediawiki/libs/less.php", + "keywords": [ + "css", + "less", + "less.js", + "lesscss", + "php", + "stylesheet" + ], + "support": { + "issues": "https://github.com/wikimedia/less.php/issues", + "source": "https://github.com/wikimedia/less.php/tree/v5.1.1" + }, + "install-path": "../wikimedia/less.php" + } + ], + "dev": true, + "dev-package-names": [] +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/composer/installed.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/composer/installed.php new file mode 100644 index 0000000000..e7a7784af8 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/composer/installed.php @@ -0,0 +1,375 @@ +<?php return array( + 'root' => array( + 'pretty_version' => 'dev-master', + 'version' => 'dev-master', + 'type' => 'library', + 'install_path' => __DIR__ . '/../../', + 'aliases' => array(), + 'reference' => '53588980042992e9da0cf02b65071d4a81815440', + 'name' => 'unaio/una', + 'dev' => true, + ), + 'versions' => array( + 'achingbrain/php5-akismet' => array( + 'pretty_version' => '0.5', + 'version' => '0.5.0.0', + 'type' => 'library', + 'install_path' => __DIR__ . '/../achingbrain/php5-akismet', + 'aliases' => array(), + 'reference' => 'master', + 'dev_requirement' => false, + ), + 'akeeba/s3' => array( + 'pretty_version' => 'dev-development', + 'version' => 'dev-development', + 'type' => 'library', + 'install_path' => __DIR__ . '/../akeeba/s3', + 'aliases' => array( + 0 => '9999999-dev', + ), + 'reference' => '850dbfad69afcf43a4f0da29d93101fbb53422fb', + 'dev_requirement' => false, + ), + 'avto-dev/composer-cleanup-plugin' => array( + 'pretty_version' => 'dev-master', + 'version' => 'dev-master', + 'type' => 'composer-plugin', + 'install_path' => __DIR__ . '/../avto-dev/composer-cleanup-plugin', + 'aliases' => array( + 0 => '9999999-dev', + ), + 'reference' => '75187ca4854265174021765e3b67cb973dc37723', + 'dev_requirement' => false, + ), + 'bshaffer/oauth2-server-php' => array( + 'pretty_version' => 'v1.14.1', + 'version' => '1.14.1.0', + 'type' => 'library', + 'install_path' => __DIR__ . '/../bshaffer/oauth2-server-php', + 'aliases' => array(), + 'reference' => '096db2c86a7d67a2ba45e72be7d208c342694542', + 'dev_requirement' => false, + ), + 'chargebee/chargebee-php' => array( + 'pretty_version' => 'v3.33.0', + 'version' => '3.33.0.0', + 'type' => 'library', + 'install_path' => __DIR__ . '/../chargebee/chargebee-php', + 'aliases' => array(), + 'reference' => '9423e1bbf8d1f8c48e40347fb1dfe711b817dbf0', + 'dev_requirement' => false, + ), + 'curl/cacert' => array( + 'pretty_version' => '0.0.1', + 'version' => '0.0.1.0', + 'type' => 'library', + 'install_path' => __DIR__ . '/../curl/cacert', + 'aliases' => array(), + 'reference' => NULL, + 'dev_requirement' => false, + ), + 'erusev/parsedown' => array( + 'pretty_version' => 'dev-master', + 'version' => 'dev-master', + 'type' => 'library', + 'install_path' => __DIR__ . '/../erusev/parsedown', + 'aliases' => array( + 0 => '9999999-dev', + ), + 'reference' => '26cfde9dbffa43a77bfd45c87b0394df0dfcba85', + 'dev_requirement' => false, + ), + 'ezyang/htmlpurifier' => array( + 'pretty_version' => 'v4.17.0', + 'version' => '4.17.0.0', + 'type' => 'library', + 'install_path' => __DIR__ . '/../ezyang/htmlpurifier', + 'aliases' => array(), + 'reference' => 'bbc513d79acf6691fa9cf10f192c90dd2957f18c', + 'dev_requirement' => false, + ), + 'ffmpeg/ffmpeg' => array( + 'pretty_version' => '4.4.0', + 'version' => '4.4.0.0', + 'type' => 'library', + 'install_path' => __DIR__ . '/../ffmpeg/ffmpeg', + 'aliases' => array(), + 'reference' => NULL, + 'dev_requirement' => false, + ), + 'guzzlehttp/guzzle' => array( + 'pretty_version' => '7.9.2', + 'version' => '7.9.2.0', + 'type' => 'library', + 'install_path' => __DIR__ . '/../guzzlehttp/guzzle', + 'aliases' => array(), + 'reference' => 'd281ed313b989f213357e3be1a179f02196ac99b', + 'dev_requirement' => false, + ), + 'guzzlehttp/promises' => array( + 'pretty_version' => '2.0.3', + 'version' => '2.0.3.0', + 'type' => 'library', + 'install_path' => __DIR__ . '/../guzzlehttp/promises', + 'aliases' => array(), + 'reference' => '6ea8dd08867a2a42619d65c3deb2c0fcbf81c8f8', + 'dev_requirement' => false, + ), + 'guzzlehttp/psr7' => array( + 'pretty_version' => '2.7.0', + 'version' => '2.7.0.0', + 'type' => 'library', + 'install_path' => __DIR__ . '/../guzzlehttp/psr7', + 'aliases' => array(), + 'reference' => 'a70f5c95fb43bc83f07c9c948baa0dc1829bf201', + 'dev_requirement' => false, + ), + 'intervention/image' => array( + 'pretty_version' => '2.7.2', + 'version' => '2.7.2.0', + 'type' => 'library', + 'install_path' => __DIR__ . '/../intervention/image', + 'aliases' => array(), + 'reference' => '04be355f8d6734c826045d02a1079ad658322dad', + 'dev_requirement' => false, + ), + 'lusitanian/oauth' => array( + 'pretty_version' => 'v0.8.11', + 'version' => '0.8.11.0', + 'type' => 'library', + 'install_path' => __DIR__ . '/../lusitanian/oauth', + 'aliases' => array(), + 'reference' => 'fc11a53db4b66da555a6a11fce294f574a8374f9', + 'dev_requirement' => false, + ), + 'matthiasmullie/minify' => array( + 'pretty_version' => '1.3.73', + 'version' => '1.3.73.0', + 'type' => 'library', + 'install_path' => __DIR__ . '/../matthiasmullie/minify', + 'aliases' => array(), + 'reference' => 'cb7a9297b4ab070909cefade30ee95054d4ae87a', + 'dev_requirement' => false, + ), + 'matthiasmullie/path-converter' => array( + 'pretty_version' => '1.1.3', + 'version' => '1.1.3.0', + 'type' => 'library', + 'install_path' => __DIR__ . '/../matthiasmullie/path-converter', + 'aliases' => array(), + 'reference' => 'e7d13b2c7e2f2268e1424aaed02085518afa02d9', + 'dev_requirement' => false, + ), + 'mpratt/embera' => array( + 'pretty_version' => '2.0.41', + 'version' => '2.0.41.0', + 'type' => 'library', + 'install_path' => __DIR__ . '/../mpratt/embera', + 'aliases' => array(), + 'reference' => '069305b9252a428ba4ae6eb58d3dc8c6d9be5cd0', + 'dev_requirement' => false, + ), + 'paragonie/random_compat' => array( + 'pretty_version' => 'v9.99.100', + 'version' => '9.99.100.0', + 'type' => 'library', + 'install_path' => __DIR__ . '/../paragonie/random_compat', + 'aliases' => array(), + 'reference' => '996434e5492cb4c3edcb9168db6fbb1359ef965a', + 'dev_requirement' => false, + ), + 'paragonie/sodium_compat' => array( + 'pretty_version' => 'v1.21.1', + 'version' => '1.21.1.0', + 'type' => 'library', + 'install_path' => __DIR__ . '/../paragonie/sodium_compat', + 'aliases' => array(), + 'reference' => 'bb312875dcdd20680419564fe42ba1d9564b9e37', + 'dev_requirement' => false, + ), + 'paypal/paypal-checkout-sdk' => array( + 'pretty_version' => '1.0.2', + 'version' => '1.0.2.0', + 'type' => 'library', + 'install_path' => __DIR__ . '/../paypal/paypal-checkout-sdk', + 'aliases' => array(), + 'reference' => '19992ce7051ff9e47e643f28abb8cc1b3e5f1812', + 'dev_requirement' => false, + ), + 'paypal/paypalhttp' => array( + 'pretty_version' => '1.0.1', + 'version' => '1.0.1.0', + 'type' => 'library', + 'install_path' => __DIR__ . '/../paypal/paypalhttp', + 'aliases' => array(), + 'reference' => '7b09c89c80828e842c79230e7f156b61fbb68d25', + 'dev_requirement' => false, + ), + 'phpmailer/phpmailer' => array( + 'pretty_version' => 'v6.9.1', + 'version' => '6.9.1.0', + 'type' => 'library', + 'install_path' => __DIR__ . '/../phpmailer/phpmailer', + 'aliases' => array(), + 'reference' => '039de174cd9c17a8389754d3b877a2ed22743e18', + 'dev_requirement' => false, + ), + 'psr/http-client' => array( + 'pretty_version' => '1.0.3', + 'version' => '1.0.3.0', + 'type' => 'library', + 'install_path' => __DIR__ . '/../psr/http-client', + 'aliases' => array(), + 'reference' => 'bb5906edc1c324c9a05aa0873d40117941e5fa90', + 'dev_requirement' => false, + ), + 'psr/http-client-implementation' => array( + 'dev_requirement' => false, + 'provided' => array( + 0 => '1.0', + ), + ), + 'psr/http-factory' => array( + 'pretty_version' => '1.1.0', + 'version' => '1.1.0.0', + 'type' => 'library', + 'install_path' => __DIR__ . '/../psr/http-factory', + 'aliases' => array(), + 'reference' => '2b4765fddfe3b508ac62f829e852b1501d3f6e8a', + 'dev_requirement' => false, + ), + 'psr/http-factory-implementation' => array( + 'dev_requirement' => false, + 'provided' => array( + 0 => '1.0', + ), + ), + 'psr/http-message' => array( + 'pretty_version' => '2.0', + 'version' => '2.0.0.0', + 'type' => 'library', + 'install_path' => __DIR__ . '/../psr/http-message', + 'aliases' => array(), + 'reference' => '402d35bcb92c70c026d1a6a9883f06b2ead23d71', + 'dev_requirement' => false, + ), + 'psr/http-message-implementation' => array( + 'dev_requirement' => false, + 'provided' => array( + 0 => '1.0', + ), + ), + 'psr/log' => array( + 'pretty_version' => '3.0.1', + 'version' => '3.0.1.0', + 'type' => 'library', + 'install_path' => __DIR__ . '/../psr/log', + 'aliases' => array(), + 'reference' => '79dff0b268932c640297f5208d6298f71855c03e', + 'dev_requirement' => false, + ), + 'pusher/pusher-php-server' => array( + 'pretty_version' => '7.2.4', + 'version' => '7.2.4.0', + 'type' => 'library', + 'install_path' => __DIR__ . '/../pusher/pusher-php-server', + 'aliases' => array(), + 'reference' => 'de2f72296808f9cafa6a4462b15a768ff130cddb', + 'dev_requirement' => false, + ), + 'ralouphie/getallheaders' => array( + 'pretty_version' => '3.0.3', + 'version' => '3.0.3.0', + 'type' => 'library', + 'install_path' => __DIR__ . '/../ralouphie/getallheaders', + 'aliases' => array(), + 'reference' => '120b605dfeb996808c31b6477290a714d356e822', + 'dev_requirement' => false, + ), + 'snipe/banbuilder' => array( + 'pretty_version' => 'dev-master', + 'version' => 'dev-master', + 'type' => 'library', + 'install_path' => __DIR__ . '/../snipe/banbuilder', + 'aliases' => array( + 0 => '9999999-dev', + ), + 'reference' => '5e76a97b3ff80e2beaae75ac140c38573ea027a0', + 'dev_requirement' => false, + ), + 'spatie/calendar-links' => array( + 'pretty_version' => '1.11.0', + 'version' => '1.11.0.0', + 'type' => 'library', + 'install_path' => __DIR__ . '/../spatie/calendar-links', + 'aliases' => array(), + 'reference' => 'da41e7edae84859d3d598b0b3ce3233c843c3e46', + 'dev_requirement' => false, + ), + 'stripe/stripe-php' => array( + 'pretty_version' => 'v7.128.0', + 'version' => '7.128.0.0', + 'type' => 'library', + 'install_path' => __DIR__ . '/../stripe/stripe-php', + 'aliases' => array(), + 'reference' => 'c704949c49b72985c76cc61063aa26fefbd2724e', + 'dev_requirement' => false, + ), + 'symfony/deprecation-contracts' => array( + 'pretty_version' => 'v3.5.0', + 'version' => '3.5.0.0', + 'type' => 'library', + 'install_path' => __DIR__ . '/../symfony/deprecation-contracts', + 'aliases' => array(), + 'reference' => '0e0d29ce1f20deffb4ab1b016a7257c4f1e789a1', + 'dev_requirement' => false, + ), + 'tpyo/amazon-s3-php-class' => array( + 'pretty_version' => 'dev-master', + 'version' => 'dev-master', + 'type' => 'library', + 'install_path' => __DIR__ . '/../tpyo/amazon-s3-php-class', + 'aliases' => array( + 0 => '9999999-dev', + ), + 'reference' => '7c62b0e9b7d956a04e377ca236979a78dbac4e66', + 'dev_requirement' => false, + ), + 'twilio/sdk' => array( + 'pretty_version' => '5.42.2', + 'version' => '5.42.2.0', + 'type' => 'library', + 'install_path' => __DIR__ . '/../twilio/sdk', + 'aliases' => array(), + 'reference' => '0cfcb871b18a9c427dd9e8f0ed7458d43009b48a', + 'dev_requirement' => false, + ), + 'unaio/amazon-s3-php-class-hmac-v2' => array( + 'pretty_version' => '0.6', + 'version' => '0.6.0.0', + 'type' => 'library', + 'install_path' => __DIR__ . '/../unaio/amazon-s3-php-class-hmac-v2', + 'aliases' => array(), + 'reference' => '3687dec0af7be2cb11f21828aa4b12d20c4c5935', + 'dev_requirement' => false, + ), + 'unaio/una' => array( + 'pretty_version' => 'dev-master', + 'version' => 'dev-master', + 'type' => 'library', + 'install_path' => __DIR__ . '/../../', + 'aliases' => array(), + 'reference' => '53588980042992e9da0cf02b65071d4a81815440', + 'dev_requirement' => false, + ), + 'wikimedia/less.php' => array( + 'pretty_version' => 'v5.1.1', + 'version' => '5.1.1.0', + 'type' => 'library', + 'install_path' => __DIR__ . '/../wikimedia/less.php', + 'aliases' => array(), + 'reference' => '29e14517d40b321bdbf8823eae1c327fc6b227f5', + 'dev_requirement' => false, + ), + ), +); diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/composer/platform_check.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/composer/platform_check.php new file mode 100644 index 0000000000..4c3a5d68f1 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/composer/platform_check.php @@ -0,0 +1,26 @@ +<?php + +// platform_check.php @generated by Composer + +$issues = array(); + +if (!(PHP_VERSION_ID >= 80100)) { + $issues[] = 'Your Composer dependencies require a PHP version ">= 8.1.0". You are running ' . PHP_VERSION . '.'; +} + +if ($issues) { + if (!headers_sent()) { + header('HTTP/1.1 500 Internal Server Error'); + } + if (!ini_get('display_errors')) { + if (PHP_SAPI === 'cli' || PHP_SAPI === 'phpdbg') { + fwrite(STDERR, 'Composer detected issues in your platform:' . PHP_EOL.PHP_EOL . implode(PHP_EOL, $issues) . PHP_EOL.PHP_EOL); + } elseif (!headers_sent()) { + echo 'Composer detected issues in your platform:' . PHP_EOL.PHP_EOL . str_replace('You are running '.PHP_VERSION.'.', '', implode(PHP_EOL, $issues)) . PHP_EOL.PHP_EOL; + } + } + trigger_error( + 'Composer detected issues in your platform: ' . implode(' ', $issues), + E_USER_ERROR + ); +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/erusev/parsedown/Parsedown.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/erusev/parsedown/Parsedown.php new file mode 100644 index 0000000000..fb5239d1fd --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/erusev/parsedown/Parsedown.php @@ -0,0 +1,1994 @@ +<?php + +# +# +# Parsedown +# http://parsedown.org +# +# (c) Emanuil Rusev +# http://erusev.com +# +# For the full license information, view the LICENSE file that was distributed +# with this source code. +# +# + +class Parsedown +{ + # ~ + + const version = '1.8.0-beta-7'; + + # ~ + + function text($text) + { + $Elements = $this->textElements($text); + + # convert to markup + $markup = $this->elements($Elements); + + # trim line breaks + $markup = trim($markup, "\n"); + + return $markup; + } + + protected function textElements($text) + { + # make sure no definitions are set + $this->DefinitionData = array(); + + # standardize line breaks + $text = str_replace(array("\r\n", "\r"), "\n", $text); + + # remove surrounding line breaks + $text = trim($text, "\n"); + + # split text into lines + $lines = explode("\n", $text); + + # iterate through lines to identify blocks + return $this->linesElements($lines); + } + + # + # Setters + # + + function setBreaksEnabled($breaksEnabled) + { + $this->breaksEnabled = $breaksEnabled; + + return $this; + } + + protected $breaksEnabled; + + function setMarkupEscaped($markupEscaped) + { + $this->markupEscaped = $markupEscaped; + + return $this; + } + + protected $markupEscaped; + + function setUrlsLinked($urlsLinked) + { + $this->urlsLinked = $urlsLinked; + + return $this; + } + + protected $urlsLinked = true; + + function setSafeMode($safeMode) + { + $this->safeMode = (bool) $safeMode; + + return $this; + } + + protected $safeMode; + + function setStrictMode($strictMode) + { + $this->strictMode = (bool) $strictMode; + + return $this; + } + + protected $strictMode; + + protected $safeLinksWhitelist = array( + 'http://', + 'https://', + 'ftp://', + 'ftps://', + 'mailto:', + 'tel:', + 'data:image/png;base64,', + 'data:image/gif;base64,', + 'data:image/jpeg;base64,', + 'irc:', + 'ircs:', + 'git:', + 'ssh:', + 'news:', + 'steam:', + ); + + # + # Lines + # + + protected $BlockTypes = array( + '#' => array('Header'), + '*' => array('Rule', 'List'), + '+' => array('List'), + '-' => array('SetextHeader', 'Table', 'Rule', 'List'), + '0' => array('List'), + '1' => array('List'), + '2' => array('List'), + '3' => array('List'), + '4' => array('List'), + '5' => array('List'), + '6' => array('List'), + '7' => array('List'), + '8' => array('List'), + '9' => array('List'), + ':' => array('Table'), + '<' => array('Comment', 'Markup'), + '=' => array('SetextHeader'), + '>' => array('Quote'), + '[' => array('Reference'), + '_' => array('Rule'), + '`' => array('FencedCode'), + '|' => array('Table'), + '~' => array('FencedCode'), + ); + + # ~ + + protected $unmarkedBlockTypes = array( + 'Code', + ); + + # + # Blocks + # + + protected function lines(array $lines) + { + return $this->elements($this->linesElements($lines)); + } + + protected function linesElements(array $lines) + { + $Elements = array(); + $CurrentBlock = null; + + foreach ($lines as $line) + { + if (chop($line) === '') + { + if (isset($CurrentBlock)) + { + $CurrentBlock['interrupted'] = (isset($CurrentBlock['interrupted']) + ? $CurrentBlock['interrupted'] + 1 : 1 + ); + } + + continue; + } + + while (($beforeTab = strstr($line, "\t", true)) !== false) + { + $shortage = 4 - mb_strlen($beforeTab, 'utf-8') % 4; + + $line = $beforeTab + . str_repeat(' ', $shortage) + . substr($line, strlen($beforeTab) + 1) + ; + } + + $indent = strspn($line, ' '); + + $text = $indent > 0 ? substr($line, $indent) : $line; + + # ~ + + $Line = array('body' => $line, 'indent' => $indent, 'text' => $text); + + # ~ + + if (isset($CurrentBlock['continuable'])) + { + $methodName = 'block' . $CurrentBlock['type'] . 'Continue'; + $Block = $this->$methodName($Line, $CurrentBlock); + + if (isset($Block)) + { + $CurrentBlock = $Block; + + continue; + } + else + { + if ($this->isBlockCompletable($CurrentBlock['type'])) + { + $methodName = 'block' . $CurrentBlock['type'] . 'Complete'; + $CurrentBlock = $this->$methodName($CurrentBlock); + } + } + } + + # ~ + + $marker = $text[0]; + + # ~ + + $blockTypes = $this->unmarkedBlockTypes; + + if (isset($this->BlockTypes[$marker])) + { + foreach ($this->BlockTypes[$marker] as $blockType) + { + $blockTypes []= $blockType; + } + } + + # + # ~ + + foreach ($blockTypes as $blockType) + { + $Block = $this->{"block$blockType"}($Line, $CurrentBlock); + + if (isset($Block)) + { + $Block['type'] = $blockType; + + if ( ! isset($Block['identified'])) + { + if (isset($CurrentBlock)) + { + $Elements[] = $this->extractElement($CurrentBlock); + } + + $Block['identified'] = true; + } + + if ($this->isBlockContinuable($blockType)) + { + $Block['continuable'] = true; + } + + $CurrentBlock = $Block; + + continue 2; + } + } + + # ~ + + if (isset($CurrentBlock) and $CurrentBlock['type'] === 'Paragraph') + { + $Block = $this->paragraphContinue($Line, $CurrentBlock); + } + + if (isset($Block)) + { + $CurrentBlock = $Block; + } + else + { + if (isset($CurrentBlock)) + { + $Elements[] = $this->extractElement($CurrentBlock); + } + + $CurrentBlock = $this->paragraph($Line); + + $CurrentBlock['identified'] = true; + } + } + + # ~ + + if (isset($CurrentBlock['continuable']) and $this->isBlockCompletable($CurrentBlock['type'])) + { + $methodName = 'block' . $CurrentBlock['type'] . 'Complete'; + $CurrentBlock = $this->$methodName($CurrentBlock); + } + + # ~ + + if (isset($CurrentBlock)) + { + $Elements[] = $this->extractElement($CurrentBlock); + } + + # ~ + + return $Elements; + } + + protected function extractElement(array $Component) + { + if ( ! isset($Component['element'])) + { + if (isset($Component['markup'])) + { + $Component['element'] = array('rawHtml' => $Component['markup']); + } + elseif (isset($Component['hidden'])) + { + $Component['element'] = array(); + } + } + + return $Component['element']; + } + + protected function isBlockContinuable($Type) + { + return method_exists($this, 'block' . $Type . 'Continue'); + } + + protected function isBlockCompletable($Type) + { + return method_exists($this, 'block' . $Type . 'Complete'); + } + + # + # Code + + protected function blockCode($Line, $Block = null) + { + if (isset($Block) and $Block['type'] === 'Paragraph' and ! isset($Block['interrupted'])) + { + return; + } + + if ($Line['indent'] >= 4) + { + $text = substr($Line['body'], 4); + + $Block = array( + 'element' => array( + 'name' => 'pre', + 'element' => array( + 'name' => 'code', + 'text' => $text, + ), + ), + ); + + return $Block; + } + } + + protected function blockCodeContinue($Line, $Block) + { + if ($Line['indent'] >= 4) + { + if (isset($Block['interrupted'])) + { + $Block['element']['element']['text'] .= str_repeat("\n", $Block['interrupted']); + + unset($Block['interrupted']); + } + + $Block['element']['element']['text'] .= "\n"; + + $text = substr($Line['body'], 4); + + $Block['element']['element']['text'] .= $text; + + return $Block; + } + } + + protected function blockCodeComplete($Block) + { + return $Block; + } + + # + # Comment + + protected function blockComment($Line) + { + if ($this->markupEscaped or $this->safeMode) + { + return; + } + + if (strpos($Line['text'], '<!--') === 0) + { + $Block = array( + 'element' => array( + 'rawHtml' => $Line['body'], + 'autobreak' => true, + ), + ); + + if (strpos($Line['text'], '-->') !== false) + { + $Block['closed'] = true; + } + + return $Block; + } + } + + protected function blockCommentContinue($Line, array $Block) + { + if (isset($Block['closed'])) + { + return; + } + + $Block['element']['rawHtml'] .= "\n" . $Line['body']; + + if (strpos($Line['text'], '-->') !== false) + { + $Block['closed'] = true; + } + + return $Block; + } + + # + # Fenced Code + + protected function blockFencedCode($Line) + { + $marker = $Line['text'][0]; + + $openerLength = strspn($Line['text'], $marker); + + if ($openerLength < 3) + { + return; + } + + $infostring = trim(substr($Line['text'], $openerLength), "\t "); + + if (strpos($infostring, '`') !== false) + { + return; + } + + $Element = array( + 'name' => 'code', + 'text' => '', + ); + + if ($infostring !== '') + { + /** + * https://www.w3.org/TR/2011/WD-html5-20110525/elements.html#classes + * Every HTML element may have a class attribute specified. + * The attribute, if specified, must have a value that is a set + * of space-separated tokens representing the various classes + * that the element belongs to. + * [...] + * The space characters, for the purposes of this specification, + * are U+0020 SPACE, U+0009 CHARACTER TABULATION (tab), + * U+000A LINE FEED (LF), U+000C FORM FEED (FF), and + * U+000D CARRIAGE RETURN (CR). + */ + $language = substr($infostring, 0, strcspn($infostring, " \t\n\f\r")); + + $Element['attributes'] = array('class' => "language-$language"); + } + + $Block = array( + 'char' => $marker, + 'openerLength' => $openerLength, + 'element' => array( + 'name' => 'pre', + 'element' => $Element, + ), + ); + + return $Block; + } + + protected function blockFencedCodeContinue($Line, $Block) + { + if (isset($Block['complete'])) + { + return; + } + + if (isset($Block['interrupted'])) + { + $Block['element']['element']['text'] .= str_repeat("\n", $Block['interrupted']); + + unset($Block['interrupted']); + } + + if (($len = strspn($Line['text'], $Block['char'])) >= $Block['openerLength'] + and chop(substr($Line['text'], $len), ' ') === '' + ) { + $Block['element']['element']['text'] = substr($Block['element']['element']['text'], 1); + + $Block['complete'] = true; + + return $Block; + } + + $Block['element']['element']['text'] .= "\n" . $Line['body']; + + return $Block; + } + + protected function blockFencedCodeComplete($Block) + { + return $Block; + } + + # + # Header + + protected function blockHeader($Line) + { + $level = strspn($Line['text'], '#'); + + if ($level > 6) + { + return; + } + + $text = trim($Line['text'], '#'); + + if ($this->strictMode and isset($text[0]) and $text[0] !== ' ') + { + return; + } + + $text = trim($text, ' '); + + $Block = array( + 'element' => array( + 'name' => 'h' . $level, + 'handler' => array( + 'function' => 'lineElements', + 'argument' => $text, + 'destination' => 'elements', + ) + ), + ); + + return $Block; + } + + # + # List + + protected function blockList($Line, ?array $CurrentBlock = null) + { + list($name, $pattern) = $Line['text'][0] <= '-' ? array('ul', '[*+-]') : array('ol', '[0-9]{1,9}+[.\)]'); + + if (preg_match('/^('.$pattern.'([ ]++|$))(.*+)/', $Line['text'], $matches)) + { + $contentIndent = strlen($matches[2]); + + if ($contentIndent >= 5) + { + $contentIndent -= 1; + $matches[1] = substr($matches[1], 0, -$contentIndent); + $matches[3] = str_repeat(' ', $contentIndent) . $matches[3]; + } + elseif ($contentIndent === 0) + { + $matches[1] .= ' '; + } + + $markerWithoutWhitespace = strstr($matches[1], ' ', true); + + $Block = array( + 'indent' => $Line['indent'], + 'pattern' => $pattern, + 'data' => array( + 'type' => $name, + 'marker' => $matches[1], + 'markerType' => ($name === 'ul' ? $markerWithoutWhitespace : substr($markerWithoutWhitespace, -1)), + ), + 'element' => array( + 'name' => $name, + 'elements' => array(), + ), + ); + $Block['data']['markerTypeRegex'] = preg_quote($Block['data']['markerType'], '/'); + + if ($name === 'ol') + { + $listStart = ltrim(strstr($matches[1], $Block['data']['markerType'], true), '0') ?: '0'; + + if ($listStart !== '1') + { + if ( + isset($CurrentBlock) + and $CurrentBlock['type'] === 'Paragraph' + and ! isset($CurrentBlock['interrupted']) + ) { + return; + } + + $Block['element']['attributes'] = array('start' => $listStart); + } + } + + $Block['li'] = array( + 'name' => 'li', + 'handler' => array( + 'function' => 'li', + 'argument' => !empty($matches[3]) ? array($matches[3]) : array(), + 'destination' => 'elements' + ) + ); + + $Block['element']['elements'] []= & $Block['li']; + + return $Block; + } + } + + protected function blockListContinue($Line, array $Block) + { + if (isset($Block['interrupted']) and empty($Block['li']['handler']['argument'])) + { + return null; + } + + $requiredIndent = ($Block['indent'] + strlen($Block['data']['marker'])); + + if ($Line['indent'] < $requiredIndent + and ( + ( + $Block['data']['type'] === 'ol' + and preg_match('/^[0-9]++'.$Block['data']['markerTypeRegex'].'(?:[ ]++(.*)|$)/', $Line['text'], $matches) + ) or ( + $Block['data']['type'] === 'ul' + and preg_match('/^'.$Block['data']['markerTypeRegex'].'(?:[ ]++(.*)|$)/', $Line['text'], $matches) + ) + ) + ) { + if (isset($Block['interrupted'])) + { + $Block['li']['handler']['argument'] []= ''; + + $Block['loose'] = true; + + unset($Block['interrupted']); + } + + unset($Block['li']); + + $text = isset($matches[1]) ? $matches[1] : ''; + + $Block['indent'] = $Line['indent']; + + $Block['li'] = array( + 'name' => 'li', + 'handler' => array( + 'function' => 'li', + 'argument' => array($text), + 'destination' => 'elements' + ) + ); + + $Block['element']['elements'] []= & $Block['li']; + + return $Block; + } + elseif ($Line['indent'] < $requiredIndent and $this->blockList($Line)) + { + return null; + } + + if ($Line['text'][0] === '[' and $this->blockReference($Line)) + { + return $Block; + } + + if ($Line['indent'] >= $requiredIndent) + { + if (isset($Block['interrupted'])) + { + $Block['li']['handler']['argument'] []= ''; + + $Block['loose'] = true; + + unset($Block['interrupted']); + } + + $text = substr($Line['body'], $requiredIndent); + + $Block['li']['handler']['argument'] []= $text; + + return $Block; + } + + if ( ! isset($Block['interrupted'])) + { + $text = preg_replace('/^[ ]{0,'.$requiredIndent.'}+/', '', $Line['body']); + + $Block['li']['handler']['argument'] []= $text; + + return $Block; + } + } + + protected function blockListComplete(array $Block) + { + if (isset($Block['loose'])) + { + foreach ($Block['element']['elements'] as &$li) + { + if (end($li['handler']['argument']) !== '') + { + $li['handler']['argument'] []= ''; + } + } + } + + return $Block; + } + + # + # Quote + + protected function blockQuote($Line) + { + if (preg_match('/^>[ ]?+(.*+)/', $Line['text'], $matches)) + { + $Block = array( + 'element' => array( + 'name' => 'blockquote', + 'handler' => array( + 'function' => 'linesElements', + 'argument' => (array) $matches[1], + 'destination' => 'elements', + ) + ), + ); + + return $Block; + } + } + + protected function blockQuoteContinue($Line, array $Block) + { + if (isset($Block['interrupted'])) + { + return; + } + + if ($Line['text'][0] === '>' and preg_match('/^>[ ]?+(.*+)/', $Line['text'], $matches)) + { + $Block['element']['handler']['argument'] []= $matches[1]; + + return $Block; + } + + if ( ! isset($Block['interrupted'])) + { + $Block['element']['handler']['argument'] []= $Line['text']; + + return $Block; + } + } + + # + # Rule + + protected function blockRule($Line) + { + $marker = $Line['text'][0]; + + if (substr_count($Line['text'], $marker) >= 3 and chop($Line['text'], " $marker") === '') + { + $Block = array( + 'element' => array( + 'name' => 'hr', + ), + ); + + return $Block; + } + } + + # + # Setext + + protected function blockSetextHeader($Line, ?array $Block = null) + { + if ( ! isset($Block) or $Block['type'] !== 'Paragraph' or isset($Block['interrupted'])) + { + return; + } + + if ($Line['indent'] < 4 and chop(chop($Line['text'], ' '), $Line['text'][0]) === '') + { + $Block['element']['name'] = $Line['text'][0] === '=' ? 'h1' : 'h2'; + + return $Block; + } + } + + # + # Markup + + protected function blockMarkup($Line) + { + if ($this->markupEscaped or $this->safeMode) + { + return; + } + + if (preg_match('/^<[\/]?+(\w*)(?:[ ]*+'.$this->regexHtmlAttribute.')*+[ ]*+(\/)?>/', $Line['text'], $matches)) + { + $element = strtolower($matches[1]); + + if (in_array($element, $this->textLevelElements)) + { + return; + } + + $Block = array( + 'name' => $matches[1], + 'element' => array( + 'rawHtml' => $Line['text'], + 'autobreak' => true, + ), + ); + + return $Block; + } + } + + protected function blockMarkupContinue($Line, array $Block) + { + if (isset($Block['closed']) or isset($Block['interrupted'])) + { + return; + } + + $Block['element']['rawHtml'] .= "\n" . $Line['body']; + + return $Block; + } + + # + # Reference + + protected function blockReference($Line) + { + if (strpos($Line['text'], ']') !== false + and preg_match('/^\[(.+?)\]:[ ]*+<?(\S+?)>?(?:[ ]+["\'(](.+)["\')])?[ ]*+$/', $Line['text'], $matches) + ) { + $id = strtolower($matches[1]); + + $Data = array( + 'url' => $matches[2], + 'title' => isset($matches[3]) ? $matches[3] : null, + ); + + $this->DefinitionData['Reference'][$id] = $Data; + + $Block = array( + 'element' => array(), + ); + + return $Block; + } + } + + # + # Table + + protected function blockTable($Line, ?array $Block = null) + { + if ( ! isset($Block) or $Block['type'] !== 'Paragraph' or isset($Block['interrupted'])) + { + return; + } + + if ( + strpos($Block['element']['handler']['argument'], '|') === false + and strpos($Line['text'], '|') === false + and strpos($Line['text'], ':') === false + or strpos($Block['element']['handler']['argument'], "\n") !== false + ) { + return; + } + + if (chop($Line['text'], ' -:|') !== '') + { + return; + } + + $alignments = array(); + + $divider = $Line['text']; + + $divider = trim($divider); + $divider = trim($divider, '|'); + + $dividerCells = explode('|', $divider); + + foreach ($dividerCells as $dividerCell) + { + $dividerCell = trim($dividerCell); + + if ($dividerCell === '') + { + return; + } + + $alignment = null; + + if ($dividerCell[0] === ':') + { + $alignment = 'left'; + } + + if (substr($dividerCell, - 1) === ':') + { + $alignment = $alignment === 'left' ? 'center' : 'right'; + } + + $alignments []= $alignment; + } + + # ~ + + $HeaderElements = array(); + + $header = $Block['element']['handler']['argument']; + + $header = trim($header); + $header = trim($header, '|'); + + $headerCells = explode('|', $header); + + if (count($headerCells) !== count($alignments)) + { + return; + } + + foreach ($headerCells as $index => $headerCell) + { + $headerCell = trim($headerCell); + + $HeaderElement = array( + 'name' => 'th', + 'handler' => array( + 'function' => 'lineElements', + 'argument' => $headerCell, + 'destination' => 'elements', + ) + ); + + if (isset($alignments[$index])) + { + $alignment = $alignments[$index]; + + $HeaderElement['attributes'] = array( + 'style' => "text-align: $alignment;", + ); + } + + $HeaderElements []= $HeaderElement; + } + + # ~ + + $Block = array( + 'alignments' => $alignments, + 'identified' => true, + 'element' => array( + 'name' => 'table', + 'elements' => array(), + ), + ); + + $Block['element']['elements'] []= array( + 'name' => 'thead', + ); + + $Block['element']['elements'] []= array( + 'name' => 'tbody', + 'elements' => array(), + ); + + $Block['element']['elements'][0]['elements'] []= array( + 'name' => 'tr', + 'elements' => $HeaderElements, + ); + + return $Block; + } + + protected function blockTableContinue($Line, array $Block) + { + if (isset($Block['interrupted'])) + { + return; + } + + if (count($Block['alignments']) === 1 or $Line['text'][0] === '|' or strpos($Line['text'], '|')) + { + $Elements = array(); + + $row = $Line['text']; + + $row = trim($row); + $row = trim($row, '|'); + + preg_match_all('/(?:(\\\\[|])|[^|`]|`[^`]++`|`)++/', $row, $matches); + + $cells = array_slice($matches[0], 0, count($Block['alignments'])); + + foreach ($cells as $index => $cell) + { + $cell = trim($cell); + + $Element = array( + 'name' => 'td', + 'handler' => array( + 'function' => 'lineElements', + 'argument' => $cell, + 'destination' => 'elements', + ) + ); + + if (isset($Block['alignments'][$index])) + { + $Element['attributes'] = array( + 'style' => 'text-align: ' . $Block['alignments'][$index] . ';', + ); + } + + $Elements []= $Element; + } + + $Element = array( + 'name' => 'tr', + 'elements' => $Elements, + ); + + $Block['element']['elements'][1]['elements'] []= $Element; + + return $Block; + } + } + + # + # ~ + # + + protected function paragraph($Line) + { + return array( + 'type' => 'Paragraph', + 'element' => array( + 'name' => 'p', + 'handler' => array( + 'function' => 'lineElements', + 'argument' => $Line['text'], + 'destination' => 'elements', + ), + ), + ); + } + + protected function paragraphContinue($Line, array $Block) + { + if (isset($Block['interrupted'])) + { + return; + } + + $Block['element']['handler']['argument'] .= "\n".$Line['text']; + + return $Block; + } + + # + # Inline Elements + # + + protected $InlineTypes = array( + '!' => array('Image'), + '&' => array('SpecialCharacter'), + '*' => array('Emphasis'), + ':' => array('Url'), + '<' => array('UrlTag', 'EmailTag', 'Markup'), + '[' => array('Link'), + '_' => array('Emphasis'), + '`' => array('Code'), + '~' => array('Strikethrough'), + '\\' => array('EscapeSequence'), + ); + + # ~ + + protected $inlineMarkerList = '!*_&[:<`~\\'; + + # + # ~ + # + + public function line($text, $nonNestables = array()) + { + return $this->elements($this->lineElements($text, $nonNestables)); + } + + protected function lineElements($text, $nonNestables = array()) + { + # standardize line breaks + $text = str_replace(array("\r\n", "\r"), "\n", $text); + + $Elements = array(); + + $nonNestables = (empty($nonNestables) + ? array() + : array_combine($nonNestables, $nonNestables) + ); + + # $excerpt is based on the first occurrence of a marker + + while ($excerpt = strpbrk($text, $this->inlineMarkerList)) + { + $marker = $excerpt[0]; + + $markerPosition = strlen($text) - strlen($excerpt); + + $Excerpt = array('text' => $excerpt, 'context' => $text); + + foreach ($this->InlineTypes[$marker] as $inlineType) + { + # check to see if the current inline type is nestable in the current context + + if (isset($nonNestables[$inlineType])) + { + continue; + } + + $Inline = $this->{"inline$inlineType"}($Excerpt); + + if ( ! isset($Inline)) + { + continue; + } + + # makes sure that the inline belongs to "our" marker + + if (isset($Inline['position']) and $Inline['position'] > $markerPosition) + { + continue; + } + + # sets a default inline position + + if ( ! isset($Inline['position'])) + { + $Inline['position'] = $markerPosition; + } + + # cause the new element to 'inherit' our non nestables + + + $Inline['element']['nonNestables'] = isset($Inline['element']['nonNestables']) + ? array_merge($Inline['element']['nonNestables'], $nonNestables) + : $nonNestables + ; + + # the text that comes before the inline + $unmarkedText = substr($text, 0, $Inline['position']); + + # compile the unmarked text + $InlineText = $this->inlineText($unmarkedText); + $Elements[] = $InlineText['element']; + + # compile the inline + $Elements[] = $this->extractElement($Inline); + + # remove the examined text + $text = substr($text, $Inline['position'] + $Inline['extent']); + + continue 2; + } + + # the marker does not belong to an inline + + $unmarkedText = substr($text, 0, $markerPosition + 1); + + $InlineText = $this->inlineText($unmarkedText); + $Elements[] = $InlineText['element']; + + $text = substr($text, $markerPosition + 1); + } + + $InlineText = $this->inlineText($text); + $Elements[] = $InlineText['element']; + + foreach ($Elements as &$Element) + { + if ( ! isset($Element['autobreak'])) + { + $Element['autobreak'] = false; + } + } + + return $Elements; + } + + # + # ~ + # + + protected function inlineText($text) + { + $Inline = array( + 'extent' => strlen($text), + 'element' => array(), + ); + + $Inline['element']['elements'] = self::pregReplaceElements( + $this->breaksEnabled ? '/[ ]*+\n/' : '/(?:[ ]*+\\\\|[ ]{2,}+)\n/', + array( + array('name' => 'br'), + array('text' => "\n"), + ), + $text + ); + + return $Inline; + } + + protected function inlineCode($Excerpt) + { + $marker = $Excerpt['text'][0]; + + if (preg_match('/^(['.$marker.']++)[ ]*+(.+?)[ ]*+(?<!['.$marker.'])\1(?!'.$marker.')/s', $Excerpt['text'], $matches)) + { + $text = $matches[2]; + $text = preg_replace('/[ ]*+\n/', ' ', $text); + + return array( + 'extent' => strlen($matches[0]), + 'element' => array( + 'name' => 'code', + 'text' => $text, + ), + ); + } + } + + protected function inlineEmailTag($Excerpt) + { + $hostnameLabel = '[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?'; + + $commonMarkEmail = '[a-zA-Z0-9.!#$%&\'*+\/=?^_`{|}~-]++@' + . $hostnameLabel . '(?:\.' . $hostnameLabel . ')*'; + + if (strpos($Excerpt['text'], '>') !== false + and preg_match("/^<((mailto:)?$commonMarkEmail)>/i", $Excerpt['text'], $matches) + ){ + $url = $matches[1]; + + if ( ! isset($matches[2])) + { + $url = "mailto:$url"; + } + + return array( + 'extent' => strlen($matches[0]), + 'element' => array( + 'name' => 'a', + 'text' => $matches[1], + 'attributes' => array( + 'href' => $url, + ), + ), + ); + } + } + + protected function inlineEmphasis($Excerpt) + { + if ( ! isset($Excerpt['text'][1])) + { + return; + } + + $marker = $Excerpt['text'][0]; + + if ($Excerpt['text'][1] === $marker and preg_match($this->StrongRegex[$marker], $Excerpt['text'], $matches)) + { + $emphasis = 'strong'; + } + elseif (preg_match($this->EmRegex[$marker], $Excerpt['text'], $matches)) + { + $emphasis = 'em'; + } + else + { + return; + } + + return array( + 'extent' => strlen($matches[0]), + 'element' => array( + 'name' => $emphasis, + 'handler' => array( + 'function' => 'lineElements', + 'argument' => $matches[1], + 'destination' => 'elements', + ) + ), + ); + } + + protected function inlineEscapeSequence($Excerpt) + { + if (isset($Excerpt['text'][1]) and in_array($Excerpt['text'][1], $this->specialCharacters)) + { + return array( + 'element' => array('rawHtml' => $Excerpt['text'][1]), + 'extent' => 2, + ); + } + } + + protected function inlineImage($Excerpt) + { + if ( ! isset($Excerpt['text'][1]) or $Excerpt['text'][1] !== '[') + { + return; + } + + $Excerpt['text']= substr($Excerpt['text'], 1); + + $Link = $this->inlineLink($Excerpt); + + if ($Link === null) + { + return; + } + + $Inline = array( + 'extent' => $Link['extent'] + 1, + 'element' => array( + 'name' => 'img', + 'attributes' => array( + 'src' => $Link['element']['attributes']['href'], + 'alt' => $Link['element']['handler']['argument'], + ), + 'autobreak' => true, + ), + ); + + $Inline['element']['attributes'] += $Link['element']['attributes']; + + unset($Inline['element']['attributes']['href']); + + return $Inline; + } + + protected function inlineLink($Excerpt) + { + $Element = array( + 'name' => 'a', + 'handler' => array( + 'function' => 'lineElements', + 'argument' => null, + 'destination' => 'elements', + ), + 'nonNestables' => array('Url', 'Link'), + 'attributes' => array( + 'href' => null, + 'title' => null, + ), + ); + + $extent = 0; + + $remainder = $Excerpt['text']; + + if (preg_match('/\[((?:[^][]++|(?R))*+)\]/', $remainder, $matches)) + { + $Element['handler']['argument'] = $matches[1]; + + $extent += strlen($matches[0]); + + $remainder = substr($remainder, $extent); + } + else + { + return; + } + + if (preg_match('/^[(]\s*+((?:[^ ()]++|[(][^ )]+[)])++)(?:[ ]+("[^"]*+"|\'[^\']*+\'))?\s*+[)]/', $remainder, $matches)) + { + $Element['attributes']['href'] = $matches[1]; + + if (isset($matches[2])) + { + $Element['attributes']['title'] = substr($matches[2], 1, - 1); + } + + $extent += strlen($matches[0]); + } + else + { + if (preg_match('/^\s*\[(.*?)\]/', $remainder, $matches)) + { + $definition = strlen($matches[1]) ? $matches[1] : $Element['handler']['argument']; + $definition = strtolower($definition); + + $extent += strlen($matches[0]); + } + else + { + $definition = strtolower($Element['handler']['argument']); + } + + if ( ! isset($this->DefinitionData['Reference'][$definition])) + { + return; + } + + $Definition = $this->DefinitionData['Reference'][$definition]; + + $Element['attributes']['href'] = $Definition['url']; + $Element['attributes']['title'] = $Definition['title']; + } + + return array( + 'extent' => $extent, + 'element' => $Element, + ); + } + + protected function inlineMarkup($Excerpt) + { + if ($this->markupEscaped or $this->safeMode or strpos($Excerpt['text'], '>') === false) + { + return; + } + + if ($Excerpt['text'][1] === '/' and preg_match('/^<\/\w[\w-]*+[ ]*+>/s', $Excerpt['text'], $matches)) + { + return array( + 'element' => array('rawHtml' => $matches[0]), + 'extent' => strlen($matches[0]), + ); + } + + if ($Excerpt['text'][1] === '!' and preg_match('/^<!---?[^>-](?:-?+[^-])*-->/s', $Excerpt['text'], $matches)) + { + return array( + 'element' => array('rawHtml' => $matches[0]), + 'extent' => strlen($matches[0]), + ); + } + + if ($Excerpt['text'][1] !== ' ' and preg_match('/^<\w[\w-]*+(?:[ ]*+'.$this->regexHtmlAttribute.')*+[ ]*+\/?>/s', $Excerpt['text'], $matches)) + { + return array( + 'element' => array('rawHtml' => $matches[0]), + 'extent' => strlen($matches[0]), + ); + } + } + + protected function inlineSpecialCharacter($Excerpt) + { + if (substr($Excerpt['text'], 1, 1) !== ' ' and strpos($Excerpt['text'], ';') !== false + and preg_match('/^&(#?+[0-9a-zA-Z]++);/', $Excerpt['text'], $matches) + ) { + return array( + 'element' => array('rawHtml' => '&' . $matches[1] . ';'), + 'extent' => strlen($matches[0]), + ); + } + + return; + } + + protected function inlineStrikethrough($Excerpt) + { + if ( ! isset($Excerpt['text'][1])) + { + return; + } + + if ($Excerpt['text'][1] === '~' and preg_match('/^~~(?=\S)(.+?)(?<=\S)~~/', $Excerpt['text'], $matches)) + { + return array( + 'extent' => strlen($matches[0]), + 'element' => array( + 'name' => 'del', + 'handler' => array( + 'function' => 'lineElements', + 'argument' => $matches[1], + 'destination' => 'elements', + ) + ), + ); + } + } + + protected function inlineUrl($Excerpt) + { + if ($this->urlsLinked !== true or ! isset($Excerpt['text'][2]) or $Excerpt['text'][2] !== '/') + { + return; + } + + if (strpos($Excerpt['context'], 'http') !== false + and preg_match('/\bhttps?+:[\/]{2}[^\s<]+\b\/*+/ui', $Excerpt['context'], $matches, PREG_OFFSET_CAPTURE) + ) { + $url = $matches[0][0]; + + $Inline = array( + 'extent' => strlen($matches[0][0]), + 'position' => $matches[0][1], + 'element' => array( + 'name' => 'a', + 'text' => $url, + 'attributes' => array( + 'href' => $url, + ), + ), + ); + + return $Inline; + } + } + + protected function inlineUrlTag($Excerpt) + { + if (strpos($Excerpt['text'], '>') !== false and preg_match('/^<(\w++:\/{2}[^ >]++)>/i', $Excerpt['text'], $matches)) + { + $url = $matches[1]; + + return array( + 'extent' => strlen($matches[0]), + 'element' => array( + 'name' => 'a', + 'text' => $url, + 'attributes' => array( + 'href' => $url, + ), + ), + ); + } + } + + # ~ + + protected function unmarkedText($text) + { + $Inline = $this->inlineText($text); + return $this->element($Inline['element']); + } + + # + # Handlers + # + + protected function handle(array $Element) + { + if (isset($Element['handler'])) + { + if (!isset($Element['nonNestables'])) + { + $Element['nonNestables'] = array(); + } + + if (is_string($Element['handler'])) + { + $function = $Element['handler']; + $argument = $Element['text']; + unset($Element['text']); + $destination = 'rawHtml'; + } + else + { + $function = $Element['handler']['function']; + $argument = $Element['handler']['argument']; + $destination = $Element['handler']['destination']; + } + + $Element[$destination] = $this->{$function}($argument, $Element['nonNestables']); + + if ($destination === 'handler') + { + $Element = $this->handle($Element); + } + + unset($Element['handler']); + } + + return $Element; + } + + protected function handleElementRecursive(array $Element) + { + return $this->elementApplyRecursive(array($this, 'handle'), $Element); + } + + protected function handleElementsRecursive(array $Elements) + { + return $this->elementsApplyRecursive(array($this, 'handle'), $Elements); + } + + protected function elementApplyRecursive($closure, array $Element) + { + $Element = call_user_func($closure, $Element); + + if (isset($Element['elements'])) + { + $Element['elements'] = $this->elementsApplyRecursive($closure, $Element['elements']); + } + elseif (isset($Element['element'])) + { + $Element['element'] = $this->elementApplyRecursive($closure, $Element['element']); + } + + return $Element; + } + + protected function elementApplyRecursiveDepthFirst($closure, array $Element) + { + if (isset($Element['elements'])) + { + $Element['elements'] = $this->elementsApplyRecursiveDepthFirst($closure, $Element['elements']); + } + elseif (isset($Element['element'])) + { + $Element['element'] = $this->elementsApplyRecursiveDepthFirst($closure, $Element['element']); + } + + $Element = call_user_func($closure, $Element); + + return $Element; + } + + protected function elementsApplyRecursive($closure, array $Elements) + { + foreach ($Elements as &$Element) + { + $Element = $this->elementApplyRecursive($closure, $Element); + } + + return $Elements; + } + + protected function elementsApplyRecursiveDepthFirst($closure, array $Elements) + { + foreach ($Elements as &$Element) + { + $Element = $this->elementApplyRecursiveDepthFirst($closure, $Element); + } + + return $Elements; + } + + protected function element(array $Element) + { + if ($this->safeMode) + { + $Element = $this->sanitiseElement($Element); + } + + # identity map if element has no handler + $Element = $this->handle($Element); + + $hasName = isset($Element['name']); + + $markup = ''; + + if ($hasName) + { + $markup .= '<' . $Element['name']; + + if (isset($Element['attributes'])) + { + foreach ($Element['attributes'] as $name => $value) + { + if ($value === null) + { + continue; + } + + $markup .= " $name=\"".self::escape($value).'"'; + } + } + } + + $permitRawHtml = false; + + if (isset($Element['text'])) + { + $text = $Element['text']; + } + // very strongly consider an alternative if you're writing an + // extension + elseif (isset($Element['rawHtml'])) + { + $text = $Element['rawHtml']; + + $allowRawHtmlInSafeMode = isset($Element['allowRawHtmlInSafeMode']) && $Element['allowRawHtmlInSafeMode']; + $permitRawHtml = !$this->safeMode || $allowRawHtmlInSafeMode; + } + + $hasContent = isset($text) || isset($Element['element']) || isset($Element['elements']); + + if ($hasContent) + { + $markup .= $hasName ? '>' : ''; + + if (isset($Element['elements'])) + { + $markup .= $this->elements($Element['elements']); + } + elseif (isset($Element['element'])) + { + $markup .= $this->element($Element['element']); + } + else + { + if (!$permitRawHtml) + { + $markup .= self::escape($text, true); + } + else + { + $markup .= $text; + } + } + + $markup .= $hasName ? '</' . $Element['name'] . '>' : ''; + } + elseif ($hasName) + { + $markup .= ' />'; + } + + return $markup; + } + + protected function elements(array $Elements) + { + $markup = ''; + + $autoBreak = true; + + foreach ($Elements as $Element) + { + if (empty($Element)) + { + continue; + } + + $autoBreakNext = (isset($Element['autobreak']) + ? $Element['autobreak'] : isset($Element['name']) + ); + // (autobreak === false) covers both sides of an element + $autoBreak = !$autoBreak ? $autoBreak : $autoBreakNext; + + $markup .= ($autoBreak ? "\n" : '') . $this->element($Element); + $autoBreak = $autoBreakNext; + } + + $markup .= $autoBreak ? "\n" : ''; + + return $markup; + } + + # ~ + + protected function li($lines) + { + $Elements = $this->linesElements($lines); + + if ( ! in_array('', $lines) + and isset($Elements[0]) and isset($Elements[0]['name']) + and $Elements[0]['name'] === 'p' + ) { + unset($Elements[0]['name']); + } + + return $Elements; + } + + # + # AST Convenience + # + + /** + * Replace occurrences $regexp with $Elements in $text. Return an array of + * elements representing the replacement. + */ + protected static function pregReplaceElements($regexp, $Elements, $text) + { + $newElements = array(); + + while (preg_match($regexp, $text, $matches, PREG_OFFSET_CAPTURE)) + { + $offset = $matches[0][1]; + $before = substr($text, 0, $offset); + $after = substr($text, $offset + strlen($matches[0][0])); + + $newElements[] = array('text' => $before); + + foreach ($Elements as $Element) + { + $newElements[] = $Element; + } + + $text = $after; + } + + $newElements[] = array('text' => $text); + + return $newElements; + } + + # + # Deprecated Methods + # + + function parse($text) + { + $markup = $this->text($text); + + return $markup; + } + + protected function sanitiseElement(array $Element) + { + static $goodAttribute = '/^[a-zA-Z0-9][a-zA-Z0-9-_]*+$/'; + static $safeUrlNameToAtt = array( + 'a' => 'href', + 'img' => 'src', + ); + + if ( ! isset($Element['name'])) + { + unset($Element['attributes']); + return $Element; + } + + if (isset($safeUrlNameToAtt[$Element['name']])) + { + $Element = $this->filterUnsafeUrlInAttribute($Element, $safeUrlNameToAtt[$Element['name']]); + } + + if ( ! empty($Element['attributes'])) + { + foreach ($Element['attributes'] as $att => $val) + { + # filter out badly parsed attribute + if ( ! preg_match($goodAttribute, $att)) + { + unset($Element['attributes'][$att]); + } + # dump onevent attribute + elseif (self::striAtStart($att, 'on')) + { + unset($Element['attributes'][$att]); + } + } + } + + return $Element; + } + + protected function filterUnsafeUrlInAttribute(array $Element, $attribute) + { + foreach ($this->safeLinksWhitelist as $scheme) + { + if (self::striAtStart($Element['attributes'][$attribute], $scheme)) + { + return $Element; + } + } + + $Element['attributes'][$attribute] = str_replace(':', '%3A', $Element['attributes'][$attribute]); + + return $Element; + } + + # + # Static Methods + # + + protected static function escape($text, $allowQuotes = false) + { + return htmlspecialchars($text, $allowQuotes ? ENT_NOQUOTES : ENT_QUOTES, 'UTF-8'); + } + + protected static function striAtStart($string, $needle) + { + $len = strlen($needle); + + if ($len > strlen($string)) + { + return false; + } + else + { + return strtolower(substr($string, 0, $len)) === strtolower($needle); + } + } + + static function instance($name = 'default') + { + if (isset(self::$instances[$name])) + { + return self::$instances[$name]; + } + + $instance = new static(); + + self::$instances[$name] = $instance; + + return $instance; + } + + private static $instances = array(); + + # + # Fields + # + + protected $DefinitionData; + + # + # Read-Only + + protected $specialCharacters = array( + '\\', '`', '*', '_', '{', '}', '[', ']', '(', ')', '>', '#', '+', '-', '.', '!', '|', '~' + ); + + protected $StrongRegex = array( + '*' => '/^[*]{2}((?:\\\\\*|[^*]|[*][^*]*+[*])+?)[*]{2}(?![*])/s', + '_' => '/^__((?:\\\\_|[^_]|_[^_]*+_)+?)__(?!_)/us', + ); + + protected $EmRegex = array( + '*' => '/^[*]((?:\\\\\*|[^*]|[*][*][^*]+?[*][*])+?)[*](?![*])/s', + '_' => '/^_((?:\\\\_|[^_]|__[^_]*__)+?)_(?!_)\b/us', + ); + + protected $regexHtmlAttribute = '[a-zA-Z_:][\w:.-]*+(?:\s*+=\s*+(?:[^"\'=<>`\s]+|"[^"]*+"|\'[^\']*+\'))?+'; + + protected $voidElements = array( + 'area', 'base', 'br', 'col', 'command', 'embed', 'hr', 'img', 'input', 'link', 'meta', 'param', 'source', + ); + + protected $textLevelElements = array( + 'a', 'br', 'bdo', 'abbr', 'blink', 'nextid', 'acronym', 'basefont', + 'b', 'em', 'big', 'cite', 'small', 'spacer', 'listing', + 'i', 'rp', 'del', 'code', 'strike', 'marquee', + 'q', 'rt', 'ins', 'font', 'strong', + 's', 'tt', 'kbd', 'mark', + 'u', 'xm', 'sub', 'nobr', + 'sup', 'ruby', + 'var', 'span', + 'wbr', 'time', + ); +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/composer.json b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/composer.json new file mode 100644 index 0000000000..cbede149ac --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/composer.json @@ -0,0 +1,131 @@ +{ + "name": "guzzlehttp/guzzle", + "description": "Guzzle is a PHP HTTP client library", + "keywords": [ + "framework", + "http", + "rest", + "web service", + "curl", + "client", + "HTTP client", + "PSR-7", + "PSR-18" + ], + "license": "MIT", + "authors": [ + { + "name": "Graham Campbell", + "email": "hello@gjcampbell.co.uk", + "homepage": "https://github.com/GrahamCampbell" + }, + { + "name": "Michael Dowling", + "email": "mtdowling@gmail.com", + "homepage": "https://github.com/mtdowling" + }, + { + "name": "Jeremy Lindblom", + "email": "jeremeamia@gmail.com", + "homepage": "https://github.com/jeremeamia" + }, + { + "name": "George Mponos", + "email": "gmponos@gmail.com", + "homepage": "https://github.com/gmponos" + }, + { + "name": "Tobias Nyholm", + "email": "tobias.nyholm@gmail.com", + "homepage": "https://github.com/Nyholm" + }, + { + "name": "Márk Sági-Kazár", + "email": "mark.sagikazar@gmail.com", + "homepage": "https://github.com/sagikazarmark" + }, + { + "name": "Tobias Schultze", + "email": "webmaster@tubo-world.de", + "homepage": "https://github.com/Tobion" + } + ], + "repositories": [ + { + "type": "package", + "package": { + "name": "guzzle/client-integration-tests", + "version": "v3.0.2", + "dist": { + "url": "https://codeload.github.com/guzzle/client-integration-tests/zip/2c025848417c1135031fdf9c728ee53d0a7ceaee", + "type": "zip" + }, + "require": { + "php": "^7.2.5 || ^8.0", + "phpunit/phpunit": "^7.5.20 || ^8.5.8 || ^9.3.11", + "php-http/message": "^1.0 || ^2.0", + "guzzlehttp/psr7": "^1.7 || ^2.0", + "th3n3rd/cartesian-product": "^0.3" + }, + "autoload": { + "psr-4": { + "Http\\Client\\Tests\\": "src/" + } + }, + "bin": [ + "bin/http_test_server" + ] + } + } + ], + "require": { + "php": "^7.2.5 || ^8.0", + "ext-json": "*", + "guzzlehttp/promises": "^1.5.3 || ^2.0.3", + "guzzlehttp/psr7": "^2.7.0", + "psr/http-client": "^1.0", + "symfony/deprecation-contracts": "^2.2 || ^3.0" + }, + "provide": { + "psr/http-client-implementation": "1.0" + }, + "require-dev": { + "ext-curl": "*", + "bamarni/composer-bin-plugin": "^1.8.2", + "guzzle/client-integration-tests": "3.0.2", + "php-http/message-factory": "^1.1", + "phpunit/phpunit": "^8.5.39 || ^9.6.20", + "psr/log": "^1.1 || ^2.0 || ^3.0" + }, + "suggest": { + "ext-curl": "Required for CURL handler support", + "ext-intl": "Required for Internationalized Domain Name (IDN) support", + "psr/log": "Required for using the Log middleware" + }, + "config": { + "allow-plugins": { + "bamarni/composer-bin-plugin": true + }, + "preferred-install": "dist", + "sort-packages": true + }, + "extra": { + "bamarni-bin": { + "bin-links": true, + "forward-command": false + } + }, + "autoload": { + "psr-4": { + "GuzzleHttp\\": "src/" + }, + "files": [ + "src/functions_include.php" + ] + }, + "autoload-dev": { + "psr-4": { + "GuzzleHttp\\Tests\\": "tests/" + } + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/BodySummarizer.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/BodySummarizer.php new file mode 100644 index 0000000000..761506dd07 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/BodySummarizer.php @@ -0,0 +1,28 @@ +<?php + +namespace GuzzleHttp; + +use Psr\Http\Message\MessageInterface; + +final class BodySummarizer implements BodySummarizerInterface +{ + /** + * @var int|null + */ + private $truncateAt; + + public function __construct(?int $truncateAt = null) + { + $this->truncateAt = $truncateAt; + } + + /** + * Returns a summarized message body. + */ + public function summarize(MessageInterface $message): ?string + { + return $this->truncateAt === null + ? Psr7\Message::bodySummary($message) + : Psr7\Message::bodySummary($message, $this->truncateAt); + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/Client.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/Client.php new file mode 100644 index 0000000000..c78919a4fc --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/Client.php @@ -0,0 +1,483 @@ +<?php + +namespace GuzzleHttp; + +use GuzzleHttp\Cookie\CookieJar; +use GuzzleHttp\Exception\GuzzleException; +use GuzzleHttp\Exception\InvalidArgumentException; +use GuzzleHttp\Promise as P; +use GuzzleHttp\Promise\PromiseInterface; +use Psr\Http\Message\RequestInterface; +use Psr\Http\Message\ResponseInterface; +use Psr\Http\Message\UriInterface; + +/** + * @final + */ +class Client implements ClientInterface, \Psr\Http\Client\ClientInterface +{ + use ClientTrait; + + /** + * @var array Default request options + */ + private $config; + + /** + * Clients accept an array of constructor parameters. + * + * Here's an example of creating a client using a base_uri and an array of + * default request options to apply to each request: + * + * $client = new Client([ + * 'base_uri' => 'http://www.foo.com/1.0/', + * 'timeout' => 0, + * 'allow_redirects' => false, + * 'proxy' => '192.168.16.1:10' + * ]); + * + * Client configuration settings include the following options: + * + * - handler: (callable) Function that transfers HTTP requests over the + * wire. The function is called with a Psr7\Http\Message\RequestInterface + * and array of transfer options, and must return a + * GuzzleHttp\Promise\PromiseInterface that is fulfilled with a + * Psr7\Http\Message\ResponseInterface on success. + * If no handler is provided, a default handler will be created + * that enables all of the request options below by attaching all of the + * default middleware to the handler. + * - base_uri: (string|UriInterface) Base URI of the client that is merged + * into relative URIs. Can be a string or instance of UriInterface. + * - **: any request option + * + * @param array $config Client configuration settings. + * + * @see RequestOptions for a list of available request options. + */ + public function __construct(array $config = []) + { + if (!isset($config['handler'])) { + $config['handler'] = HandlerStack::create(); + } elseif (!\is_callable($config['handler'])) { + throw new InvalidArgumentException('handler must be a callable'); + } + + // Convert the base_uri to a UriInterface + if (isset($config['base_uri'])) { + $config['base_uri'] = Psr7\Utils::uriFor($config['base_uri']); + } + + $this->configureDefaults($config); + } + + /** + * @param string $method + * @param array $args + * + * @return PromiseInterface|ResponseInterface + * + * @deprecated Client::__call will be removed in guzzlehttp/guzzle:8.0. + */ + public function __call($method, $args) + { + if (\count($args) < 1) { + throw new InvalidArgumentException('Magic request methods require a URI and optional options array'); + } + + $uri = $args[0]; + $opts = $args[1] ?? []; + + return \substr($method, -5) === 'Async' + ? $this->requestAsync(\substr($method, 0, -5), $uri, $opts) + : $this->request($method, $uri, $opts); + } + + /** + * Asynchronously send an HTTP request. + * + * @param array $options Request options to apply to the given + * request and to the transfer. See \GuzzleHttp\RequestOptions. + */ + public function sendAsync(RequestInterface $request, array $options = []): PromiseInterface + { + // Merge the base URI into the request URI if needed. + $options = $this->prepareDefaults($options); + + return $this->transfer( + $request->withUri($this->buildUri($request->getUri(), $options), $request->hasHeader('Host')), + $options + ); + } + + /** + * Send an HTTP request. + * + * @param array $options Request options to apply to the given + * request and to the transfer. See \GuzzleHttp\RequestOptions. + * + * @throws GuzzleException + */ + public function send(RequestInterface $request, array $options = []): ResponseInterface + { + $options[RequestOptions::SYNCHRONOUS] = true; + + return $this->sendAsync($request, $options)->wait(); + } + + /** + * The HttpClient PSR (PSR-18) specify this method. + * + * {@inheritDoc} + */ + public function sendRequest(RequestInterface $request): ResponseInterface + { + $options[RequestOptions::SYNCHRONOUS] = true; + $options[RequestOptions::ALLOW_REDIRECTS] = false; + $options[RequestOptions::HTTP_ERRORS] = false; + + return $this->sendAsync($request, $options)->wait(); + } + + /** + * Create and send an asynchronous HTTP request. + * + * Use an absolute path to override the base path of the client, or a + * relative path to append to the base path of the client. The URL can + * contain the query string as well. Use an array to provide a URL + * template and additional variables to use in the URL template expansion. + * + * @param string $method HTTP method + * @param string|UriInterface $uri URI object or string. + * @param array $options Request options to apply. See \GuzzleHttp\RequestOptions. + */ + public function requestAsync(string $method, $uri = '', array $options = []): PromiseInterface + { + $options = $this->prepareDefaults($options); + // Remove request modifying parameter because it can be done up-front. + $headers = $options['headers'] ?? []; + $body = $options['body'] ?? null; + $version = $options['version'] ?? '1.1'; + // Merge the URI into the base URI. + $uri = $this->buildUri(Psr7\Utils::uriFor($uri), $options); + if (\is_array($body)) { + throw $this->invalidBody(); + } + $request = new Psr7\Request($method, $uri, $headers, $body, $version); + // Remove the option so that they are not doubly-applied. + unset($options['headers'], $options['body'], $options['version']); + + return $this->transfer($request, $options); + } + + /** + * Create and send an HTTP request. + * + * Use an absolute path to override the base path of the client, or a + * relative path to append to the base path of the client. The URL can + * contain the query string as well. + * + * @param string $method HTTP method. + * @param string|UriInterface $uri URI object or string. + * @param array $options Request options to apply. See \GuzzleHttp\RequestOptions. + * + * @throws GuzzleException + */ + public function request(string $method, $uri = '', array $options = []): ResponseInterface + { + $options[RequestOptions::SYNCHRONOUS] = true; + + return $this->requestAsync($method, $uri, $options)->wait(); + } + + /** + * Get a client configuration option. + * + * These options include default request options of the client, a "handler" + * (if utilized by the concrete client), and a "base_uri" if utilized by + * the concrete client. + * + * @param string|null $option The config option to retrieve. + * + * @return mixed + * + * @deprecated Client::getConfig will be removed in guzzlehttp/guzzle:8.0. + */ + public function getConfig(?string $option = null) + { + return $option === null + ? $this->config + : ($this->config[$option] ?? null); + } + + private function buildUri(UriInterface $uri, array $config): UriInterface + { + if (isset($config['base_uri'])) { + $uri = Psr7\UriResolver::resolve(Psr7\Utils::uriFor($config['base_uri']), $uri); + } + + if (isset($config['idn_conversion']) && ($config['idn_conversion'] !== false)) { + $idnOptions = ($config['idn_conversion'] === true) ? \IDNA_DEFAULT : $config['idn_conversion']; + $uri = Utils::idnUriConvert($uri, $idnOptions); + } + + return $uri->getScheme() === '' && $uri->getHost() !== '' ? $uri->withScheme('http') : $uri; + } + + /** + * Configures the default options for a client. + */ + private function configureDefaults(array $config): void + { + $defaults = [ + 'allow_redirects' => RedirectMiddleware::$defaultSettings, + 'http_errors' => true, + 'decode_content' => true, + 'verify' => true, + 'cookies' => false, + 'idn_conversion' => false, + ]; + + // Use the standard Linux HTTP_PROXY and HTTPS_PROXY if set. + + // We can only trust the HTTP_PROXY environment variable in a CLI + // process due to the fact that PHP has no reliable mechanism to + // get environment variables that start with "HTTP_". + if (\PHP_SAPI === 'cli' && ($proxy = Utils::getenv('HTTP_PROXY'))) { + $defaults['proxy']['http'] = $proxy; + } + + if ($proxy = Utils::getenv('HTTPS_PROXY')) { + $defaults['proxy']['https'] = $proxy; + } + + if ($noProxy = Utils::getenv('NO_PROXY')) { + $cleanedNoProxy = \str_replace(' ', '', $noProxy); + $defaults['proxy']['no'] = \explode(',', $cleanedNoProxy); + } + + $this->config = $config + $defaults; + + if (!empty($config['cookies']) && $config['cookies'] === true) { + $this->config['cookies'] = new CookieJar(); + } + + // Add the default user-agent header. + if (!isset($this->config['headers'])) { + $this->config['headers'] = ['User-Agent' => Utils::defaultUserAgent()]; + } else { + // Add the User-Agent header if one was not already set. + foreach (\array_keys($this->config['headers']) as $name) { + if (\strtolower($name) === 'user-agent') { + return; + } + } + $this->config['headers']['User-Agent'] = Utils::defaultUserAgent(); + } + } + + /** + * Merges default options into the array. + * + * @param array $options Options to modify by reference + */ + private function prepareDefaults(array $options): array + { + $defaults = $this->config; + + if (!empty($defaults['headers'])) { + // Default headers are only added if they are not present. + $defaults['_conditional'] = $defaults['headers']; + unset($defaults['headers']); + } + + // Special handling for headers is required as they are added as + // conditional headers and as headers passed to a request ctor. + if (\array_key_exists('headers', $options)) { + // Allows default headers to be unset. + if ($options['headers'] === null) { + $defaults['_conditional'] = []; + unset($options['headers']); + } elseif (!\is_array($options['headers'])) { + throw new InvalidArgumentException('headers must be an array'); + } + } + + // Shallow merge defaults underneath options. + $result = $options + $defaults; + + // Remove null values. + foreach ($result as $k => $v) { + if ($v === null) { + unset($result[$k]); + } + } + + return $result; + } + + /** + * Transfers the given request and applies request options. + * + * The URI of the request is not modified and the request options are used + * as-is without merging in default options. + * + * @param array $options See \GuzzleHttp\RequestOptions. + */ + private function transfer(RequestInterface $request, array $options): PromiseInterface + { + $request = $this->applyOptions($request, $options); + /** @var HandlerStack $handler */ + $handler = $options['handler']; + + try { + return P\Create::promiseFor($handler($request, $options)); + } catch (\Exception $e) { + return P\Create::rejectionFor($e); + } + } + + /** + * Applies the array of request options to a request. + */ + private function applyOptions(RequestInterface $request, array &$options): RequestInterface + { + $modify = [ + 'set_headers' => [], + ]; + + if (isset($options['headers'])) { + if (array_keys($options['headers']) === range(0, count($options['headers']) - 1)) { + throw new InvalidArgumentException('The headers array must have header name as keys.'); + } + $modify['set_headers'] = $options['headers']; + unset($options['headers']); + } + + if (isset($options['form_params'])) { + if (isset($options['multipart'])) { + throw new InvalidArgumentException('You cannot use ' + .'form_params and multipart at the same time. Use the ' + .'form_params option if you want to send application/' + .'x-www-form-urlencoded requests, and the multipart ' + .'option to send multipart/form-data requests.'); + } + $options['body'] = \http_build_query($options['form_params'], '', '&'); + unset($options['form_params']); + // Ensure that we don't have the header in different case and set the new value. + $options['_conditional'] = Psr7\Utils::caselessRemove(['Content-Type'], $options['_conditional']); + $options['_conditional']['Content-Type'] = 'application/x-www-form-urlencoded'; + } + + if (isset($options['multipart'])) { + $options['body'] = new Psr7\MultipartStream($options['multipart']); + unset($options['multipart']); + } + + if (isset($options['json'])) { + $options['body'] = Utils::jsonEncode($options['json']); + unset($options['json']); + // Ensure that we don't have the header in different case and set the new value. + $options['_conditional'] = Psr7\Utils::caselessRemove(['Content-Type'], $options['_conditional']); + $options['_conditional']['Content-Type'] = 'application/json'; + } + + if (!empty($options['decode_content']) + && $options['decode_content'] !== true + ) { + // Ensure that we don't have the header in different case and set the new value. + $options['_conditional'] = Psr7\Utils::caselessRemove(['Accept-Encoding'], $options['_conditional']); + $modify['set_headers']['Accept-Encoding'] = $options['decode_content']; + } + + if (isset($options['body'])) { + if (\is_array($options['body'])) { + throw $this->invalidBody(); + } + $modify['body'] = Psr7\Utils::streamFor($options['body']); + unset($options['body']); + } + + if (!empty($options['auth']) && \is_array($options['auth'])) { + $value = $options['auth']; + $type = isset($value[2]) ? \strtolower($value[2]) : 'basic'; + switch ($type) { + case 'basic': + // Ensure that we don't have the header in different case and set the new value. + $modify['set_headers'] = Psr7\Utils::caselessRemove(['Authorization'], $modify['set_headers']); + $modify['set_headers']['Authorization'] = 'Basic ' + .\base64_encode("$value[0]:$value[1]"); + break; + case 'digest': + // @todo: Do not rely on curl + $options['curl'][\CURLOPT_HTTPAUTH] = \CURLAUTH_DIGEST; + $options['curl'][\CURLOPT_USERPWD] = "$value[0]:$value[1]"; + break; + case 'ntlm': + $options['curl'][\CURLOPT_HTTPAUTH] = \CURLAUTH_NTLM; + $options['curl'][\CURLOPT_USERPWD] = "$value[0]:$value[1]"; + break; + } + } + + if (isset($options['query'])) { + $value = $options['query']; + if (\is_array($value)) { + $value = \http_build_query($value, '', '&', \PHP_QUERY_RFC3986); + } + if (!\is_string($value)) { + throw new InvalidArgumentException('query must be a string or array'); + } + $modify['query'] = $value; + unset($options['query']); + } + + // Ensure that sink is not an invalid value. + if (isset($options['sink'])) { + // TODO: Add more sink validation? + if (\is_bool($options['sink'])) { + throw new InvalidArgumentException('sink must not be a boolean'); + } + } + + if (isset($options['version'])) { + $modify['version'] = $options['version']; + } + + $request = Psr7\Utils::modifyRequest($request, $modify); + if ($request->getBody() instanceof Psr7\MultipartStream) { + // Use a multipart/form-data POST if a Content-Type is not set. + // Ensure that we don't have the header in different case and set the new value. + $options['_conditional'] = Psr7\Utils::caselessRemove(['Content-Type'], $options['_conditional']); + $options['_conditional']['Content-Type'] = 'multipart/form-data; boundary=' + .$request->getBody()->getBoundary(); + } + + // Merge in conditional headers if they are not present. + if (isset($options['_conditional'])) { + // Build up the changes so it's in a single clone of the message. + $modify = []; + foreach ($options['_conditional'] as $k => $v) { + if (!$request->hasHeader($k)) { + $modify['set_headers'][$k] = $v; + } + } + $request = Psr7\Utils::modifyRequest($request, $modify); + // Don't pass this internal value along to middleware/handlers. + unset($options['_conditional']); + } + + return $request; + } + + /** + * Return an InvalidArgumentException with pre-set message. + */ + private function invalidBody(): InvalidArgumentException + { + return new InvalidArgumentException('Passing in the "body" request ' + .'option as an array to send a request is not supported. ' + .'Please use the "form_params" request option to send a ' + .'application/x-www-form-urlencoded request, or the "multipart" ' + .'request option to send a multipart/form-data request.'); + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/ClientInterface.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/ClientInterface.php new file mode 100644 index 0000000000..6aaee61afc --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/ClientInterface.php @@ -0,0 +1,84 @@ +<?php + +namespace GuzzleHttp; + +use GuzzleHttp\Exception\GuzzleException; +use GuzzleHttp\Promise\PromiseInterface; +use Psr\Http\Message\RequestInterface; +use Psr\Http\Message\ResponseInterface; +use Psr\Http\Message\UriInterface; + +/** + * Client interface for sending HTTP requests. + */ +interface ClientInterface +{ + /** + * The Guzzle major version. + */ + public const MAJOR_VERSION = 7; + + /** + * Send an HTTP request. + * + * @param RequestInterface $request Request to send + * @param array $options Request options to apply to the given + * request and to the transfer. + * + * @throws GuzzleException + */ + public function send(RequestInterface $request, array $options = []): ResponseInterface; + + /** + * Asynchronously send an HTTP request. + * + * @param RequestInterface $request Request to send + * @param array $options Request options to apply to the given + * request and to the transfer. + */ + public function sendAsync(RequestInterface $request, array $options = []): PromiseInterface; + + /** + * Create and send an HTTP request. + * + * Use an absolute path to override the base path of the client, or a + * relative path to append to the base path of the client. The URL can + * contain the query string as well. + * + * @param string $method HTTP method. + * @param string|UriInterface $uri URI object or string. + * @param array $options Request options to apply. + * + * @throws GuzzleException + */ + public function request(string $method, $uri, array $options = []): ResponseInterface; + + /** + * Create and send an asynchronous HTTP request. + * + * Use an absolute path to override the base path of the client, or a + * relative path to append to the base path of the client. The URL can + * contain the query string as well. Use an array to provide a URL + * template and additional variables to use in the URL template expansion. + * + * @param string $method HTTP method + * @param string|UriInterface $uri URI object or string. + * @param array $options Request options to apply. + */ + public function requestAsync(string $method, $uri, array $options = []): PromiseInterface; + + /** + * Get a client configuration option. + * + * These options include default request options of the client, a "handler" + * (if utilized by the concrete client), and a "base_uri" if utilized by + * the concrete client. + * + * @param string|null $option The config option to retrieve. + * + * @return mixed + * + * @deprecated ClientInterface::getConfig will be removed in guzzlehttp/guzzle:8.0. + */ + public function getConfig(?string $option = null); +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/Cookie/CookieJar.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/Cookie/CookieJar.php new file mode 100644 index 0000000000..b616cf2ed6 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/Cookie/CookieJar.php @@ -0,0 +1,307 @@ +<?php + +namespace GuzzleHttp\Cookie; + +use Psr\Http\Message\RequestInterface; +use Psr\Http\Message\ResponseInterface; + +/** + * Cookie jar that stores cookies as an array + */ +class CookieJar implements CookieJarInterface +{ + /** + * @var SetCookie[] Loaded cookie data + */ + private $cookies = []; + + /** + * @var bool + */ + private $strictMode; + + /** + * @param bool $strictMode Set to true to throw exceptions when invalid + * cookies are added to the cookie jar. + * @param array $cookieArray Array of SetCookie objects or a hash of + * arrays that can be used with the SetCookie + * constructor + */ + public function __construct(bool $strictMode = false, array $cookieArray = []) + { + $this->strictMode = $strictMode; + + foreach ($cookieArray as $cookie) { + if (!($cookie instanceof SetCookie)) { + $cookie = new SetCookie($cookie); + } + $this->setCookie($cookie); + } + } + + /** + * Create a new Cookie jar from an associative array and domain. + * + * @param array $cookies Cookies to create the jar from + * @param string $domain Domain to set the cookies to + */ + public static function fromArray(array $cookies, string $domain): self + { + $cookieJar = new self(); + foreach ($cookies as $name => $value) { + $cookieJar->setCookie(new SetCookie([ + 'Domain' => $domain, + 'Name' => $name, + 'Value' => $value, + 'Discard' => true, + ])); + } + + return $cookieJar; + } + + /** + * Evaluate if this cookie should be persisted to storage + * that survives between requests. + * + * @param SetCookie $cookie Being evaluated. + * @param bool $allowSessionCookies If we should persist session cookies + */ + public static function shouldPersist(SetCookie $cookie, bool $allowSessionCookies = false): bool + { + if ($cookie->getExpires() || $allowSessionCookies) { + if (!$cookie->getDiscard()) { + return true; + } + } + + return false; + } + + /** + * Finds and returns the cookie based on the name + * + * @param string $name cookie name to search for + * + * @return SetCookie|null cookie that was found or null if not found + */ + public function getCookieByName(string $name): ?SetCookie + { + foreach ($this->cookies as $cookie) { + if ($cookie->getName() !== null && \strcasecmp($cookie->getName(), $name) === 0) { + return $cookie; + } + } + + return null; + } + + public function toArray(): array + { + return \array_map(static function (SetCookie $cookie): array { + return $cookie->toArray(); + }, $this->getIterator()->getArrayCopy()); + } + + public function clear(?string $domain = null, ?string $path = null, ?string $name = null): void + { + if (!$domain) { + $this->cookies = []; + + return; + } elseif (!$path) { + $this->cookies = \array_filter( + $this->cookies, + static function (SetCookie $cookie) use ($domain): bool { + return !$cookie->matchesDomain($domain); + } + ); + } elseif (!$name) { + $this->cookies = \array_filter( + $this->cookies, + static function (SetCookie $cookie) use ($path, $domain): bool { + return !($cookie->matchesPath($path) + && $cookie->matchesDomain($domain)); + } + ); + } else { + $this->cookies = \array_filter( + $this->cookies, + static function (SetCookie $cookie) use ($path, $domain, $name) { + return !($cookie->getName() == $name + && $cookie->matchesPath($path) + && $cookie->matchesDomain($domain)); + } + ); + } + } + + public function clearSessionCookies(): void + { + $this->cookies = \array_filter( + $this->cookies, + static function (SetCookie $cookie): bool { + return !$cookie->getDiscard() && $cookie->getExpires(); + } + ); + } + + public function setCookie(SetCookie $cookie): bool + { + // If the name string is empty (but not 0), ignore the set-cookie + // string entirely. + $name = $cookie->getName(); + if (!$name && $name !== '0') { + return false; + } + + // Only allow cookies with set and valid domain, name, value + $result = $cookie->validate(); + if ($result !== true) { + if ($this->strictMode) { + throw new \RuntimeException('Invalid cookie: '.$result); + } + $this->removeCookieIfEmpty($cookie); + + return false; + } + + // Resolve conflicts with previously set cookies + foreach ($this->cookies as $i => $c) { + // Two cookies are identical, when their path, and domain are + // identical. + if ($c->getPath() != $cookie->getPath() + || $c->getDomain() != $cookie->getDomain() + || $c->getName() != $cookie->getName() + ) { + continue; + } + + // The previously set cookie is a discard cookie and this one is + // not so allow the new cookie to be set + if (!$cookie->getDiscard() && $c->getDiscard()) { + unset($this->cookies[$i]); + continue; + } + + // If the new cookie's expiration is further into the future, then + // replace the old cookie + if ($cookie->getExpires() > $c->getExpires()) { + unset($this->cookies[$i]); + continue; + } + + // If the value has changed, we better change it + if ($cookie->getValue() !== $c->getValue()) { + unset($this->cookies[$i]); + continue; + } + + // The cookie exists, so no need to continue + return false; + } + + $this->cookies[] = $cookie; + + return true; + } + + public function count(): int + { + return \count($this->cookies); + } + + /** + * @return \ArrayIterator<int, SetCookie> + */ + public function getIterator(): \ArrayIterator + { + return new \ArrayIterator(\array_values($this->cookies)); + } + + public function extractCookies(RequestInterface $request, ResponseInterface $response): void + { + if ($cookieHeader = $response->getHeader('Set-Cookie')) { + foreach ($cookieHeader as $cookie) { + $sc = SetCookie::fromString($cookie); + if (!$sc->getDomain()) { + $sc->setDomain($request->getUri()->getHost()); + } + if (0 !== \strpos($sc->getPath(), '/')) { + $sc->setPath($this->getCookiePathFromRequest($request)); + } + if (!$sc->matchesDomain($request->getUri()->getHost())) { + continue; + } + // Note: At this point `$sc->getDomain()` being a public suffix should + // be rejected, but we don't want to pull in the full PSL dependency. + $this->setCookie($sc); + } + } + } + + /** + * Computes cookie path following RFC 6265 section 5.1.4 + * + * @see https://datatracker.ietf.org/doc/html/rfc6265#section-5.1.4 + */ + private function getCookiePathFromRequest(RequestInterface $request): string + { + $uriPath = $request->getUri()->getPath(); + if ('' === $uriPath) { + return '/'; + } + if (0 !== \strpos($uriPath, '/')) { + return '/'; + } + if ('/' === $uriPath) { + return '/'; + } + $lastSlashPos = \strrpos($uriPath, '/'); + if (0 === $lastSlashPos || false === $lastSlashPos) { + return '/'; + } + + return \substr($uriPath, 0, $lastSlashPos); + } + + public function withCookieHeader(RequestInterface $request): RequestInterface + { + $values = []; + $uri = $request->getUri(); + $scheme = $uri->getScheme(); + $host = $uri->getHost(); + $path = $uri->getPath() ?: '/'; + + foreach ($this->cookies as $cookie) { + if ($cookie->matchesPath($path) + && $cookie->matchesDomain($host) + && !$cookie->isExpired() + && (!$cookie->getSecure() || $scheme === 'https') + ) { + $values[] = $cookie->getName().'=' + .$cookie->getValue(); + } + } + + return $values + ? $request->withHeader('Cookie', \implode('; ', $values)) + : $request; + } + + /** + * If a cookie already exists and the server asks to set it again with a + * null value, the cookie must be deleted. + */ + private function removeCookieIfEmpty(SetCookie $cookie): void + { + $cookieValue = $cookie->getValue(); + if ($cookieValue === null || $cookieValue === '') { + $this->clear( + $cookie->getDomain(), + $cookie->getPath(), + $cookie->getName() + ); + } + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/Cookie/CookieJarInterface.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/Cookie/CookieJarInterface.php new file mode 100644 index 0000000000..93ada58d22 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/Cookie/CookieJarInterface.php @@ -0,0 +1,80 @@ +<?php + +namespace GuzzleHttp\Cookie; + +use Psr\Http\Message\RequestInterface; +use Psr\Http\Message\ResponseInterface; + +/** + * Stores HTTP cookies. + * + * It extracts cookies from HTTP requests, and returns them in HTTP responses. + * CookieJarInterface instances automatically expire contained cookies when + * necessary. Subclasses are also responsible for storing and retrieving + * cookies from a file, database, etc. + * + * @see https://docs.python.org/2/library/cookielib.html Inspiration + * + * @extends \IteratorAggregate<SetCookie> + */ +interface CookieJarInterface extends \Countable, \IteratorAggregate +{ + /** + * Create a request with added cookie headers. + * + * If no matching cookies are found in the cookie jar, then no Cookie + * header is added to the request and the same request is returned. + * + * @param RequestInterface $request Request object to modify. + * + * @return RequestInterface returns the modified request. + */ + public function withCookieHeader(RequestInterface $request): RequestInterface; + + /** + * Extract cookies from an HTTP response and store them in the CookieJar. + * + * @param RequestInterface $request Request that was sent + * @param ResponseInterface $response Response that was received + */ + public function extractCookies(RequestInterface $request, ResponseInterface $response): void; + + /** + * Sets a cookie in the cookie jar. + * + * @param SetCookie $cookie Cookie to set. + * + * @return bool Returns true on success or false on failure + */ + public function setCookie(SetCookie $cookie): bool; + + /** + * Remove cookies currently held in the cookie jar. + * + * Invoking this method without arguments will empty the whole cookie jar. + * If given a $domain argument only cookies belonging to that domain will + * be removed. If given a $domain and $path argument, cookies belonging to + * the specified path within that domain are removed. If given all three + * arguments, then the cookie with the specified name, path and domain is + * removed. + * + * @param string|null $domain Clears cookies matching a domain + * @param string|null $path Clears cookies matching a domain and path + * @param string|null $name Clears cookies matching a domain, path, and name + */ + public function clear(?string $domain = null, ?string $path = null, ?string $name = null): void; + + /** + * Discard all sessions cookies. + * + * Removes cookies that don't have an expire field or a have a discard + * field set to true. To be called when the user agent shuts down according + * to RFC 2965. + */ + public function clearSessionCookies(): void; + + /** + * Converts the cookie jar to an array. + */ + public function toArray(): array; +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/Exception/BadResponseException.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/Exception/BadResponseException.php new file mode 100644 index 0000000000..ba67ad498c --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/Exception/BadResponseException.php @@ -0,0 +1,39 @@ +<?php + +namespace GuzzleHttp\Exception; + +use Psr\Http\Message\RequestInterface; +use Psr\Http\Message\ResponseInterface; + +/** + * Exception when an HTTP error occurs (4xx or 5xx error) + */ +class BadResponseException extends RequestException +{ + public function __construct( + string $message, + RequestInterface $request, + ResponseInterface $response, + ?\Throwable $previous = null, + array $handlerContext = [] + ) { + parent::__construct($message, $request, $response, $previous, $handlerContext); + } + + /** + * Current exception and the ones that extend it will always have a response. + */ + public function hasResponse(): bool + { + return true; + } + + /** + * This function narrows the return type from the parent class and does not allow it to be nullable. + */ + public function getResponse(): ResponseInterface + { + /** @var ResponseInterface */ + return parent::getResponse(); + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/Exception/ConnectException.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/Exception/ConnectException.php new file mode 100644 index 0000000000..eab51ca177 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/Exception/ConnectException.php @@ -0,0 +1,56 @@ +<?php + +namespace GuzzleHttp\Exception; + +use Psr\Http\Client\NetworkExceptionInterface; +use Psr\Http\Message\RequestInterface; + +/** + * Exception thrown when a connection cannot be established. + * + * Note that no response is present for a ConnectException + */ +class ConnectException extends TransferException implements NetworkExceptionInterface +{ + /** + * @var RequestInterface + */ + private $request; + + /** + * @var array + */ + private $handlerContext; + + public function __construct( + string $message, + RequestInterface $request, + ?\Throwable $previous = null, + array $handlerContext = [] + ) { + parent::__construct($message, 0, $previous); + $this->request = $request; + $this->handlerContext = $handlerContext; + } + + /** + * Get the request that caused the exception + */ + public function getRequest(): RequestInterface + { + return $this->request; + } + + /** + * Get contextual information about the error from the underlying handler. + * + * The contents of this array will vary depending on which handler you are + * using. It may also be just an empty array. Relying on this data will + * couple you to a specific handler, but can give more debug information + * when needed. + */ + public function getHandlerContext(): array + { + return $this->handlerContext; + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/Exception/RequestException.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/Exception/RequestException.php new file mode 100644 index 0000000000..b42c88abfa --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/Exception/RequestException.php @@ -0,0 +1,150 @@ +<?php + +namespace GuzzleHttp\Exception; + +use GuzzleHttp\BodySummarizer; +use GuzzleHttp\BodySummarizerInterface; +use Psr\Http\Client\RequestExceptionInterface; +use Psr\Http\Message\RequestInterface; +use Psr\Http\Message\ResponseInterface; + +/** + * HTTP Request exception + */ +class RequestException extends TransferException implements RequestExceptionInterface +{ + /** + * @var RequestInterface + */ + private $request; + + /** + * @var ResponseInterface|null + */ + private $response; + + /** + * @var array + */ + private $handlerContext; + + public function __construct( + string $message, + RequestInterface $request, + ?ResponseInterface $response = null, + ?\Throwable $previous = null, + array $handlerContext = [] + ) { + // Set the code of the exception if the response is set and not future. + $code = $response ? $response->getStatusCode() : 0; + parent::__construct($message, $code, $previous); + $this->request = $request; + $this->response = $response; + $this->handlerContext = $handlerContext; + } + + /** + * Wrap non-RequestExceptions with a RequestException + */ + public static function wrapException(RequestInterface $request, \Throwable $e): RequestException + { + return $e instanceof RequestException ? $e : new RequestException($e->getMessage(), $request, null, $e); + } + + /** + * Factory method to create a new exception with a normalized error message + * + * @param RequestInterface $request Request sent + * @param ResponseInterface $response Response received + * @param \Throwable|null $previous Previous exception + * @param array $handlerContext Optional handler context + * @param BodySummarizerInterface|null $bodySummarizer Optional body summarizer + */ + public static function create( + RequestInterface $request, + ?ResponseInterface $response = null, + ?\Throwable $previous = null, + array $handlerContext = [], + ?BodySummarizerInterface $bodySummarizer = null + ): self { + if (!$response) { + return new self( + 'Error completing request', + $request, + null, + $previous, + $handlerContext + ); + } + + $level = (int) \floor($response->getStatusCode() / 100); + if ($level === 4) { + $label = 'Client error'; + $className = ClientException::class; + } elseif ($level === 5) { + $label = 'Server error'; + $className = ServerException::class; + } else { + $label = 'Unsuccessful request'; + $className = __CLASS__; + } + + $uri = \GuzzleHttp\Psr7\Utils::redactUserInfo($request->getUri()); + + // Client Error: `GET /` resulted in a `404 Not Found` response: + // <html> ... (truncated) + $message = \sprintf( + '%s: `%s %s` resulted in a `%s %s` response', + $label, + $request->getMethod(), + $uri->__toString(), + $response->getStatusCode(), + $response->getReasonPhrase() + ); + + $summary = ($bodySummarizer ?? new BodySummarizer())->summarize($response); + + if ($summary !== null) { + $message .= ":\n{$summary}\n"; + } + + return new $className($message, $request, $response, $previous, $handlerContext); + } + + /** + * Get the request that caused the exception + */ + public function getRequest(): RequestInterface + { + return $this->request; + } + + /** + * Get the associated response + */ + public function getResponse(): ?ResponseInterface + { + return $this->response; + } + + /** + * Check if a response was received + */ + public function hasResponse(): bool + { + return $this->response !== null; + } + + /** + * Get contextual information about the error from the underlying handler. + * + * The contents of this array will vary depending on which handler you are + * using. It may also be just an empty array. Relying on this data will + * couple you to a specific handler, but can give more debug information + * when needed. + */ + public function getHandlerContext(): array + { + return $this->handlerContext; + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/Handler/CurlFactory.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/Handler/CurlFactory.php new file mode 100644 index 0000000000..fe36137513 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/Handler/CurlFactory.php @@ -0,0 +1,736 @@ +<?php + +namespace GuzzleHttp\Handler; + +use GuzzleHttp\Exception\ConnectException; +use GuzzleHttp\Exception\RequestException; +use GuzzleHttp\Promise as P; +use GuzzleHttp\Promise\FulfilledPromise; +use GuzzleHttp\Promise\PromiseInterface; +use GuzzleHttp\Psr7\LazyOpenStream; +use GuzzleHttp\TransferStats; +use GuzzleHttp\Utils; +use Psr\Http\Message\RequestInterface; +use Psr\Http\Message\UriInterface; + +/** + * Creates curl resources from a request + * + * @final + */ +class CurlFactory implements CurlFactoryInterface +{ + public const CURL_VERSION_STR = 'curl_version'; + + /** + * @deprecated + */ + public const LOW_CURL_VERSION_NUMBER = '7.21.2'; + + /** + * @var resource[]|\CurlHandle[] + */ + private $handles = []; + + /** + * @var int Total number of idle handles to keep in cache + */ + private $maxHandles; + + /** + * @param int $maxHandles Maximum number of idle handles. + */ + public function __construct(int $maxHandles) + { + $this->maxHandles = $maxHandles; + } + + public function create(RequestInterface $request, array $options): EasyHandle + { + $protocolVersion = $request->getProtocolVersion(); + + if ('2' === $protocolVersion || '2.0' === $protocolVersion) { + if (!self::supportsHttp2()) { + throw new ConnectException('HTTP/2 is supported by the cURL handler, however libcurl is built without HTTP/2 support.', $request); + } + } elseif ('1.0' !== $protocolVersion && '1.1' !== $protocolVersion) { + throw new ConnectException(sprintf('HTTP/%s is not supported by the cURL handler.', $protocolVersion), $request); + } + + if (isset($options['curl']['body_as_string'])) { + $options['_body_as_string'] = $options['curl']['body_as_string']; + unset($options['curl']['body_as_string']); + } + + $easy = new EasyHandle(); + $easy->request = $request; + $easy->options = $options; + $conf = $this->getDefaultConf($easy); + $this->applyMethod($easy, $conf); + $this->applyHandlerOptions($easy, $conf); + $this->applyHeaders($easy, $conf); + unset($conf['_headers']); + + // Add handler options from the request configuration options + if (isset($options['curl'])) { + $conf = \array_replace($conf, $options['curl']); + } + + $conf[\CURLOPT_HEADERFUNCTION] = $this->createHeaderFn($easy); + $easy->handle = $this->handles ? \array_pop($this->handles) : \curl_init(); + curl_setopt_array($easy->handle, $conf); + + return $easy; + } + + private static function supportsHttp2(): bool + { + static $supportsHttp2 = null; + + if (null === $supportsHttp2) { + $supportsHttp2 = self::supportsTls12() + && defined('CURL_VERSION_HTTP2') + && (\CURL_VERSION_HTTP2 & \curl_version()['features']); + } + + return $supportsHttp2; + } + + private static function supportsTls12(): bool + { + static $supportsTls12 = null; + + if (null === $supportsTls12) { + $supportsTls12 = \CURL_SSLVERSION_TLSv1_2 & \curl_version()['features']; + } + + return $supportsTls12; + } + + private static function supportsTls13(): bool + { + static $supportsTls13 = null; + + if (null === $supportsTls13) { + $supportsTls13 = defined('CURL_SSLVERSION_TLSv1_3') + && (\CURL_SSLVERSION_TLSv1_3 & \curl_version()['features']); + } + + return $supportsTls13; + } + + public function release(EasyHandle $easy): void + { + $resource = $easy->handle; + unset($easy->handle); + + if (\count($this->handles) >= $this->maxHandles) { + \curl_close($resource); + } else { + // Remove all callback functions as they can hold onto references + // and are not cleaned up by curl_reset. Using curl_setopt_array + // does not work for some reason, so removing each one + // individually. + \curl_setopt($resource, \CURLOPT_HEADERFUNCTION, null); + \curl_setopt($resource, \CURLOPT_READFUNCTION, null); + \curl_setopt($resource, \CURLOPT_WRITEFUNCTION, null); + \curl_setopt($resource, \CURLOPT_PROGRESSFUNCTION, null); + \curl_reset($resource); + $this->handles[] = $resource; + } + } + + /** + * Completes a cURL transaction, either returning a response promise or a + * rejected promise. + * + * @param callable(RequestInterface, array): PromiseInterface $handler + * @param CurlFactoryInterface $factory Dictates how the handle is released + */ + public static function finish(callable $handler, EasyHandle $easy, CurlFactoryInterface $factory): PromiseInterface + { + if (isset($easy->options['on_stats'])) { + self::invokeStats($easy); + } + + if (!$easy->response || $easy->errno) { + return self::finishError($handler, $easy, $factory); + } + + // Return the response if it is present and there is no error. + $factory->release($easy); + + // Rewind the body of the response if possible. + $body = $easy->response->getBody(); + if ($body->isSeekable()) { + $body->rewind(); + } + + return new FulfilledPromise($easy->response); + } + + private static function invokeStats(EasyHandle $easy): void + { + $curlStats = \curl_getinfo($easy->handle); + $curlStats['appconnect_time'] = \curl_getinfo($easy->handle, \CURLINFO_APPCONNECT_TIME); + $stats = new TransferStats( + $easy->request, + $easy->response, + $curlStats['total_time'], + $easy->errno, + $curlStats + ); + ($easy->options['on_stats'])($stats); + } + + /** + * @param callable(RequestInterface, array): PromiseInterface $handler + */ + private static function finishError(callable $handler, EasyHandle $easy, CurlFactoryInterface $factory): PromiseInterface + { + // Get error information and release the handle to the factory. + $ctx = [ + 'errno' => $easy->errno, + 'error' => \curl_error($easy->handle), + 'appconnect_time' => \curl_getinfo($easy->handle, \CURLINFO_APPCONNECT_TIME), + ] + \curl_getinfo($easy->handle); + $ctx[self::CURL_VERSION_STR] = self::getCurlVersion(); + $factory->release($easy); + + // Retry when nothing is present or when curl failed to rewind. + if (empty($easy->options['_err_message']) && (!$easy->errno || $easy->errno == 65)) { + return self::retryFailedRewind($handler, $easy, $ctx); + } + + return self::createRejection($easy, $ctx); + } + + private static function getCurlVersion(): string + { + static $curlVersion = null; + + if (null === $curlVersion) { + $curlVersion = \curl_version()['version']; + } + + return $curlVersion; + } + + private static function createRejection(EasyHandle $easy, array $ctx): PromiseInterface + { + static $connectionErrors = [ + \CURLE_OPERATION_TIMEOUTED => true, + \CURLE_COULDNT_RESOLVE_HOST => true, + \CURLE_COULDNT_CONNECT => true, + \CURLE_SSL_CONNECT_ERROR => true, + \CURLE_GOT_NOTHING => true, + ]; + + if ($easy->createResponseException) { + return P\Create::rejectionFor( + new RequestException( + 'An error was encountered while creating the response', + $easy->request, + $easy->response, + $easy->createResponseException, + $ctx + ) + ); + } + + // If an exception was encountered during the onHeaders event, then + // return a rejected promise that wraps that exception. + if ($easy->onHeadersException) { + return P\Create::rejectionFor( + new RequestException( + 'An error was encountered during the on_headers event', + $easy->request, + $easy->response, + $easy->onHeadersException, + $ctx + ) + ); + } + + $uri = $easy->request->getUri(); + + $sanitizedError = self::sanitizeCurlError($ctx['error'] ?? '', $uri); + + $message = \sprintf( + 'cURL error %s: %s (%s)', + $ctx['errno'], + $sanitizedError, + 'see https://curl.haxx.se/libcurl/c/libcurl-errors.html' + ); + + if ('' !== $sanitizedError) { + $redactedUriString = \GuzzleHttp\Psr7\Utils::redactUserInfo($uri)->__toString(); + if ($redactedUriString !== '' && false === \strpos($sanitizedError, $redactedUriString)) { + $message .= \sprintf(' for %s', $redactedUriString); + } + } + + // Create a connection exception if it was a specific error code. + $error = isset($connectionErrors[$easy->errno]) + ? new ConnectException($message, $easy->request, null, $ctx) + : new RequestException($message, $easy->request, $easy->response, null, $ctx); + + return P\Create::rejectionFor($error); + } + + private static function sanitizeCurlError(string $error, UriInterface $uri): string + { + if ('' === $error) { + return $error; + } + + $baseUri = $uri->withQuery('')->withFragment(''); + $baseUriString = $baseUri->__toString(); + + if ('' === $baseUriString) { + return $error; + } + + $redactedUriString = \GuzzleHttp\Psr7\Utils::redactUserInfo($baseUri)->__toString(); + + return str_replace($baseUriString, $redactedUriString, $error); + } + + /** + * @return array<int|string, mixed> + */ + private function getDefaultConf(EasyHandle $easy): array + { + $conf = [ + '_headers' => $easy->request->getHeaders(), + \CURLOPT_CUSTOMREQUEST => $easy->request->getMethod(), + \CURLOPT_URL => (string) $easy->request->getUri()->withFragment(''), + \CURLOPT_RETURNTRANSFER => false, + \CURLOPT_HEADER => false, + \CURLOPT_CONNECTTIMEOUT => 300, + ]; + + if (\defined('CURLOPT_PROTOCOLS')) { + $conf[\CURLOPT_PROTOCOLS] = \CURLPROTO_HTTP | \CURLPROTO_HTTPS; + } + + $version = $easy->request->getProtocolVersion(); + + if ('2' === $version || '2.0' === $version) { + $conf[\CURLOPT_HTTP_VERSION] = \CURL_HTTP_VERSION_2_0; + } elseif ('1.1' === $version) { + $conf[\CURLOPT_HTTP_VERSION] = \CURL_HTTP_VERSION_1_1; + } else { + $conf[\CURLOPT_HTTP_VERSION] = \CURL_HTTP_VERSION_1_0; + } + + return $conf; + } + + private function applyMethod(EasyHandle $easy, array &$conf): void + { + $body = $easy->request->getBody(); + $size = $body->getSize(); + + if ($size === null || $size > 0) { + $this->applyBody($easy->request, $easy->options, $conf); + + return; + } + + $method = $easy->request->getMethod(); + if ($method === 'PUT' || $method === 'POST') { + // See https://datatracker.ietf.org/doc/html/rfc7230#section-3.3.2 + if (!$easy->request->hasHeader('Content-Length')) { + $conf[\CURLOPT_HTTPHEADER][] = 'Content-Length: 0'; + } + } elseif ($method === 'HEAD') { + $conf[\CURLOPT_NOBODY] = true; + unset( + $conf[\CURLOPT_WRITEFUNCTION], + $conf[\CURLOPT_READFUNCTION], + $conf[\CURLOPT_FILE], + $conf[\CURLOPT_INFILE] + ); + } + } + + private function applyBody(RequestInterface $request, array $options, array &$conf): void + { + $size = $request->hasHeader('Content-Length') + ? (int) $request->getHeaderLine('Content-Length') + : null; + + // Send the body as a string if the size is less than 1MB OR if the + // [curl][body_as_string] request value is set. + if (($size !== null && $size < 1000000) || !empty($options['_body_as_string'])) { + $conf[\CURLOPT_POSTFIELDS] = (string) $request->getBody(); + // Don't duplicate the Content-Length header + $this->removeHeader('Content-Length', $conf); + $this->removeHeader('Transfer-Encoding', $conf); + } else { + $conf[\CURLOPT_UPLOAD] = true; + if ($size !== null) { + $conf[\CURLOPT_INFILESIZE] = $size; + $this->removeHeader('Content-Length', $conf); + } + $body = $request->getBody(); + if ($body->isSeekable()) { + $body->rewind(); + } + $conf[\CURLOPT_READFUNCTION] = static function ($ch, $fd, $length) use ($body) { + return $body->read($length); + }; + } + + // If the Expect header is not present, prevent curl from adding it + if (!$request->hasHeader('Expect')) { + $conf[\CURLOPT_HTTPHEADER][] = 'Expect:'; + } + + // cURL sometimes adds a content-type by default. Prevent this. + if (!$request->hasHeader('Content-Type')) { + $conf[\CURLOPT_HTTPHEADER][] = 'Content-Type:'; + } + } + + private function applyHeaders(EasyHandle $easy, array &$conf): void + { + foreach ($conf['_headers'] as $name => $values) { + foreach ($values as $value) { + $value = (string) $value; + if ($value === '') { + // cURL requires a special format for empty headers. + // See https://github.com/guzzle/guzzle/issues/1882 for more details. + $conf[\CURLOPT_HTTPHEADER][] = "$name;"; + } else { + $conf[\CURLOPT_HTTPHEADER][] = "$name: $value"; + } + } + } + + // Remove the Accept header if one was not set + if (!$easy->request->hasHeader('Accept')) { + $conf[\CURLOPT_HTTPHEADER][] = 'Accept:'; + } + } + + /** + * Remove a header from the options array. + * + * @param string $name Case-insensitive header to remove + * @param array $options Array of options to modify + */ + private function removeHeader(string $name, array &$options): void + { + foreach (\array_keys($options['_headers']) as $key) { + if (!\strcasecmp($key, $name)) { + unset($options['_headers'][$key]); + + return; + } + } + } + + private function applyHandlerOptions(EasyHandle $easy, array &$conf): void + { + $options = $easy->options; + if (isset($options['verify'])) { + if ($options['verify'] === false) { + unset($conf[\CURLOPT_CAINFO]); + $conf[\CURLOPT_SSL_VERIFYHOST] = 0; + $conf[\CURLOPT_SSL_VERIFYPEER] = false; + } else { + $conf[\CURLOPT_SSL_VERIFYHOST] = 2; + $conf[\CURLOPT_SSL_VERIFYPEER] = true; + if (\is_string($options['verify'])) { + // Throw an error if the file/folder/link path is not valid or doesn't exist. + if (!\file_exists($options['verify'])) { + throw new \InvalidArgumentException("SSL CA bundle not found: {$options['verify']}"); + } + // If it's a directory or a link to a directory use CURLOPT_CAPATH. + // If not, it's probably a file, or a link to a file, so use CURLOPT_CAINFO. + if ( + \is_dir($options['verify']) + || ( + \is_link($options['verify']) === true + && ($verifyLink = \readlink($options['verify'])) !== false + && \is_dir($verifyLink) + ) + ) { + $conf[\CURLOPT_CAPATH] = $options['verify']; + } else { + $conf[\CURLOPT_CAINFO] = $options['verify']; + } + } + } + } + + if (!isset($options['curl'][\CURLOPT_ENCODING]) && !empty($options['decode_content'])) { + $accept = $easy->request->getHeaderLine('Accept-Encoding'); + if ($accept) { + $conf[\CURLOPT_ENCODING] = $accept; + } else { + // The empty string enables all available decoders and implicitly + // sets a matching 'Accept-Encoding' header. + $conf[\CURLOPT_ENCODING] = ''; + // But as the user did not specify any encoding preference, + // let's leave it up to server by preventing curl from sending + // the header, which will be interpreted as 'Accept-Encoding: *'. + // https://www.rfc-editor.org/rfc/rfc9110#field.accept-encoding + $conf[\CURLOPT_HTTPHEADER][] = 'Accept-Encoding:'; + } + } + + if (!isset($options['sink'])) { + // Use a default temp stream if no sink was set. + $options['sink'] = \GuzzleHttp\Psr7\Utils::tryFopen('php://temp', 'w+'); + } + $sink = $options['sink']; + if (!\is_string($sink)) { + $sink = \GuzzleHttp\Psr7\Utils::streamFor($sink); + } elseif (!\is_dir(\dirname($sink))) { + // Ensure that the directory exists before failing in curl. + throw new \RuntimeException(\sprintf('Directory %s does not exist for sink value of %s', \dirname($sink), $sink)); + } else { + $sink = new LazyOpenStream($sink, 'w+'); + } + $easy->sink = $sink; + $conf[\CURLOPT_WRITEFUNCTION] = static function ($ch, $write) use ($sink): int { + return $sink->write($write); + }; + + $timeoutRequiresNoSignal = false; + if (isset($options['timeout'])) { + $timeoutRequiresNoSignal |= $options['timeout'] < 1; + $conf[\CURLOPT_TIMEOUT_MS] = $options['timeout'] * 1000; + } + + // CURL default value is CURL_IPRESOLVE_WHATEVER + if (isset($options['force_ip_resolve'])) { + if ('v4' === $options['force_ip_resolve']) { + $conf[\CURLOPT_IPRESOLVE] = \CURL_IPRESOLVE_V4; + } elseif ('v6' === $options['force_ip_resolve']) { + $conf[\CURLOPT_IPRESOLVE] = \CURL_IPRESOLVE_V6; + } + } + + if (isset($options['connect_timeout'])) { + $timeoutRequiresNoSignal |= $options['connect_timeout'] < 1; + $conf[\CURLOPT_CONNECTTIMEOUT_MS] = $options['connect_timeout'] * 1000; + } + + if ($timeoutRequiresNoSignal && \strtoupper(\substr(\PHP_OS, 0, 3)) !== 'WIN') { + $conf[\CURLOPT_NOSIGNAL] = true; + } + + if (isset($options['proxy'])) { + if (!\is_array($options['proxy'])) { + $conf[\CURLOPT_PROXY] = $options['proxy']; + } else { + $scheme = $easy->request->getUri()->getScheme(); + if (isset($options['proxy'][$scheme])) { + $host = $easy->request->getUri()->getHost(); + if (isset($options['proxy']['no']) && Utils::isHostInNoProxy($host, $options['proxy']['no'])) { + unset($conf[\CURLOPT_PROXY]); + } else { + $conf[\CURLOPT_PROXY] = $options['proxy'][$scheme]; + } + } + } + } + + if (isset($options['crypto_method'])) { + $protocolVersion = $easy->request->getProtocolVersion(); + + // If HTTP/2, upgrade TLS 1.0 and 1.1 to 1.2 + if ('2' === $protocolVersion || '2.0' === $protocolVersion) { + if ( + \STREAM_CRYPTO_METHOD_TLSv1_0_CLIENT === $options['crypto_method'] + || \STREAM_CRYPTO_METHOD_TLSv1_1_CLIENT === $options['crypto_method'] + || \STREAM_CRYPTO_METHOD_TLSv1_2_CLIENT === $options['crypto_method'] + ) { + $conf[\CURLOPT_SSLVERSION] = \CURL_SSLVERSION_TLSv1_2; + } elseif (defined('STREAM_CRYPTO_METHOD_TLSv1_3_CLIENT') && \STREAM_CRYPTO_METHOD_TLSv1_3_CLIENT === $options['crypto_method']) { + if (!self::supportsTls13()) { + throw new \InvalidArgumentException('Invalid crypto_method request option: TLS 1.3 not supported by your version of cURL'); + } + $conf[\CURLOPT_SSLVERSION] = \CURL_SSLVERSION_TLSv1_3; + } else { + throw new \InvalidArgumentException('Invalid crypto_method request option: unknown version provided'); + } + } elseif (\STREAM_CRYPTO_METHOD_TLSv1_0_CLIENT === $options['crypto_method']) { + $conf[\CURLOPT_SSLVERSION] = \CURL_SSLVERSION_TLSv1_0; + } elseif (\STREAM_CRYPTO_METHOD_TLSv1_1_CLIENT === $options['crypto_method']) { + $conf[\CURLOPT_SSLVERSION] = \CURL_SSLVERSION_TLSv1_1; + } elseif (\STREAM_CRYPTO_METHOD_TLSv1_2_CLIENT === $options['crypto_method']) { + if (!self::supportsTls12()) { + throw new \InvalidArgumentException('Invalid crypto_method request option: TLS 1.2 not supported by your version of cURL'); + } + $conf[\CURLOPT_SSLVERSION] = \CURL_SSLVERSION_TLSv1_2; + } elseif (defined('STREAM_CRYPTO_METHOD_TLSv1_3_CLIENT') && \STREAM_CRYPTO_METHOD_TLSv1_3_CLIENT === $options['crypto_method']) { + if (!self::supportsTls13()) { + throw new \InvalidArgumentException('Invalid crypto_method request option: TLS 1.3 not supported by your version of cURL'); + } + $conf[\CURLOPT_SSLVERSION] = \CURL_SSLVERSION_TLSv1_3; + } else { + throw new \InvalidArgumentException('Invalid crypto_method request option: unknown version provided'); + } + } + + if (isset($options['cert'])) { + $cert = $options['cert']; + if (\is_array($cert)) { + $conf[\CURLOPT_SSLCERTPASSWD] = $cert[1]; + $cert = $cert[0]; + } + if (!\file_exists($cert)) { + throw new \InvalidArgumentException("SSL certificate not found: {$cert}"); + } + // OpenSSL (versions 0.9.3 and later) also support "P12" for PKCS#12-encoded files. + // see https://curl.se/libcurl/c/CURLOPT_SSLCERTTYPE.html + $ext = pathinfo($cert, \PATHINFO_EXTENSION); + if (preg_match('#^(der|p12)$#i', $ext)) { + $conf[\CURLOPT_SSLCERTTYPE] = strtoupper($ext); + } + $conf[\CURLOPT_SSLCERT] = $cert; + } + + if (isset($options['ssl_key'])) { + if (\is_array($options['ssl_key'])) { + if (\count($options['ssl_key']) === 2) { + [$sslKey, $conf[\CURLOPT_SSLKEYPASSWD]] = $options['ssl_key']; + } else { + [$sslKey] = $options['ssl_key']; + } + } + + $sslKey = $sslKey ?? $options['ssl_key']; + + if (!\file_exists($sslKey)) { + throw new \InvalidArgumentException("SSL private key not found: {$sslKey}"); + } + $conf[\CURLOPT_SSLKEY] = $sslKey; + } + + if (isset($options['progress'])) { + $progress = $options['progress']; + if (!\is_callable($progress)) { + throw new \InvalidArgumentException('progress client option must be callable'); + } + $conf[\CURLOPT_NOPROGRESS] = false; + $conf[\CURLOPT_PROGRESSFUNCTION] = static function ($resource, int $downloadSize, int $downloaded, int $uploadSize, int $uploaded) use ($progress) { + $progress($downloadSize, $downloaded, $uploadSize, $uploaded); + }; + } + + if (!empty($options['debug'])) { + $conf[\CURLOPT_STDERR] = Utils::debugResource($options['debug']); + $conf[\CURLOPT_VERBOSE] = true; + } + } + + /** + * This function ensures that a response was set on a transaction. If one + * was not set, then the request is retried if possible. This error + * typically means you are sending a payload, curl encountered a + * "Connection died, retrying a fresh connect" error, tried to rewind the + * stream, and then encountered a "necessary data rewind wasn't possible" + * error, causing the request to be sent through curl_multi_info_read() + * without an error status. + * + * @param callable(RequestInterface, array): PromiseInterface $handler + */ + private static function retryFailedRewind(callable $handler, EasyHandle $easy, array $ctx): PromiseInterface + { + try { + // Only rewind if the body has been read from. + $body = $easy->request->getBody(); + if ($body->tell() > 0) { + $body->rewind(); + } + } catch (\RuntimeException $e) { + $ctx['error'] = 'The connection unexpectedly failed without ' + .'providing an error. The request would have been retried, ' + .'but attempting to rewind the request body failed. ' + .'Exception: '.$e; + + return self::createRejection($easy, $ctx); + } + + // Retry no more than 3 times before giving up. + if (!isset($easy->options['_curl_retries'])) { + $easy->options['_curl_retries'] = 1; + } elseif ($easy->options['_curl_retries'] == 2) { + $ctx['error'] = 'The cURL request was retried 3 times ' + .'and did not succeed. The most likely reason for the failure ' + .'is that cURL was unable to rewind the body of the request ' + .'and subsequent retries resulted in the same error. Turn on ' + .'the debug option to see what went wrong. See ' + .'https://bugs.php.net/bug.php?id=47204 for more information.'; + + return self::createRejection($easy, $ctx); + } else { + ++$easy->options['_curl_retries']; + } + + return $handler($easy->request, $easy->options); + } + + private function createHeaderFn(EasyHandle $easy): callable + { + if (isset($easy->options['on_headers'])) { + $onHeaders = $easy->options['on_headers']; + + if (!\is_callable($onHeaders)) { + throw new \InvalidArgumentException('on_headers must be callable'); + } + } else { + $onHeaders = null; + } + + return static function ($ch, $h) use ( + $onHeaders, + $easy, + &$startingResponse + ) { + $value = \trim($h); + if ($value === '') { + $startingResponse = true; + try { + $easy->createResponse(); + } catch (\Exception $e) { + $easy->createResponseException = $e; + + return -1; + } + if ($onHeaders !== null) { + try { + $onHeaders($easy->response); + } catch (\Exception $e) { + // Associate the exception with the handle and trigger + // a curl header write error by returning 0. + $easy->onHeadersException = $e; + + return -1; + } + } + } elseif ($startingResponse) { + $startingResponse = false; + $easy->headers = [$value]; + } else { + $easy->headers[] = $value; + } + + return \strlen($h); + }; + } + + public function __destruct() + { + foreach ($this->handles as $id => $handle) { + \curl_close($handle); + unset($this->handles[$id]); + } + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/Handler/CurlMultiHandler.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/Handler/CurlMultiHandler.php new file mode 100644 index 0000000000..73a6abe333 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/Handler/CurlMultiHandler.php @@ -0,0 +1,284 @@ +<?php + +namespace GuzzleHttp\Handler; + +use Closure; +use GuzzleHttp\Promise as P; +use GuzzleHttp\Promise\Promise; +use GuzzleHttp\Promise\PromiseInterface; +use GuzzleHttp\Utils; +use Psr\Http\Message\RequestInterface; + +/** + * Returns an asynchronous response using curl_multi_* functions. + * + * When using the CurlMultiHandler, custom curl options can be specified as an + * associative array of curl option constants mapping to values in the + * **curl** key of the provided request options. + * + * @final + */ +class CurlMultiHandler +{ + /** + * @var CurlFactoryInterface + */ + private $factory; + + /** + * @var int + */ + private $selectTimeout; + + /** + * @var int Will be higher than 0 when `curl_multi_exec` is still running. + */ + private $active = 0; + + /** + * @var array Request entry handles, indexed by handle id in `addRequest`. + * + * @see CurlMultiHandler::addRequest + */ + private $handles = []; + + /** + * @var array<int, float> An array of delay times, indexed by handle id in `addRequest`. + * + * @see CurlMultiHandler::addRequest + */ + private $delays = []; + + /** + * @var array<mixed> An associative array of CURLMOPT_* options and corresponding values for curl_multi_setopt() + */ + private $options = []; + + /** @var resource|\CurlMultiHandle */ + private $_mh; + + /** + * This handler accepts the following options: + * + * - handle_factory: An optional factory used to create curl handles + * - select_timeout: Optional timeout (in seconds) to block before timing + * out while selecting curl handles. Defaults to 1 second. + * - options: An associative array of CURLMOPT_* options and + * corresponding values for curl_multi_setopt() + */ + public function __construct(array $options = []) + { + $this->factory = $options['handle_factory'] ?? new CurlFactory(50); + + if (isset($options['select_timeout'])) { + $this->selectTimeout = $options['select_timeout']; + } elseif ($selectTimeout = Utils::getenv('GUZZLE_CURL_SELECT_TIMEOUT')) { + @trigger_error('Since guzzlehttp/guzzle 7.2.0: Using environment variable GUZZLE_CURL_SELECT_TIMEOUT is deprecated. Use option "select_timeout" instead.', \E_USER_DEPRECATED); + $this->selectTimeout = (int) $selectTimeout; + } else { + $this->selectTimeout = 1; + } + + $this->options = $options['options'] ?? []; + + // unsetting the property forces the first access to go through + // __get(). + unset($this->_mh); + } + + /** + * @param string $name + * + * @return resource|\CurlMultiHandle + * + * @throws \BadMethodCallException when another field as `_mh` will be gotten + * @throws \RuntimeException when curl can not initialize a multi handle + */ + public function __get($name) + { + if ($name !== '_mh') { + throw new \BadMethodCallException("Can not get other property as '_mh'."); + } + + $multiHandle = \curl_multi_init(); + + if (false === $multiHandle) { + throw new \RuntimeException('Can not initialize curl multi handle.'); + } + + $this->_mh = $multiHandle; + + foreach ($this->options as $option => $value) { + // A warning is raised in case of a wrong option. + curl_multi_setopt($this->_mh, $option, $value); + } + + return $this->_mh; + } + + public function __destruct() + { + if (isset($this->_mh)) { + \curl_multi_close($this->_mh); + unset($this->_mh); + } + } + + public function __invoke(RequestInterface $request, array $options): PromiseInterface + { + $easy = $this->factory->create($request, $options); + $id = (int) $easy->handle; + + $promise = new Promise( + [$this, 'execute'], + function () use ($id) { + return $this->cancel($id); + } + ); + + $this->addRequest(['easy' => $easy, 'deferred' => $promise]); + + return $promise; + } + + /** + * Ticks the curl event loop. + */ + public function tick(): void + { + // Add any delayed handles if needed. + if ($this->delays) { + $currentTime = Utils::currentTime(); + foreach ($this->delays as $id => $delay) { + if ($currentTime >= $delay) { + unset($this->delays[$id]); + \curl_multi_add_handle( + $this->_mh, + $this->handles[$id]['easy']->handle + ); + } + } + } + + // Run curl_multi_exec in the queue to enable other async tasks to run + P\Utils::queue()->add(Closure::fromCallable([$this, 'tickInQueue'])); + + // Step through the task queue which may add additional requests. + P\Utils::queue()->run(); + + if ($this->active && \curl_multi_select($this->_mh, $this->selectTimeout) === -1) { + // Perform a usleep if a select returns -1. + // See: https://bugs.php.net/bug.php?id=61141 + \usleep(250); + } + + while (\curl_multi_exec($this->_mh, $this->active) === \CURLM_CALL_MULTI_PERFORM) { + // Prevent busy looping for slow HTTP requests. + \curl_multi_select($this->_mh, $this->selectTimeout); + } + + $this->processMessages(); + } + + /** + * Runs \curl_multi_exec() inside the event loop, to prevent busy looping + */ + private function tickInQueue(): void + { + if (\curl_multi_exec($this->_mh, $this->active) === \CURLM_CALL_MULTI_PERFORM) { + \curl_multi_select($this->_mh, 0); + P\Utils::queue()->add(Closure::fromCallable([$this, 'tickInQueue'])); + } + } + + /** + * Runs until all outstanding connections have completed. + */ + public function execute(): void + { + $queue = P\Utils::queue(); + + while ($this->handles || !$queue->isEmpty()) { + // If there are no transfers, then sleep for the next delay + if (!$this->active && $this->delays) { + \usleep($this->timeToNext()); + } + $this->tick(); + } + } + + private function addRequest(array $entry): void + { + $easy = $entry['easy']; + $id = (int) $easy->handle; + $this->handles[$id] = $entry; + if (empty($easy->options['delay'])) { + \curl_multi_add_handle($this->_mh, $easy->handle); + } else { + $this->delays[$id] = Utils::currentTime() + ($easy->options['delay'] / 1000); + } + } + + /** + * Cancels a handle from sending and removes references to it. + * + * @param int $id Handle ID to cancel and remove. + * + * @return bool True on success, false on failure. + */ + private function cancel($id): bool + { + if (!is_int($id)) { + trigger_deprecation('guzzlehttp/guzzle', '7.4', 'Not passing an integer to %s::%s() is deprecated and will cause an error in 8.0.', __CLASS__, __FUNCTION__); + } + + // Cannot cancel if it has been processed. + if (!isset($this->handles[$id])) { + return false; + } + + $handle = $this->handles[$id]['easy']->handle; + unset($this->delays[$id], $this->handles[$id]); + \curl_multi_remove_handle($this->_mh, $handle); + \curl_close($handle); + + return true; + } + + private function processMessages(): void + { + while ($done = \curl_multi_info_read($this->_mh)) { + if ($done['msg'] !== \CURLMSG_DONE) { + // if it's not done, then it would be premature to remove the handle. ref https://github.com/guzzle/guzzle/pull/2892#issuecomment-945150216 + continue; + } + $id = (int) $done['handle']; + \curl_multi_remove_handle($this->_mh, $done['handle']); + + if (!isset($this->handles[$id])) { + // Probably was cancelled. + continue; + } + + $entry = $this->handles[$id]; + unset($this->handles[$id], $this->delays[$id]); + $entry['easy']->errno = $done['result']; + $entry['deferred']->resolve( + CurlFactory::finish($this, $entry['easy'], $this->factory) + ); + } + } + + private function timeToNext(): int + { + $currentTime = Utils::currentTime(); + $nextTime = \PHP_INT_MAX; + foreach ($this->delays as $time) { + if ($time < $nextTime) { + $nextTime = $time; + } + } + + return ((int) \max(0, $nextTime - $currentTime)) * 1000000; + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/Handler/MockHandler.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/Handler/MockHandler.php new file mode 100644 index 0000000000..3ecd5964de --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/Handler/MockHandler.php @@ -0,0 +1,212 @@ +<?php + +namespace GuzzleHttp\Handler; + +use GuzzleHttp\Exception\RequestException; +use GuzzleHttp\HandlerStack; +use GuzzleHttp\Promise as P; +use GuzzleHttp\Promise\PromiseInterface; +use GuzzleHttp\TransferStats; +use GuzzleHttp\Utils; +use Psr\Http\Message\RequestInterface; +use Psr\Http\Message\ResponseInterface; +use Psr\Http\Message\StreamInterface; + +/** + * Handler that returns responses or throw exceptions from a queue. + * + * @final + */ +class MockHandler implements \Countable +{ + /** + * @var array + */ + private $queue = []; + + /** + * @var RequestInterface|null + */ + private $lastRequest; + + /** + * @var array + */ + private $lastOptions = []; + + /** + * @var callable|null + */ + private $onFulfilled; + + /** + * @var callable|null + */ + private $onRejected; + + /** + * Creates a new MockHandler that uses the default handler stack list of + * middlewares. + * + * @param array|null $queue Array of responses, callables, or exceptions. + * @param callable|null $onFulfilled Callback to invoke when the return value is fulfilled. + * @param callable|null $onRejected Callback to invoke when the return value is rejected. + */ + public static function createWithMiddleware(?array $queue = null, ?callable $onFulfilled = null, ?callable $onRejected = null): HandlerStack + { + return HandlerStack::create(new self($queue, $onFulfilled, $onRejected)); + } + + /** + * The passed in value must be an array of + * {@see ResponseInterface} objects, Exceptions, + * callables, or Promises. + * + * @param array<int, mixed>|null $queue The parameters to be passed to the append function, as an indexed array. + * @param callable|null $onFulfilled Callback to invoke when the return value is fulfilled. + * @param callable|null $onRejected Callback to invoke when the return value is rejected. + */ + public function __construct(?array $queue = null, ?callable $onFulfilled = null, ?callable $onRejected = null) + { + $this->onFulfilled = $onFulfilled; + $this->onRejected = $onRejected; + + if ($queue) { + // array_values included for BC + $this->append(...array_values($queue)); + } + } + + public function __invoke(RequestInterface $request, array $options): PromiseInterface + { + if (!$this->queue) { + throw new \OutOfBoundsException('Mock queue is empty'); + } + + if (isset($options['delay']) && \is_numeric($options['delay'])) { + \usleep((int) $options['delay'] * 1000); + } + + $this->lastRequest = $request; + $this->lastOptions = $options; + $response = \array_shift($this->queue); + + if (isset($options['on_headers'])) { + if (!\is_callable($options['on_headers'])) { + throw new \InvalidArgumentException('on_headers must be callable'); + } + try { + $options['on_headers']($response); + } catch (\Exception $e) { + $msg = 'An error was encountered during the on_headers event'; + $response = new RequestException($msg, $request, $response, $e); + } + } + + if (\is_callable($response)) { + $response = $response($request, $options); + } + + $response = $response instanceof \Throwable + ? P\Create::rejectionFor($response) + : P\Create::promiseFor($response); + + return $response->then( + function (?ResponseInterface $value) use ($request, $options) { + $this->invokeStats($request, $options, $value); + if ($this->onFulfilled) { + ($this->onFulfilled)($value); + } + + if ($value !== null && isset($options['sink'])) { + $contents = (string) $value->getBody(); + $sink = $options['sink']; + + if (\is_resource($sink)) { + \fwrite($sink, $contents); + } elseif (\is_string($sink)) { + \file_put_contents($sink, $contents); + } elseif ($sink instanceof StreamInterface) { + $sink->write($contents); + } + } + + return $value; + }, + function ($reason) use ($request, $options) { + $this->invokeStats($request, $options, null, $reason); + if ($this->onRejected) { + ($this->onRejected)($reason); + } + + return P\Create::rejectionFor($reason); + } + ); + } + + /** + * Adds one or more variadic requests, exceptions, callables, or promises + * to the queue. + * + * @param mixed ...$values + */ + public function append(...$values): void + { + foreach ($values as $value) { + if ($value instanceof ResponseInterface + || $value instanceof \Throwable + || $value instanceof PromiseInterface + || \is_callable($value) + ) { + $this->queue[] = $value; + } else { + throw new \TypeError('Expected a Response, Promise, Throwable or callable. Found '.Utils::describeType($value)); + } + } + } + + /** + * Get the last received request. + */ + public function getLastRequest(): ?RequestInterface + { + return $this->lastRequest; + } + + /** + * Get the last received request options. + */ + public function getLastOptions(): array + { + return $this->lastOptions; + } + + /** + * Returns the number of remaining items in the queue. + */ + public function count(): int + { + return \count($this->queue); + } + + public function reset(): void + { + $this->queue = []; + } + + /** + * @param mixed $reason Promise or reason. + */ + private function invokeStats( + RequestInterface $request, + array $options, + ?ResponseInterface $response = null, + $reason = null + ): void { + if (isset($options['on_stats'])) { + $transferTime = $options['transfer_time'] ?? 0; + $stats = new TransferStats($request, $response, $transferTime, $reason); + ($options['on_stats'])($stats); + } + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/Handler/StreamHandler.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/Handler/StreamHandler.php new file mode 100644 index 0000000000..1d89a8fbc8 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/Handler/StreamHandler.php @@ -0,0 +1,621 @@ +<?php + +namespace GuzzleHttp\Handler; + +use GuzzleHttp\Exception\ConnectException; +use GuzzleHttp\Exception\RequestException; +use GuzzleHttp\Promise as P; +use GuzzleHttp\Promise\FulfilledPromise; +use GuzzleHttp\Promise\PromiseInterface; +use GuzzleHttp\Psr7; +use GuzzleHttp\TransferStats; +use GuzzleHttp\Utils; +use Psr\Http\Message\RequestInterface; +use Psr\Http\Message\ResponseInterface; +use Psr\Http\Message\StreamInterface; +use Psr\Http\Message\UriInterface; + +/** + * HTTP handler that uses PHP's HTTP stream wrapper. + * + * @final + */ +class StreamHandler +{ + /** + * @var array + */ + private $lastHeaders = []; + + /** + * Sends an HTTP request. + * + * @param RequestInterface $request Request to send. + * @param array $options Request transfer options. + */ + public function __invoke(RequestInterface $request, array $options): PromiseInterface + { + // Sleep if there is a delay specified. + if (isset($options['delay'])) { + \usleep($options['delay'] * 1000); + } + + $protocolVersion = $request->getProtocolVersion(); + + if ('1.0' !== $protocolVersion && '1.1' !== $protocolVersion) { + throw new ConnectException(sprintf('HTTP/%s is not supported by the stream handler.', $protocolVersion), $request); + } + + $startTime = isset($options['on_stats']) ? Utils::currentTime() : null; + + try { + // Does not support the expect header. + $request = $request->withoutHeader('Expect'); + + // Append a content-length header if body size is zero to match + // cURL's behavior. + if (0 === $request->getBody()->getSize()) { + $request = $request->withHeader('Content-Length', '0'); + } + + return $this->createResponse( + $request, + $options, + $this->createStream($request, $options), + $startTime + ); + } catch (\InvalidArgumentException $e) { + throw $e; + } catch (\Exception $e) { + // Determine if the error was a networking error. + $message = $e->getMessage(); + // This list can probably get more comprehensive. + if (false !== \strpos($message, 'getaddrinfo') // DNS lookup failed + || false !== \strpos($message, 'Connection refused') + || false !== \strpos($message, "couldn't connect to host") // error on HHVM + || false !== \strpos($message, 'connection attempt failed') + ) { + $e = new ConnectException($e->getMessage(), $request, $e); + } else { + $e = RequestException::wrapException($request, $e); + } + $this->invokeStats($options, $request, $startTime, null, $e); + + return P\Create::rejectionFor($e); + } + } + + private function invokeStats( + array $options, + RequestInterface $request, + ?float $startTime, + ?ResponseInterface $response = null, + ?\Throwable $error = null + ): void { + if (isset($options['on_stats'])) { + $stats = new TransferStats($request, $response, Utils::currentTime() - $startTime, $error, []); + ($options['on_stats'])($stats); + } + } + + /** + * @param resource $stream + */ + private function createResponse(RequestInterface $request, array $options, $stream, ?float $startTime): PromiseInterface + { + $hdrs = $this->lastHeaders; + $this->lastHeaders = []; + + try { + [$ver, $status, $reason, $headers] = HeaderProcessor::parseHeaders($hdrs); + } catch (\Exception $e) { + return P\Create::rejectionFor( + new RequestException('An error was encountered while creating the response', $request, null, $e) + ); + } + + [$stream, $headers] = $this->checkDecode($options, $headers, $stream); + $stream = Psr7\Utils::streamFor($stream); + $sink = $stream; + + if (\strcasecmp('HEAD', $request->getMethod())) { + $sink = $this->createSink($stream, $options); + } + + try { + $response = new Psr7\Response($status, $headers, $sink, $ver, $reason); + } catch (\Exception $e) { + return P\Create::rejectionFor( + new RequestException('An error was encountered while creating the response', $request, null, $e) + ); + } + + if (isset($options['on_headers'])) { + try { + $options['on_headers']($response); + } catch (\Exception $e) { + return P\Create::rejectionFor( + new RequestException('An error was encountered during the on_headers event', $request, $response, $e) + ); + } + } + + // Do not drain when the request is a HEAD request because they have + // no body. + if ($sink !== $stream) { + $this->drain($stream, $sink, $response->getHeaderLine('Content-Length')); + } + + $this->invokeStats($options, $request, $startTime, $response, null); + + return new FulfilledPromise($response); + } + + private function createSink(StreamInterface $stream, array $options): StreamInterface + { + if (!empty($options['stream'])) { + return $stream; + } + + $sink = $options['sink'] ?? Psr7\Utils::tryFopen('php://temp', 'r+'); + + return \is_string($sink) ? new Psr7\LazyOpenStream($sink, 'w+') : Psr7\Utils::streamFor($sink); + } + + /** + * @param resource $stream + */ + private function checkDecode(array $options, array $headers, $stream): array + { + // Automatically decode responses when instructed. + if (!empty($options['decode_content'])) { + $normalizedKeys = Utils::normalizeHeaderKeys($headers); + if (isset($normalizedKeys['content-encoding'])) { + $encoding = $headers[$normalizedKeys['content-encoding']]; + if ($encoding[0] === 'gzip' || $encoding[0] === 'deflate') { + $stream = new Psr7\InflateStream(Psr7\Utils::streamFor($stream)); + $headers['x-encoded-content-encoding'] = $headers[$normalizedKeys['content-encoding']]; + + // Remove content-encoding header + unset($headers[$normalizedKeys['content-encoding']]); + + // Fix content-length header + if (isset($normalizedKeys['content-length'])) { + $headers['x-encoded-content-length'] = $headers[$normalizedKeys['content-length']]; + $length = (int) $stream->getSize(); + if ($length === 0) { + unset($headers[$normalizedKeys['content-length']]); + } else { + $headers[$normalizedKeys['content-length']] = [$length]; + } + } + } + } + } + + return [$stream, $headers]; + } + + /** + * Drains the source stream into the "sink" client option. + * + * @param string $contentLength Header specifying the amount of + * data to read. + * + * @throws \RuntimeException when the sink option is invalid. + */ + private function drain(StreamInterface $source, StreamInterface $sink, string $contentLength): StreamInterface + { + // If a content-length header is provided, then stop reading once + // that number of bytes has been read. This can prevent infinitely + // reading from a stream when dealing with servers that do not honor + // Connection: Close headers. + Psr7\Utils::copyToStream( + $source, + $sink, + (\strlen($contentLength) > 0 && (int) $contentLength > 0) ? (int) $contentLength : -1 + ); + + $sink->seek(0); + $source->close(); + + return $sink; + } + + /** + * Create a resource and check to ensure it was created successfully + * + * @param callable $callback Callable that returns stream resource + * + * @return resource + * + * @throws \RuntimeException on error + */ + private function createResource(callable $callback) + { + $errors = []; + \set_error_handler(static function ($_, $msg, $file, $line) use (&$errors): bool { + $errors[] = [ + 'message' => $msg, + 'file' => $file, + 'line' => $line, + ]; + + return true; + }); + + try { + $resource = $callback(); + } finally { + \restore_error_handler(); + } + + if (!$resource) { + $message = 'Error creating resource: '; + foreach ($errors as $err) { + foreach ($err as $key => $value) { + $message .= "[$key] $value".\PHP_EOL; + } + } + throw new \RuntimeException(\trim($message)); + } + + return $resource; + } + + /** + * @return resource + */ + private function createStream(RequestInterface $request, array $options) + { + static $methods; + if (!$methods) { + $methods = \array_flip(\get_class_methods(__CLASS__)); + } + + if (!\in_array($request->getUri()->getScheme(), ['http', 'https'])) { + throw new RequestException(\sprintf("The scheme '%s' is not supported.", $request->getUri()->getScheme()), $request); + } + + // HTTP/1.1 streams using the PHP stream wrapper require a + // Connection: close header + if ($request->getProtocolVersion() === '1.1' + && !$request->hasHeader('Connection') + ) { + $request = $request->withHeader('Connection', 'close'); + } + + // Ensure SSL is verified by default + if (!isset($options['verify'])) { + $options['verify'] = true; + } + + $params = []; + $context = $this->getDefaultContext($request); + + if (isset($options['on_headers']) && !\is_callable($options['on_headers'])) { + throw new \InvalidArgumentException('on_headers must be callable'); + } + + if (!empty($options)) { + foreach ($options as $key => $value) { + $method = "add_{$key}"; + if (isset($methods[$method])) { + $this->{$method}($request, $context, $value, $params); + } + } + } + + if (isset($options['stream_context'])) { + if (!\is_array($options['stream_context'])) { + throw new \InvalidArgumentException('stream_context must be an array'); + } + $context = \array_replace_recursive($context, $options['stream_context']); + } + + // Microsoft NTLM authentication only supported with curl handler + if (isset($options['auth'][2]) && 'ntlm' === $options['auth'][2]) { + throw new \InvalidArgumentException('Microsoft NTLM authentication only supported with curl handler'); + } + + $uri = $this->resolveHost($request, $options); + + $contextResource = $this->createResource( + static function () use ($context, $params) { + return \stream_context_create($context, $params); + } + ); + + return $this->createResource( + function () use ($uri, &$http_response_header, $contextResource, $context, $options, $request) { + $resource = @\fopen((string) $uri, 'r', false, $contextResource); + $this->lastHeaders = $http_response_header ?? []; + + if (false === $resource) { + throw new ConnectException(sprintf('Connection refused for URI %s', $uri), $request, null, $context); + } + + if (isset($options['read_timeout'])) { + $readTimeout = $options['read_timeout']; + $sec = (int) $readTimeout; + $usec = ($readTimeout - $sec) * 100000; + \stream_set_timeout($resource, $sec, $usec); + } + + return $resource; + } + ); + } + + private function resolveHost(RequestInterface $request, array $options): UriInterface + { + $uri = $request->getUri(); + + if (isset($options['force_ip_resolve']) && !\filter_var($uri->getHost(), \FILTER_VALIDATE_IP)) { + if ('v4' === $options['force_ip_resolve']) { + $records = \dns_get_record($uri->getHost(), \DNS_A); + if (false === $records || !isset($records[0]['ip'])) { + throw new ConnectException(\sprintf("Could not resolve IPv4 address for host '%s'", $uri->getHost()), $request); + } + + return $uri->withHost($records[0]['ip']); + } + if ('v6' === $options['force_ip_resolve']) { + $records = \dns_get_record($uri->getHost(), \DNS_AAAA); + if (false === $records || !isset($records[0]['ipv6'])) { + throw new ConnectException(\sprintf("Could not resolve IPv6 address for host '%s'", $uri->getHost()), $request); + } + + return $uri->withHost('['.$records[0]['ipv6'].']'); + } + } + + return $uri; + } + + private function getDefaultContext(RequestInterface $request): array + { + $headers = ''; + foreach ($request->getHeaders() as $name => $value) { + foreach ($value as $val) { + $headers .= "$name: $val\r\n"; + } + } + + $context = [ + 'http' => [ + 'method' => $request->getMethod(), + 'header' => $headers, + 'protocol_version' => $request->getProtocolVersion(), + 'ignore_errors' => true, + 'follow_location' => 0, + ], + 'ssl' => [ + 'peer_name' => $request->getUri()->getHost(), + ], + ]; + + $body = (string) $request->getBody(); + + if ('' !== $body) { + $context['http']['content'] = $body; + // Prevent the HTTP handler from adding a Content-Type header. + if (!$request->hasHeader('Content-Type')) { + $context['http']['header'] .= "Content-Type:\r\n"; + } + } + + $context['http']['header'] = \rtrim($context['http']['header']); + + return $context; + } + + /** + * @param mixed $value as passed via Request transfer options. + */ + private function add_proxy(RequestInterface $request, array &$options, $value, array &$params): void + { + $uri = null; + + if (!\is_array($value)) { + $uri = $value; + } else { + $scheme = $request->getUri()->getScheme(); + if (isset($value[$scheme])) { + if (!isset($value['no']) || !Utils::isHostInNoProxy($request->getUri()->getHost(), $value['no'])) { + $uri = $value[$scheme]; + } + } + } + + if (!$uri) { + return; + } + + $parsed = $this->parse_proxy($uri); + $options['http']['proxy'] = $parsed['proxy']; + + if ($parsed['auth']) { + if (!isset($options['http']['header'])) { + $options['http']['header'] = []; + } + $options['http']['header'] .= "\r\nProxy-Authorization: {$parsed['auth']}"; + } + } + + /** + * Parses the given proxy URL to make it compatible with the format PHP's stream context expects. + */ + private function parse_proxy(string $url): array + { + $parsed = \parse_url($url); + + if ($parsed !== false && isset($parsed['scheme']) && $parsed['scheme'] === 'http') { + if (isset($parsed['host']) && isset($parsed['port'])) { + $auth = null; + if (isset($parsed['user']) && isset($parsed['pass'])) { + $auth = \base64_encode("{$parsed['user']}:{$parsed['pass']}"); + } + + return [ + 'proxy' => "tcp://{$parsed['host']}:{$parsed['port']}", + 'auth' => $auth ? "Basic {$auth}" : null, + ]; + } + } + + // Return proxy as-is. + return [ + 'proxy' => $url, + 'auth' => null, + ]; + } + + /** + * @param mixed $value as passed via Request transfer options. + */ + private function add_timeout(RequestInterface $request, array &$options, $value, array &$params): void + { + if ($value > 0) { + $options['http']['timeout'] = $value; + } + } + + /** + * @param mixed $value as passed via Request transfer options. + */ + private function add_crypto_method(RequestInterface $request, array &$options, $value, array &$params): void + { + if ( + $value === \STREAM_CRYPTO_METHOD_TLSv1_0_CLIENT + || $value === \STREAM_CRYPTO_METHOD_TLSv1_1_CLIENT + || $value === \STREAM_CRYPTO_METHOD_TLSv1_2_CLIENT + || (defined('STREAM_CRYPTO_METHOD_TLSv1_3_CLIENT') && $value === \STREAM_CRYPTO_METHOD_TLSv1_3_CLIENT) + ) { + $options['http']['crypto_method'] = $value; + + return; + } + + throw new \InvalidArgumentException('Invalid crypto_method request option: unknown version provided'); + } + + /** + * @param mixed $value as passed via Request transfer options. + */ + private function add_verify(RequestInterface $request, array &$options, $value, array &$params): void + { + if ($value === false) { + $options['ssl']['verify_peer'] = false; + $options['ssl']['verify_peer_name'] = false; + + return; + } + + if (\is_string($value)) { + $options['ssl']['cafile'] = $value; + if (!\file_exists($value)) { + throw new \RuntimeException("SSL CA bundle not found: $value"); + } + } elseif ($value !== true) { + throw new \InvalidArgumentException('Invalid verify request option'); + } + + $options['ssl']['verify_peer'] = true; + $options['ssl']['verify_peer_name'] = true; + $options['ssl']['allow_self_signed'] = false; + } + + /** + * @param mixed $value as passed via Request transfer options. + */ + private function add_cert(RequestInterface $request, array &$options, $value, array &$params): void + { + if (\is_array($value)) { + $options['ssl']['passphrase'] = $value[1]; + $value = $value[0]; + } + + if (!\file_exists($value)) { + throw new \RuntimeException("SSL certificate not found: {$value}"); + } + + $options['ssl']['local_cert'] = $value; + } + + /** + * @param mixed $value as passed via Request transfer options. + */ + private function add_progress(RequestInterface $request, array &$options, $value, array &$params): void + { + self::addNotification( + $params, + static function ($code, $a, $b, $c, $transferred, $total) use ($value) { + if ($code == \STREAM_NOTIFY_PROGRESS) { + // The upload progress cannot be determined. Use 0 for cURL compatibility: + // https://curl.se/libcurl/c/CURLOPT_PROGRESSFUNCTION.html + $value($total, $transferred, 0, 0); + } + } + ); + } + + /** + * @param mixed $value as passed via Request transfer options. + */ + private function add_debug(RequestInterface $request, array &$options, $value, array &$params): void + { + if ($value === false) { + return; + } + + static $map = [ + \STREAM_NOTIFY_CONNECT => 'CONNECT', + \STREAM_NOTIFY_AUTH_REQUIRED => 'AUTH_REQUIRED', + \STREAM_NOTIFY_AUTH_RESULT => 'AUTH_RESULT', + \STREAM_NOTIFY_MIME_TYPE_IS => 'MIME_TYPE_IS', + \STREAM_NOTIFY_FILE_SIZE_IS => 'FILE_SIZE_IS', + \STREAM_NOTIFY_REDIRECTED => 'REDIRECTED', + \STREAM_NOTIFY_PROGRESS => 'PROGRESS', + \STREAM_NOTIFY_FAILURE => 'FAILURE', + \STREAM_NOTIFY_COMPLETED => 'COMPLETED', + \STREAM_NOTIFY_RESOLVE => 'RESOLVE', + ]; + static $args = ['severity', 'message', 'message_code', 'bytes_transferred', 'bytes_max']; + + $value = Utils::debugResource($value); + $ident = $request->getMethod().' '.$request->getUri()->withFragment(''); + self::addNotification( + $params, + static function (int $code, ...$passed) use ($ident, $value, $map, $args): void { + \fprintf($value, '<%s> [%s] ', $ident, $map[$code]); + foreach (\array_filter($passed) as $i => $v) { + \fwrite($value, $args[$i].': "'.$v.'" '); + } + \fwrite($value, "\n"); + } + ); + } + + private static function addNotification(array &$params, callable $notify): void + { + // Wrap the existing function if needed. + if (!isset($params['notification'])) { + $params['notification'] = $notify; + } else { + $params['notification'] = self::callArray([ + $params['notification'], + $notify, + ]); + } + } + + private static function callArray(array $functions): callable + { + return static function (...$args) use ($functions) { + foreach ($functions as $fn) { + $fn(...$args); + } + }; + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/HandlerStack.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/HandlerStack.php new file mode 100644 index 0000000000..03f9a18ffd --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/HandlerStack.php @@ -0,0 +1,275 @@ +<?php + +namespace GuzzleHttp; + +use GuzzleHttp\Promise\PromiseInterface; +use Psr\Http\Message\RequestInterface; +use Psr\Http\Message\ResponseInterface; + +/** + * Creates a composed Guzzle handler function by stacking middlewares on top of + * an HTTP handler function. + * + * @final + */ +class HandlerStack +{ + /** + * @var (callable(RequestInterface, array): PromiseInterface)|null + */ + private $handler; + + /** + * @var array{(callable(callable(RequestInterface, array): PromiseInterface): callable), (string|null)}[] + */ + private $stack = []; + + /** + * @var (callable(RequestInterface, array): PromiseInterface)|null + */ + private $cached; + + /** + * Creates a default handler stack that can be used by clients. + * + * The returned handler will wrap the provided handler or use the most + * appropriate default handler for your system. The returned HandlerStack has + * support for cookies, redirects, HTTP error exceptions, and preparing a body + * before sending. + * + * The returned handler stack can be passed to a client in the "handler" + * option. + * + * @param (callable(RequestInterface, array): PromiseInterface)|null $handler HTTP handler function to use with the stack. If no + * handler is provided, the best handler for your + * system will be utilized. + */ + public static function create(?callable $handler = null): self + { + $stack = new self($handler ?: Utils::chooseHandler()); + $stack->push(Middleware::httpErrors(), 'http_errors'); + $stack->push(Middleware::redirect(), 'allow_redirects'); + $stack->push(Middleware::cookies(), 'cookies'); + $stack->push(Middleware::prepareBody(), 'prepare_body'); + + return $stack; + } + + /** + * @param (callable(RequestInterface, array): PromiseInterface)|null $handler Underlying HTTP handler. + */ + public function __construct(?callable $handler = null) + { + $this->handler = $handler; + } + + /** + * Invokes the handler stack as a composed handler + * + * @return ResponseInterface|PromiseInterface + */ + public function __invoke(RequestInterface $request, array $options) + { + $handler = $this->resolve(); + + return $handler($request, $options); + } + + /** + * Dumps a string representation of the stack. + * + * @return string + */ + public function __toString() + { + $depth = 0; + $stack = []; + + if ($this->handler !== null) { + $stack[] = '0) Handler: '.$this->debugCallable($this->handler); + } + + $result = ''; + foreach (\array_reverse($this->stack) as $tuple) { + ++$depth; + $str = "{$depth}) Name: '{$tuple[1]}', "; + $str .= 'Function: '.$this->debugCallable($tuple[0]); + $result = "> {$str}\n{$result}"; + $stack[] = $str; + } + + foreach (\array_keys($stack) as $k) { + $result .= "< {$stack[$k]}\n"; + } + + return $result; + } + + /** + * Set the HTTP handler that actually returns a promise. + * + * @param callable(RequestInterface, array): PromiseInterface $handler Accepts a request and array of options and + * returns a Promise. + */ + public function setHandler(callable $handler): void + { + $this->handler = $handler; + $this->cached = null; + } + + /** + * Returns true if the builder has a handler. + */ + public function hasHandler(): bool + { + return $this->handler !== null; + } + + /** + * Unshift a middleware to the bottom of the stack. + * + * @param callable(callable): callable $middleware Middleware function + * @param string $name Name to register for this middleware. + */ + public function unshift(callable $middleware, ?string $name = null): void + { + \array_unshift($this->stack, [$middleware, $name]); + $this->cached = null; + } + + /** + * Push a middleware to the top of the stack. + * + * @param callable(callable): callable $middleware Middleware function + * @param string $name Name to register for this middleware. + */ + public function push(callable $middleware, string $name = ''): void + { + $this->stack[] = [$middleware, $name]; + $this->cached = null; + } + + /** + * Add a middleware before another middleware by name. + * + * @param string $findName Middleware to find + * @param callable(callable): callable $middleware Middleware function + * @param string $withName Name to register for this middleware. + */ + public function before(string $findName, callable $middleware, string $withName = ''): void + { + $this->splice($findName, $withName, $middleware, true); + } + + /** + * Add a middleware after another middleware by name. + * + * @param string $findName Middleware to find + * @param callable(callable): callable $middleware Middleware function + * @param string $withName Name to register for this middleware. + */ + public function after(string $findName, callable $middleware, string $withName = ''): void + { + $this->splice($findName, $withName, $middleware, false); + } + + /** + * Remove a middleware by instance or name from the stack. + * + * @param callable|string $remove Middleware to remove by instance or name. + */ + public function remove($remove): void + { + if (!is_string($remove) && !is_callable($remove)) { + trigger_deprecation('guzzlehttp/guzzle', '7.4', 'Not passing a callable or string to %s::%s() is deprecated and will cause an error in 8.0.', __CLASS__, __FUNCTION__); + } + + $this->cached = null; + $idx = \is_callable($remove) ? 0 : 1; + $this->stack = \array_values(\array_filter( + $this->stack, + static function ($tuple) use ($idx, $remove) { + return $tuple[$idx] !== $remove; + } + )); + } + + /** + * Compose the middleware and handler into a single callable function. + * + * @return callable(RequestInterface, array): PromiseInterface + */ + public function resolve(): callable + { + if ($this->cached === null) { + if (($prev = $this->handler) === null) { + throw new \LogicException('No handler has been specified'); + } + + foreach (\array_reverse($this->stack) as $fn) { + /** @var callable(RequestInterface, array): PromiseInterface $prev */ + $prev = $fn[0]($prev); + } + + $this->cached = $prev; + } + + return $this->cached; + } + + private function findByName(string $name): int + { + foreach ($this->stack as $k => $v) { + if ($v[1] === $name) { + return $k; + } + } + + throw new \InvalidArgumentException("Middleware not found: $name"); + } + + /** + * Splices a function into the middleware list at a specific position. + */ + private function splice(string $findName, string $withName, callable $middleware, bool $before): void + { + $this->cached = null; + $idx = $this->findByName($findName); + $tuple = [$middleware, $withName]; + + if ($before) { + if ($idx === 0) { + \array_unshift($this->stack, $tuple); + } else { + $replacement = [$tuple, $this->stack[$idx]]; + \array_splice($this->stack, $idx, 1, $replacement); + } + } elseif ($idx === \count($this->stack) - 1) { + $this->stack[] = $tuple; + } else { + $replacement = [$this->stack[$idx], $tuple]; + \array_splice($this->stack, $idx, 1, $replacement); + } + } + + /** + * Provides a debug string for a given callable. + * + * @param callable|string $fn Function to write as a string. + */ + private function debugCallable($fn): string + { + if (\is_string($fn)) { + return "callable({$fn})"; + } + + if (\is_array($fn)) { + return \is_string($fn[0]) + ? "callable({$fn[0]}::{$fn[1]})" + : "callable(['".\get_class($fn[0])."', '{$fn[1]}'])"; + } + + /** @var object $fn */ + return 'callable('.\spl_object_hash($fn).')'; + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/MessageFormatter.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/MessageFormatter.php new file mode 100644 index 0000000000..9b77eee832 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/MessageFormatter.php @@ -0,0 +1,199 @@ +<?php + +namespace GuzzleHttp; + +use Psr\Http\Message\MessageInterface; +use Psr\Http\Message\RequestInterface; +use Psr\Http\Message\ResponseInterface; + +/** + * Formats log messages using variable substitutions for requests, responses, + * and other transactional data. + * + * The following variable substitutions are supported: + * + * - {request}: Full HTTP request message + * - {response}: Full HTTP response message + * - {ts}: ISO 8601 date in GMT + * - {date_iso_8601} ISO 8601 date in GMT + * - {date_common_log} Apache common log date using the configured timezone. + * - {host}: Host of the request + * - {method}: Method of the request + * - {uri}: URI of the request + * - {version}: Protocol version + * - {target}: Request target of the request (path + query + fragment) + * - {hostname}: Hostname of the machine that sent the request + * - {code}: Status code of the response (if available) + * - {phrase}: Reason phrase of the response (if available) + * - {error}: Any error messages (if available) + * - {req_header_*}: Replace `*` with the lowercased name of a request header to add to the message + * - {res_header_*}: Replace `*` with the lowercased name of a response header to add to the message + * - {req_headers}: Request headers + * - {res_headers}: Response headers + * - {req_body}: Request body + * - {res_body}: Response body + * + * @final + */ +class MessageFormatter implements MessageFormatterInterface +{ + /** + * Apache Common Log Format. + * + * @see https://httpd.apache.org/docs/2.4/logs.html#common + * + * @var string + */ + public const CLF = '{hostname} {req_header_User-Agent} - [{date_common_log}] "{method} {target} HTTP/{version}" {code} {res_header_Content-Length}'; + public const DEBUG = ">>>>>>>>\n{request}\n<<<<<<<<\n{response}\n--------\n{error}"; + public const SHORT = '[{ts}] "{method} {target} HTTP/{version}" {code}'; + + /** + * @var string Template used to format log messages + */ + private $template; + + /** + * @param string $template Log message template + */ + public function __construct(?string $template = self::CLF) + { + $this->template = $template ?: self::CLF; + } + + /** + * Returns a formatted message string. + * + * @param RequestInterface $request Request that was sent + * @param ResponseInterface|null $response Response that was received + * @param \Throwable|null $error Exception that was received + */ + public function format(RequestInterface $request, ?ResponseInterface $response = null, ?\Throwable $error = null): string + { + $cache = []; + + /** @var string */ + return \preg_replace_callback( + '/{\s*([A-Za-z_\-\.0-9]+)\s*}/', + function (array $matches) use ($request, $response, $error, &$cache) { + if (isset($cache[$matches[1]])) { + return $cache[$matches[1]]; + } + + $result = ''; + switch ($matches[1]) { + case 'request': + $result = Psr7\Message::toString($request); + break; + case 'response': + $result = $response ? Psr7\Message::toString($response) : ''; + break; + case 'req_headers': + $result = \trim($request->getMethod() + .' '.$request->getRequestTarget()) + .' HTTP/'.$request->getProtocolVersion()."\r\n" + .$this->headers($request); + break; + case 'res_headers': + $result = $response ? + \sprintf( + 'HTTP/%s %d %s', + $response->getProtocolVersion(), + $response->getStatusCode(), + $response->getReasonPhrase() + )."\r\n".$this->headers($response) + : 'NULL'; + break; + case 'req_body': + $result = $request->getBody()->__toString(); + break; + case 'res_body': + if (!$response instanceof ResponseInterface) { + $result = 'NULL'; + break; + } + + $body = $response->getBody(); + + if (!$body->isSeekable()) { + $result = 'RESPONSE_NOT_LOGGEABLE'; + break; + } + + $result = $response->getBody()->__toString(); + break; + case 'ts': + case 'date_iso_8601': + $result = \gmdate('c'); + break; + case 'date_common_log': + $result = \date('d/M/Y:H:i:s O'); + break; + case 'method': + $result = $request->getMethod(); + break; + case 'version': + $result = $request->getProtocolVersion(); + break; + case 'uri': + case 'url': + $result = $request->getUri()->__toString(); + break; + case 'target': + $result = $request->getRequestTarget(); + break; + case 'req_version': + $result = $request->getProtocolVersion(); + break; + case 'res_version': + $result = $response + ? $response->getProtocolVersion() + : 'NULL'; + break; + case 'host': + $result = $request->getHeaderLine('Host'); + break; + case 'hostname': + $result = \gethostname(); + break; + case 'code': + $result = $response ? $response->getStatusCode() : 'NULL'; + break; + case 'phrase': + $result = $response ? $response->getReasonPhrase() : 'NULL'; + break; + case 'error': + $result = $error ? $error->getMessage() : 'NULL'; + break; + default: + // handle prefixed dynamic headers + if (\strpos($matches[1], 'req_header_') === 0) { + $result = $request->getHeaderLine(\substr($matches[1], 11)); + } elseif (\strpos($matches[1], 'res_header_') === 0) { + $result = $response + ? $response->getHeaderLine(\substr($matches[1], 11)) + : 'NULL'; + } + } + + $cache[$matches[1]] = $result; + + return $result; + }, + $this->template + ); + } + + /** + * Get headers from message as string + */ + private function headers(MessageInterface $message): string + { + $result = ''; + foreach ($message->getHeaders() as $name => $values) { + $result .= $name.': '.\implode(', ', $values)."\r\n"; + } + + return \trim($result); + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/MessageFormatterInterface.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/MessageFormatterInterface.php new file mode 100644 index 0000000000..a39ac248ee --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/MessageFormatterInterface.php @@ -0,0 +1,18 @@ +<?php + +namespace GuzzleHttp; + +use Psr\Http\Message\RequestInterface; +use Psr\Http\Message\ResponseInterface; + +interface MessageFormatterInterface +{ + /** + * Returns a formatted message string. + * + * @param RequestInterface $request Request that was sent + * @param ResponseInterface|null $response Response that was received + * @param \Throwable|null $error Exception that was received + */ + public function format(RequestInterface $request, ?ResponseInterface $response = null, ?\Throwable $error = null): string; +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/Middleware.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/Middleware.php new file mode 100644 index 0000000000..6edbb3fe4f --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/Middleware.php @@ -0,0 +1,268 @@ +<?php + +namespace GuzzleHttp; + +use GuzzleHttp\Cookie\CookieJarInterface; +use GuzzleHttp\Exception\RequestException; +use GuzzleHttp\Promise as P; +use GuzzleHttp\Promise\PromiseInterface; +use Psr\Http\Message\RequestInterface; +use Psr\Http\Message\ResponseInterface; +use Psr\Log\LoggerInterface; + +/** + * Functions used to create and wrap handlers with handler middleware. + */ +final class Middleware +{ + /** + * Middleware that adds cookies to requests. + * + * The options array must be set to a CookieJarInterface in order to use + * cookies. This is typically handled for you by a client. + * + * @return callable Returns a function that accepts the next handler. + */ + public static function cookies(): callable + { + return static function (callable $handler): callable { + return static function ($request, array $options) use ($handler) { + if (empty($options['cookies'])) { + return $handler($request, $options); + } elseif (!($options['cookies'] instanceof CookieJarInterface)) { + throw new \InvalidArgumentException('cookies must be an instance of GuzzleHttp\Cookie\CookieJarInterface'); + } + $cookieJar = $options['cookies']; + $request = $cookieJar->withCookieHeader($request); + + return $handler($request, $options) + ->then( + static function (ResponseInterface $response) use ($cookieJar, $request): ResponseInterface { + $cookieJar->extractCookies($request, $response); + + return $response; + } + ); + }; + }; + } + + /** + * Middleware that throws exceptions for 4xx or 5xx responses when the + * "http_errors" request option is set to true. + * + * @param BodySummarizerInterface|null $bodySummarizer The body summarizer to use in exception messages. + * + * @return callable(callable): callable Returns a function that accepts the next handler. + */ + public static function httpErrors(?BodySummarizerInterface $bodySummarizer = null): callable + { + return static function (callable $handler) use ($bodySummarizer): callable { + return static function ($request, array $options) use ($handler, $bodySummarizer) { + if (empty($options['http_errors'])) { + return $handler($request, $options); + } + + return $handler($request, $options)->then( + static function (ResponseInterface $response) use ($request, $bodySummarizer) { + $code = $response->getStatusCode(); + if ($code < 400) { + return $response; + } + throw RequestException::create($request, $response, null, [], $bodySummarizer); + } + ); + }; + }; + } + + /** + * Middleware that pushes history data to an ArrayAccess container. + * + * @param array|\ArrayAccess<int, array> $container Container to hold the history (by reference). + * + * @return callable(callable): callable Returns a function that accepts the next handler. + * + * @throws \InvalidArgumentException if container is not an array or ArrayAccess. + */ + public static function history(&$container): callable + { + if (!\is_array($container) && !$container instanceof \ArrayAccess) { + throw new \InvalidArgumentException('history container must be an array or object implementing ArrayAccess'); + } + + return static function (callable $handler) use (&$container): callable { + return static function (RequestInterface $request, array $options) use ($handler, &$container) { + return $handler($request, $options)->then( + static function ($value) use ($request, &$container, $options) { + $container[] = [ + 'request' => $request, + 'response' => $value, + 'error' => null, + 'options' => $options, + ]; + + return $value; + }, + static function ($reason) use ($request, &$container, $options) { + $container[] = [ + 'request' => $request, + 'response' => null, + 'error' => $reason, + 'options' => $options, + ]; + + return P\Create::rejectionFor($reason); + } + ); + }; + }; + } + + /** + * Middleware that invokes a callback before and after sending a request. + * + * The provided listener cannot modify or alter the response. It simply + * "taps" into the chain to be notified before returning the promise. The + * before listener accepts a request and options array, and the after + * listener accepts a request, options array, and response promise. + * + * @param callable $before Function to invoke before forwarding the request. + * @param callable $after Function invoked after forwarding. + * + * @return callable Returns a function that accepts the next handler. + */ + public static function tap(?callable $before = null, ?callable $after = null): callable + { + return static function (callable $handler) use ($before, $after): callable { + return static function (RequestInterface $request, array $options) use ($handler, $before, $after) { + if ($before) { + $before($request, $options); + } + $response = $handler($request, $options); + if ($after) { + $after($request, $options, $response); + } + + return $response; + }; + }; + } + + /** + * Middleware that handles request redirects. + * + * @return callable Returns a function that accepts the next handler. + */ + public static function redirect(): callable + { + return static function (callable $handler): RedirectMiddleware { + return new RedirectMiddleware($handler); + }; + } + + /** + * Middleware that retries requests based on the boolean result of + * invoking the provided "decider" function. + * + * If no delay function is provided, a simple implementation of exponential + * backoff will be utilized. + * + * @param callable $decider Function that accepts the number of retries, + * a request, [response], and [exception] and + * returns true if the request is to be retried. + * @param callable $delay Function that accepts the number of retries and + * returns the number of milliseconds to delay. + * + * @return callable Returns a function that accepts the next handler. + */ + public static function retry(callable $decider, ?callable $delay = null): callable + { + return static function (callable $handler) use ($decider, $delay): RetryMiddleware { + return new RetryMiddleware($decider, $handler, $delay); + }; + } + + /** + * Middleware that logs requests, responses, and errors using a message + * formatter. + * + * @phpstan-param \Psr\Log\LogLevel::* $logLevel Level at which to log requests. + * + * @param LoggerInterface $logger Logs messages. + * @param MessageFormatterInterface|MessageFormatter $formatter Formatter used to create message strings. + * @param string $logLevel Level at which to log requests. + * + * @return callable Returns a function that accepts the next handler. + */ + public static function log(LoggerInterface $logger, $formatter, string $logLevel = 'info'): callable + { + // To be compatible with Guzzle 7.1.x we need to allow users to pass a MessageFormatter + if (!$formatter instanceof MessageFormatter && !$formatter instanceof MessageFormatterInterface) { + throw new \LogicException(sprintf('Argument 2 to %s::log() must be of type %s', self::class, MessageFormatterInterface::class)); + } + + return static function (callable $handler) use ($logger, $formatter, $logLevel): callable { + return static function (RequestInterface $request, array $options = []) use ($handler, $logger, $formatter, $logLevel) { + return $handler($request, $options)->then( + static function ($response) use ($logger, $request, $formatter, $logLevel): ResponseInterface { + $message = $formatter->format($request, $response); + $logger->log($logLevel, $message); + + return $response; + }, + static function ($reason) use ($logger, $request, $formatter): PromiseInterface { + $response = $reason instanceof RequestException ? $reason->getResponse() : null; + $message = $formatter->format($request, $response, P\Create::exceptionFor($reason)); + $logger->error($message); + + return P\Create::rejectionFor($reason); + } + ); + }; + }; + } + + /** + * This middleware adds a default content-type if possible, a default + * content-length or transfer-encoding header, and the expect header. + */ + public static function prepareBody(): callable + { + return static function (callable $handler): PrepareBodyMiddleware { + return new PrepareBodyMiddleware($handler); + }; + } + + /** + * Middleware that applies a map function to the request before passing to + * the next handler. + * + * @param callable $fn Function that accepts a RequestInterface and returns + * a RequestInterface. + */ + public static function mapRequest(callable $fn): callable + { + return static function (callable $handler) use ($fn): callable { + return static function (RequestInterface $request, array $options) use ($handler, $fn) { + return $handler($fn($request), $options); + }; + }; + } + + /** + * Middleware that applies a map function to the resolved promise's + * response. + * + * @param callable $fn Function that accepts a ResponseInterface and + * returns a ResponseInterface. + */ + public static function mapResponse(callable $fn): callable + { + return static function (callable $handler) use ($fn): callable { + return static function (RequestInterface $request, array $options) use ($handler, $fn) { + return $handler($request, $options)->then($fn); + }; + }; + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/PrepareBodyMiddleware.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/PrepareBodyMiddleware.php new file mode 100644 index 0000000000..7dde6c5f46 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/PrepareBodyMiddleware.php @@ -0,0 +1,105 @@ +<?php + +namespace GuzzleHttp; + +use GuzzleHttp\Promise\PromiseInterface; +use Psr\Http\Message\RequestInterface; + +/** + * Prepares requests that contain a body, adding the Content-Length, + * Content-Type, and Expect headers. + * + * @final + */ +class PrepareBodyMiddleware +{ + /** + * @var callable(RequestInterface, array): PromiseInterface + */ + private $nextHandler; + + /** + * @param callable(RequestInterface, array): PromiseInterface $nextHandler Next handler to invoke. + */ + public function __construct(callable $nextHandler) + { + $this->nextHandler = $nextHandler; + } + + public function __invoke(RequestInterface $request, array $options): PromiseInterface + { + $fn = $this->nextHandler; + + // Don't do anything if the request has no body. + if ($request->getBody()->getSize() === 0) { + return $fn($request, $options); + } + + $modify = []; + + // Add a default content-type if possible. + if (!$request->hasHeader('Content-Type')) { + if ($uri = $request->getBody()->getMetadata('uri')) { + if (is_string($uri) && $type = Psr7\MimeType::fromFilename($uri)) { + $modify['set_headers']['Content-Type'] = $type; + } + } + } + + // Add a default content-length or transfer-encoding header. + if (!$request->hasHeader('Content-Length') + && !$request->hasHeader('Transfer-Encoding') + ) { + $size = $request->getBody()->getSize(); + if ($size !== null) { + $modify['set_headers']['Content-Length'] = $size; + } else { + $modify['set_headers']['Transfer-Encoding'] = 'chunked'; + } + } + + // Add the expect header if needed. + $this->addExpectHeader($request, $options, $modify); + + return $fn(Psr7\Utils::modifyRequest($request, $modify), $options); + } + + /** + * Add expect header + */ + private function addExpectHeader(RequestInterface $request, array $options, array &$modify): void + { + // Determine if the Expect header should be used + if ($request->hasHeader('Expect')) { + return; + } + + $expect = $options['expect'] ?? null; + + // Return if disabled or using HTTP/1.0 + if ($expect === false || $request->getProtocolVersion() === '1.0') { + return; + } + + // The expect header is unconditionally enabled + if ($expect === true) { + $modify['set_headers']['Expect'] = '100-Continue'; + + return; + } + + // By default, send the expect header when the payload is > 1mb + if ($expect === null) { + $expect = 1048576; + } + + // Always add if the body cannot be rewound, the size cannot be + // determined, or the size is greater than the cutoff threshold + $body = $request->getBody(); + $size = $body->getSize(); + + if ($size === null || $size >= (int) $expect || !$body->isSeekable()) { + $modify['set_headers']['Expect'] = '100-Continue'; + } + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/RequestOptions.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/RequestOptions.php new file mode 100644 index 0000000000..84a3500e44 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/RequestOptions.php @@ -0,0 +1,274 @@ +<?php + +namespace GuzzleHttp; + +/** + * This class contains a list of built-in Guzzle request options. + * + * @see https://docs.guzzlephp.org/en/latest/request-options.html + */ +final class RequestOptions +{ + /** + * allow_redirects: (bool|array) Controls redirect behavior. Pass false + * to disable redirects, pass true to enable redirects, pass an + * associative to provide custom redirect settings. Defaults to "false". + * This option only works if your handler has the RedirectMiddleware. When + * passing an associative array, you can provide the following key value + * pairs: + * + * - max: (int, default=5) maximum number of allowed redirects. + * - strict: (bool, default=false) Set to true to use strict redirects + * meaning redirect POST requests with POST requests vs. doing what most + * browsers do which is redirect POST requests with GET requests + * - referer: (bool, default=false) Set to true to enable the Referer + * header. + * - protocols: (array, default=['http', 'https']) Allowed redirect + * protocols. + * - on_redirect: (callable) PHP callable that is invoked when a redirect + * is encountered. The callable is invoked with the request, the redirect + * response that was received, and the effective URI. Any return value + * from the on_redirect function is ignored. + */ + public const ALLOW_REDIRECTS = 'allow_redirects'; + + /** + * auth: (array) Pass an array of HTTP authentication parameters to use + * with the request. The array must contain the username in index [0], + * the password in index [1], and you can optionally provide a built-in + * authentication type in index [2]. Pass null to disable authentication + * for a request. + */ + public const AUTH = 'auth'; + + /** + * body: (resource|string|null|int|float|StreamInterface|callable|\Iterator) + * Body to send in the request. + */ + public const BODY = 'body'; + + /** + * cert: (string|array) Set to a string to specify the path to a file + * containing a PEM formatted SSL client side certificate. If a password + * is required, then set cert to an array containing the path to the PEM + * file in the first array element followed by the certificate password + * in the second array element. + */ + public const CERT = 'cert'; + + /** + * cookies: (bool|GuzzleHttp\Cookie\CookieJarInterface, default=false) + * Specifies whether or not cookies are used in a request or what cookie + * jar to use or what cookies to send. This option only works if your + * handler has the `cookie` middleware. Valid values are `false` and + * an instance of {@see Cookie\CookieJarInterface}. + */ + public const COOKIES = 'cookies'; + + /** + * connect_timeout: (float, default=0) Float describing the number of + * seconds to wait while trying to connect to a server. Use 0 to wait + * 300 seconds (the default behavior). + */ + public const CONNECT_TIMEOUT = 'connect_timeout'; + + /** + * crypto_method: (int) A value describing the minimum TLS protocol + * version to use. + * + * This setting must be set to one of the + * ``STREAM_CRYPTO_METHOD_TLS*_CLIENT`` constants. PHP 7.4 or higher is + * required in order to use TLS 1.3, and cURL 7.34.0 or higher is required + * in order to specify a crypto method, with cURL 7.52.0 or higher being + * required to use TLS 1.3. + */ + public const CRYPTO_METHOD = 'crypto_method'; + + /** + * debug: (bool|resource) Set to true or set to a PHP stream returned by + * fopen() enable debug output with the HTTP handler used to send a + * request. + */ + public const DEBUG = 'debug'; + + /** + * decode_content: (bool, default=true) Specify whether or not + * Content-Encoding responses (gzip, deflate, etc.) are automatically + * decoded. + */ + public const DECODE_CONTENT = 'decode_content'; + + /** + * delay: (int) The amount of time to delay before sending in milliseconds. + */ + public const DELAY = 'delay'; + + /** + * expect: (bool|integer) Controls the behavior of the + * "Expect: 100-Continue" header. + * + * Set to `true` to enable the "Expect: 100-Continue" header for all + * requests that sends a body. Set to `false` to disable the + * "Expect: 100-Continue" header for all requests. Set to a number so that + * the size of the payload must be greater than the number in order to send + * the Expect header. Setting to a number will send the Expect header for + * all requests in which the size of the payload cannot be determined or + * where the body is not rewindable. + * + * By default, Guzzle will add the "Expect: 100-Continue" header when the + * size of the body of a request is greater than 1 MB and a request is + * using HTTP/1.1. + */ + public const EXPECT = 'expect'; + + /** + * form_params: (array) Associative array of form field names to values + * where each value is a string or array of strings. Sets the Content-Type + * header to application/x-www-form-urlencoded when no Content-Type header + * is already present. + */ + public const FORM_PARAMS = 'form_params'; + + /** + * headers: (array) Associative array of HTTP headers. Each value MUST be + * a string or array of strings. + */ + public const HEADERS = 'headers'; + + /** + * http_errors: (bool, default=true) Set to false to disable exceptions + * when a non- successful HTTP response is received. By default, + * exceptions will be thrown for 4xx and 5xx responses. This option only + * works if your handler has the `httpErrors` middleware. + */ + public const HTTP_ERRORS = 'http_errors'; + + /** + * idn: (bool|int, default=true) A combination of IDNA_* constants for + * idn_to_ascii() PHP's function (see "options" parameter). Set to false to + * disable IDN support completely, or to true to use the default + * configuration (IDNA_DEFAULT constant). + */ + public const IDN_CONVERSION = 'idn_conversion'; + + /** + * json: (mixed) Adds JSON data to a request. The provided value is JSON + * encoded and a Content-Type header of application/json will be added to + * the request if no Content-Type header is already present. + */ + public const JSON = 'json'; + + /** + * multipart: (array) Array of associative arrays, each containing a + * required "name" key mapping to the form field, name, a required + * "contents" key mapping to a StreamInterface|resource|string, an + * optional "headers" associative array of custom headers, and an + * optional "filename" key mapping to a string to send as the filename in + * the part. If no "filename" key is present, then no "filename" attribute + * will be added to the part. + */ + public const MULTIPART = 'multipart'; + + /** + * on_headers: (callable) A callable that is invoked when the HTTP headers + * of the response have been received but the body has not yet begun to + * download. + */ + public const ON_HEADERS = 'on_headers'; + + /** + * on_stats: (callable) allows you to get access to transfer statistics of + * a request and access the lower level transfer details of the handler + * associated with your client. ``on_stats`` is a callable that is invoked + * when a handler has finished sending a request. The callback is invoked + * with transfer statistics about the request, the response received, or + * the error encountered. Included in the data is the total amount of time + * taken to send the request. + */ + public const ON_STATS = 'on_stats'; + + /** + * progress: (callable) Defines a function to invoke when transfer + * progress is made. The function accepts the following positional + * arguments: the total number of bytes expected to be downloaded, the + * number of bytes downloaded so far, the number of bytes expected to be + * uploaded, the number of bytes uploaded so far. + */ + public const PROGRESS = 'progress'; + + /** + * proxy: (string|array) Pass a string to specify an HTTP proxy, or an + * array to specify different proxies for different protocols (where the + * key is the protocol and the value is a proxy string). + */ + public const PROXY = 'proxy'; + + /** + * query: (array|string) Associative array of query string values to add + * to the request. This option uses PHP's http_build_query() to create + * the string representation. Pass a string value if you need more + * control than what this method provides + */ + public const QUERY = 'query'; + + /** + * sink: (resource|string|StreamInterface) Where the data of the + * response is written to. Defaults to a PHP temp stream. Providing a + * string will write data to a file by the given name. + */ + public const SINK = 'sink'; + + /** + * synchronous: (bool) Set to true to inform HTTP handlers that you intend + * on waiting on the response. This can be useful for optimizations. Note + * that a promise is still returned if you are using one of the async + * client methods. + */ + public const SYNCHRONOUS = 'synchronous'; + + /** + * ssl_key: (array|string) Specify the path to a file containing a private + * SSL key in PEM format. If a password is required, then set to an array + * containing the path to the SSL key in the first array element followed + * by the password required for the certificate in the second element. + */ + public const SSL_KEY = 'ssl_key'; + + /** + * stream: Set to true to attempt to stream a response rather than + * download it all up-front. + */ + public const STREAM = 'stream'; + + /** + * verify: (bool|string, default=true) Describes the SSL certificate + * verification behavior of a request. Set to true to enable SSL + * certificate verification using the system CA bundle when available + * (the default). Set to false to disable certificate verification (this + * is insecure!). Set to a string to provide the path to a CA bundle on + * disk to enable verification using a custom certificate. + */ + public const VERIFY = 'verify'; + + /** + * timeout: (float, default=0) Float describing the timeout of the + * request in seconds. Use 0 to wait indefinitely (the default behavior). + */ + public const TIMEOUT = 'timeout'; + + /** + * read_timeout: (float, default=default_socket_timeout ini setting) Float describing + * the body read timeout, for stream requests. + */ + public const READ_TIMEOUT = 'read_timeout'; + + /** + * version: (float) Specifies the HTTP protocol version to attempt to use. + */ + public const VERSION = 'version'; + + /** + * force_ip_resolve: (bool) Force client to use only ipv4 or ipv6 protocol + */ + public const FORCE_IP_RESOLVE = 'force_ip_resolve'; +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/RetryMiddleware.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/RetryMiddleware.php new file mode 100644 index 0000000000..65f49cb759 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/RetryMiddleware.php @@ -0,0 +1,119 @@ +<?php + +namespace GuzzleHttp; + +use GuzzleHttp\Promise as P; +use GuzzleHttp\Promise\PromiseInterface; +use Psr\Http\Message\RequestInterface; +use Psr\Http\Message\ResponseInterface; + +/** + * Middleware that retries requests based on the boolean result of + * invoking the provided "decider" function. + * + * @final + */ +class RetryMiddleware +{ + /** + * @var callable(RequestInterface, array): PromiseInterface + */ + private $nextHandler; + + /** + * @var callable + */ + private $decider; + + /** + * @var callable(int) + */ + private $delay; + + /** + * @param callable $decider Function that accepts the number of retries, + * a request, [response], and [exception] and + * returns true if the request is to be + * retried. + * @param callable(RequestInterface, array): PromiseInterface $nextHandler Next handler to invoke. + * @param (callable(int): int)|null $delay Function that accepts the number of retries + * and returns the number of + * milliseconds to delay. + */ + public function __construct(callable $decider, callable $nextHandler, ?callable $delay = null) + { + $this->decider = $decider; + $this->nextHandler = $nextHandler; + $this->delay = $delay ?: __CLASS__.'::exponentialDelay'; + } + + /** + * Default exponential backoff delay function. + * + * @return int milliseconds. + */ + public static function exponentialDelay(int $retries): int + { + return (int) 2 ** ($retries - 1) * 1000; + } + + public function __invoke(RequestInterface $request, array $options): PromiseInterface + { + if (!isset($options['retries'])) { + $options['retries'] = 0; + } + + $fn = $this->nextHandler; + + return $fn($request, $options) + ->then( + $this->onFulfilled($request, $options), + $this->onRejected($request, $options) + ); + } + + /** + * Execute fulfilled closure + */ + private function onFulfilled(RequestInterface $request, array $options): callable + { + return function ($value) use ($request, $options) { + if (!($this->decider)( + $options['retries'], + $request, + $value, + null + )) { + return $value; + } + + return $this->doRetry($request, $options, $value); + }; + } + + /** + * Execute rejected closure + */ + private function onRejected(RequestInterface $req, array $options): callable + { + return function ($reason) use ($req, $options) { + if (!($this->decider)( + $options['retries'], + $req, + null, + $reason + )) { + return P\Create::rejectionFor($reason); + } + + return $this->doRetry($req, $options); + }; + } + + private function doRetry(RequestInterface $request, array $options, ?ResponseInterface $response = null): PromiseInterface + { + $options['delay'] = ($this->delay)(++$options['retries'], $response, $request); + + return $this($request, $options); + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/TransferStats.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/TransferStats.php new file mode 100644 index 0000000000..93fa334c8d --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/TransferStats.php @@ -0,0 +1,133 @@ +<?php + +namespace GuzzleHttp; + +use Psr\Http\Message\RequestInterface; +use Psr\Http\Message\ResponseInterface; +use Psr\Http\Message\UriInterface; + +/** + * Represents data at the point after it was transferred either successfully + * or after a network error. + */ +final class TransferStats +{ + /** + * @var RequestInterface + */ + private $request; + + /** + * @var ResponseInterface|null + */ + private $response; + + /** + * @var float|null + */ + private $transferTime; + + /** + * @var array + */ + private $handlerStats; + + /** + * @var mixed|null + */ + private $handlerErrorData; + + /** + * @param RequestInterface $request Request that was sent. + * @param ResponseInterface|null $response Response received (if any) + * @param float|null $transferTime Total handler transfer time. + * @param mixed $handlerErrorData Handler error data. + * @param array $handlerStats Handler specific stats. + */ + public function __construct( + RequestInterface $request, + ?ResponseInterface $response = null, + ?float $transferTime = null, + $handlerErrorData = null, + array $handlerStats = [] + ) { + $this->request = $request; + $this->response = $response; + $this->transferTime = $transferTime; + $this->handlerErrorData = $handlerErrorData; + $this->handlerStats = $handlerStats; + } + + public function getRequest(): RequestInterface + { + return $this->request; + } + + /** + * Returns the response that was received (if any). + */ + public function getResponse(): ?ResponseInterface + { + return $this->response; + } + + /** + * Returns true if a response was received. + */ + public function hasResponse(): bool + { + return $this->response !== null; + } + + /** + * Gets handler specific error data. + * + * This might be an exception, a integer representing an error code, or + * anything else. Relying on this value assumes that you know what handler + * you are using. + * + * @return mixed + */ + public function getHandlerErrorData() + { + return $this->handlerErrorData; + } + + /** + * Get the effective URI the request was sent to. + */ + public function getEffectiveUri(): UriInterface + { + return $this->request->getUri(); + } + + /** + * Get the estimated time the request was being transferred by the handler. + * + * @return float|null Time in seconds. + */ + public function getTransferTime(): ?float + { + return $this->transferTime; + } + + /** + * Gets an array of all of the handler specific transfer data. + */ + public function getHandlerStats(): array + { + return $this->handlerStats; + } + + /** + * Get a specific handler statistic from the handler by name. + * + * @param string $stat Handler specific transfer stat to retrieve. + * + * @return mixed|null + */ + public function getHandlerStat(string $stat) + { + return $this->handlerStats[$stat] ?? null; + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/Utils.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/Utils.php new file mode 100644 index 0000000000..df529270e1 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/Utils.php @@ -0,0 +1,384 @@ +<?php + +namespace GuzzleHttp; + +use GuzzleHttp\Exception\InvalidArgumentException; +use GuzzleHttp\Handler\CurlHandler; +use GuzzleHttp\Handler\CurlMultiHandler; +use GuzzleHttp\Handler\Proxy; +use GuzzleHttp\Handler\StreamHandler; +use Psr\Http\Message\UriInterface; + +final class Utils +{ + /** + * Debug function used to describe the provided value type and class. + * + * @param mixed $input + * + * @return string Returns a string containing the type of the variable and + * if a class is provided, the class name. + */ + public static function describeType($input): string + { + switch (\gettype($input)) { + case 'object': + return 'object('.\get_class($input).')'; + case 'array': + return 'array('.\count($input).')'; + default: + \ob_start(); + \var_dump($input); + // normalize float vs double + /** @var string $varDumpContent */ + $varDumpContent = \ob_get_clean(); + + return \str_replace('double(', 'float(', \rtrim($varDumpContent)); + } + } + + /** + * Parses an array of header lines into an associative array of headers. + * + * @param iterable $lines Header lines array of strings in the following + * format: "Name: Value" + */ + public static function headersFromLines(iterable $lines): array + { + $headers = []; + + foreach ($lines as $line) { + $parts = \explode(':', $line, 2); + $headers[\trim($parts[0])][] = isset($parts[1]) ? \trim($parts[1]) : null; + } + + return $headers; + } + + /** + * Returns a debug stream based on the provided variable. + * + * @param mixed $value Optional value + * + * @return resource + */ + public static function debugResource($value = null) + { + if (\is_resource($value)) { + return $value; + } + if (\defined('STDOUT')) { + return \STDOUT; + } + + return Psr7\Utils::tryFopen('php://output', 'w'); + } + + /** + * Chooses and creates a default handler to use based on the environment. + * + * The returned handler is not wrapped by any default middlewares. + * + * @return callable(\Psr\Http\Message\RequestInterface, array): \GuzzleHttp\Promise\PromiseInterface Returns the best handler for the given system. + * + * @throws \RuntimeException if no viable Handler is available. + */ + public static function chooseHandler(): callable + { + $handler = null; + + if (\defined('CURLOPT_CUSTOMREQUEST') && \function_exists('curl_version') && version_compare(curl_version()['version'], '7.21.2') >= 0) { + if (\function_exists('curl_multi_exec') && \function_exists('curl_exec')) { + $handler = Proxy::wrapSync(new CurlMultiHandler(), new CurlHandler()); + } elseif (\function_exists('curl_exec')) { + $handler = new CurlHandler(); + } elseif (\function_exists('curl_multi_exec')) { + $handler = new CurlMultiHandler(); + } + } + + if (\ini_get('allow_url_fopen')) { + $handler = $handler + ? Proxy::wrapStreaming($handler, new StreamHandler()) + : new StreamHandler(); + } elseif (!$handler) { + throw new \RuntimeException('GuzzleHttp requires cURL, the allow_url_fopen ini setting, or a custom HTTP handler.'); + } + + return $handler; + } + + /** + * Get the default User-Agent string to use with Guzzle. + */ + public static function defaultUserAgent(): string + { + return sprintf('GuzzleHttp/%d', ClientInterface::MAJOR_VERSION); + } + + /** + * Returns the default cacert bundle for the current system. + * + * First, the openssl.cafile and curl.cainfo php.ini settings are checked. + * If those settings are not configured, then the common locations for + * bundles found on Red Hat, CentOS, Fedora, Ubuntu, Debian, FreeBSD, OS X + * and Windows are checked. If any of these file locations are found on + * disk, they will be utilized. + * + * Note: the result of this function is cached for subsequent calls. + * + * @throws \RuntimeException if no bundle can be found. + * + * @deprecated Utils::defaultCaBundle will be removed in guzzlehttp/guzzle:8.0. This method is not needed in PHP 5.6+. + */ + public static function defaultCaBundle(): string + { + static $cached = null; + static $cafiles = [ + // Red Hat, CentOS, Fedora (provided by the ca-certificates package) + '/etc/pki/tls/certs/ca-bundle.crt', + // Ubuntu, Debian (provided by the ca-certificates package) + '/etc/ssl/certs/ca-certificates.crt', + // FreeBSD (provided by the ca_root_nss package) + '/usr/local/share/certs/ca-root-nss.crt', + // SLES 12 (provided by the ca-certificates package) + '/var/lib/ca-certificates/ca-bundle.pem', + // OS X provided by homebrew (using the default path) + '/usr/local/etc/openssl/cert.pem', + // Google app engine + '/etc/ca-certificates.crt', + // Windows? + 'C:\\windows\\system32\\curl-ca-bundle.crt', + 'C:\\windows\\curl-ca-bundle.crt', + ]; + + if ($cached) { + return $cached; + } + + if ($ca = \ini_get('openssl.cafile')) { + return $cached = $ca; + } + + if ($ca = \ini_get('curl.cainfo')) { + return $cached = $ca; + } + + foreach ($cafiles as $filename) { + if (\file_exists($filename)) { + return $cached = $filename; + } + } + + throw new \RuntimeException( + <<< EOT +No system CA bundle could be found in any of the the common system locations. +PHP versions earlier than 5.6 are not properly configured to use the system's +CA bundle by default. In order to verify peer certificates, you will need to +supply the path on disk to a certificate bundle to the 'verify' request +option: https://docs.guzzlephp.org/en/latest/request-options.html#verify. If +you do not need a specific certificate bundle, then Mozilla provides a commonly +used CA bundle which can be downloaded here (provided by the maintainer of +cURL): https://curl.haxx.se/ca/cacert.pem. Once you have a CA bundle available +on disk, you can set the 'openssl.cafile' PHP ini setting to point to the path +to the file, allowing you to omit the 'verify' request option. See +https://curl.haxx.se/docs/sslcerts.html for more information. +EOT + ); + } + + /** + * Creates an associative array of lowercase header names to the actual + * header casing. + */ + public static function normalizeHeaderKeys(array $headers): array + { + $result = []; + foreach (\array_keys($headers) as $key) { + $result[\strtolower($key)] = $key; + } + + return $result; + } + + /** + * Returns true if the provided host matches any of the no proxy areas. + * + * This method will strip a port from the host if it is present. Each pattern + * can be matched with an exact match (e.g., "foo.com" == "foo.com") or a + * partial match: (e.g., "foo.com" == "baz.foo.com" and ".foo.com" == + * "baz.foo.com", but ".foo.com" != "foo.com"). + * + * Areas are matched in the following cases: + * 1. "*" (without quotes) always matches any hosts. + * 2. An exact match. + * 3. The area starts with "." and the area is the last part of the host. e.g. + * '.mit.edu' will match any host that ends with '.mit.edu'. + * + * @param string $host Host to check against the patterns. + * @param string[] $noProxyArray An array of host patterns. + * + * @throws InvalidArgumentException + */ + public static function isHostInNoProxy(string $host, array $noProxyArray): bool + { + if (\strlen($host) === 0) { + throw new InvalidArgumentException('Empty host provided'); + } + + // Strip port if present. + [$host] = \explode(':', $host, 2); + + foreach ($noProxyArray as $area) { + // Always match on wildcards. + if ($area === '*') { + return true; + } + + if (empty($area)) { + // Don't match on empty values. + continue; + } + + if ($area === $host) { + // Exact matches. + return true; + } + // Special match if the area when prefixed with ".". Remove any + // existing leading "." and add a new leading ".". + $area = '.'.\ltrim($area, '.'); + if (\substr($host, -\strlen($area)) === $area) { + return true; + } + } + + return false; + } + + /** + * Wrapper for json_decode that throws when an error occurs. + * + * @param string $json JSON data to parse + * @param bool $assoc When true, returned objects will be converted + * into associative arrays. + * @param int $depth User specified recursion depth. + * @param int $options Bitmask of JSON decode options. + * + * @return object|array|string|int|float|bool|null + * + * @throws InvalidArgumentException if the JSON cannot be decoded. + * + * @see https://www.php.net/manual/en/function.json-decode.php + */ + public static function jsonDecode(string $json, bool $assoc = false, int $depth = 512, int $options = 0) + { + $data = \json_decode($json, $assoc, $depth, $options); + if (\JSON_ERROR_NONE !== \json_last_error()) { + throw new InvalidArgumentException('json_decode error: '.\json_last_error_msg()); + } + + return $data; + } + + /** + * Wrapper for JSON encoding that throws when an error occurs. + * + * @param mixed $value The value being encoded + * @param int $options JSON encode option bitmask + * @param int $depth Set the maximum depth. Must be greater than zero. + * + * @throws InvalidArgumentException if the JSON cannot be encoded. + * + * @see https://www.php.net/manual/en/function.json-encode.php + */ + public static function jsonEncode($value, int $options = 0, int $depth = 512): string + { + $json = \json_encode($value, $options, $depth); + if (\JSON_ERROR_NONE !== \json_last_error()) { + throw new InvalidArgumentException('json_encode error: '.\json_last_error_msg()); + } + + /** @var string */ + return $json; + } + + /** + * Wrapper for the hrtime() or microtime() functions + * (depending on the PHP version, one of the two is used) + * + * @return float UNIX timestamp + * + * @internal + */ + public static function currentTime(): float + { + return (float) \function_exists('hrtime') ? \hrtime(true) / 1e9 : \microtime(true); + } + + /** + * @throws InvalidArgumentException + * + * @internal + */ + public static function idnUriConvert(UriInterface $uri, int $options = 0): UriInterface + { + if ($uri->getHost()) { + $asciiHost = self::idnToAsci($uri->getHost(), $options, $info); + if ($asciiHost === false) { + $errorBitSet = $info['errors'] ?? 0; + + $errorConstants = array_filter(array_keys(get_defined_constants()), static function (string $name): bool { + return substr($name, 0, 11) === 'IDNA_ERROR_'; + }); + + $errors = []; + foreach ($errorConstants as $errorConstant) { + if ($errorBitSet & constant($errorConstant)) { + $errors[] = $errorConstant; + } + } + + $errorMessage = 'IDN conversion failed'; + if ($errors) { + $errorMessage .= ' (errors: '.implode(', ', $errors).')'; + } + + throw new InvalidArgumentException($errorMessage); + } + if ($uri->getHost() !== $asciiHost) { + // Replace URI only if the ASCII version is different + $uri = $uri->withHost($asciiHost); + } + } + + return $uri; + } + + /** + * @internal + */ + public static function getenv(string $name): ?string + { + if (isset($_SERVER[$name])) { + return (string) $_SERVER[$name]; + } + + if (\PHP_SAPI === 'cli' && ($value = \getenv($name)) !== false && $value !== null) { + return (string) $value; + } + + return null; + } + + /** + * @return string|false + */ + private static function idnToAsci(string $domain, int $options, ?array &$info = []) + { + if (\function_exists('idn_to_ascii') && \defined('INTL_IDNA_VARIANT_UTS46')) { + return \idn_to_ascii($domain, $options, \INTL_IDNA_VARIANT_UTS46, $info); + } + + throw new \Error('ext-idn or symfony/polyfill-intl-idn not loaded or too old'); + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/promises/composer.json b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/promises/composer.json new file mode 100644 index 0000000000..f64ed7714e --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/promises/composer.json @@ -0,0 +1,58 @@ +{ + "name": "guzzlehttp/promises", + "description": "Guzzle promises library", + "keywords": ["promise"], + "license": "MIT", + "authors": [ + { + "name": "Graham Campbell", + "email": "hello@gjcampbell.co.uk", + "homepage": "https://github.com/GrahamCampbell" + }, + { + "name": "Michael Dowling", + "email": "mtdowling@gmail.com", + "homepage": "https://github.com/mtdowling" + }, + { + "name": "Tobias Nyholm", + "email": "tobias.nyholm@gmail.com", + "homepage": "https://github.com/Nyholm" + }, + { + "name": "Tobias Schultze", + "email": "webmaster@tubo-world.de", + "homepage": "https://github.com/Tobion" + } + ], + "require": { + "php": "^7.2.5 || ^8.0" + }, + "require-dev": { + "bamarni/composer-bin-plugin": "^1.8.2", + "phpunit/phpunit": "^8.5.39 || ^9.6.20" + }, + "autoload": { + "psr-4": { + "GuzzleHttp\\Promise\\": "src/" + } + }, + "autoload-dev": { + "psr-4": { + "GuzzleHttp\\Promise\\Tests\\": "tests/" + } + }, + "extra": { + "bamarni-bin": { + "bin-links": true, + "forward-command": false + } + }, + "config": { + "allow-plugins": { + "bamarni/composer-bin-plugin": true + }, + "preferred-install": "dist", + "sort-packages": true + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/promises/src/Coroutine.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/promises/src/Coroutine.php new file mode 100644 index 0000000000..0da0228344 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/promises/src/Coroutine.php @@ -0,0 +1,162 @@ +<?php + +declare(strict_types=1); + +namespace GuzzleHttp\Promise; + +use Generator; +use Throwable; + +/** + * Creates a promise that is resolved using a generator that yields values or + * promises (somewhat similar to C#'s async keyword). + * + * When called, the Coroutine::of method will start an instance of the generator + * and returns a promise that is fulfilled with its final yielded value. + * + * Control is returned back to the generator when the yielded promise settles. + * This can lead to less verbose code when doing lots of sequential async calls + * with minimal processing in between. + * + * use GuzzleHttp\Promise; + * + * function createPromise($value) { + * return new Promise\FulfilledPromise($value); + * } + * + * $promise = Promise\Coroutine::of(function () { + * $value = (yield createPromise('a')); + * try { + * $value = (yield createPromise($value . 'b')); + * } catch (\Throwable $e) { + * // The promise was rejected. + * } + * yield $value . 'c'; + * }); + * + * // Outputs "abc" + * $promise->then(function ($v) { echo $v; }); + * + * @param callable $generatorFn Generator function to wrap into a promise. + * + * @return Promise + * + * @see https://github.com/petkaantonov/bluebird/blob/master/API.md#generators inspiration + */ +final class Coroutine implements PromiseInterface +{ + /** + * @var PromiseInterface|null + */ + private $currentPromise; + + /** + * @var Generator + */ + private $generator; + + /** + * @var Promise + */ + private $result; + + public function __construct(callable $generatorFn) + { + $this->generator = $generatorFn(); + $this->result = new Promise(function (): void { + while (isset($this->currentPromise)) { + $this->currentPromise->wait(); + } + }); + try { + $this->nextCoroutine($this->generator->current()); + } catch (Throwable $throwable) { + $this->result->reject($throwable); + } + } + + /** + * Create a new coroutine. + */ + public static function of(callable $generatorFn): self + { + return new self($generatorFn); + } + + public function then( + ?callable $onFulfilled = null, + ?callable $onRejected = null + ): PromiseInterface { + return $this->result->then($onFulfilled, $onRejected); + } + + public function otherwise(callable $onRejected): PromiseInterface + { + return $this->result->otherwise($onRejected); + } + + public function wait(bool $unwrap = true) + { + return $this->result->wait($unwrap); + } + + public function getState(): string + { + return $this->result->getState(); + } + + public function resolve($value): void + { + $this->result->resolve($value); + } + + public function reject($reason): void + { + $this->result->reject($reason); + } + + public function cancel(): void + { + $this->currentPromise->cancel(); + $this->result->cancel(); + } + + private function nextCoroutine($yielded): void + { + $this->currentPromise = Create::promiseFor($yielded) + ->then([$this, '_handleSuccess'], [$this, '_handleFailure']); + } + + /** + * @internal + */ + public function _handleSuccess($value): void + { + unset($this->currentPromise); + try { + $next = $this->generator->send($value); + if ($this->generator->valid()) { + $this->nextCoroutine($next); + } else { + $this->result->resolve($value); + } + } catch (Throwable $throwable) { + $this->result->reject($throwable); + } + } + + /** + * @internal + */ + public function _handleFailure($reason): void + { + unset($this->currentPromise); + try { + $nextYield = $this->generator->throw(Create::exceptionFor($reason)); + // The throw was caught, so keep iterating on the coroutine + $this->nextCoroutine($nextYield); + } catch (Throwable $throwable) { + $this->result->reject($throwable); + } + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/promises/src/Each.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/promises/src/Each.php new file mode 100644 index 0000000000..dd72c8310b --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/promises/src/Each.php @@ -0,0 +1,81 @@ +<?php + +declare(strict_types=1); + +namespace GuzzleHttp\Promise; + +final class Each +{ + /** + * Given an iterator that yields promises or values, returns a promise that + * is fulfilled with a null value when the iterator has been consumed or + * the aggregate promise has been fulfilled or rejected. + * + * $onFulfilled is a function that accepts the fulfilled value, iterator + * index, and the aggregate promise. The callback can invoke any necessary + * side effects and choose to resolve or reject the aggregate if needed. + * + * $onRejected is a function that accepts the rejection reason, iterator + * index, and the aggregate promise. The callback can invoke any necessary + * side effects and choose to resolve or reject the aggregate if needed. + * + * @param mixed $iterable Iterator or array to iterate over. + */ + public static function of( + $iterable, + ?callable $onFulfilled = null, + ?callable $onRejected = null + ): PromiseInterface { + return (new EachPromise($iterable, [ + 'fulfilled' => $onFulfilled, + 'rejected' => $onRejected, + ]))->promise(); + } + + /** + * Like of, but only allows a certain number of outstanding promises at any + * given time. + * + * $concurrency may be an integer or a function that accepts the number of + * pending promises and returns a numeric concurrency limit value to allow + * for dynamic a concurrency size. + * + * @param mixed $iterable + * @param int|callable $concurrency + */ + public static function ofLimit( + $iterable, + $concurrency, + ?callable $onFulfilled = null, + ?callable $onRejected = null + ): PromiseInterface { + return (new EachPromise($iterable, [ + 'fulfilled' => $onFulfilled, + 'rejected' => $onRejected, + 'concurrency' => $concurrency, + ]))->promise(); + } + + /** + * Like limit, but ensures that no promise in the given $iterable argument + * is rejected. If any promise is rejected, then the aggregate promise is + * rejected with the encountered rejection. + * + * @param mixed $iterable + * @param int|callable $concurrency + */ + public static function ofLimitAll( + $iterable, + $concurrency, + ?callable $onFulfilled = null + ): PromiseInterface { + return self::ofLimit( + $iterable, + $concurrency, + $onFulfilled, + function ($reason, $idx, PromiseInterface $aggregate): void { + $aggregate->reject($reason); + } + ); + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/promises/src/FulfilledPromise.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/promises/src/FulfilledPromise.php new file mode 100644 index 0000000000..727ec315c4 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/promises/src/FulfilledPromise.php @@ -0,0 +1,89 @@ +<?php + +declare(strict_types=1); + +namespace GuzzleHttp\Promise; + +/** + * A promise that has been fulfilled. + * + * Thenning off of this promise will invoke the onFulfilled callback + * immediately and ignore other callbacks. + * + * @final + */ +class FulfilledPromise implements PromiseInterface +{ + private $value; + + /** + * @param mixed $value + */ + public function __construct($value) + { + if (is_object($value) && method_exists($value, 'then')) { + throw new \InvalidArgumentException( + 'You cannot create a FulfilledPromise with a promise.' + ); + } + + $this->value = $value; + } + + public function then( + ?callable $onFulfilled = null, + ?callable $onRejected = null + ): PromiseInterface { + // Return itself if there is no onFulfilled function. + if (!$onFulfilled) { + return $this; + } + + $queue = Utils::queue(); + $p = new Promise([$queue, 'run']); + $value = $this->value; + $queue->add(static function () use ($p, $value, $onFulfilled): void { + if (Is::pending($p)) { + try { + $p->resolve($onFulfilled($value)); + } catch (\Throwable $e) { + $p->reject($e); + } + } + }); + + return $p; + } + + public function otherwise(callable $onRejected): PromiseInterface + { + return $this->then(null, $onRejected); + } + + public function wait(bool $unwrap = true) + { + return $unwrap ? $this->value : null; + } + + public function getState(): string + { + return self::FULFILLED; + } + + public function resolve($value): void + { + if ($value !== $this->value) { + throw new \LogicException('Cannot resolve a fulfilled promise'); + } + } + + public function reject($reason): void + { + throw new \LogicException('Cannot reject a fulfilled promise'); + } + + public function cancel(): void + { + // pass + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/promises/src/Promise.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/promises/src/Promise.php new file mode 100644 index 0000000000..c0c5be2c09 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/promises/src/Promise.php @@ -0,0 +1,281 @@ +<?php + +declare(strict_types=1); + +namespace GuzzleHttp\Promise; + +/** + * Promises/A+ implementation that avoids recursion when possible. + * + * @see https://promisesaplus.com/ + * + * @final + */ +class Promise implements PromiseInterface +{ + private $state = self::PENDING; + private $result; + private $cancelFn; + private $waitFn; + private $waitList; + private $handlers = []; + + /** + * @param callable $waitFn Fn that when invoked resolves the promise. + * @param callable $cancelFn Fn that when invoked cancels the promise. + */ + public function __construct( + ?callable $waitFn = null, + ?callable $cancelFn = null + ) { + $this->waitFn = $waitFn; + $this->cancelFn = $cancelFn; + } + + public function then( + ?callable $onFulfilled = null, + ?callable $onRejected = null + ): PromiseInterface { + if ($this->state === self::PENDING) { + $p = new Promise(null, [$this, 'cancel']); + $this->handlers[] = [$p, $onFulfilled, $onRejected]; + $p->waitList = $this->waitList; + $p->waitList[] = $this; + + return $p; + } + + // Return a fulfilled promise and immediately invoke any callbacks. + if ($this->state === self::FULFILLED) { + $promise = Create::promiseFor($this->result); + + return $onFulfilled ? $promise->then($onFulfilled) : $promise; + } + + // It's either cancelled or rejected, so return a rejected promise + // and immediately invoke any callbacks. + $rejection = Create::rejectionFor($this->result); + + return $onRejected ? $rejection->then(null, $onRejected) : $rejection; + } + + public function otherwise(callable $onRejected): PromiseInterface + { + return $this->then(null, $onRejected); + } + + public function wait(bool $unwrap = true) + { + $this->waitIfPending(); + + if ($this->result instanceof PromiseInterface) { + return $this->result->wait($unwrap); + } + if ($unwrap) { + if ($this->state === self::FULFILLED) { + return $this->result; + } + // It's rejected so "unwrap" and throw an exception. + throw Create::exceptionFor($this->result); + } + } + + public function getState(): string + { + return $this->state; + } + + public function cancel(): void + { + if ($this->state !== self::PENDING) { + return; + } + + $this->waitFn = $this->waitList = null; + + if ($this->cancelFn) { + $fn = $this->cancelFn; + $this->cancelFn = null; + try { + $fn(); + } catch (\Throwable $e) { + $this->reject($e); + } + } + + // Reject the promise only if it wasn't rejected in a then callback. + /** @psalm-suppress RedundantCondition */ + if ($this->state === self::PENDING) { + $this->reject(new CancellationException('Promise has been cancelled')); + } + } + + public function resolve($value): void + { + $this->settle(self::FULFILLED, $value); + } + + public function reject($reason): void + { + $this->settle(self::REJECTED, $reason); + } + + private function settle(string $state, $value): void + { + if ($this->state !== self::PENDING) { + // Ignore calls with the same resolution. + if ($state === $this->state && $value === $this->result) { + return; + } + throw $this->state === $state + ? new \LogicException("The promise is already {$state}.") + : new \LogicException("Cannot change a {$this->state} promise to {$state}"); + } + + if ($value === $this) { + throw new \LogicException('Cannot fulfill or reject a promise with itself'); + } + + // Clear out the state of the promise but stash the handlers. + $this->state = $state; + $this->result = $value; + $handlers = $this->handlers; + $this->handlers = null; + $this->waitList = $this->waitFn = null; + $this->cancelFn = null; + + if (!$handlers) { + return; + } + + // If the value was not a settled promise or a thenable, then resolve + // it in the task queue using the correct ID. + if (!is_object($value) || !method_exists($value, 'then')) { + $id = $state === self::FULFILLED ? 1 : 2; + // It's a success, so resolve the handlers in the queue. + Utils::queue()->add(static function () use ($id, $value, $handlers): void { + foreach ($handlers as $handler) { + self::callHandler($id, $value, $handler); + } + }); + } elseif ($value instanceof Promise && Is::pending($value)) { + // We can just merge our handlers onto the next promise. + $value->handlers = array_merge($value->handlers, $handlers); + } else { + // Resolve the handlers when the forwarded promise is resolved. + $value->then( + static function ($value) use ($handlers): void { + foreach ($handlers as $handler) { + self::callHandler(1, $value, $handler); + } + }, + static function ($reason) use ($handlers): void { + foreach ($handlers as $handler) { + self::callHandler(2, $reason, $handler); + } + } + ); + } + } + + /** + * Call a stack of handlers using a specific callback index and value. + * + * @param int $index 1 (resolve) or 2 (reject). + * @param mixed $value Value to pass to the callback. + * @param array $handler Array of handler data (promise and callbacks). + */ + private static function callHandler(int $index, $value, array $handler): void + { + /** @var PromiseInterface $promise */ + $promise = $handler[0]; + + // The promise may have been cancelled or resolved before placing + // this thunk in the queue. + if (Is::settled($promise)) { + return; + } + + try { + if (isset($handler[$index])) { + /* + * If $f throws an exception, then $handler will be in the exception + * stack trace. Since $handler contains a reference to the callable + * itself we get a circular reference. We clear the $handler + * here to avoid that memory leak. + */ + $f = $handler[$index]; + unset($handler); + $promise->resolve($f($value)); + } elseif ($index === 1) { + // Forward resolution values as-is. + $promise->resolve($value); + } else { + // Forward rejections down the chain. + $promise->reject($value); + } + } catch (\Throwable $reason) { + $promise->reject($reason); + } + } + + private function waitIfPending(): void + { + if ($this->state !== self::PENDING) { + return; + } elseif ($this->waitFn) { + $this->invokeWaitFn(); + } elseif ($this->waitList) { + $this->invokeWaitList(); + } else { + // If there's no wait function, then reject the promise. + $this->reject('Cannot wait on a promise that has ' + .'no internal wait function. You must provide a wait ' + .'function when constructing the promise to be able to ' + .'wait on a promise.'); + } + + Utils::queue()->run(); + + /** @psalm-suppress RedundantCondition */ + if ($this->state === self::PENDING) { + $this->reject('Invoking the wait callback did not resolve the promise'); + } + } + + private function invokeWaitFn(): void + { + try { + $wfn = $this->waitFn; + $this->waitFn = null; + $wfn(true); + } catch (\Throwable $reason) { + if ($this->state === self::PENDING) { + // The promise has not been resolved yet, so reject the promise + // with the exception. + $this->reject($reason); + } else { + // The promise was already resolved, so there's a problem in + // the application. + throw $reason; + } + } + } + + private function invokeWaitList(): void + { + $waitList = $this->waitList; + $this->waitList = null; + + foreach ($waitList as $result) { + do { + $result->waitIfPending(); + $result = $result->result; + } while ($result instanceof Promise); + + if ($result instanceof PromiseInterface) { + $result->wait(false); + } + } + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/promises/src/PromiseInterface.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/promises/src/PromiseInterface.php new file mode 100644 index 0000000000..c11721e4d9 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/promises/src/PromiseInterface.php @@ -0,0 +1,91 @@ +<?php + +declare(strict_types=1); + +namespace GuzzleHttp\Promise; + +/** + * A promise represents the eventual result of an asynchronous operation. + * + * The primary way of interacting with a promise is through its then method, + * which registers callbacks to receive either a promise’s eventual value or + * the reason why the promise cannot be fulfilled. + * + * @see https://promisesaplus.com/ + */ +interface PromiseInterface +{ + public const PENDING = 'pending'; + public const FULFILLED = 'fulfilled'; + public const REJECTED = 'rejected'; + + /** + * Appends fulfillment and rejection handlers to the promise, and returns + * a new promise resolving to the return value of the called handler. + * + * @param callable $onFulfilled Invoked when the promise fulfills. + * @param callable $onRejected Invoked when the promise is rejected. + */ + public function then( + ?callable $onFulfilled = null, + ?callable $onRejected = null + ): PromiseInterface; + + /** + * Appends a rejection handler callback to the promise, and returns a new + * promise resolving to the return value of the callback if it is called, + * or to its original fulfillment value if the promise is instead + * fulfilled. + * + * @param callable $onRejected Invoked when the promise is rejected. + */ + public function otherwise(callable $onRejected): PromiseInterface; + + /** + * Get the state of the promise ("pending", "rejected", or "fulfilled"). + * + * The three states can be checked against the constants defined on + * PromiseInterface: PENDING, FULFILLED, and REJECTED. + */ + public function getState(): string; + + /** + * Resolve the promise with the given value. + * + * @param mixed $value + * + * @throws \RuntimeException if the promise is already resolved. + */ + public function resolve($value): void; + + /** + * Reject the promise with the given reason. + * + * @param mixed $reason + * + * @throws \RuntimeException if the promise is already resolved. + */ + public function reject($reason): void; + + /** + * Cancels the promise if possible. + * + * @see https://github.com/promises-aplus/cancellation-spec/issues/7 + */ + public function cancel(): void; + + /** + * Waits until the promise completes if possible. + * + * Pass $unwrap as true to unwrap the result of the promise, either + * returning the resolved value or throwing the rejected exception. + * + * If the promise cannot be waited on, then the promise will be rejected. + * + * @return mixed + * + * @throws \LogicException if the promise has no wait function or if the + * promise does not settle after waiting. + */ + public function wait(bool $unwrap = true); +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/promises/src/RejectedPromise.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/promises/src/RejectedPromise.php new file mode 100644 index 0000000000..1ebf0b2a62 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/promises/src/RejectedPromise.php @@ -0,0 +1,95 @@ +<?php + +declare(strict_types=1); + +namespace GuzzleHttp\Promise; + +/** + * A promise that has been rejected. + * + * Thenning off of this promise will invoke the onRejected callback + * immediately and ignore other callbacks. + * + * @final + */ +class RejectedPromise implements PromiseInterface +{ + private $reason; + + /** + * @param mixed $reason + */ + public function __construct($reason) + { + if (is_object($reason) && method_exists($reason, 'then')) { + throw new \InvalidArgumentException( + 'You cannot create a RejectedPromise with a promise.' + ); + } + + $this->reason = $reason; + } + + public function then( + ?callable $onFulfilled = null, + ?callable $onRejected = null + ): PromiseInterface { + // If there's no onRejected callback then just return self. + if (!$onRejected) { + return $this; + } + + $queue = Utils::queue(); + $reason = $this->reason; + $p = new Promise([$queue, 'run']); + $queue->add(static function () use ($p, $reason, $onRejected): void { + if (Is::pending($p)) { + try { + // Return a resolved promise if onRejected does not throw. + $p->resolve($onRejected($reason)); + } catch (\Throwable $e) { + // onRejected threw, so return a rejected promise. + $p->reject($e); + } + } + }); + + return $p; + } + + public function otherwise(callable $onRejected): PromiseInterface + { + return $this->then(null, $onRejected); + } + + public function wait(bool $unwrap = true) + { + if ($unwrap) { + throw Create::exceptionFor($this->reason); + } + + return null; + } + + public function getState(): string + { + return self::REJECTED; + } + + public function resolve($value): void + { + throw new \LogicException('Cannot resolve a rejected promise'); + } + + public function reject($reason): void + { + if ($reason !== $this->reason) { + throw new \LogicException('Cannot reject a rejected promise'); + } + } + + public function cancel(): void + { + // pass + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/promises/src/RejectionException.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/promises/src/RejectionException.php new file mode 100644 index 0000000000..47dca86248 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/promises/src/RejectionException.php @@ -0,0 +1,49 @@ +<?php + +declare(strict_types=1); + +namespace GuzzleHttp\Promise; + +/** + * A special exception that is thrown when waiting on a rejected promise. + * + * The reason value is available via the getReason() method. + */ +class RejectionException extends \RuntimeException +{ + /** @var mixed Rejection reason. */ + private $reason; + + /** + * @param mixed $reason Rejection reason. + * @param string|null $description Optional description. + */ + public function __construct($reason, ?string $description = null) + { + $this->reason = $reason; + + $message = 'The promise was rejected'; + + if ($description) { + $message .= ' with reason: '.$description; + } elseif (is_string($reason) + || (is_object($reason) && method_exists($reason, '__toString')) + ) { + $message .= ' with reason: '.$this->reason; + } elseif ($reason instanceof \JsonSerializable) { + $message .= ' with reason: '.json_encode($this->reason, JSON_PRETTY_PRINT); + } + + parent::__construct($message); + } + + /** + * Returns the rejection reason. + * + * @return mixed + */ + public function getReason() + { + return $this->reason; + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/promises/src/Utils.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/promises/src/Utils.php new file mode 100644 index 0000000000..45b0893fcc --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/promises/src/Utils.php @@ -0,0 +1,259 @@ +<?php + +declare(strict_types=1); + +namespace GuzzleHttp\Promise; + +final class Utils +{ + /** + * Get the global task queue used for promise resolution. + * + * This task queue MUST be run in an event loop in order for promises to be + * settled asynchronously. It will be automatically run when synchronously + * waiting on a promise. + * + * <code> + * while ($eventLoop->isRunning()) { + * GuzzleHttp\Promise\Utils::queue()->run(); + * } + * </code> + * + * @param TaskQueueInterface|null $assign Optionally specify a new queue instance. + */ + public static function queue(?TaskQueueInterface $assign = null): TaskQueueInterface + { + static $queue; + + if ($assign) { + $queue = $assign; + } elseif (!$queue) { + $queue = new TaskQueue(); + } + + return $queue; + } + + /** + * Adds a function to run in the task queue when it is next `run()` and + * returns a promise that is fulfilled or rejected with the result. + * + * @param callable $task Task function to run. + */ + public static function task(callable $task): PromiseInterface + { + $queue = self::queue(); + $promise = new Promise([$queue, 'run']); + $queue->add(function () use ($task, $promise): void { + try { + if (Is::pending($promise)) { + $promise->resolve($task()); + } + } catch (\Throwable $e) { + $promise->reject($e); + } + }); + + return $promise; + } + + /** + * Synchronously waits on a promise to resolve and returns an inspection + * state array. + * + * Returns a state associative array containing a "state" key mapping to a + * valid promise state. If the state of the promise is "fulfilled", the + * array will contain a "value" key mapping to the fulfilled value of the + * promise. If the promise is rejected, the array will contain a "reason" + * key mapping to the rejection reason of the promise. + * + * @param PromiseInterface $promise Promise or value. + */ + public static function inspect(PromiseInterface $promise): array + { + try { + return [ + 'state' => PromiseInterface::FULFILLED, + 'value' => $promise->wait(), + ]; + } catch (RejectionException $e) { + return ['state' => PromiseInterface::REJECTED, 'reason' => $e->getReason()]; + } catch (\Throwable $e) { + return ['state' => PromiseInterface::REJECTED, 'reason' => $e]; + } + } + + /** + * Waits on all of the provided promises, but does not unwrap rejected + * promises as thrown exception. + * + * Returns an array of inspection state arrays. + * + * @see inspect for the inspection state array format. + * + * @param PromiseInterface[] $promises Traversable of promises to wait upon. + */ + public static function inspectAll($promises): array + { + $results = []; + foreach ($promises as $key => $promise) { + $results[$key] = self::inspect($promise); + } + + return $results; + } + + /** + * Waits on all of the provided promises and returns the fulfilled values. + * + * Returns an array that contains the value of each promise (in the same + * order the promises were provided). An exception is thrown if any of the + * promises are rejected. + * + * @param iterable<PromiseInterface> $promises Iterable of PromiseInterface objects to wait on. + * + * @throws \Throwable on error + */ + public static function unwrap($promises): array + { + $results = []; + foreach ($promises as $key => $promise) { + $results[$key] = $promise->wait(); + } + + return $results; + } + + /** + * Given an array of promises, return a promise that is fulfilled when all + * the items in the array are fulfilled. + * + * The promise's fulfillment value is an array with fulfillment values at + * respective positions to the original array. If any promise in the array + * rejects, the returned promise is rejected with the rejection reason. + * + * @param mixed $promises Promises or values. + * @param bool $recursive If true, resolves new promises that might have been added to the stack during its own resolution. + */ + public static function all($promises, bool $recursive = false): PromiseInterface + { + $results = []; + $promise = Each::of( + $promises, + function ($value, $idx) use (&$results): void { + $results[$idx] = $value; + }, + function ($reason, $idx, Promise $aggregate): void { + $aggregate->reject($reason); + } + )->then(function () use (&$results) { + ksort($results); + + return $results; + }); + + if (true === $recursive) { + $promise = $promise->then(function ($results) use ($recursive, &$promises) { + foreach ($promises as $promise) { + if (Is::pending($promise)) { + return self::all($promises, $recursive); + } + } + + return $results; + }); + } + + return $promise; + } + + /** + * Initiate a competitive race between multiple promises or values (values + * will become immediately fulfilled promises). + * + * When count amount of promises have been fulfilled, the returned promise + * is fulfilled with an array that contains the fulfillment values of the + * winners in order of resolution. + * + * This promise is rejected with a {@see AggregateException} if the number + * of fulfilled promises is less than the desired $count. + * + * @param int $count Total number of promises. + * @param mixed $promises Promises or values. + */ + public static function some(int $count, $promises): PromiseInterface + { + $results = []; + $rejections = []; + + return Each::of( + $promises, + function ($value, $idx, PromiseInterface $p) use (&$results, $count): void { + if (Is::settled($p)) { + return; + } + $results[$idx] = $value; + if (count($results) >= $count) { + $p->resolve(null); + } + }, + function ($reason) use (&$rejections): void { + $rejections[] = $reason; + } + )->then( + function () use (&$results, &$rejections, $count) { + if (count($results) !== $count) { + throw new AggregateException( + 'Not enough promises to fulfill count', + $rejections + ); + } + ksort($results); + + return array_values($results); + } + ); + } + + /** + * Like some(), with 1 as count. However, if the promise fulfills, the + * fulfillment value is not an array of 1 but the value directly. + * + * @param mixed $promises Promises or values. + */ + public static function any($promises): PromiseInterface + { + return self::some(1, $promises)->then(function ($values) { + return $values[0]; + }); + } + + /** + * Returns a promise that is fulfilled when all of the provided promises have + * been fulfilled or rejected. + * + * The returned promise is fulfilled with an array of inspection state arrays. + * + * @see inspect for the inspection state array format. + * + * @param mixed $promises Promises or values. + */ + public static function settle($promises): PromiseInterface + { + $results = []; + + return Each::of( + $promises, + function ($value, $idx) use (&$results): void { + $results[$idx] = ['state' => PromiseInterface::FULFILLED, 'value' => $value]; + }, + function ($reason, $idx) use (&$results): void { + $results[$idx] = ['state' => PromiseInterface::REJECTED, 'reason' => $reason]; + } + )->then(function () use (&$results) { + ksort($results); + + return $results; + }); + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/psr7/composer.json b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/psr7/composer.json new file mode 100644 index 0000000000..28d15f5714 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/psr7/composer.json @@ -0,0 +1,93 @@ +{ + "name": "guzzlehttp/psr7", + "description": "PSR-7 message implementation that also provides common utility methods", + "keywords": [ + "request", + "response", + "message", + "stream", + "http", + "uri", + "url", + "psr-7" + ], + "license": "MIT", + "authors": [ + { + "name": "Graham Campbell", + "email": "hello@gjcampbell.co.uk", + "homepage": "https://github.com/GrahamCampbell" + }, + { + "name": "Michael Dowling", + "email": "mtdowling@gmail.com", + "homepage": "https://github.com/mtdowling" + }, + { + "name": "George Mponos", + "email": "gmponos@gmail.com", + "homepage": "https://github.com/gmponos" + }, + { + "name": "Tobias Nyholm", + "email": "tobias.nyholm@gmail.com", + "homepage": "https://github.com/Nyholm" + }, + { + "name": "Márk Sági-Kazár", + "email": "mark.sagikazar@gmail.com", + "homepage": "https://github.com/sagikazarmark" + }, + { + "name": "Tobias Schultze", + "email": "webmaster@tubo-world.de", + "homepage": "https://github.com/Tobion" + }, + { + "name": "Márk Sági-Kazár", + "email": "mark.sagikazar@gmail.com", + "homepage": "https://sagikazarmark.hu" + } + ], + "require": { + "php": "^7.2.5 || ^8.0", + "psr/http-factory": "^1.0", + "psr/http-message": "^1.1 || ^2.0", + "ralouphie/getallheaders": "^3.0" + }, + "provide": { + "psr/http-factory-implementation": "1.0", + "psr/http-message-implementation": "1.0" + }, + "require-dev": { + "bamarni/composer-bin-plugin": "^1.8.2", + "http-interop/http-factory-tests": "0.9.0", + "phpunit/phpunit": "^8.5.39 || ^9.6.20" + }, + "suggest": { + "laminas/laminas-httphandlerrunner": "Emit PSR-7 responses" + }, + "autoload": { + "psr-4": { + "GuzzleHttp\\Psr7\\": "src/" + } + }, + "autoload-dev": { + "psr-4": { + "GuzzleHttp\\Tests\\Psr7\\": "tests/" + } + }, + "extra": { + "bamarni-bin": { + "bin-links": true, + "forward-command": false + } + }, + "config": { + "allow-plugins": { + "bamarni/composer-bin-plugin": true + }, + "preferred-install": "dist", + "sort-packages": true + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/psr7/src/CachingStream.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/psr7/src/CachingStream.php new file mode 100644 index 0000000000..7e4554d5c7 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/psr7/src/CachingStream.php @@ -0,0 +1,153 @@ +<?php + +declare(strict_types=1); + +namespace GuzzleHttp\Psr7; + +use Psr\Http\Message\StreamInterface; + +/** + * Stream decorator that can cache previously read bytes from a sequentially + * read stream. + */ +final class CachingStream implements StreamInterface +{ + use StreamDecoratorTrait; + + /** @var StreamInterface Stream being wrapped */ + private $remoteStream; + + /** @var int Number of bytes to skip reading due to a write on the buffer */ + private $skipReadBytes = 0; + + /** + * @var StreamInterface + */ + private $stream; + + /** + * We will treat the buffer object as the body of the stream + * + * @param StreamInterface $stream Stream to cache. The cursor is assumed to be at the beginning of the stream. + * @param StreamInterface $target Optionally specify where data is cached + */ + public function __construct( + StreamInterface $stream, + ?StreamInterface $target = null + ) { + $this->remoteStream = $stream; + $this->stream = $target ?: new Stream(Utils::tryFopen('php://temp', 'r+')); + } + + public function getSize(): ?int + { + $remoteSize = $this->remoteStream->getSize(); + + if (null === $remoteSize) { + return null; + } + + return max($this->stream->getSize(), $remoteSize); + } + + public function rewind(): void + { + $this->seek(0); + } + + public function seek($offset, $whence = SEEK_SET): void + { + if ($whence === SEEK_SET) { + $byte = $offset; + } elseif ($whence === SEEK_CUR) { + $byte = $offset + $this->tell(); + } elseif ($whence === SEEK_END) { + $size = $this->remoteStream->getSize(); + if ($size === null) { + $size = $this->cacheEntireStream(); + } + $byte = $size + $offset; + } else { + throw new \InvalidArgumentException('Invalid whence'); + } + + $diff = $byte - $this->stream->getSize(); + + if ($diff > 0) { + // Read the remoteStream until we have read in at least the amount + // of bytes requested, or we reach the end of the file. + while ($diff > 0 && !$this->remoteStream->eof()) { + $this->read($diff); + $diff = $byte - $this->stream->getSize(); + } + } else { + // We can just do a normal seek since we've already seen this byte. + $this->stream->seek($byte); + } + } + + public function read($length): string + { + // Perform a regular read on any previously read data from the buffer + $data = $this->stream->read($length); + $remaining = $length - strlen($data); + + // More data was requested so read from the remote stream + if ($remaining) { + // If data was written to the buffer in a position that would have + // been filled from the remote stream, then we must skip bytes on + // the remote stream to emulate overwriting bytes from that + // position. This mimics the behavior of other PHP stream wrappers. + $remoteData = $this->remoteStream->read( + $remaining + $this->skipReadBytes + ); + + if ($this->skipReadBytes) { + $len = strlen($remoteData); + $remoteData = substr($remoteData, $this->skipReadBytes); + $this->skipReadBytes = max(0, $this->skipReadBytes - $len); + } + + $data .= $remoteData; + $this->stream->write($remoteData); + } + + return $data; + } + + public function write($string): int + { + // When appending to the end of the currently read stream, you'll want + // to skip bytes from being read from the remote stream to emulate + // other stream wrappers. Basically replacing bytes of data of a fixed + // length. + $overflow = (strlen($string) + $this->tell()) - $this->remoteStream->tell(); + if ($overflow > 0) { + $this->skipReadBytes += $overflow; + } + + return $this->stream->write($string); + } + + public function eof(): bool + { + return $this->stream->eof() && $this->remoteStream->eof(); + } + + /** + * Close both the remote stream and buffer stream + */ + public function close(): void + { + $this->remoteStream->close(); + $this->stream->close(); + } + + private function cacheEntireStream(): int + { + $target = new FnStream(['write' => 'strlen']); + Utils::copyToStream($this, $target); + + return $this->tell(); + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/psr7/src/HttpFactory.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/psr7/src/HttpFactory.php new file mode 100644 index 0000000000..3ef15103a7 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/psr7/src/HttpFactory.php @@ -0,0 +1,94 @@ +<?php + +declare(strict_types=1); + +namespace GuzzleHttp\Psr7; + +use Psr\Http\Message\RequestFactoryInterface; +use Psr\Http\Message\RequestInterface; +use Psr\Http\Message\ResponseFactoryInterface; +use Psr\Http\Message\ResponseInterface; +use Psr\Http\Message\ServerRequestFactoryInterface; +use Psr\Http\Message\ServerRequestInterface; +use Psr\Http\Message\StreamFactoryInterface; +use Psr\Http\Message\StreamInterface; +use Psr\Http\Message\UploadedFileFactoryInterface; +use Psr\Http\Message\UploadedFileInterface; +use Psr\Http\Message\UriFactoryInterface; +use Psr\Http\Message\UriInterface; + +/** + * Implements all of the PSR-17 interfaces. + * + * Note: in consuming code it is recommended to require the implemented interfaces + * and inject the instance of this class multiple times. + */ +final class HttpFactory implements RequestFactoryInterface, ResponseFactoryInterface, ServerRequestFactoryInterface, StreamFactoryInterface, UploadedFileFactoryInterface, UriFactoryInterface +{ + public function createUploadedFile( + StreamInterface $stream, + ?int $size = null, + int $error = \UPLOAD_ERR_OK, + ?string $clientFilename = null, + ?string $clientMediaType = null + ): UploadedFileInterface { + if ($size === null) { + $size = $stream->getSize(); + } + + return new UploadedFile($stream, $size, $error, $clientFilename, $clientMediaType); + } + + public function createStream(string $content = ''): StreamInterface + { + return Utils::streamFor($content); + } + + public function createStreamFromFile(string $file, string $mode = 'r'): StreamInterface + { + try { + $resource = Utils::tryFopen($file, $mode); + } catch (\RuntimeException $e) { + if ('' === $mode || false === \in_array($mode[0], ['r', 'w', 'a', 'x', 'c'], true)) { + throw new \InvalidArgumentException(sprintf('Invalid file opening mode "%s"', $mode), 0, $e); + } + + throw $e; + } + + return Utils::streamFor($resource); + } + + public function createStreamFromResource($resource): StreamInterface + { + return Utils::streamFor($resource); + } + + public function createServerRequest(string $method, $uri, array $serverParams = []): ServerRequestInterface + { + if (empty($method)) { + if (!empty($serverParams['REQUEST_METHOD'])) { + $method = $serverParams['REQUEST_METHOD']; + } else { + throw new \InvalidArgumentException('Cannot determine HTTP method'); + } + } + + return new ServerRequest($method, $uri, [], null, '1.1', $serverParams); + } + + public function createResponse(int $code = 200, string $reasonPhrase = ''): ResponseInterface + { + return new Response($code, [], null, '1.1', $reasonPhrase); + } + + public function createRequest(string $method, $uri): RequestInterface + { + return new Request($method, $uri); + } + + public function createUri(string $uri = ''): UriInterface + { + return new Uri($uri); + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/psr7/src/MultipartStream.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/psr7/src/MultipartStream.php new file mode 100644 index 0000000000..43d718f658 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/psr7/src/MultipartStream.php @@ -0,0 +1,165 @@ +<?php + +declare(strict_types=1); + +namespace GuzzleHttp\Psr7; + +use Psr\Http\Message\StreamInterface; + +/** + * Stream that when read returns bytes for a streaming multipart or + * multipart/form-data stream. + */ +final class MultipartStream implements StreamInterface +{ + use StreamDecoratorTrait; + + /** @var string */ + private $boundary; + + /** @var StreamInterface */ + private $stream; + + /** + * @param array $elements Array of associative arrays, each containing a + * required "name" key mapping to the form field, + * name, a required "contents" key mapping to a + * StreamInterface/resource/string, an optional + * "headers" associative array of custom headers, + * and an optional "filename" key mapping to a + * string to send as the filename in the part. + * @param string $boundary You can optionally provide a specific boundary + * + * @throws \InvalidArgumentException + */ + public function __construct(array $elements = [], ?string $boundary = null) + { + $this->boundary = $boundary ?: bin2hex(random_bytes(20)); + $this->stream = $this->createStream($elements); + } + + public function getBoundary(): string + { + return $this->boundary; + } + + public function isWritable(): bool + { + return false; + } + + /** + * Get the headers needed before transferring the content of a POST file + * + * @param string[] $headers + */ + private function getHeaders(array $headers): string + { + $str = ''; + foreach ($headers as $key => $value) { + $str .= "{$key}: {$value}\r\n"; + } + + return "--{$this->boundary}\r\n".trim($str)."\r\n\r\n"; + } + + /** + * Create the aggregate stream that will be used to upload the POST data + */ + protected function createStream(array $elements = []): StreamInterface + { + $stream = new AppendStream(); + + foreach ($elements as $element) { + if (!is_array($element)) { + throw new \UnexpectedValueException('An array is expected'); + } + $this->addElement($stream, $element); + } + + // Add the trailing boundary with CRLF + $stream->addStream(Utils::streamFor("--{$this->boundary}--\r\n")); + + return $stream; + } + + private function addElement(AppendStream $stream, array $element): void + { + foreach (['contents', 'name'] as $key) { + if (!array_key_exists($key, $element)) { + throw new \InvalidArgumentException("A '{$key}' key is required"); + } + } + + $element['contents'] = Utils::streamFor($element['contents']); + + if (empty($element['filename'])) { + $uri = $element['contents']->getMetadata('uri'); + if ($uri && \is_string($uri) && \substr($uri, 0, 6) !== 'php://' && \substr($uri, 0, 7) !== 'data://') { + $element['filename'] = $uri; + } + } + + [$body, $headers] = $this->createElement( + $element['name'], + $element['contents'], + $element['filename'] ?? null, + $element['headers'] ?? [] + ); + + $stream->addStream(Utils::streamFor($this->getHeaders($headers))); + $stream->addStream($body); + $stream->addStream(Utils::streamFor("\r\n")); + } + + /** + * @param string[] $headers + * + * @return array{0: StreamInterface, 1: string[]} + */ + private function createElement(string $name, StreamInterface $stream, ?string $filename, array $headers): array + { + // Set a default content-disposition header if one was no provided + $disposition = self::getHeader($headers, 'content-disposition'); + if (!$disposition) { + $headers['Content-Disposition'] = ($filename === '0' || $filename) + ? sprintf( + 'form-data; name="%s"; filename="%s"', + $name, + basename($filename) + ) + : "form-data; name=\"{$name}\""; + } + + // Set a default content-length header if one was no provided + $length = self::getHeader($headers, 'content-length'); + if (!$length) { + if ($length = $stream->getSize()) { + $headers['Content-Length'] = (string) $length; + } + } + + // Set a default Content-Type if one was not supplied + $type = self::getHeader($headers, 'content-type'); + if (!$type && ($filename === '0' || $filename)) { + $headers['Content-Type'] = MimeType::fromFilename($filename) ?? 'application/octet-stream'; + } + + return [$stream, $headers]; + } + + /** + * @param string[] $headers + */ + private static function getHeader(array $headers, string $key): ?string + { + $lowercaseHeader = strtolower($key); + foreach ($headers as $k => $v) { + if (strtolower((string) $k) === $lowercaseHeader) { + return $v; + } + } + + return null; + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/psr7/src/Query.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/psr7/src/Query.php new file mode 100644 index 0000000000..ccf867a0bd --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/psr7/src/Query.php @@ -0,0 +1,118 @@ +<?php + +declare(strict_types=1); + +namespace GuzzleHttp\Psr7; + +final class Query +{ + /** + * Parse a query string into an associative array. + * + * If multiple values are found for the same key, the value of that key + * value pair will become an array. This function does not parse nested + * PHP style arrays into an associative array (e.g., `foo[a]=1&foo[b]=2` + * will be parsed into `['foo[a]' => '1', 'foo[b]' => '2'])`. + * + * @param string $str Query string to parse + * @param int|bool $urlEncoding How the query string is encoded + */ + public static function parse(string $str, $urlEncoding = true): array + { + $result = []; + + if ($str === '') { + return $result; + } + + if ($urlEncoding === true) { + $decoder = function ($value) { + return rawurldecode(str_replace('+', ' ', (string) $value)); + }; + } elseif ($urlEncoding === PHP_QUERY_RFC3986) { + $decoder = 'rawurldecode'; + } elseif ($urlEncoding === PHP_QUERY_RFC1738) { + $decoder = 'urldecode'; + } else { + $decoder = function ($str) { + return $str; + }; + } + + foreach (explode('&', $str) as $kvp) { + $parts = explode('=', $kvp, 2); + $key = $decoder($parts[0]); + $value = isset($parts[1]) ? $decoder($parts[1]) : null; + if (!array_key_exists($key, $result)) { + $result[$key] = $value; + } else { + if (!is_array($result[$key])) { + $result[$key] = [$result[$key]]; + } + $result[$key][] = $value; + } + } + + return $result; + } + + /** + * Build a query string from an array of key value pairs. + * + * This function can use the return value of `parse()` to build a query + * string. This function does not modify the provided keys when an array is + * encountered (like `http_build_query()` would). + * + * @param array $params Query string parameters. + * @param int|false $encoding Set to false to not encode, + * PHP_QUERY_RFC3986 to encode using + * RFC3986, or PHP_QUERY_RFC1738 to + * encode using RFC1738. + * @param bool $treatBoolsAsInts Set to true to encode as 0/1, and + * false as false/true. + */ + public static function build(array $params, $encoding = PHP_QUERY_RFC3986, bool $treatBoolsAsInts = true): string + { + if (!$params) { + return ''; + } + + if ($encoding === false) { + $encoder = function (string $str): string { + return $str; + }; + } elseif ($encoding === PHP_QUERY_RFC3986) { + $encoder = 'rawurlencode'; + } elseif ($encoding === PHP_QUERY_RFC1738) { + $encoder = 'urlencode'; + } else { + throw new \InvalidArgumentException('Invalid type'); + } + + $castBool = $treatBoolsAsInts ? static function ($v) { return (int) $v; } : static function ($v) { return $v ? 'true' : 'false'; }; + + $qs = ''; + foreach ($params as $k => $v) { + $k = $encoder((string) $k); + if (!is_array($v)) { + $qs .= $k; + $v = is_bool($v) ? $castBool($v) : $v; + if ($v !== null) { + $qs .= '='.$encoder((string) $v); + } + $qs .= '&'; + } else { + foreach ($v as $vv) { + $qs .= $k; + $vv = is_bool($vv) ? $castBool($vv) : $vv; + if ($vv !== null) { + $qs .= '='.$encoder((string) $vv); + } + $qs .= '&'; + } + } + } + + return $qs ? (string) substr($qs, 0, -1) : ''; + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/psr7/src/Response.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/psr7/src/Response.php new file mode 100644 index 0000000000..34e612fda5 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/psr7/src/Response.php @@ -0,0 +1,161 @@ +<?php + +declare(strict_types=1); + +namespace GuzzleHttp\Psr7; + +use Psr\Http\Message\ResponseInterface; +use Psr\Http\Message\StreamInterface; + +/** + * PSR-7 response implementation. + */ +class Response implements ResponseInterface +{ + use MessageTrait; + + /** Map of standard HTTP status code/reason phrases */ + private const PHRASES = [ + 100 => 'Continue', + 101 => 'Switching Protocols', + 102 => 'Processing', + 200 => 'OK', + 201 => 'Created', + 202 => 'Accepted', + 203 => 'Non-Authoritative Information', + 204 => 'No Content', + 205 => 'Reset Content', + 206 => 'Partial Content', + 207 => 'Multi-status', + 208 => 'Already Reported', + 300 => 'Multiple Choices', + 301 => 'Moved Permanently', + 302 => 'Found', + 303 => 'See Other', + 304 => 'Not Modified', + 305 => 'Use Proxy', + 306 => 'Switch Proxy', + 307 => 'Temporary Redirect', + 308 => 'Permanent Redirect', + 400 => 'Bad Request', + 401 => 'Unauthorized', + 402 => 'Payment Required', + 403 => 'Forbidden', + 404 => 'Not Found', + 405 => 'Method Not Allowed', + 406 => 'Not Acceptable', + 407 => 'Proxy Authentication Required', + 408 => 'Request Time-out', + 409 => 'Conflict', + 410 => 'Gone', + 411 => 'Length Required', + 412 => 'Precondition Failed', + 413 => 'Request Entity Too Large', + 414 => 'Request-URI Too Large', + 415 => 'Unsupported Media Type', + 416 => 'Requested range not satisfiable', + 417 => 'Expectation Failed', + 418 => 'I\'m a teapot', + 422 => 'Unprocessable Entity', + 423 => 'Locked', + 424 => 'Failed Dependency', + 425 => 'Unordered Collection', + 426 => 'Upgrade Required', + 428 => 'Precondition Required', + 429 => 'Too Many Requests', + 431 => 'Request Header Fields Too Large', + 451 => 'Unavailable For Legal Reasons', + 500 => 'Internal Server Error', + 501 => 'Not Implemented', + 502 => 'Bad Gateway', + 503 => 'Service Unavailable', + 504 => 'Gateway Time-out', + 505 => 'HTTP Version not supported', + 506 => 'Variant Also Negotiates', + 507 => 'Insufficient Storage', + 508 => 'Loop Detected', + 510 => 'Not Extended', + 511 => 'Network Authentication Required', + ]; + + /** @var string */ + private $reasonPhrase; + + /** @var int */ + private $statusCode; + + /** + * @param int $status Status code + * @param (string|string[])[] $headers Response headers + * @param string|resource|StreamInterface|null $body Response body + * @param string $version Protocol version + * @param string|null $reason Reason phrase (when empty a default will be used based on the status code) + */ + public function __construct( + int $status = 200, + array $headers = [], + $body = null, + string $version = '1.1', + ?string $reason = null + ) { + $this->assertStatusCodeRange($status); + + $this->statusCode = $status; + + if ($body !== '' && $body !== null) { + $this->stream = Utils::streamFor($body); + } + + $this->setHeaders($headers); + if ($reason == '' && isset(self::PHRASES[$this->statusCode])) { + $this->reasonPhrase = self::PHRASES[$this->statusCode]; + } else { + $this->reasonPhrase = (string) $reason; + } + + $this->protocol = $version; + } + + public function getStatusCode(): int + { + return $this->statusCode; + } + + public function getReasonPhrase(): string + { + return $this->reasonPhrase; + } + + public function withStatus($code, $reasonPhrase = ''): ResponseInterface + { + $this->assertStatusCodeIsInteger($code); + $code = (int) $code; + $this->assertStatusCodeRange($code); + + $new = clone $this; + $new->statusCode = $code; + if ($reasonPhrase == '' && isset(self::PHRASES[$new->statusCode])) { + $reasonPhrase = self::PHRASES[$new->statusCode]; + } + $new->reasonPhrase = (string) $reasonPhrase; + + return $new; + } + + /** + * @param mixed $statusCode + */ + private function assertStatusCodeIsInteger($statusCode): void + { + if (filter_var($statusCode, FILTER_VALIDATE_INT) === false) { + throw new \InvalidArgumentException('Status code must be an integer value.'); + } + } + + private function assertStatusCodeRange(int $statusCode): void + { + if ($statusCode < 100 || $statusCode >= 600) { + throw new \InvalidArgumentException('Status code must be an integer value between 1xx and 5xx.'); + } + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/psr7/src/StreamWrapper.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/psr7/src/StreamWrapper.php new file mode 100644 index 0000000000..77b04d7471 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/psr7/src/StreamWrapper.php @@ -0,0 +1,207 @@ +<?php + +declare(strict_types=1); + +namespace GuzzleHttp\Psr7; + +use Psr\Http\Message\StreamInterface; + +/** + * Converts Guzzle streams into PHP stream resources. + * + * @see https://www.php.net/streamwrapper + */ +final class StreamWrapper +{ + /** @var resource */ + public $context; + + /** @var StreamInterface */ + private $stream; + + /** @var string r, r+, or w */ + private $mode; + + /** + * Returns a resource representing the stream. + * + * @param StreamInterface $stream The stream to get a resource for + * + * @return resource + * + * @throws \InvalidArgumentException if stream is not readable or writable + */ + public static function getResource(StreamInterface $stream) + { + self::register(); + + if ($stream->isReadable()) { + $mode = $stream->isWritable() ? 'r+' : 'r'; + } elseif ($stream->isWritable()) { + $mode = 'w'; + } else { + throw new \InvalidArgumentException('The stream must be readable, ' + .'writable, or both.'); + } + + return fopen('guzzle://stream', $mode, false, self::createStreamContext($stream)); + } + + /** + * Creates a stream context that can be used to open a stream as a php stream resource. + * + * @return resource + */ + public static function createStreamContext(StreamInterface $stream) + { + return stream_context_create([ + 'guzzle' => ['stream' => $stream], + ]); + } + + /** + * Registers the stream wrapper if needed + */ + public static function register(): void + { + if (!in_array('guzzle', stream_get_wrappers())) { + stream_wrapper_register('guzzle', __CLASS__); + } + } + + public function stream_open(string $path, string $mode, int $options, ?string &$opened_path = null): bool + { + $options = stream_context_get_options($this->context); + + if (!isset($options['guzzle']['stream'])) { + return false; + } + + $this->mode = $mode; + $this->stream = $options['guzzle']['stream']; + + return true; + } + + public function stream_read(int $count): string + { + return $this->stream->read($count); + } + + public function stream_write(string $data): int + { + return $this->stream->write($data); + } + + public function stream_tell(): int + { + return $this->stream->tell(); + } + + public function stream_eof(): bool + { + return $this->stream->eof(); + } + + public function stream_seek(int $offset, int $whence): bool + { + $this->stream->seek($offset, $whence); + + return true; + } + + /** + * @return resource|false + */ + public function stream_cast(int $cast_as) + { + $stream = clone $this->stream; + $resource = $stream->detach(); + + return $resource ?? false; + } + + /** + * @return array{ + * dev: int, + * ino: int, + * mode: int, + * nlink: int, + * uid: int, + * gid: int, + * rdev: int, + * size: int, + * atime: int, + * mtime: int, + * ctime: int, + * blksize: int, + * blocks: int + * }|false + */ + public function stream_stat() + { + if ($this->stream->getSize() === null) { + return false; + } + + static $modeMap = [ + 'r' => 33060, + 'rb' => 33060, + 'r+' => 33206, + 'w' => 33188, + 'wb' => 33188, + ]; + + return [ + 'dev' => 0, + 'ino' => 0, + 'mode' => $modeMap[$this->mode], + 'nlink' => 0, + 'uid' => 0, + 'gid' => 0, + 'rdev' => 0, + 'size' => $this->stream->getSize() ?: 0, + 'atime' => 0, + 'mtime' => 0, + 'ctime' => 0, + 'blksize' => 0, + 'blocks' => 0, + ]; + } + + /** + * @return array{ + * dev: int, + * ino: int, + * mode: int, + * nlink: int, + * uid: int, + * gid: int, + * rdev: int, + * size: int, + * atime: int, + * mtime: int, + * ctime: int, + * blksize: int, + * blocks: int + * } + */ + public function url_stat(string $path, int $flags): array + { + return [ + 'dev' => 0, + 'ino' => 0, + 'mode' => 0, + 'nlink' => 0, + 'uid' => 0, + 'gid' => 0, + 'rdev' => 0, + 'size' => 0, + 'atime' => 0, + 'mtime' => 0, + 'ctime' => 0, + 'blksize' => 0, + 'blocks' => 0, + ]; + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/psr7/src/UploadedFile.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/psr7/src/UploadedFile.php new file mode 100644 index 0000000000..9c9ea49fbd --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/psr7/src/UploadedFile.php @@ -0,0 +1,211 @@ +<?php + +declare(strict_types=1); + +namespace GuzzleHttp\Psr7; + +use InvalidArgumentException; +use Psr\Http\Message\StreamInterface; +use Psr\Http\Message\UploadedFileInterface; +use RuntimeException; + +class UploadedFile implements UploadedFileInterface +{ + private const ERRORS = [ + UPLOAD_ERR_OK, + UPLOAD_ERR_INI_SIZE, + UPLOAD_ERR_FORM_SIZE, + UPLOAD_ERR_PARTIAL, + UPLOAD_ERR_NO_FILE, + UPLOAD_ERR_NO_TMP_DIR, + UPLOAD_ERR_CANT_WRITE, + UPLOAD_ERR_EXTENSION, + ]; + + /** + * @var string|null + */ + private $clientFilename; + + /** + * @var string|null + */ + private $clientMediaType; + + /** + * @var int + */ + private $error; + + /** + * @var string|null + */ + private $file; + + /** + * @var bool + */ + private $moved = false; + + /** + * @var int|null + */ + private $size; + + /** + * @var StreamInterface|null + */ + private $stream; + + /** + * @param StreamInterface|string|resource $streamOrFile + */ + public function __construct( + $streamOrFile, + ?int $size, + int $errorStatus, + ?string $clientFilename = null, + ?string $clientMediaType = null + ) { + $this->setError($errorStatus); + $this->size = $size; + $this->clientFilename = $clientFilename; + $this->clientMediaType = $clientMediaType; + + if ($this->isOk()) { + $this->setStreamOrFile($streamOrFile); + } + } + + /** + * Depending on the value set file or stream variable + * + * @param StreamInterface|string|resource $streamOrFile + * + * @throws InvalidArgumentException + */ + private function setStreamOrFile($streamOrFile): void + { + if (is_string($streamOrFile)) { + $this->file = $streamOrFile; + } elseif (is_resource($streamOrFile)) { + $this->stream = new Stream($streamOrFile); + } elseif ($streamOrFile instanceof StreamInterface) { + $this->stream = $streamOrFile; + } else { + throw new InvalidArgumentException( + 'Invalid stream or file provided for UploadedFile' + ); + } + } + + /** + * @throws InvalidArgumentException + */ + private function setError(int $error): void + { + if (false === in_array($error, UploadedFile::ERRORS, true)) { + throw new InvalidArgumentException( + 'Invalid error status for UploadedFile' + ); + } + + $this->error = $error; + } + + private static function isStringNotEmpty($param): bool + { + return is_string($param) && false === empty($param); + } + + /** + * Return true if there is no upload error + */ + private function isOk(): bool + { + return $this->error === UPLOAD_ERR_OK; + } + + public function isMoved(): bool + { + return $this->moved; + } + + /** + * @throws RuntimeException if is moved or not ok + */ + private function validateActive(): void + { + if (false === $this->isOk()) { + throw new RuntimeException('Cannot retrieve stream due to upload error'); + } + + if ($this->isMoved()) { + throw new RuntimeException('Cannot retrieve stream after it has already been moved'); + } + } + + public function getStream(): StreamInterface + { + $this->validateActive(); + + if ($this->stream instanceof StreamInterface) { + return $this->stream; + } + + /** @var string $file */ + $file = $this->file; + + return new LazyOpenStream($file, 'r+'); + } + + public function moveTo($targetPath): void + { + $this->validateActive(); + + if (false === self::isStringNotEmpty($targetPath)) { + throw new InvalidArgumentException( + 'Invalid path provided for move operation; must be a non-empty string' + ); + } + + if ($this->file) { + $this->moved = PHP_SAPI === 'cli' + ? rename($this->file, $targetPath) + : move_uploaded_file($this->file, $targetPath); + } else { + Utils::copyToStream( + $this->getStream(), + new LazyOpenStream($targetPath, 'w') + ); + + $this->moved = true; + } + + if (false === $this->moved) { + throw new RuntimeException( + sprintf('Uploaded file could not be moved to %s', $targetPath) + ); + } + } + + public function getSize(): ?int + { + return $this->size; + } + + public function getError(): int + { + return $this->error; + } + + public function getClientFilename(): ?string + { + return $this->clientFilename; + } + + public function getClientMediaType(): ?string + { + return $this->clientMediaType; + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/psr7/src/Uri.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/psr7/src/Uri.php new file mode 100644 index 0000000000..481dfca946 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/psr7/src/Uri.php @@ -0,0 +1,743 @@ +<?php + +declare(strict_types=1); + +namespace GuzzleHttp\Psr7; + +use GuzzleHttp\Psr7\Exception\MalformedUriException; +use Psr\Http\Message\UriInterface; + +/** + * PSR-7 URI implementation. + * + * @author Michael Dowling + * @author Tobias Schultze + * @author Matthew Weier O'Phinney + */ +class Uri implements UriInterface, \JsonSerializable +{ + /** + * Absolute http and https URIs require a host per RFC 7230 Section 2.7 + * but in generic URIs the host can be empty. So for http(s) URIs + * we apply this default host when no host is given yet to form a + * valid URI. + */ + private const HTTP_DEFAULT_HOST = 'localhost'; + + private const DEFAULT_PORTS = [ + 'http' => 80, + 'https' => 443, + 'ftp' => 21, + 'gopher' => 70, + 'nntp' => 119, + 'news' => 119, + 'telnet' => 23, + 'tn3270' => 23, + 'imap' => 143, + 'pop' => 110, + 'ldap' => 389, + ]; + + /** + * Unreserved characters for use in a regex. + * + * @see https://datatracker.ietf.org/doc/html/rfc3986#section-2.3 + */ + private const CHAR_UNRESERVED = 'a-zA-Z0-9_\-\.~'; + + /** + * Sub-delims for use in a regex. + * + * @see https://datatracker.ietf.org/doc/html/rfc3986#section-2.2 + */ + private const CHAR_SUB_DELIMS = '!\$&\'\(\)\*\+,;='; + private const QUERY_SEPARATORS_REPLACEMENT = ['=' => '%3D', '&' => '%26']; + + /** @var string Uri scheme. */ + private $scheme = ''; + + /** @var string Uri user info. */ + private $userInfo = ''; + + /** @var string Uri host. */ + private $host = ''; + + /** @var int|null Uri port. */ + private $port; + + /** @var string Uri path. */ + private $path = ''; + + /** @var string Uri query string. */ + private $query = ''; + + /** @var string Uri fragment. */ + private $fragment = ''; + + /** @var string|null String representation */ + private $composedComponents; + + public function __construct(string $uri = '') + { + if ($uri !== '') { + $parts = self::parse($uri); + if ($parts === false) { + throw new MalformedUriException("Unable to parse URI: $uri"); + } + $this->applyParts($parts); + } + } + + /** + * UTF-8 aware \parse_url() replacement. + * + * The internal function produces broken output for non ASCII domain names + * (IDN) when used with locales other than "C". + * + * On the other hand, cURL understands IDN correctly only when UTF-8 locale + * is configured ("C.UTF-8", "en_US.UTF-8", etc.). + * + * @see https://bugs.php.net/bug.php?id=52923 + * @see https://www.php.net/manual/en/function.parse-url.php#114817 + * @see https://curl.haxx.se/libcurl/c/CURLOPT_URL.html#ENCODING + * + * @return array|false + */ + private static function parse(string $url) + { + // If IPv6 + $prefix = ''; + if (preg_match('%^(.*://\[[0-9:a-f]+\])(.*?)$%', $url, $matches)) { + /** @var array{0:string, 1:string, 2:string} $matches */ + $prefix = $matches[1]; + $url = $matches[2]; + } + + /** @var string */ + $encodedUrl = preg_replace_callback( + '%[^:/@?&=#]+%usD', + static function ($matches) { + return urlencode($matches[0]); + }, + $url + ); + + $result = parse_url($prefix.$encodedUrl); + + if ($result === false) { + return false; + } + + return array_map('urldecode', $result); + } + + public function __toString(): string + { + if ($this->composedComponents === null) { + $this->composedComponents = self::composeComponents( + $this->scheme, + $this->getAuthority(), + $this->path, + $this->query, + $this->fragment + ); + } + + return $this->composedComponents; + } + + /** + * Composes a URI reference string from its various components. + * + * Usually this method does not need to be called manually but instead is used indirectly via + * `Psr\Http\Message\UriInterface::__toString`. + * + * PSR-7 UriInterface treats an empty component the same as a missing component as + * getQuery(), getFragment() etc. always return a string. This explains the slight + * difference to RFC 3986 Section 5.3. + * + * Another adjustment is that the authority separator is added even when the authority is missing/empty + * for the "file" scheme. This is because PHP stream functions like `file_get_contents` only work with + * `file:///myfile` but not with `file:/myfile` although they are equivalent according to RFC 3986. But + * `file:///` is the more common syntax for the file scheme anyway (Chrome for example redirects to + * that format). + * + * @see https://datatracker.ietf.org/doc/html/rfc3986#section-5.3 + */ + public static function composeComponents(?string $scheme, ?string $authority, string $path, ?string $query, ?string $fragment): string + { + $uri = ''; + + // weak type checks to also accept null until we can add scalar type hints + if ($scheme != '') { + $uri .= $scheme.':'; + } + + if ($authority != '' || $scheme === 'file') { + $uri .= '//'.$authority; + } + + if ($authority != '' && $path != '' && $path[0] != '/') { + $path = '/'.$path; + } + + $uri .= $path; + + if ($query != '') { + $uri .= '?'.$query; + } + + if ($fragment != '') { + $uri .= '#'.$fragment; + } + + return $uri; + } + + /** + * Whether the URI has the default port of the current scheme. + * + * `Psr\Http\Message\UriInterface::getPort` may return null or the standard port. This method can be used + * independently of the implementation. + */ + public static function isDefaultPort(UriInterface $uri): bool + { + return $uri->getPort() === null + || (isset(self::DEFAULT_PORTS[$uri->getScheme()]) && $uri->getPort() === self::DEFAULT_PORTS[$uri->getScheme()]); + } + + /** + * Whether the URI is absolute, i.e. it has a scheme. + * + * An instance of UriInterface can either be an absolute URI or a relative reference. This method returns true + * if it is the former. An absolute URI has a scheme. A relative reference is used to express a URI relative + * to another URI, the base URI. Relative references can be divided into several forms: + * - network-path references, e.g. '//example.com/path' + * - absolute-path references, e.g. '/path' + * - relative-path references, e.g. 'subpath' + * + * @see Uri::isNetworkPathReference + * @see Uri::isAbsolutePathReference + * @see Uri::isRelativePathReference + * @see https://datatracker.ietf.org/doc/html/rfc3986#section-4 + */ + public static function isAbsolute(UriInterface $uri): bool + { + return $uri->getScheme() !== ''; + } + + /** + * Whether the URI is a network-path reference. + * + * A relative reference that begins with two slash characters is termed an network-path reference. + * + * @see https://datatracker.ietf.org/doc/html/rfc3986#section-4.2 + */ + public static function isNetworkPathReference(UriInterface $uri): bool + { + return $uri->getScheme() === '' && $uri->getAuthority() !== ''; + } + + /** + * Whether the URI is a absolute-path reference. + * + * A relative reference that begins with a single slash character is termed an absolute-path reference. + * + * @see https://datatracker.ietf.org/doc/html/rfc3986#section-4.2 + */ + public static function isAbsolutePathReference(UriInterface $uri): bool + { + return $uri->getScheme() === '' + && $uri->getAuthority() === '' + && isset($uri->getPath()[0]) + && $uri->getPath()[0] === '/'; + } + + /** + * Whether the URI is a relative-path reference. + * + * A relative reference that does not begin with a slash character is termed a relative-path reference. + * + * @see https://datatracker.ietf.org/doc/html/rfc3986#section-4.2 + */ + public static function isRelativePathReference(UriInterface $uri): bool + { + return $uri->getScheme() === '' + && $uri->getAuthority() === '' + && (!isset($uri->getPath()[0]) || $uri->getPath()[0] !== '/'); + } + + /** + * Whether the URI is a same-document reference. + * + * A same-document reference refers to a URI that is, aside from its fragment + * component, identical to the base URI. When no base URI is given, only an empty + * URI reference (apart from its fragment) is considered a same-document reference. + * + * @param UriInterface $uri The URI to check + * @param UriInterface|null $base An optional base URI to compare against + * + * @see https://datatracker.ietf.org/doc/html/rfc3986#section-4.4 + */ + public static function isSameDocumentReference(UriInterface $uri, ?UriInterface $base = null): bool + { + if ($base !== null) { + $uri = UriResolver::resolve($base, $uri); + + return ($uri->getScheme() === $base->getScheme()) + && ($uri->getAuthority() === $base->getAuthority()) + && ($uri->getPath() === $base->getPath()) + && ($uri->getQuery() === $base->getQuery()); + } + + return $uri->getScheme() === '' && $uri->getAuthority() === '' && $uri->getPath() === '' && $uri->getQuery() === ''; + } + + /** + * Creates a new URI with a specific query string value removed. + * + * Any existing query string values that exactly match the provided key are + * removed. + * + * @param UriInterface $uri URI to use as a base. + * @param string $key Query string key to remove. + */ + public static function withoutQueryValue(UriInterface $uri, string $key): UriInterface + { + $result = self::getFilteredQueryString($uri, [$key]); + + return $uri->withQuery(implode('&', $result)); + } + + /** + * Creates a new URI with a specific query string value. + * + * Any existing query string values that exactly match the provided key are + * removed and replaced with the given key value pair. + * + * A value of null will set the query string key without a value, e.g. "key" + * instead of "key=value". + * + * @param UriInterface $uri URI to use as a base. + * @param string $key Key to set. + * @param string|null $value Value to set + */ + public static function withQueryValue(UriInterface $uri, string $key, ?string $value): UriInterface + { + $result = self::getFilteredQueryString($uri, [$key]); + + $result[] = self::generateQueryString($key, $value); + + return $uri->withQuery(implode('&', $result)); + } + + /** + * Creates a new URI with multiple specific query string values. + * + * It has the same behavior as withQueryValue() but for an associative array of key => value. + * + * @param UriInterface $uri URI to use as a base. + * @param (string|null)[] $keyValueArray Associative array of key and values + */ + public static function withQueryValues(UriInterface $uri, array $keyValueArray): UriInterface + { + $result = self::getFilteredQueryString($uri, array_keys($keyValueArray)); + + foreach ($keyValueArray as $key => $value) { + $result[] = self::generateQueryString((string) $key, $value !== null ? (string) $value : null); + } + + return $uri->withQuery(implode('&', $result)); + } + + /** + * Creates a URI from a hash of `parse_url` components. + * + * @see https://www.php.net/manual/en/function.parse-url.php + * + * @throws MalformedUriException If the components do not form a valid URI. + */ + public static function fromParts(array $parts): UriInterface + { + $uri = new self(); + $uri->applyParts($parts); + $uri->validateState(); + + return $uri; + } + + public function getScheme(): string + { + return $this->scheme; + } + + public function getAuthority(): string + { + $authority = $this->host; + if ($this->userInfo !== '') { + $authority = $this->userInfo.'@'.$authority; + } + + if ($this->port !== null) { + $authority .= ':'.$this->port; + } + + return $authority; + } + + public function getUserInfo(): string + { + return $this->userInfo; + } + + public function getHost(): string + { + return $this->host; + } + + public function getPort(): ?int + { + return $this->port; + } + + public function getPath(): string + { + return $this->path; + } + + public function getQuery(): string + { + return $this->query; + } + + public function getFragment(): string + { + return $this->fragment; + } + + public function withScheme($scheme): UriInterface + { + $scheme = $this->filterScheme($scheme); + + if ($this->scheme === $scheme) { + return $this; + } + + $new = clone $this; + $new->scheme = $scheme; + $new->composedComponents = null; + $new->removeDefaultPort(); + $new->validateState(); + + return $new; + } + + public function withUserInfo($user, $password = null): UriInterface + { + $info = $this->filterUserInfoComponent($user); + if ($password !== null) { + $info .= ':'.$this->filterUserInfoComponent($password); + } + + if ($this->userInfo === $info) { + return $this; + } + + $new = clone $this; + $new->userInfo = $info; + $new->composedComponents = null; + $new->validateState(); + + return $new; + } + + public function withHost($host): UriInterface + { + $host = $this->filterHost($host); + + if ($this->host === $host) { + return $this; + } + + $new = clone $this; + $new->host = $host; + $new->composedComponents = null; + $new->validateState(); + + return $new; + } + + public function withPort($port): UriInterface + { + $port = $this->filterPort($port); + + if ($this->port === $port) { + return $this; + } + + $new = clone $this; + $new->port = $port; + $new->composedComponents = null; + $new->removeDefaultPort(); + $new->validateState(); + + return $new; + } + + public function withPath($path): UriInterface + { + $path = $this->filterPath($path); + + if ($this->path === $path) { + return $this; + } + + $new = clone $this; + $new->path = $path; + $new->composedComponents = null; + $new->validateState(); + + return $new; + } + + public function withQuery($query): UriInterface + { + $query = $this->filterQueryAndFragment($query); + + if ($this->query === $query) { + return $this; + } + + $new = clone $this; + $new->query = $query; + $new->composedComponents = null; + + return $new; + } + + public function withFragment($fragment): UriInterface + { + $fragment = $this->filterQueryAndFragment($fragment); + + if ($this->fragment === $fragment) { + return $this; + } + + $new = clone $this; + $new->fragment = $fragment; + $new->composedComponents = null; + + return $new; + } + + public function jsonSerialize(): string + { + return $this->__toString(); + } + + /** + * Apply parse_url parts to a URI. + * + * @param array $parts Array of parse_url parts to apply. + */ + private function applyParts(array $parts): void + { + $this->scheme = isset($parts['scheme']) + ? $this->filterScheme($parts['scheme']) + : ''; + $this->userInfo = isset($parts['user']) + ? $this->filterUserInfoComponent($parts['user']) + : ''; + $this->host = isset($parts['host']) + ? $this->filterHost($parts['host']) + : ''; + $this->port = isset($parts['port']) + ? $this->filterPort($parts['port']) + : null; + $this->path = isset($parts['path']) + ? $this->filterPath($parts['path']) + : ''; + $this->query = isset($parts['query']) + ? $this->filterQueryAndFragment($parts['query']) + : ''; + $this->fragment = isset($parts['fragment']) + ? $this->filterQueryAndFragment($parts['fragment']) + : ''; + if (isset($parts['pass'])) { + $this->userInfo .= ':'.$this->filterUserInfoComponent($parts['pass']); + } + + $this->removeDefaultPort(); + } + + /** + * @param mixed $scheme + * + * @throws \InvalidArgumentException If the scheme is invalid. + */ + private function filterScheme($scheme): string + { + if (!is_string($scheme)) { + throw new \InvalidArgumentException('Scheme must be a string'); + } + + return \strtr($scheme, 'ABCDEFGHIJKLMNOPQRSTUVWXYZ', 'abcdefghijklmnopqrstuvwxyz'); + } + + /** + * @param mixed $component + * + * @throws \InvalidArgumentException If the user info is invalid. + */ + private function filterUserInfoComponent($component): string + { + if (!is_string($component)) { + throw new \InvalidArgumentException('User info must be a string'); + } + + return preg_replace_callback( + '/(?:[^%'.self::CHAR_UNRESERVED.self::CHAR_SUB_DELIMS.']+|%(?![A-Fa-f0-9]{2}))/', + [$this, 'rawurlencodeMatchZero'], + $component + ); + } + + /** + * @param mixed $host + * + * @throws \InvalidArgumentException If the host is invalid. + */ + private function filterHost($host): string + { + if (!is_string($host)) { + throw new \InvalidArgumentException('Host must be a string'); + } + + return \strtr($host, 'ABCDEFGHIJKLMNOPQRSTUVWXYZ', 'abcdefghijklmnopqrstuvwxyz'); + } + + /** + * @param mixed $port + * + * @throws \InvalidArgumentException If the port is invalid. + */ + private function filterPort($port): ?int + { + if ($port === null) { + return null; + } + + $port = (int) $port; + if (0 > $port || 0xFFFF < $port) { + throw new \InvalidArgumentException( + sprintf('Invalid port: %d. Must be between 0 and 65535', $port) + ); + } + + return $port; + } + + /** + * @param (string|int)[] $keys + * + * @return string[] + */ + private static function getFilteredQueryString(UriInterface $uri, array $keys): array + { + $current = $uri->getQuery(); + + if ($current === '') { + return []; + } + + $decodedKeys = array_map(function ($k): string { + return rawurldecode((string) $k); + }, $keys); + + return array_filter(explode('&', $current), function ($part) use ($decodedKeys) { + return !in_array(rawurldecode(explode('=', $part)[0]), $decodedKeys, true); + }); + } + + private static function generateQueryString(string $key, ?string $value): string + { + // Query string separators ("=", "&") within the key or value need to be encoded + // (while preventing double-encoding) before setting the query string. All other + // chars that need percent-encoding will be encoded by withQuery(). + $queryString = strtr($key, self::QUERY_SEPARATORS_REPLACEMENT); + + if ($value !== null) { + $queryString .= '='.strtr($value, self::QUERY_SEPARATORS_REPLACEMENT); + } + + return $queryString; + } + + private function removeDefaultPort(): void + { + if ($this->port !== null && self::isDefaultPort($this)) { + $this->port = null; + } + } + + /** + * Filters the path of a URI + * + * @param mixed $path + * + * @throws \InvalidArgumentException If the path is invalid. + */ + private function filterPath($path): string + { + if (!is_string($path)) { + throw new \InvalidArgumentException('Path must be a string'); + } + + return preg_replace_callback( + '/(?:[^'.self::CHAR_UNRESERVED.self::CHAR_SUB_DELIMS.'%:@\/]++|%(?![A-Fa-f0-9]{2}))/', + [$this, 'rawurlencodeMatchZero'], + $path + ); + } + + /** + * Filters the query string or fragment of a URI. + * + * @param mixed $str + * + * @throws \InvalidArgumentException If the query or fragment is invalid. + */ + private function filterQueryAndFragment($str): string + { + if (!is_string($str)) { + throw new \InvalidArgumentException('Query and fragment must be a string'); + } + + return preg_replace_callback( + '/(?:[^'.self::CHAR_UNRESERVED.self::CHAR_SUB_DELIMS.'%:@\/\?]++|%(?![A-Fa-f0-9]{2}))/', + [$this, 'rawurlencodeMatchZero'], + $str + ); + } + + private function rawurlencodeMatchZero(array $match): string + { + return rawurlencode($match[0]); + } + + private function validateState(): void + { + if ($this->host === '' && ($this->scheme === 'http' || $this->scheme === 'https')) { + $this->host = self::HTTP_DEFAULT_HOST; + } + + if ($this->getAuthority() === '') { + if (0 === strpos($this->path, '//')) { + throw new MalformedUriException('The path of a URI without an authority must not start with two slashes "//"'); + } + if ($this->scheme === '' && false !== strpos(explode('/', $this->path, 2)[0], ':')) { + throw new MalformedUriException('A relative URI must not have a path beginning with a segment containing a colon'); + } + } + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/psr7/src/Utils.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/psr7/src/Utils.php new file mode 100644 index 0000000000..7682d2cdc7 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/psr7/src/Utils.php @@ -0,0 +1,477 @@ +<?php + +declare(strict_types=1); + +namespace GuzzleHttp\Psr7; + +use Psr\Http\Message\RequestInterface; +use Psr\Http\Message\ServerRequestInterface; +use Psr\Http\Message\StreamInterface; +use Psr\Http\Message\UriInterface; + +final class Utils +{ + /** + * Remove the items given by the keys, case insensitively from the data. + * + * @param (string|int)[] $keys + */ + public static function caselessRemove(array $keys, array $data): array + { + $result = []; + + foreach ($keys as &$key) { + $key = strtolower((string) $key); + } + + foreach ($data as $k => $v) { + if (!in_array(strtolower((string) $k), $keys)) { + $result[$k] = $v; + } + } + + return $result; + } + + /** + * Copy the contents of a stream into another stream until the given number + * of bytes have been read. + * + * @param StreamInterface $source Stream to read from + * @param StreamInterface $dest Stream to write to + * @param int $maxLen Maximum number of bytes to read. Pass -1 + * to read the entire stream. + * + * @throws \RuntimeException on error. + */ + public static function copyToStream(StreamInterface $source, StreamInterface $dest, int $maxLen = -1): void + { + $bufferSize = 8192; + + if ($maxLen === -1) { + while (!$source->eof()) { + if (!$dest->write($source->read($bufferSize))) { + break; + } + } + } else { + $remaining = $maxLen; + while ($remaining > 0 && !$source->eof()) { + $buf = $source->read(min($bufferSize, $remaining)); + $len = strlen($buf); + if (!$len) { + break; + } + $remaining -= $len; + $dest->write($buf); + } + } + } + + /** + * Copy the contents of a stream into a string until the given number of + * bytes have been read. + * + * @param StreamInterface $stream Stream to read + * @param int $maxLen Maximum number of bytes to read. Pass -1 + * to read the entire stream. + * + * @throws \RuntimeException on error. + */ + public static function copyToString(StreamInterface $stream, int $maxLen = -1): string + { + $buffer = ''; + + if ($maxLen === -1) { + while (!$stream->eof()) { + $buf = $stream->read(1048576); + if ($buf === '') { + break; + } + $buffer .= $buf; + } + + return $buffer; + } + + $len = 0; + while (!$stream->eof() && $len < $maxLen) { + $buf = $stream->read($maxLen - $len); + if ($buf === '') { + break; + } + $buffer .= $buf; + $len = strlen($buffer); + } + + return $buffer; + } + + /** + * Calculate a hash of a stream. + * + * This method reads the entire stream to calculate a rolling hash, based + * on PHP's `hash_init` functions. + * + * @param StreamInterface $stream Stream to calculate the hash for + * @param string $algo Hash algorithm (e.g. md5, crc32, etc) + * @param bool $rawOutput Whether or not to use raw output + * + * @throws \RuntimeException on error. + */ + public static function hash(StreamInterface $stream, string $algo, bool $rawOutput = false): string + { + $pos = $stream->tell(); + + if ($pos > 0) { + $stream->rewind(); + } + + $ctx = hash_init($algo); + while (!$stream->eof()) { + hash_update($ctx, $stream->read(1048576)); + } + + $out = hash_final($ctx, $rawOutput); + $stream->seek($pos); + + return $out; + } + + /** + * Clone and modify a request with the given changes. + * + * This method is useful for reducing the number of clones needed to mutate + * a message. + * + * The changes can be one of: + * - method: (string) Changes the HTTP method. + * - set_headers: (array) Sets the given headers. + * - remove_headers: (array) Remove the given headers. + * - body: (mixed) Sets the given body. + * - uri: (UriInterface) Set the URI. + * - query: (string) Set the query string value of the URI. + * - version: (string) Set the protocol version. + * + * @param RequestInterface $request Request to clone and modify. + * @param array $changes Changes to apply. + */ + public static function modifyRequest(RequestInterface $request, array $changes): RequestInterface + { + if (!$changes) { + return $request; + } + + $headers = $request->getHeaders(); + + if (!isset($changes['uri'])) { + $uri = $request->getUri(); + } else { + // Remove the host header if one is on the URI + if ($host = $changes['uri']->getHost()) { + $changes['set_headers']['Host'] = $host; + + if ($port = $changes['uri']->getPort()) { + $standardPorts = ['http' => 80, 'https' => 443]; + $scheme = $changes['uri']->getScheme(); + if (isset($standardPorts[$scheme]) && $port != $standardPorts[$scheme]) { + $changes['set_headers']['Host'] .= ':'.$port; + } + } + } + $uri = $changes['uri']; + } + + if (!empty($changes['remove_headers'])) { + $headers = self::caselessRemove($changes['remove_headers'], $headers); + } + + if (!empty($changes['set_headers'])) { + $headers = self::caselessRemove(array_keys($changes['set_headers']), $headers); + $headers = $changes['set_headers'] + $headers; + } + + if (isset($changes['query'])) { + $uri = $uri->withQuery($changes['query']); + } + + if ($request instanceof ServerRequestInterface) { + $new = (new ServerRequest( + $changes['method'] ?? $request->getMethod(), + $uri, + $headers, + $changes['body'] ?? $request->getBody(), + $changes['version'] ?? $request->getProtocolVersion(), + $request->getServerParams() + )) + ->withParsedBody($request->getParsedBody()) + ->withQueryParams($request->getQueryParams()) + ->withCookieParams($request->getCookieParams()) + ->withUploadedFiles($request->getUploadedFiles()); + + foreach ($request->getAttributes() as $key => $value) { + $new = $new->withAttribute($key, $value); + } + + return $new; + } + + return new Request( + $changes['method'] ?? $request->getMethod(), + $uri, + $headers, + $changes['body'] ?? $request->getBody(), + $changes['version'] ?? $request->getProtocolVersion() + ); + } + + /** + * Read a line from the stream up to the maximum allowed buffer length. + * + * @param StreamInterface $stream Stream to read from + * @param int|null $maxLength Maximum buffer length + */ + public static function readLine(StreamInterface $stream, ?int $maxLength = null): string + { + $buffer = ''; + $size = 0; + + while (!$stream->eof()) { + if ('' === ($byte = $stream->read(1))) { + return $buffer; + } + $buffer .= $byte; + // Break when a new line is found or the max length - 1 is reached + if ($byte === "\n" || ++$size === $maxLength - 1) { + break; + } + } + + return $buffer; + } + + /** + * Redact the password in the user info part of a URI. + */ + public static function redactUserInfo(UriInterface $uri): UriInterface + { + $userInfo = $uri->getUserInfo(); + + if (false !== ($pos = \strpos($userInfo, ':'))) { + return $uri->withUserInfo(\substr($userInfo, 0, $pos), '***'); + } + + return $uri; + } + + /** + * Create a new stream based on the input type. + * + * Options is an associative array that can contain the following keys: + * - metadata: Array of custom metadata. + * - size: Size of the stream. + * + * This method accepts the following `$resource` types: + * - `Psr\Http\Message\StreamInterface`: Returns the value as-is. + * - `string`: Creates a stream object that uses the given string as the contents. + * - `resource`: Creates a stream object that wraps the given PHP stream resource. + * - `Iterator`: If the provided value implements `Iterator`, then a read-only + * stream object will be created that wraps the given iterable. Each time the + * stream is read from, data from the iterator will fill a buffer and will be + * continuously called until the buffer is equal to the requested read size. + * Subsequent read calls will first read from the buffer and then call `next` + * on the underlying iterator until it is exhausted. + * - `object` with `__toString()`: If the object has the `__toString()` method, + * the object will be cast to a string and then a stream will be returned that + * uses the string value. + * - `NULL`: When `null` is passed, an empty stream object is returned. + * - `callable` When a callable is passed, a read-only stream object will be + * created that invokes the given callable. The callable is invoked with the + * number of suggested bytes to read. The callable can return any number of + * bytes, but MUST return `false` when there is no more data to return. The + * stream object that wraps the callable will invoke the callable until the + * number of requested bytes are available. Any additional bytes will be + * buffered and used in subsequent reads. + * + * @param resource|string|int|float|bool|StreamInterface|callable|\Iterator|null $resource Entity body data + * @param array{size?: int, metadata?: array} $options Additional options + * + * @throws \InvalidArgumentException if the $resource arg is not valid. + */ + public static function streamFor($resource = '', array $options = []): StreamInterface + { + if (is_scalar($resource)) { + $stream = self::tryFopen('php://temp', 'r+'); + if ($resource !== '') { + fwrite($stream, (string) $resource); + fseek($stream, 0); + } + + return new Stream($stream, $options); + } + + switch (gettype($resource)) { + case 'resource': + /* + * The 'php://input' is a special stream with quirks and inconsistencies. + * We avoid using that stream by reading it into php://temp + */ + + /** @var resource $resource */ + if ((\stream_get_meta_data($resource)['uri'] ?? '') === 'php://input') { + $stream = self::tryFopen('php://temp', 'w+'); + stream_copy_to_stream($resource, $stream); + fseek($stream, 0); + $resource = $stream; + } + + return new Stream($resource, $options); + case 'object': + /** @var object $resource */ + if ($resource instanceof StreamInterface) { + return $resource; + } elseif ($resource instanceof \Iterator) { + return new PumpStream(function () use ($resource) { + if (!$resource->valid()) { + return false; + } + $result = $resource->current(); + $resource->next(); + + return $result; + }, $options); + } elseif (method_exists($resource, '__toString')) { + return self::streamFor((string) $resource, $options); + } + break; + case 'NULL': + return new Stream(self::tryFopen('php://temp', 'r+'), $options); + } + + if (is_callable($resource)) { + return new PumpStream($resource, $options); + } + + throw new \InvalidArgumentException('Invalid resource type: '.gettype($resource)); + } + + /** + * Safely opens a PHP stream resource using a filename. + * + * When fopen fails, PHP normally raises a warning. This function adds an + * error handler that checks for errors and throws an exception instead. + * + * @param string $filename File to open + * @param string $mode Mode used to open the file + * + * @return resource + * + * @throws \RuntimeException if the file cannot be opened + */ + public static function tryFopen(string $filename, string $mode) + { + $ex = null; + set_error_handler(static function (int $errno, string $errstr) use ($filename, $mode, &$ex): bool { + $ex = new \RuntimeException(sprintf( + 'Unable to open "%s" using mode "%s": %s', + $filename, + $mode, + $errstr + )); + + return true; + }); + + try { + /** @var resource $handle */ + $handle = fopen($filename, $mode); + } catch (\Throwable $e) { + $ex = new \RuntimeException(sprintf( + 'Unable to open "%s" using mode "%s": %s', + $filename, + $mode, + $e->getMessage() + ), 0, $e); + } + + restore_error_handler(); + + if ($ex) { + /** @var $ex \RuntimeException */ + throw $ex; + } + + return $handle; + } + + /** + * Safely gets the contents of a given stream. + * + * When stream_get_contents fails, PHP normally raises a warning. This + * function adds an error handler that checks for errors and throws an + * exception instead. + * + * @param resource $stream + * + * @throws \RuntimeException if the stream cannot be read + */ + public static function tryGetContents($stream): string + { + $ex = null; + set_error_handler(static function (int $errno, string $errstr) use (&$ex): bool { + $ex = new \RuntimeException(sprintf( + 'Unable to read stream contents: %s', + $errstr + )); + + return true; + }); + + try { + /** @var string|false $contents */ + $contents = stream_get_contents($stream); + + if ($contents === false) { + $ex = new \RuntimeException('Unable to read stream contents'); + } + } catch (\Throwable $e) { + $ex = new \RuntimeException(sprintf( + 'Unable to read stream contents: %s', + $e->getMessage() + ), 0, $e); + } + + restore_error_handler(); + + if ($ex) { + /** @var $ex \RuntimeException */ + throw $ex; + } + + return $contents; + } + + /** + * Returns a UriInterface for the given value. + * + * This function accepts a string or UriInterface and returns a + * UriInterface for the given value. If the value is already a + * UriInterface, it is returned as-is. + * + * @param string|UriInterface $uri + * + * @throws \InvalidArgumentException + */ + public static function uriFor($uri): UriInterface + { + if ($uri instanceof UriInterface) { + return $uri; + } + + if (is_string($uri)) { + return new Uri($uri); + } + + throw new \InvalidArgumentException('URI must be a string or UriInterface'); + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/matthiasmullie/minify/src/CSS.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/matthiasmullie/minify/src/CSS.php new file mode 100644 index 0000000000..4f56320c47 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/matthiasmullie/minify/src/CSS.php @@ -0,0 +1,870 @@ +<?php + +/** + * CSS Minifier. + * + * Please report bugs on https://github.com/matthiasmullie/minify/issues + * + * @author Matthias Mullie <minify@mullie.eu> + * @copyright Copyright (c) 2012, Matthias Mullie. All rights reserved + * @license MIT License + */ + +namespace MatthiasMullie\Minify; + +use MatthiasMullie\Minify\Exceptions\FileImportException; +use MatthiasMullie\PathConverter\Converter; +use MatthiasMullie\PathConverter\ConverterInterface; + +/** + * CSS minifier. + * + * Please report bugs on https://github.com/matthiasmullie/minify/issues + * + * @author Matthias Mullie <minify@mullie.eu> + * @author Tijs Verkoyen <minify@verkoyen.eu> + * @copyright Copyright (c) 2012, Matthias Mullie. All rights reserved + * @license MIT License + */ +class CSS extends Minify +{ + /** + * @var int maximum inport size in kB + */ + protected $maxImportSize = 5; + + /** + * @var string[] valid import extensions + */ + protected $importExtensions = array( + 'gif' => 'data:image/gif', + 'png' => 'data:image/png', + 'jpe' => 'data:image/jpeg', + 'jpg' => 'data:image/jpeg', + 'jpeg' => 'data:image/jpeg', + 'svg' => 'data:image/svg+xml', + 'woff' => 'data:application/x-font-woff', + 'woff2' => 'data:application/x-font-woff2', + 'avif' => 'data:image/avif', + 'apng' => 'data:image/apng', + 'webp' => 'data:image/webp', + 'tif' => 'image/tiff', + 'tiff' => 'image/tiff', + 'xbm' => 'image/x-xbitmap', + ); + + /** + * Set the maximum size if files to be imported. + * + * Files larger than this size (in kB) will not be imported into the CSS. + * Importing files into the CSS as data-uri will save you some connections, + * but we should only import relatively small decorative images so that our + * CSS file doesn't get too bulky. + * + * @param int $size Size in kB + */ + public function setMaxImportSize($size) + { + $this->maxImportSize = $size; + } + + /** + * Set the type of extensions to be imported into the CSS (to save network + * connections). + * Keys of the array should be the file extensions & respective values + * should be the data type. + * + * @param string[] $extensions Array of file extensions + */ + public function setImportExtensions(array $extensions) + { + $this->importExtensions = $extensions; + } + + /** + * Move any import statements to the top. + * + * @param string $content Nearly finished CSS content + * + * @return string + */ + protected function moveImportsToTop($content) + { + if (preg_match_all('/(;?)(@import (?<url>url\()?(?P<quotes>["\']?).+?(?P=quotes)(?(url)\)));?/', $content, $matches)) { + // remove from content + foreach ($matches[0] as $import) { + $content = str_replace($import, '', $content); + } + + // add to top + $content = implode(';', $matches[2]) . ';' . trim($content, ';'); + } + + return $content; + } + + /** + * Combine CSS from import statements. + * + * \@import's will be loaded and their content merged into the original file, + * to save HTTP requests. + * + * @param string $source The file to combine imports for + * @param string $content The CSS content to combine imports for + * @param string[] $parents Parent paths, for circular reference checks + * + * @return string + * + * @throws FileImportException + */ + protected function combineImports($source, $content, $parents) + { + $importRegexes = array( + // @import url(xxx) + '/ + # import statement + @import + + # whitespace + \s+ + + # open url() + url\( + + # (optional) open path enclosure + (?P<quotes>["\']?) + + # fetch path + (?P<path>.+?) + + # (optional) close path enclosure + (?P=quotes) + + # close url() + \) + + # (optional) trailing whitespace + \s* + + # (optional) media statement(s) + (?P<media>[^;]*) + + # (optional) trailing whitespace + \s* + + # (optional) closing semi-colon + ;? + + /ix', + + // @import 'xxx' + '/ + + # import statement + @import + + # whitespace + \s+ + + # open path enclosure + (?P<quotes>["\']) + + # fetch path + (?P<path>.+?) + + # close path enclosure + (?P=quotes) + + # (optional) trailing whitespace + \s* + + # (optional) media statement(s) + (?P<media>[^;]*) + + # (optional) trailing whitespace + \s* + + # (optional) closing semi-colon + ;? + + /ix', + ); + + // find all relative imports in css + $matches = array(); + foreach ($importRegexes as $importRegex) { + if (preg_match_all($importRegex, $content, $regexMatches, PREG_SET_ORDER)) { + $matches = array_merge($matches, $regexMatches); + } + } + + $search = array(); + $replace = array(); + + // loop the matches + foreach ($matches as $match) { + // get the path for the file that will be imported + $importPath = dirname($source) . '/' . $match['path']; + + // only replace the import with the content if we can grab the + // content of the file + if (!$this->canImportByPath($match['path']) || !$this->canImportFile($importPath)) { + continue; + } + + // check if current file was not imported previously in the same + // import chain. + if (in_array($importPath, $parents)) { + throw new FileImportException('Failed to import file "' . $importPath . '": circular reference detected.'); + } + + // grab referenced file & minify it (which may include importing + // yet other @import statements recursively) + $minifier = new self($importPath); + $minifier->setMaxImportSize($this->maxImportSize); + $minifier->setImportExtensions($this->importExtensions); + $importContent = $minifier->execute($source, $parents); + + // check if this is only valid for certain media + if (!empty($match['media'])) { + $importContent = '@media ' . $match['media'] . '{' . $importContent . '}'; + } + + // add to replacement array + $search[] = $match[0]; + $replace[] = $importContent; + } + + // replace the import statements + return str_replace($search, $replace, $content); + } + + /** + * Import files into the CSS, base64-ized. + * + * @url(image.jpg) images will be loaded and their content merged into the + * original file, to save HTTP requests. + * + * @param string $source The file to import files for + * @param string $content The CSS content to import files for + * + * @return string + */ + protected function importFiles($source, $content) + { + $regex = '/url\((["\']?)(.+?)\\1\)/i'; + if ($this->importExtensions && preg_match_all($regex, $content, $matches, PREG_SET_ORDER)) { + $search = array(); + $replace = array(); + + // loop the matches + foreach ($matches as $match) { + $extension = substr(strrchr($match[2], '.'), 1); + if ($extension && !array_key_exists($extension, $this->importExtensions)) { + continue; + } + + // get the path for the file that will be imported + $path = $match[2]; + $path = dirname($source) . '/' . $path; + + // only replace the import with the content if we're able to get + // the content of the file, and it's relatively small + if ($this->canImportFile($path) && $this->canImportBySize($path)) { + // grab content && base64-ize + $importContent = $this->load($path); + $importContent = base64_encode($importContent); + + // build replacement + $search[] = $match[0]; + $replace[] = 'url(' . $this->importExtensions[$extension] . ';base64,' . $importContent . ')'; + } + } + + // replace the import statements + $content = str_replace($search, $replace, $content); + } + + return $content; + } + + /** + * Minify the data. + * Perform CSS optimizations. + * + * @param string[optional] $path Path to write the data to + * @param string[] $parents Parent paths, for circular reference checks + * + * @return string The minified data + */ + public function execute($path = null, $parents = array()) + { + $content = ''; + + // loop CSS data (raw data and files) + foreach ($this->data as $source => $css) { + /* + * Let's first take out strings & comments, since we can't just + * remove whitespace anywhere. If whitespace occurs inside a string, + * we should leave it alone. E.g.: + * p { content: "a test" } + */ + $this->extractStrings(); + $this->stripComments(); + $this->extractMath(); + $this->extractCustomProperties(); + $css = $this->replace($css); + + $css = $this->stripWhitespace($css); + $css = $this->convertLegacyColors($css); + $css = $this->cleanupModernColors($css); + $css = $this->shortenHEXColors($css); + $css = $this->shortenZeroes($css); + $css = $this->shortenFontWeights($css); + $css = $this->stripEmptyTags($css); + + // restore the string we've extracted earlier + $css = $this->restoreExtractedData($css); + + $source = is_int($source) ? '' : $source; + $parents = $source ? array_merge($parents, array($source)) : $parents; + $css = $this->combineImports($source, $css, $parents); + $css = $this->importFiles($source, $css); + + /* + * If we'll save to a new path, we'll have to fix the relative paths + * to be relative no longer to the source file, but to the new path. + * If we don't write to a file, fall back to same path so no + * conversion happens (because we still want it to go through most + * of the move code, which also addresses url() & @import syntax...) + */ + $converter = $this->getPathConverter($source, $path ?: $source); + $css = $this->move($converter, $css); + + // combine css + $content .= $css; + } + + $content = $this->moveImportsToTop($content); + + return $content; + } + + /** + * Moving a css file should update all relative urls. + * Relative references (e.g. ../images/image.gif) in a certain css file, + * will have to be updated when a file is being saved at another location + * (e.g. ../../images/image.gif, if the new CSS file is 1 folder deeper). + * + * @param ConverterInterface $converter Relative path converter + * @param string $content The CSS content to update relative urls for + * + * @return string + */ + protected function move(ConverterInterface $converter, $content) + { + /* + * Relative path references will usually be enclosed by url(). @import + * is an exception, where url() is not necessary around the path (but is + * allowed). + * This *could* be 1 regular expression, where both regular expressions + * in this array are on different sides of a |. But we're using named + * patterns in both regexes, the same name on both regexes. This is only + * possible with a (?J) modifier, but that only works after a fairly + * recent PCRE version. That's why I'm doing 2 separate regular + * expressions & combining the matches after executing of both. + */ + $relativeRegexes = array( + // url(xxx) + '/ + # open url() + url\( + + \s* + + # open path enclosure + (?P<quotes>["\'])? + + # fetch path + (?P<path>.+?) + + # close path enclosure + (?(quotes)(?P=quotes)) + + \s* + + # close url() + \) + + /ix', + + // @import "xxx" + '/ + # import statement + @import + + # whitespace + \s+ + + # we don\'t have to check for @import url(), because the + # condition above will already catch these + + # open path enclosure + (?P<quotes>["\']) + + # fetch path + (?P<path>.+?) + + # close path enclosure + (?P=quotes) + + /ix', + ); + + // find all relative urls in css + $matches = array(); + foreach ($relativeRegexes as $relativeRegex) { + if (preg_match_all($relativeRegex, $content, $regexMatches, PREG_SET_ORDER)) { + $matches = array_merge($matches, $regexMatches); + } + } + + $search = array(); + $replace = array(); + + // loop all urls + foreach ($matches as $match) { + // determine if it's a url() or an @import match + $type = (strpos($match[0], '@import') === 0 ? 'import' : 'url'); + + $url = $match['path']; + if ($this->canImportByPath($url)) { + // attempting to interpret GET-params makes no sense, so let's discard them for awhile + $params = strrchr($url, '?'); + $url = $params ? substr($url, 0, -strlen($params)) : $url; + + // fix relative url + $url = $converter->convert($url); + + // now that the path has been converted, re-apply GET-params + $url .= $params; + } + + /* + * Urls with control characters above 0x7e should be quoted. + * According to Mozilla's parser, whitespace is only allowed at the + * end of unquoted urls. + * Urls with `)` (as could happen with data: uris) should also be + * quoted to avoid being confused for the url() closing parentheses. + * And urls with a # have also been reported to cause issues. + * Urls with quotes inside should also remain escaped. + * + * @see https://developer.mozilla.org/nl/docs/Web/CSS/url#The_url()_functional_notation + * @see https://hg.mozilla.org/mozilla-central/rev/14abca4e7378 + * @see https://github.com/matthiasmullie/minify/issues/193 + */ + $url = trim($url); + if (preg_match('/[\s\)\'"#\x{7f}-\x{9f}]/u', $url)) { + $url = $match['quotes'] . $url . $match['quotes']; + } + + // build replacement + $search[] = $match[0]; + if ($type === 'url') { + $replace[] = 'url(' . $url . ')'; + } elseif ($type === 'import') { + $replace[] = '@import "' . $url . '"'; + } + } + + // replace urls + return str_replace($search, $replace, $content); + } + + /** + * Shorthand HEX color codes. + * #FF0000FF -> #f00 -> red + * #FF00FF00 -> transparent. + * + * @param string $content The CSS content to shorten the HEX color codes for + * + * @return string + */ + protected function shortenHexColors($content) + { + // shorten repeating patterns within HEX .. + $content = preg_replace('/(?<=[: ])#([0-9a-f])\\1([0-9a-f])\\2([0-9a-f])\\3(?:([0-9a-f])\\4)?(?=[; }])/i', '#$1$2$3$4', $content); + + // remove alpha channel if it's pointless .. + $content = preg_replace('/(?<=[: ])#([0-9a-f]{6})ff(?=[; }])/i', '#$1', $content); + $content = preg_replace('/(?<=[: ])#([0-9a-f]{3})f(?=[; }])/i', '#$1', $content); + + // replace `transparent` with shortcut .. + $content = preg_replace('/(?<=[: ])#[0-9a-f]{6}00(?=[; }])/i', '#fff0', $content); + + $colors = array( + // make these more readable + '#00f' => 'blue', + '#dc143c' => 'crimson', + '#0ff' => 'cyan', + '#8b0000' => 'darkred', + '#696969' => 'dimgray', + '#ff69b4' => 'hotpink', + '#0f0' => 'lime', + '#fdf5e6' => 'oldlace', + '#87ceeb' => 'skyblue', + '#d8bfd8' => 'thistle', + // we can shorten some even more by replacing them with their color name + '#f0ffff' => 'azure', + '#f5f5dc' => 'beige', + '#ffe4c4' => 'bisque', + '#a52a2a' => 'brown', + '#ff7f50' => 'coral', + '#ffd700' => 'gold', + '#808080' => 'gray', + '#008000' => 'green', + '#4b0082' => 'indigo', + '#fffff0' => 'ivory', + '#f0e68c' => 'khaki', + '#faf0e6' => 'linen', + '#800000' => 'maroon', + '#000080' => 'navy', + '#808000' => 'olive', + '#ffa500' => 'orange', + '#da70d6' => 'orchid', + '#cd853f' => 'peru', + '#ffc0cb' => 'pink', + '#dda0dd' => 'plum', + '#800080' => 'purple', + '#f00' => 'red', + '#fa8072' => 'salmon', + '#a0522d' => 'sienna', + '#c0c0c0' => 'silver', + '#fffafa' => 'snow', + '#d2b48c' => 'tan', + '#008080' => 'teal', + '#ff6347' => 'tomato', + '#ee82ee' => 'violet', + '#f5deb3' => 'wheat', + // or the other way around + 'black' => '#000', + 'fuchsia' => '#f0f', + 'magenta' => '#f0f', + 'white' => '#fff', + 'yellow' => '#ff0', + // and also `transparent` + 'transparent' => '#fff0', + ); + + return preg_replace_callback( + '/(?<=[: ])(' . implode('|', array_keys($colors)) . ')(?=[; }])/i', + function ($match) use ($colors) { + return $colors[strtolower($match[0])]; + }, + $content + ); + } + + /** + * Convert RGB|HSL color codes. + * rgb(255,0,0,.5) -> rgb(255 0 0 / .5). + * rgb(255,0,0) -> #f00. + * + * @param string $content The CSS content to shorten the RGB color codes for + * + * @return string + */ + protected function convertLegacyColors($content) + { + /* + https://drafts.csswg.org/css-color/#color-syntax-legacy + https://developer.mozilla.org/en-US/docs/Web/CSS/color_value/rgb + https://developer.mozilla.org/en-US/docs/Web/CSS/color_value/hsl + */ + + // convert legacy color syntax + $content = preg_replace('/(rgb)a?\(\s*([0-9]{1,3}%?)\s*,\s*([0-9]{1,3}%?)\s*,\s*([0-9]{1,3}%?)\s*,\s*([0,1]?(?:\.[0-9]*)?)\s*\)/i', '$1($2 $3 $4 / $5)', $content); + $content = preg_replace('/(rgb)a?\(\s*([0-9]{1,3}%?)\s*,\s*([0-9]{1,3}%?)\s*,\s*([0-9]{1,3}%?)\s*\)/i', '$1($2 $3 $4)', $content); + $content = preg_replace('/(hsl)a?\(\s*([0-9]+(?:deg|grad|rad|turn)?)\s*,\s*([0-9]{1,3}%)\s*,\s*([0-9]{1,3}%)\s*,\s*([0,1]?(?:\.[0-9]*)?)\s*\)/i', '$1($2 $3 $4 / $5)', $content); + $content = preg_replace('/(hsl)a?\(\s*([0-9]+(?:deg|grad|rad|turn)?)\s*,\s*([0-9]{1,3}%)\s*,\s*([0-9]{1,3}%)\s*\)/i', '$1($2 $3 $4)', $content); + + // convert `rgb` to `hex` + $dec = '([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])'; + return preg_replace_callback( + "/rgb\($dec $dec $dec\)/i", + function ($match) { + return sprintf('#%02x%02x%02x', $match[1], $match[2], $match[3]); + }, + $content + ); + } + + /** + * Cleanup RGB|HSL|HWB|LCH|LAB + * rgb(255 0 0 / 1) -> rgb(255 0 0). + * rgb(255 0 0 / 0) -> transparent. + * + * @param string $content The CSS content to cleanup HSL|HWB|LCH|LAB + * + * @return string + */ + protected function cleanupModernColors($content) + { + /* + https://drafts.csswg.org/css-color/#color-syntax-modern + https://developer.mozilla.org/en-US/docs/Web/CSS/color_value/hwb + https://developer.mozilla.org/en-US/docs/Web/CSS/color_value/lch + https://developer.mozilla.org/en-US/docs/Web/CSS/color_value/lab + https://developer.mozilla.org/en-US/docs/Web/CSS/color_value/oklch + https://developer.mozilla.org/en-US/docs/Web/CSS/color_value/oklab + */ + $tag = '(rgb|hsl|hwb|(?:(?:ok)?(?:lch|lab)))'; + + // remove alpha channel if it's pointless .. + $content = preg_replace('/' . $tag . '\(\s*([^\s]+)\s+([^\s]+)\s+([^\s]+)\s+\/\s+1(?:(?:\.\d?)*|00%)?\s*\)/i', '$1($2 $3 $4)', $content); + + // replace `transparent` with shortcut .. + $content = preg_replace('/' . $tag . '\(\s*[^\s]+\s+[^\s]+\s+[^\s]+\s+\/\s+0(?:[\.0%]*)?\s*\)/i', '#fff0', $content); + + return $content; + } + + /** + * Shorten CSS font weights. + * + * @param string $content The CSS content to shorten the font weights for + * + * @return string + */ + protected function shortenFontWeights($content) + { + $weights = array( + 'normal' => 400, + 'bold' => 700, + ); + + $callback = function ($match) use ($weights) { + return $match[1] . $weights[$match[2]]; + }; + + return preg_replace_callback('/(font-weight\s*:\s*)(' . implode('|', array_keys($weights)) . ')(?=[;}])/', $callback, $content); + } + + /** + * Shorthand 0 values to plain 0, instead of e.g. -0em. + * + * @param string $content The CSS content to shorten the zero values for + * + * @return string + */ + protected function shortenZeroes($content) + { + // we don't want to strip units in `calc()` expressions: + // `5px - 0px` is valid, but `5px - 0` is not + // `10px * 0` is valid (equates to 0), and so is `10 * 0px`, but + // `10 * 0` is invalid + // we've extracted calcs earlier, so we don't need to worry about this + + // reusable bits of code throughout these regexes: + // before & after are used to make sure we don't match lose unintended + // 0-like values (e.g. in #000, or in http://url/1.0) + // units can be stripped from 0 values, or used to recognize non 0 + // values (where wa may be able to strip a .0 suffix) + $before = '(?<=[:(, ])'; + $after = '(?=[ ,);}])'; + $units = '(em|ex|%|px|cm|mm|in|pt|pc|ch|rem|vh|vw|vmin|vmax|vm)'; + + // strip units after zeroes (0px -> 0) + // NOTE: it should be safe to remove all units for a 0 value, but in + // practice, Webkit (especially Safari) seems to stumble over at least + // 0%, potentially other units as well. Only stripping 'px' for now. + // @see https://github.com/matthiasmullie/minify/issues/60 + $content = preg_replace('/' . $before . '(-?0*(\.0+)?)(?<=0)px' . $after . '/', '\\1', $content); + + // strip 0-digits (.0 -> 0) + $content = preg_replace('/' . $before . '\.0+' . $units . '?' . $after . '/', '0\\1', $content); + // strip trailing 0: 50.10 -> 50.1, 50.10px -> 50.1px + $content = preg_replace('/' . $before . '(-?[0-9]+\.[0-9]+)0+' . $units . '?' . $after . '/', '\\1\\2', $content); + // strip trailing 0: 50.00 -> 50, 50.00px -> 50px + $content = preg_replace('/' . $before . '(-?[0-9]+)\.0+' . $units . '?' . $after . '/', '\\1\\2', $content); + // strip leading 0: 0.1 -> .1, 01.1 -> 1.1 + $content = preg_replace('/' . $before . '(-?)0+([0-9]*\.[0-9]+)' . $units . '?' . $after . '/', '\\1\\2\\3', $content); + + // strip negative zeroes (-0 -> 0) & truncate zeroes (00 -> 0) + $content = preg_replace('/' . $before . '-?0+' . $units . '?' . $after . '/', '0\\1', $content); + + // IE doesn't seem to understand a unitless flex-basis value (correct - + // it goes against the spec), so let's add it in again (make it `%`, + // which is only 1 char: 0%, 0px, 0 anything, it's all just the same) + // @see https://developer.mozilla.org/nl/docs/Web/CSS/flex + $content = preg_replace('/flex:([0-9]+\s[0-9]+\s)0([;\}])/', 'flex:${1}0%${2}', $content); + $content = preg_replace('/flex-basis:0([;\}])/', 'flex-basis:0%${1}', $content); + + return $content; + } + + /** + * Strip empty tags from source code. + * + * @param string $content + * + * @return string + */ + protected function stripEmptyTags($content) + { + $content = preg_replace('/(?<=^)[^\{\};]+\{\s*\}/', '', $content); + $content = preg_replace('/(?<=(\}|;))[^\{\};]+\{\s*\}/', '', $content); + + return $content; + } + + /** + * Strip comments from source code. + */ + protected function stripComments() + { + $this->stripMultilineComments(); + } + + /** + * Strip whitespace. + * + * @param string $content The CSS content to strip the whitespace for + * + * @return string + */ + protected function stripWhitespace($content) + { + // remove leading & trailing whitespace + $content = preg_replace('/^\s*/m', '', $content); + $content = preg_replace('/\s*$/m', '', $content); + + // replace newlines with a single space + $content = preg_replace('/\s+/', ' ', $content); + + // remove whitespace around meta characters + // inspired by stackoverflow.com/questions/15195750/minify-compress-css-with-regex + $content = preg_replace('/\s*([\*$~^|]?+=|[{};,>~]|!important\b)\s*/', '$1', $content); + $content = preg_replace('/([\[(:>\+])\s+/', '$1', $content); + $content = preg_replace('/\s+([\]\)>\+])/', '$1', $content); + $content = preg_replace('/\s+(:)(?![^\}]*\{)/', '$1', $content); + + // whitespace around + and - can only be stripped inside some pseudo- + // classes, like `:nth-child(3+2n)` + // not in things like `calc(3px + 2px)`, shorthands like `3px -2px`, or + // selectors like `div.weird- p` + $pseudos = array('nth-child', 'nth-last-child', 'nth-last-of-type', 'nth-of-type'); + $content = preg_replace('/:(' . implode('|', $pseudos) . ')\(\s*([+-]?)\s*(.+?)\s*([+-]?)\s*(.*?)\s*\)/', ':$1($2$3$4$5)', $content); + + // remove semicolon/whitespace followed by closing bracket + $content = str_replace(';}', '}', $content); + + return trim($content); + } + + /** + * Replace all occurrences of functions that may contain math, where + * whitespace around operators needs to be preserved (e.g. calc, clamp). + */ + protected function extractMath() + { + $functions = array('calc', 'clamp', 'min', 'max'); + $pattern = '/\b(' . implode('|', $functions) . ')(\(.+?)(?=$|;|})/m'; + + // PHP only supports $this inside anonymous functions since 5.4 + $minifier = $this; + $callback = function ($match) use ($minifier, $pattern, &$callback) { + $function = $match[1]; + $length = strlen($match[2]); + $expr = ''; + $opened = 0; + + // the regular expression for extracting math has 1 significant problem: + // it can't determine the correct closing parenthesis... + // instead, it'll match a larger portion of code to where it's certain that + // the calc() musts have ended, and we'll figure out which is the correct + // closing parenthesis here, by counting how many have opened + for ($i = 0; $i < $length; ++$i) { + $char = $match[2][$i]; + $expr .= $char; + if ($char === '(') { + ++$opened; + } elseif ($char === ')' && --$opened === 0) { + break; + } + } + + // now that we've figured out where the calc() starts and ends, extract it + $count = count($minifier->extracted); + $placeholder = 'math(' . $count . ')'; + $minifier->extracted[$placeholder] = $function . '(' . trim(substr($expr, 1, -1)) . ')'; + + // and since we've captured more code than required, we may have some leftover + // calc() in here too - go recursive on the remaining but of code to go figure + // that out and extract what is needed + $rest = $minifier->str_replace_first($function . $expr, '', $match[0]); + $rest = preg_replace_callback($pattern, $callback, $rest); + + return $placeholder . $rest; + }; + + $this->registerPattern($pattern, $callback); + } + + /** + * Replace custom properties, whose values may be used in scenarios where + * we wouldn't want them to be minified (e.g. inside calc). + */ + protected function extractCustomProperties() + { + // PHP only supports $this inside anonymous functions since 5.4 + $minifier = $this; + $this->registerPattern( + '/(?<=^|[;}{])\s*(--[^:;{}"\'\s]+)\s*:([^;{}]+)/m', + function ($match) use ($minifier) { + $placeholder = '--custom-' . count($minifier->extracted) . ':0'; + $minifier->extracted[$placeholder] = $match[1] . ':' . trim($match[2]); + + return $placeholder; + } + ); + } + + /** + * Check if file is small enough to be imported. + * + * @param string $path The path to the file + * + * @return bool + */ + protected function canImportBySize($path) + { + return ($size = @filesize($path)) && $size <= $this->maxImportSize * 1024; + } + + /** + * Check if file a file can be imported, going by the path. + * + * @param string $path + * + * @return bool + */ + protected function canImportByPath($path) + { + return preg_match('/^(data:|https?:|\\/)/', $path) === 0; + } + + /** + * Return a converter to update relative paths to be relative to the new + * destination. + * + * @param string $source + * @param string $target + * + * @return ConverterInterface + */ + protected function getPathConverter($source, $target) + { + return new Converter($source, $target); + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/matthiasmullie/minify/src/JS.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/matthiasmullie/minify/src/JS.php new file mode 100644 index 0000000000..9cf43a2e74 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/matthiasmullie/minify/src/JS.php @@ -0,0 +1,618 @@ +<?php + +/** + * JavaScript minifier. + * + * Please report bugs on https://github.com/matthiasmullie/minify/issues + * + * @author Matthias Mullie <minify@mullie.eu> + * @copyright Copyright (c) 2012, Matthias Mullie. All rights reserved + * @license MIT License + */ + +namespace MatthiasMullie\Minify; + +/** + * JavaScript Minifier Class. + * + * Please report bugs on https://github.com/matthiasmullie/minify/issues + * + * @author Matthias Mullie <minify@mullie.eu> + * @author Tijs Verkoyen <minify@verkoyen.eu> + * @copyright Copyright (c) 2012, Matthias Mullie. All rights reserved + * @license MIT License + */ +class JS extends Minify +{ + /** + * Var-matching regex based on http://stackoverflow.com/a/9337047/802993. + * + * Note that regular expressions using that bit must have the PCRE_UTF8 + * pattern modifier (/u) set. + * + * @internal + * + * @var string + */ + const REGEX_VARIABLE = '\b[$A-Z\_a-z\xaa\xb5\xba\xc0-\xd6\xd8-\xf6\xf8-\x{02c1}\x{02c6}-\x{02d1}\x{02e0}-\x{02e4}\x{02ec}\x{02ee}\x{0370}-\x{0374}\x{0376}\x{0377}\x{037a}-\x{037d}\x{0386}\x{0388}-\x{038a}\x{038c}\x{038e}-\x{03a1}\x{03a3}-\x{03f5}\x{03f7}-\x{0481}\x{048a}-\x{0527}\x{0531}-\x{0556}\x{0559}\x{0561}-\x{0587}\x{05d0}-\x{05ea}\x{05f0}-\x{05f2}\x{0620}-\x{064a}\x{066e}\x{066f}\x{0671}-\x{06d3}\x{06d5}\x{06e5}\x{06e6}\x{06ee}\x{06ef}\x{06fa}-\x{06fc}\x{06ff}\x{0710}\x{0712}-\x{072f}\x{074d}-\x{07a5}\x{07b1}\x{07ca}-\x{07ea}\x{07f4}\x{07f5}\x{07fa}\x{0800}-\x{0815}\x{081a}\x{0824}\x{0828}\x{0840}-\x{0858}\x{08a0}\x{08a2}-\x{08ac}\x{0904}-\x{0939}\x{093d}\x{0950}\x{0958}-\x{0961}\x{0971}-\x{0977}\x{0979}-\x{097f}\x{0985}-\x{098c}\x{098f}\x{0990}\x{0993}-\x{09a8}\x{09aa}-\x{09b0}\x{09b2}\x{09b6}-\x{09b9}\x{09bd}\x{09ce}\x{09dc}\x{09dd}\x{09df}-\x{09e1}\x{09f0}\x{09f1}\x{0a05}-\x{0a0a}\x{0a0f}\x{0a10}\x{0a13}-\x{0a28}\x{0a2a}-\x{0a30}\x{0a32}\x{0a33}\x{0a35}\x{0a36}\x{0a38}\x{0a39}\x{0a59}-\x{0a5c}\x{0a5e}\x{0a72}-\x{0a74}\x{0a85}-\x{0a8d}\x{0a8f}-\x{0a91}\x{0a93}-\x{0aa8}\x{0aaa}-\x{0ab0}\x{0ab2}\x{0ab3}\x{0ab5}-\x{0ab9}\x{0abd}\x{0ad0}\x{0ae0}\x{0ae1}\x{0b05}-\x{0b0c}\x{0b0f}\x{0b10}\x{0b13}-\x{0b28}\x{0b2a}-\x{0b30}\x{0b32}\x{0b33}\x{0b35}-\x{0b39}\x{0b3d}\x{0b5c}\x{0b5d}\x{0b5f}-\x{0b61}\x{0b71}\x{0b83}\x{0b85}-\x{0b8a}\x{0b8e}-\x{0b90}\x{0b92}-\x{0b95}\x{0b99}\x{0b9a}\x{0b9c}\x{0b9e}\x{0b9f}\x{0ba3}\x{0ba4}\x{0ba8}-\x{0baa}\x{0bae}-\x{0bb9}\x{0bd0}\x{0c05}-\x{0c0c}\x{0c0e}-\x{0c10}\x{0c12}-\x{0c28}\x{0c2a}-\x{0c33}\x{0c35}-\x{0c39}\x{0c3d}\x{0c58}\x{0c59}\x{0c60}\x{0c61}\x{0c85}-\x{0c8c}\x{0c8e}-\x{0c90}\x{0c92}-\x{0ca8}\x{0caa}-\x{0cb3}\x{0cb5}-\x{0cb9}\x{0cbd}\x{0cde}\x{0ce0}\x{0ce1}\x{0cf1}\x{0cf2}\x{0d05}-\x{0d0c}\x{0d0e}-\x{0d10}\x{0d12}-\x{0d3a}\x{0d3d}\x{0d4e}\x{0d60}\x{0d61}\x{0d7a}-\x{0d7f}\x{0d85}-\x{0d96}\x{0d9a}-\x{0db1}\x{0db3}-\x{0dbb}\x{0dbd}\x{0dc0}-\x{0dc6}\x{0e01}-\x{0e30}\x{0e32}\x{0e33}\x{0e40}-\x{0e46}\x{0e81}\x{0e82}\x{0e84}\x{0e87}\x{0e88}\x{0e8a}\x{0e8d}\x{0e94}-\x{0e97}\x{0e99}-\x{0e9f}\x{0ea1}-\x{0ea3}\x{0ea5}\x{0ea7}\x{0eaa}\x{0eab}\x{0ead}-\x{0eb0}\x{0eb2}\x{0eb3}\x{0ebd}\x{0ec0}-\x{0ec4}\x{0ec6}\x{0edc}-\x{0edf}\x{0f00}\x{0f40}-\x{0f47}\x{0f49}-\x{0f6c}\x{0f88}-\x{0f8c}\x{1000}-\x{102a}\x{103f}\x{1050}-\x{1055}\x{105a}-\x{105d}\x{1061}\x{1065}\x{1066}\x{106e}-\x{1070}\x{1075}-\x{1081}\x{108e}\x{10a0}-\x{10c5}\x{10c7}\x{10cd}\x{10d0}-\x{10fa}\x{10fc}-\x{1248}\x{124a}-\x{124d}\x{1250}-\x{1256}\x{1258}\x{125a}-\x{125d}\x{1260}-\x{1288}\x{128a}-\x{128d}\x{1290}-\x{12b0}\x{12b2}-\x{12b5}\x{12b8}-\x{12be}\x{12c0}\x{12c2}-\x{12c5}\x{12c8}-\x{12d6}\x{12d8}-\x{1310}\x{1312}-\x{1315}\x{1318}-\x{135a}\x{1380}-\x{138f}\x{13a0}-\x{13f4}\x{1401}-\x{166c}\x{166f}-\x{167f}\x{1681}-\x{169a}\x{16a0}-\x{16ea}\x{16ee}-\x{16f0}\x{1700}-\x{170c}\x{170e}-\x{1711}\x{1720}-\x{1731}\x{1740}-\x{1751}\x{1760}-\x{176c}\x{176e}-\x{1770}\x{1780}-\x{17b3}\x{17d7}\x{17dc}\x{1820}-\x{1877}\x{1880}-\x{18a8}\x{18aa}\x{18b0}-\x{18f5}\x{1900}-\x{191c}\x{1950}-\x{196d}\x{1970}-\x{1974}\x{1980}-\x{19ab}\x{19c1}-\x{19c7}\x{1a00}-\x{1a16}\x{1a20}-\x{1a54}\x{1aa7}\x{1b05}-\x{1b33}\x{1b45}-\x{1b4b}\x{1b83}-\x{1ba0}\x{1bae}\x{1baf}\x{1bba}-\x{1be5}\x{1c00}-\x{1c23}\x{1c4d}-\x{1c4f}\x{1c5a}-\x{1c7d}\x{1ce9}-\x{1cec}\x{1cee}-\x{1cf1}\x{1cf5}\x{1cf6}\x{1d00}-\x{1dbf}\x{1e00}-\x{1f15}\x{1f18}-\x{1f1d}\x{1f20}-\x{1f45}\x{1f48}-\x{1f4d}\x{1f50}-\x{1f57}\x{1f59}\x{1f5b}\x{1f5d}\x{1f5f}-\x{1f7d}\x{1f80}-\x{1fb4}\x{1fb6}-\x{1fbc}\x{1fbe}\x{1fc2}-\x{1fc4}\x{1fc6}-\x{1fcc}\x{1fd0}-\x{1fd3}\x{1fd6}-\x{1fdb}\x{1fe0}-\x{1fec}\x{1ff2}-\x{1ff4}\x{1ff6}-\x{1ffc}\x{2071}\x{207f}\x{2090}-\x{209c}\x{2102}\x{2107}\x{210a}-\x{2113}\x{2115}\x{2119}-\x{211d}\x{2124}\x{2126}\x{2128}\x{212a}-\x{212d}\x{212f}-\x{2139}\x{213c}-\x{213f}\x{2145}-\x{2149}\x{214e}\x{2160}-\x{2188}\x{2c00}-\x{2c2e}\x{2c30}-\x{2c5e}\x{2c60}-\x{2ce4}\x{2ceb}-\x{2cee}\x{2cf2}\x{2cf3}\x{2d00}-\x{2d25}\x{2d27}\x{2d2d}\x{2d30}-\x{2d67}\x{2d6f}\x{2d80}-\x{2d96}\x{2da0}-\x{2da6}\x{2da8}-\x{2dae}\x{2db0}-\x{2db6}\x{2db8}-\x{2dbe}\x{2dc0}-\x{2dc6}\x{2dc8}-\x{2dce}\x{2dd0}-\x{2dd6}\x{2dd8}-\x{2dde}\x{2e2f}\x{3005}-\x{3007}\x{3021}-\x{3029}\x{3031}-\x{3035}\x{3038}-\x{303c}\x{3041}-\x{3096}\x{309d}-\x{309f}\x{30a1}-\x{30fa}\x{30fc}-\x{30ff}\x{3105}-\x{312d}\x{3131}-\x{318e}\x{31a0}-\x{31ba}\x{31f0}-\x{31ff}\x{3400}-\x{4db5}\x{4e00}-\x{9fcc}\x{a000}-\x{a48c}\x{a4d0}-\x{a4fd}\x{a500}-\x{a60c}\x{a610}-\x{a61f}\x{a62a}\x{a62b}\x{a640}-\x{a66e}\x{a67f}-\x{a697}\x{a6a0}-\x{a6ef}\x{a717}-\x{a71f}\x{a722}-\x{a788}\x{a78b}-\x{a78e}\x{a790}-\x{a793}\x{a7a0}-\x{a7aa}\x{a7f8}-\x{a801}\x{a803}-\x{a805}\x{a807}-\x{a80a}\x{a80c}-\x{a822}\x{a840}-\x{a873}\x{a882}-\x{a8b3}\x{a8f2}-\x{a8f7}\x{a8fb}\x{a90a}-\x{a925}\x{a930}-\x{a946}\x{a960}-\x{a97c}\x{a984}-\x{a9b2}\x{a9cf}\x{aa00}-\x{aa28}\x{aa40}-\x{aa42}\x{aa44}-\x{aa4b}\x{aa60}-\x{aa76}\x{aa7a}\x{aa80}-\x{aaaf}\x{aab1}\x{aab5}\x{aab6}\x{aab9}-\x{aabd}\x{aac0}\x{aac2}\x{aadb}-\x{aadd}\x{aae0}-\x{aaea}\x{aaf2}-\x{aaf4}\x{ab01}-\x{ab06}\x{ab09}-\x{ab0e}\x{ab11}-\x{ab16}\x{ab20}-\x{ab26}\x{ab28}-\x{ab2e}\x{abc0}-\x{abe2}\x{ac00}-\x{d7a3}\x{d7b0}-\x{d7c6}\x{d7cb}-\x{d7fb}\x{f900}-\x{fa6d}\x{fa70}-\x{fad9}\x{fb00}-\x{fb06}\x{fb13}-\x{fb17}\x{fb1d}\x{fb1f}-\x{fb28}\x{fb2a}-\x{fb36}\x{fb38}-\x{fb3c}\x{fb3e}\x{fb40}\x{fb41}\x{fb43}\x{fb44}\x{fb46}-\x{fbb1}\x{fbd3}-\x{fd3d}\x{fd50}-\x{fd8f}\x{fd92}-\x{fdc7}\x{fdf0}-\x{fdfb}\x{fe70}-\x{fe74}\x{fe76}-\x{fefc}\x{ff21}-\x{ff3a}\x{ff41}-\x{ff5a}\x{ff66}-\x{ffbe}\x{ffc2}-\x{ffc7}\x{ffca}-\x{ffcf}\x{ffd2}-\x{ffd7}\x{ffda}-\x{ffdc}][$A-Z\_a-z\xaa\xb5\xba\xc0-\xd6\xd8-\xf6\xf8-\x{02c1}\x{02c6}-\x{02d1}\x{02e0}-\x{02e4}\x{02ec}\x{02ee}\x{0370}-\x{0374}\x{0376}\x{0377}\x{037a}-\x{037d}\x{0386}\x{0388}-\x{038a}\x{038c}\x{038e}-\x{03a1}\x{03a3}-\x{03f5}\x{03f7}-\x{0481}\x{048a}-\x{0527}\x{0531}-\x{0556}\x{0559}\x{0561}-\x{0587}\x{05d0}-\x{05ea}\x{05f0}-\x{05f2}\x{0620}-\x{064a}\x{066e}\x{066f}\x{0671}-\x{06d3}\x{06d5}\x{06e5}\x{06e6}\x{06ee}\x{06ef}\x{06fa}-\x{06fc}\x{06ff}\x{0710}\x{0712}-\x{072f}\x{074d}-\x{07a5}\x{07b1}\x{07ca}-\x{07ea}\x{07f4}\x{07f5}\x{07fa}\x{0800}-\x{0815}\x{081a}\x{0824}\x{0828}\x{0840}-\x{0858}\x{08a0}\x{08a2}-\x{08ac}\x{0904}-\x{0939}\x{093d}\x{0950}\x{0958}-\x{0961}\x{0971}-\x{0977}\x{0979}-\x{097f}\x{0985}-\x{098c}\x{098f}\x{0990}\x{0993}-\x{09a8}\x{09aa}-\x{09b0}\x{09b2}\x{09b6}-\x{09b9}\x{09bd}\x{09ce}\x{09dc}\x{09dd}\x{09df}-\x{09e1}\x{09f0}\x{09f1}\x{0a05}-\x{0a0a}\x{0a0f}\x{0a10}\x{0a13}-\x{0a28}\x{0a2a}-\x{0a30}\x{0a32}\x{0a33}\x{0a35}\x{0a36}\x{0a38}\x{0a39}\x{0a59}-\x{0a5c}\x{0a5e}\x{0a72}-\x{0a74}\x{0a85}-\x{0a8d}\x{0a8f}-\x{0a91}\x{0a93}-\x{0aa8}\x{0aaa}-\x{0ab0}\x{0ab2}\x{0ab3}\x{0ab5}-\x{0ab9}\x{0abd}\x{0ad0}\x{0ae0}\x{0ae1}\x{0b05}-\x{0b0c}\x{0b0f}\x{0b10}\x{0b13}-\x{0b28}\x{0b2a}-\x{0b30}\x{0b32}\x{0b33}\x{0b35}-\x{0b39}\x{0b3d}\x{0b5c}\x{0b5d}\x{0b5f}-\x{0b61}\x{0b71}\x{0b83}\x{0b85}-\x{0b8a}\x{0b8e}-\x{0b90}\x{0b92}-\x{0b95}\x{0b99}\x{0b9a}\x{0b9c}\x{0b9e}\x{0b9f}\x{0ba3}\x{0ba4}\x{0ba8}-\x{0baa}\x{0bae}-\x{0bb9}\x{0bd0}\x{0c05}-\x{0c0c}\x{0c0e}-\x{0c10}\x{0c12}-\x{0c28}\x{0c2a}-\x{0c33}\x{0c35}-\x{0c39}\x{0c3d}\x{0c58}\x{0c59}\x{0c60}\x{0c61}\x{0c85}-\x{0c8c}\x{0c8e}-\x{0c90}\x{0c92}-\x{0ca8}\x{0caa}-\x{0cb3}\x{0cb5}-\x{0cb9}\x{0cbd}\x{0cde}\x{0ce0}\x{0ce1}\x{0cf1}\x{0cf2}\x{0d05}-\x{0d0c}\x{0d0e}-\x{0d10}\x{0d12}-\x{0d3a}\x{0d3d}\x{0d4e}\x{0d60}\x{0d61}\x{0d7a}-\x{0d7f}\x{0d85}-\x{0d96}\x{0d9a}-\x{0db1}\x{0db3}-\x{0dbb}\x{0dbd}\x{0dc0}-\x{0dc6}\x{0e01}-\x{0e30}\x{0e32}\x{0e33}\x{0e40}-\x{0e46}\x{0e81}\x{0e82}\x{0e84}\x{0e87}\x{0e88}\x{0e8a}\x{0e8d}\x{0e94}-\x{0e97}\x{0e99}-\x{0e9f}\x{0ea1}-\x{0ea3}\x{0ea5}\x{0ea7}\x{0eaa}\x{0eab}\x{0ead}-\x{0eb0}\x{0eb2}\x{0eb3}\x{0ebd}\x{0ec0}-\x{0ec4}\x{0ec6}\x{0edc}-\x{0edf}\x{0f00}\x{0f40}-\x{0f47}\x{0f49}-\x{0f6c}\x{0f88}-\x{0f8c}\x{1000}-\x{102a}\x{103f}\x{1050}-\x{1055}\x{105a}-\x{105d}\x{1061}\x{1065}\x{1066}\x{106e}-\x{1070}\x{1075}-\x{1081}\x{108e}\x{10a0}-\x{10c5}\x{10c7}\x{10cd}\x{10d0}-\x{10fa}\x{10fc}-\x{1248}\x{124a}-\x{124d}\x{1250}-\x{1256}\x{1258}\x{125a}-\x{125d}\x{1260}-\x{1288}\x{128a}-\x{128d}\x{1290}-\x{12b0}\x{12b2}-\x{12b5}\x{12b8}-\x{12be}\x{12c0}\x{12c2}-\x{12c5}\x{12c8}-\x{12d6}\x{12d8}-\x{1310}\x{1312}-\x{1315}\x{1318}-\x{135a}\x{1380}-\x{138f}\x{13a0}-\x{13f4}\x{1401}-\x{166c}\x{166f}-\x{167f}\x{1681}-\x{169a}\x{16a0}-\x{16ea}\x{16ee}-\x{16f0}\x{1700}-\x{170c}\x{170e}-\x{1711}\x{1720}-\x{1731}\x{1740}-\x{1751}\x{1760}-\x{176c}\x{176e}-\x{1770}\x{1780}-\x{17b3}\x{17d7}\x{17dc}\x{1820}-\x{1877}\x{1880}-\x{18a8}\x{18aa}\x{18b0}-\x{18f5}\x{1900}-\x{191c}\x{1950}-\x{196d}\x{1970}-\x{1974}\x{1980}-\x{19ab}\x{19c1}-\x{19c7}\x{1a00}-\x{1a16}\x{1a20}-\x{1a54}\x{1aa7}\x{1b05}-\x{1b33}\x{1b45}-\x{1b4b}\x{1b83}-\x{1ba0}\x{1bae}\x{1baf}\x{1bba}-\x{1be5}\x{1c00}-\x{1c23}\x{1c4d}-\x{1c4f}\x{1c5a}-\x{1c7d}\x{1ce9}-\x{1cec}\x{1cee}-\x{1cf1}\x{1cf5}\x{1cf6}\x{1d00}-\x{1dbf}\x{1e00}-\x{1f15}\x{1f18}-\x{1f1d}\x{1f20}-\x{1f45}\x{1f48}-\x{1f4d}\x{1f50}-\x{1f57}\x{1f59}\x{1f5b}\x{1f5d}\x{1f5f}-\x{1f7d}\x{1f80}-\x{1fb4}\x{1fb6}-\x{1fbc}\x{1fbe}\x{1fc2}-\x{1fc4}\x{1fc6}-\x{1fcc}\x{1fd0}-\x{1fd3}\x{1fd6}-\x{1fdb}\x{1fe0}-\x{1fec}\x{1ff2}-\x{1ff4}\x{1ff6}-\x{1ffc}\x{2071}\x{207f}\x{2090}-\x{209c}\x{2102}\x{2107}\x{210a}-\x{2113}\x{2115}\x{2119}-\x{211d}\x{2124}\x{2126}\x{2128}\x{212a}-\x{212d}\x{212f}-\x{2139}\x{213c}-\x{213f}\x{2145}-\x{2149}\x{214e}\x{2160}-\x{2188}\x{2c00}-\x{2c2e}\x{2c30}-\x{2c5e}\x{2c60}-\x{2ce4}\x{2ceb}-\x{2cee}\x{2cf2}\x{2cf3}\x{2d00}-\x{2d25}\x{2d27}\x{2d2d}\x{2d30}-\x{2d67}\x{2d6f}\x{2d80}-\x{2d96}\x{2da0}-\x{2da6}\x{2da8}-\x{2dae}\x{2db0}-\x{2db6}\x{2db8}-\x{2dbe}\x{2dc0}-\x{2dc6}\x{2dc8}-\x{2dce}\x{2dd0}-\x{2dd6}\x{2dd8}-\x{2dde}\x{2e2f}\x{3005}-\x{3007}\x{3021}-\x{3029}\x{3031}-\x{3035}\x{3038}-\x{303c}\x{3041}-\x{3096}\x{309d}-\x{309f}\x{30a1}-\x{30fa}\x{30fc}-\x{30ff}\x{3105}-\x{312d}\x{3131}-\x{318e}\x{31a0}-\x{31ba}\x{31f0}-\x{31ff}\x{3400}-\x{4db5}\x{4e00}-\x{9fcc}\x{a000}-\x{a48c}\x{a4d0}-\x{a4fd}\x{a500}-\x{a60c}\x{a610}-\x{a61f}\x{a62a}\x{a62b}\x{a640}-\x{a66e}\x{a67f}-\x{a697}\x{a6a0}-\x{a6ef}\x{a717}-\x{a71f}\x{a722}-\x{a788}\x{a78b}-\x{a78e}\x{a790}-\x{a793}\x{a7a0}-\x{a7aa}\x{a7f8}-\x{a801}\x{a803}-\x{a805}\x{a807}-\x{a80a}\x{a80c}-\x{a822}\x{a840}-\x{a873}\x{a882}-\x{a8b3}\x{a8f2}-\x{a8f7}\x{a8fb}\x{a90a}-\x{a925}\x{a930}-\x{a946}\x{a960}-\x{a97c}\x{a984}-\x{a9b2}\x{a9cf}\x{aa00}-\x{aa28}\x{aa40}-\x{aa42}\x{aa44}-\x{aa4b}\x{aa60}-\x{aa76}\x{aa7a}\x{aa80}-\x{aaaf}\x{aab1}\x{aab5}\x{aab6}\x{aab9}-\x{aabd}\x{aac0}\x{aac2}\x{aadb}-\x{aadd}\x{aae0}-\x{aaea}\x{aaf2}-\x{aaf4}\x{ab01}-\x{ab06}\x{ab09}-\x{ab0e}\x{ab11}-\x{ab16}\x{ab20}-\x{ab26}\x{ab28}-\x{ab2e}\x{abc0}-\x{abe2}\x{ac00}-\x{d7a3}\x{d7b0}-\x{d7c6}\x{d7cb}-\x{d7fb}\x{f900}-\x{fa6d}\x{fa70}-\x{fad9}\x{fb00}-\x{fb06}\x{fb13}-\x{fb17}\x{fb1d}\x{fb1f}-\x{fb28}\x{fb2a}-\x{fb36}\x{fb38}-\x{fb3c}\x{fb3e}\x{fb40}\x{fb41}\x{fb43}\x{fb44}\x{fb46}-\x{fbb1}\x{fbd3}-\x{fd3d}\x{fd50}-\x{fd8f}\x{fd92}-\x{fdc7}\x{fdf0}-\x{fdfb}\x{fe70}-\x{fe74}\x{fe76}-\x{fefc}\x{ff21}-\x{ff3a}\x{ff41}-\x{ff5a}\x{ff66}-\x{ffbe}\x{ffc2}-\x{ffc7}\x{ffca}-\x{ffcf}\x{ffd2}-\x{ffd7}\x{ffda}-\x{ffdc}0-9\x{0300}-\x{036f}\x{0483}-\x{0487}\x{0591}-\x{05bd}\x{05bf}\x{05c1}\x{05c2}\x{05c4}\x{05c5}\x{05c7}\x{0610}-\x{061a}\x{064b}-\x{0669}\x{0670}\x{06d6}-\x{06dc}\x{06df}-\x{06e4}\x{06e7}\x{06e8}\x{06ea}-\x{06ed}\x{06f0}-\x{06f9}\x{0711}\x{0730}-\x{074a}\x{07a6}-\x{07b0}\x{07c0}-\x{07c9}\x{07eb}-\x{07f3}\x{0816}-\x{0819}\x{081b}-\x{0823}\x{0825}-\x{0827}\x{0829}-\x{082d}\x{0859}-\x{085b}\x{08e4}-\x{08fe}\x{0900}-\x{0903}\x{093a}-\x{093c}\x{093e}-\x{094f}\x{0951}-\x{0957}\x{0962}\x{0963}\x{0966}-\x{096f}\x{0981}-\x{0983}\x{09bc}\x{09be}-\x{09c4}\x{09c7}\x{09c8}\x{09cb}-\x{09cd}\x{09d7}\x{09e2}\x{09e3}\x{09e6}-\x{09ef}\x{0a01}-\x{0a03}\x{0a3c}\x{0a3e}-\x{0a42}\x{0a47}\x{0a48}\x{0a4b}-\x{0a4d}\x{0a51}\x{0a66}-\x{0a71}\x{0a75}\x{0a81}-\x{0a83}\x{0abc}\x{0abe}-\x{0ac5}\x{0ac7}-\x{0ac9}\x{0acb}-\x{0acd}\x{0ae2}\x{0ae3}\x{0ae6}-\x{0aef}\x{0b01}-\x{0b03}\x{0b3c}\x{0b3e}-\x{0b44}\x{0b47}\x{0b48}\x{0b4b}-\x{0b4d}\x{0b56}\x{0b57}\x{0b62}\x{0b63}\x{0b66}-\x{0b6f}\x{0b82}\x{0bbe}-\x{0bc2}\x{0bc6}-\x{0bc8}\x{0bca}-\x{0bcd}\x{0bd7}\x{0be6}-\x{0bef}\x{0c01}-\x{0c03}\x{0c3e}-\x{0c44}\x{0c46}-\x{0c48}\x{0c4a}-\x{0c4d}\x{0c55}\x{0c56}\x{0c62}\x{0c63}\x{0c66}-\x{0c6f}\x{0c82}\x{0c83}\x{0cbc}\x{0cbe}-\x{0cc4}\x{0cc6}-\x{0cc8}\x{0cca}-\x{0ccd}\x{0cd5}\x{0cd6}\x{0ce2}\x{0ce3}\x{0ce6}-\x{0cef}\x{0d02}\x{0d03}\x{0d3e}-\x{0d44}\x{0d46}-\x{0d48}\x{0d4a}-\x{0d4d}\x{0d57}\x{0d62}\x{0d63}\x{0d66}-\x{0d6f}\x{0d82}\x{0d83}\x{0dca}\x{0dcf}-\x{0dd4}\x{0dd6}\x{0dd8}-\x{0ddf}\x{0df2}\x{0df3}\x{0e31}\x{0e34}-\x{0e3a}\x{0e47}-\x{0e4e}\x{0e50}-\x{0e59}\x{0eb1}\x{0eb4}-\x{0eb9}\x{0ebb}\x{0ebc}\x{0ec8}-\x{0ecd}\x{0ed0}-\x{0ed9}\x{0f18}\x{0f19}\x{0f20}-\x{0f29}\x{0f35}\x{0f37}\x{0f39}\x{0f3e}\x{0f3f}\x{0f71}-\x{0f84}\x{0f86}\x{0f87}\x{0f8d}-\x{0f97}\x{0f99}-\x{0fbc}\x{0fc6}\x{102b}-\x{103e}\x{1040}-\x{1049}\x{1056}-\x{1059}\x{105e}-\x{1060}\x{1062}-\x{1064}\x{1067}-\x{106d}\x{1071}-\x{1074}\x{1082}-\x{108d}\x{108f}-\x{109d}\x{135d}-\x{135f}\x{1712}-\x{1714}\x{1732}-\x{1734}\x{1752}\x{1753}\x{1772}\x{1773}\x{17b4}-\x{17d3}\x{17dd}\x{17e0}-\x{17e9}\x{180b}-\x{180d}\x{1810}-\x{1819}\x{18a9}\x{1920}-\x{192b}\x{1930}-\x{193b}\x{1946}-\x{194f}\x{19b0}-\x{19c0}\x{19c8}\x{19c9}\x{19d0}-\x{19d9}\x{1a17}-\x{1a1b}\x{1a55}-\x{1a5e}\x{1a60}-\x{1a7c}\x{1a7f}-\x{1a89}\x{1a90}-\x{1a99}\x{1b00}-\x{1b04}\x{1b34}-\x{1b44}\x{1b50}-\x{1b59}\x{1b6b}-\x{1b73}\x{1b80}-\x{1b82}\x{1ba1}-\x{1bad}\x{1bb0}-\x{1bb9}\x{1be6}-\x{1bf3}\x{1c24}-\x{1c37}\x{1c40}-\x{1c49}\x{1c50}-\x{1c59}\x{1cd0}-\x{1cd2}\x{1cd4}-\x{1ce8}\x{1ced}\x{1cf2}-\x{1cf4}\x{1dc0}-\x{1de6}\x{1dfc}-\x{1dff}\x{200c}\x{200d}\x{203f}\x{2040}\x{2054}\x{20d0}-\x{20dc}\x{20e1}\x{20e5}-\x{20f0}\x{2cef}-\x{2cf1}\x{2d7f}\x{2de0}-\x{2dff}\x{302a}-\x{302f}\x{3099}\x{309a}\x{a620}-\x{a629}\x{a66f}\x{a674}-\x{a67d}\x{a69f}\x{a6f0}\x{a6f1}\x{a802}\x{a806}\x{a80b}\x{a823}-\x{a827}\x{a880}\x{a881}\x{a8b4}-\x{a8c4}\x{a8d0}-\x{a8d9}\x{a8e0}-\x{a8f1}\x{a900}-\x{a909}\x{a926}-\x{a92d}\x{a947}-\x{a953}\x{a980}-\x{a983}\x{a9b3}-\x{a9c0}\x{a9d0}-\x{a9d9}\x{aa29}-\x{aa36}\x{aa43}\x{aa4c}\x{aa4d}\x{aa50}-\x{aa59}\x{aa7b}\x{aab0}\x{aab2}-\x{aab4}\x{aab7}\x{aab8}\x{aabe}\x{aabf}\x{aac1}\x{aaeb}-\x{aaef}\x{aaf5}\x{aaf6}\x{abe3}-\x{abea}\x{abec}\x{abed}\x{abf0}-\x{abf9}\x{fb1e}\x{fe00}-\x{fe0f}\x{fe20}-\x{fe26}\x{fe33}\x{fe34}\x{fe4d}-\x{fe4f}\x{ff10}-\x{ff19}\x{ff3f}]*\b'; + + /** + * Full list of JavaScript reserved words. + * Will be loaded from /data/js/keywords_reserved.txt. + * + * @see https://mathiasbynens.be/notes/reserved-keywords + * + * @var string[] + */ + protected $keywordsReserved = array(); + + /** + * List of JavaScript reserved words that accept a <variable, value, ...> + * after them. Some end of lines are not the end of a statement, like with + * these keywords. + * + * E.g.: we shouldn't insert a ; after this else + * else + * console.log('this is quite fine') + * + * Will be loaded from /data/js/keywords_before.txt + * + * @var string[] + */ + protected $keywordsBefore = array(); + + /** + * List of JavaScript reserved words that accept a <variable, value, ...> + * before them. Some end of lines are not the end of a statement, like when + * continued by one of these keywords on the newline. + * + * E.g.: we shouldn't insert a ; before this instanceof + * variable + * instanceof String + * + * Will be loaded from /data/js/keywords_after.txt + * + * @var string[] + */ + protected $keywordsAfter = array(); + + /** + * List of all JavaScript operators. + * + * Will be loaded from /data/js/operators.txt + * + * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Expressions_and_Operators + * + * @var string[] + */ + protected $operators = array(); + + /** + * List of JavaScript operators that accept a <variable, value, ...> after + * them. Some end of lines are not the end of a statement, like with these + * operators. + * + * Note: Most operators are fine, we've only removed ++ and --. + * ++ & -- have to be joined with the value they're in-/decrementing. + * + * Will be loaded from /data/js/operators_before.txt + * + * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Expressions_and_Operators + * + * @var string[] + */ + protected $operatorsBefore = array(); + + /** + * List of JavaScript operators that accept a <variable, value, ...> before + * them. Some end of lines are not the end of a statement, like when + * continued by one of these operators on the newline. + * + * Note: Most operators are fine, we've only removed ), ], ++, --, ! and ~. + * There can't be a newline separating ! or ~ and whatever it is negating. + * ++ & -- have to be joined with the value they're in-/decrementing. + * ) & ] are "special" in that they have lots or usecases. () for example + * is used for function calls, for grouping, in if () and for (), ... + * + * Will be loaded from /data/js/operators_after.txt + * + * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Expressions_and_Operators + * + * @var string[] + */ + protected $operatorsAfter = array(); + + public function __construct() + { + call_user_func_array(array('\\MatthiasMullie\Minify\\Minify', '__construct'), func_get_args()); + + $dataDir = __DIR__ . '/../data/js/'; + $options = FILE_IGNORE_NEW_LINES | FILE_SKIP_EMPTY_LINES; + $this->keywordsReserved = file($dataDir . 'keywords_reserved.txt', $options); + $this->keywordsBefore = file($dataDir . 'keywords_before.txt', $options); + $this->keywordsAfter = file($dataDir . 'keywords_after.txt', $options); + $this->operators = file($dataDir . 'operators.txt', $options); + $this->operatorsBefore = file($dataDir . 'operators_before.txt', $options); + $this->operatorsAfter = file($dataDir . 'operators_after.txt', $options); + } + + /** + * Minify the data. + * Perform JS optimizations. + * + * @param string[optional] $path Path to write the data to + * + * @return string The minified data + */ + public function execute($path = null) + { + $content = ''; + + /* + * Let's first take out strings, comments and regular expressions. + * All of these can contain JS code-like characters, and we should make + * sure any further magic ignores anything inside of these. + * + * Consider this example, where we should not strip any whitespace: + * var str = "a test"; + * + * Comments will be removed altogether, strings and regular expressions + * will be replaced by placeholder text, which we'll restore later. + */ + $this->extractStrings('\'"`'); + $this->stripComments(); + $this->extractRegex(); + + // loop files + foreach ($this->data as $source => $js) { + // take out strings, comments & regex (for which we've registered + // the regexes just a few lines earlier) + $js = $this->replace($js); + + $js = $this->propertyNotation($js); + $js = $this->shortenBools($js); + $js = $this->stripWhitespace($js); + + // combine js: separating the scripts by a ; + $content .= $js . ';'; + } + + // clean up leftover `;`s from the combination of multiple scripts + $content = ltrim($content, ';'); + $content = (string) substr($content, 0, -1); + + /* + * Earlier, we extracted strings & regular expressions and replaced them + * with placeholder text. This will restore them. + */ + $content = $this->restoreExtractedData($content); + + return $content; + } + + /** + * Strip comments from source code. + */ + protected function stripComments() + { + $this->stripMultilineComments(); + + // single-line comments + $this->registerPattern('/\/\/.*$/m', ''); + } + + /** + * JS can have /-delimited regular expressions, like: /ab+c/.match(string). + * + * The content inside the regex can contain characters that may be confused + * for JS code: e.g. it could contain whitespace it needs to match & we + * don't want to strip whitespace in there. + * + * The regex can be pretty simple: we don't have to care about comments, + * (which also use slashes) because stripComments() will have stripped those + * already. + * + * This method will replace all string content with simple REGEX# + * placeholder text, so we've rid all regular expressions from characters + * that may be misinterpreted. Original regex content will be saved in + * $this->extracted and after doing all other minifying, we can restore the + * original content via restoreRegex() + */ + protected function extractRegex() + { + // PHP only supports $this inside anonymous functions since 5.4 + $minifier = $this; + $callback = function ($match) use ($minifier) { + $count = count($minifier->extracted); + $placeholder = '"' . $count . '"'; + $minifier->extracted[$placeholder] = $match[0]; + + return $placeholder; + }; + + // match all chars except `/` and `\` + // `\` is allowed though, along with whatever char follows (which is the + // one being escaped) + // this should allow all chars, except for an unescaped `/` (= the one + // closing the regex) + // then also ignore bare `/` inside `[]`, where they don't need to be + // escaped: anything inside `[]` can be ignored safely + $pattern = '\\/(?!\*)(?:[^\\[\\/\\\\\n\r]++|(?:\\\\.)++|(?:\\[(?:[^\\]\\\\\n\r]++|(?:\\\\.)++)++\\])++)++\\/[gimuy]*'; + + // a regular expression can only be followed by a few operators or some + // of the RegExp methods (a `\` followed by a variable or value is + // likely part of a division, not a regex) + $keywords = array('do', 'in', 'new', 'else', 'throw', 'yield', 'delete', 'return', 'typeof'); + $before = '(^|[=:,;\+\-\*\?\/\}\(\{\[&\|!]|' . implode('|', $keywords) . ')\s*'; + $propertiesAndMethods = array( + // https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp#Properties_2 + 'constructor', + 'flags', + 'global', + 'ignoreCase', + 'multiline', + 'source', + 'sticky', + 'unicode', + // https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp#Methods_2 + 'compile(', + 'exec(', + 'test(', + 'toSource(', + 'toString(', + ); + $delimiters = array_fill(0, count($propertiesAndMethods), '/'); + $propertiesAndMethods = array_map('preg_quote', $propertiesAndMethods, $delimiters); + $after = '(?=\s*([\.,;:\)\}&\|+]|\/\/|$|\.(' . implode('|', $propertiesAndMethods) . ')))'; + $this->registerPattern('/' . $before . '\K' . $pattern . $after . '/', $callback); + + // regular expressions following a `)` are rather annoying to detect... + // quite often, `/` after `)` is a division operator & if it happens to + // be followed by another one (or a comment), it is likely to be + // confused for a regular expression + // however, it's perfectly possible for a regex to follow a `)`: after + // a single-line `if()`, `while()`, ... statement, for example + // since, when they occur like that, they're always the start of a + // statement, there's only a limited amount of ways they can be useful: + // by calling the regex methods directly + // if a regex following `)` is not followed by `.<property or method>`, + // it's quite likely not a regex + $before = '\)\s*'; + $after = '(?=\s*\.(' . implode('|', $propertiesAndMethods) . '))'; + $this->registerPattern('/' . $before . '\K' . $pattern . $after . '/', $callback); + + // 1 more edge case: a regex can be followed by a lot more operators or + // keywords if there's a newline (ASI) in between, where the operator + // actually starts a new statement + // (https://github.com/matthiasmullie/minify/issues/56) + $operators = $this->getOperatorsForRegex($this->operatorsBefore, '/'); + $operators += $this->getOperatorsForRegex($this->keywordsReserved, '/'); + $after = '(?=\s*\n\s*(' . implode('|', $operators) . '))'; + $this->registerPattern('/' . $pattern . $after . '/', $callback); + } + + /** + * Strip whitespace. + * + * We won't strip *all* whitespace, but as much as possible. The thing that + * we'll preserve are newlines we're unsure about. + * JavaScript doesn't require statements to be terminated with a semicolon. + * It will automatically fix missing semicolons with ASI (automatic semi- + * colon insertion) at the end of line causing errors (without semicolon.) + * + * Because it's sometimes hard to tell if a newline is part of a statement + * that should be terminated or not, we'll just leave some of them alone. + * + * @param string $content The content to strip the whitespace for + * + * @return string + */ + protected function stripWhitespace($content) + { + // uniform line endings, make them all line feed + $content = str_replace(array("\r\n", "\r"), "\n", $content); + + // collapse all non-line feed whitespace into a single space + $content = preg_replace('/[^\S\n]+/', ' ', $content); + + // strip leading & trailing whitespace + $content = str_replace(array(" \n", "\n "), "\n", $content); + + // collapse consecutive line feeds into just 1 + $content = preg_replace('/\n+/', "\n", $content); + + $operatorsBefore = $this->getOperatorsForRegex($this->operatorsBefore, '/'); + $operatorsAfter = $this->getOperatorsForRegex($this->operatorsAfter, '/'); + $operators = $this->getOperatorsForRegex($this->operators, '/'); + $keywordsBefore = $this->getKeywordsForRegex($this->keywordsBefore, '/'); + $keywordsAfter = $this->getKeywordsForRegex($this->keywordsAfter, '/'); + + // strip whitespace that ends in (or next line begin with) an operator + // that allows statements to be broken up over multiple lines + unset($operatorsBefore['+'], $operatorsBefore['-'], $operatorsAfter['+'], $operatorsAfter['-']); + $content = preg_replace( + array( + '/(' . implode('|', $operatorsBefore) . ')\s+/', + '/\s+(' . implode('|', $operatorsAfter) . ')/', + ), + '\\1', + $content + ); + + // make sure + and - can't be mistaken for, or joined into ++ and -- + $content = preg_replace( + array( + '/(?<![\+\-])\s*([\+\-])(?![\+\-])/', + '/(?<![\+\-])([\+\-])\s*(?![\+\-])/', + ), + '\\1', + $content + ); + + // collapse whitespace around reserved words into single space + $content = preg_replace('/(^|[;\}\s])\K(' . implode('|', $keywordsBefore) . ')\s+/', '\\2 ', $content); + $content = preg_replace('/\s+(' . implode('|', $keywordsAfter) . ')(?=([;\{\s]|$))/', ' \\1', $content); + + /* + * We didn't strip whitespace after a couple of operators because they + * could be used in different contexts and we can't be sure it's ok to + * strip the newlines. However, we can safely strip any non-line feed + * whitespace that follows them. + */ + $operatorsDiffBefore = array_diff($operators, $operatorsBefore); + $operatorsDiffAfter = array_diff($operators, $operatorsAfter); + $content = preg_replace('/(' . implode('|', $operatorsDiffBefore) . ')[^\S\n]+/', '\\1', $content); + $content = preg_replace('/[^\S\n]+(' . implode('|', $operatorsDiffAfter) . ')/', '\\1', $content); + + /* + * Whitespace after `return` can be omitted in a few occasions + * (such as when followed by a string or regex) + * Same for whitespace in between `)` and `{`, or between `{` and some + * keywords. + */ + $content = preg_replace('/\breturn\s+(["\'\/\+\-])/', 'return$1', $content); + $content = preg_replace('/\)\s+\{/', '){', $content); + $content = preg_replace('/}\n(else|catch|finally)\b/', '}$1', $content); + + /* + * Get rid of double semicolons, except where they can be used like: + * "for(v=1,_=b;;)", "for(v=1;;v++)" or "for(;;ja||(ja=true))". + * I'll safeguard these double semicolons inside for-loops by + * temporarily replacing them with an invalid condition: they won't have + * a double semicolon and will be easy to spot to restore afterwards. + */ + $content = preg_replace('/\bfor\(([^;]*);;([^;]*)\)/', 'for(\\1;-;\\2)', $content); + $content = preg_replace('/;+/', ';', $content); + $content = preg_replace('/\bfor\(([^;]*);-;([^;]*)\)/', 'for(\\1;;\\2)', $content); + + /* + * Next, we'll be removing all semicolons where ASI kicks in. + * for-loops however, can have an empty body (ending in only a + * semicolon), like: `for(i=1;i<3;i++);`, of `for(i in list);` + * Here, nothing happens during the loop; it's just used to keep + * increasing `i`. With that ; omitted, the next line would be expected + * to be the for-loop's body... Same goes for while loops. + * I'm going to double that semicolon (if any) so after the next line, + * which strips semicolons here & there, we're still left with this one. + * Note the special recursive construct in the three inner parts of the for: + * (\{([^\{\}]*(?-2))*[^\{\}]*\})? - it is intended to match inline + * functions bodies, e.g.: i<arr.map(function(e){return e}).length. + * Also note that the construct is applied only once and multiplied + * for each part of the for, otherwise it risks a catastrophic backtracking. + * The limitation is that it will not allow closures in more than one + * of the three parts for a specific for() case. + * REGEX throwing catastrophic backtracking: $content = preg_replace('/(for\([^;\{]*(\{([^\{\}]*(?-2))*[^\{\}]*\})?[^;\{]*;[^;\{]*(\{([^\{\}]*(?-2))*[^\{\}]*\})?[^;\{]*;[^;\{]*(\{([^\{\}]*(?-2))*[^\{\}]*\})?[^;\{]*\));(\}|$)/s', '\\1;;\\8', $content); + */ + $content = preg_replace('/(for\((?:[^;\{]*|[^;\{]*function[^;\{]*(\{([^\{\}]*(?-2))*[^\{\}]*\})?[^;\{]*);[^;\{]*;[^;\{]*\));(\}|$)/s', '\\1;;\\4', $content); + $content = preg_replace('/(for\([^;\{]*;(?:[^;\{]*|[^;\{]*function[^;\{]*(\{([^\{\}]*(?-2))*[^\{\}]*\})?[^;\{]*);[^;\{]*\));(\}|$)/s', '\\1;;\\4', $content); + $content = preg_replace('/(for\([^;\{]*;[^;\{]*;(?:[^;\{]*|[^;\{]*function[^;\{]*(\{([^\{\}]*(?-2))*[^\{\}]*\})?[^;\{]*)\));(\}|$)/s', '\\1;;\\4', $content); + + $content = preg_replace('/(for\([^;\{]+\s+in\s+[^;\{]+\));(\}|$)/s', '\\1;;\\2', $content); + + /* + * Do the same for the if's that don't have a body but are followed by ;} + */ + $content = preg_replace('/(\bif\s*\([^{;]*\));\}/s', '\\1;;}', $content); + + /* + * Below will also keep `;` after a `do{}while();` along with `while();` + * While these could be stripped after do-while, detecting this + * distinction is cumbersome, so I'll play it safe and make sure `;` + * after any kind of `while` is kept. + */ + $content = preg_replace('/(while\([^;\{]+\));(\}|$)/s', '\\1;;\\2', $content); + + /* + * We also can't strip empty else-statements. Even though they're + * useless and probably shouldn't be in the code in the first place, we + * shouldn't be stripping the `;` that follows it as it breaks the code. + * We can just remove those useless else-statements completely. + * + * @see https://github.com/matthiasmullie/minify/issues/91 + */ + $content = preg_replace('/else;/s', '', $content); + + /* + * We also don't really want to terminate statements followed by closing + * curly braces (which we've ignored completely up until now) or end-of- + * script: ASI will kick in here & we're all about minifying. + * Semicolons at beginning of the file don't make any sense either. + */ + $content = preg_replace('/;(\}|$)/s', '\\1', $content); + $content = ltrim($content, ';'); + + // get rid of remaining whitespace af beginning/end + return trim($content); + } + + /** + * We'll strip whitespace around certain operators with regular expressions. + * This will prepare the given array by escaping all characters. + * + * @param string[] $operators + * @param string $delimiter + * + * @return string[] + */ + protected function getOperatorsForRegex(array $operators, $delimiter = '/') + { + // escape operators for use in regex + $delimiters = array_fill(0, count($operators), $delimiter); + $escaped = array_map('preg_quote', $operators, $delimiters); + + $operators = array_combine($operators, $escaped); + + // ignore + & - for now, they'll get special treatment + unset($operators['+'], $operators['-']); + + // dot can not just immediately follow a number; it can be confused for + // decimal point, or calling a method on it, e.g. 42 .toString() + $operators['.'] = '(?<![0-9]\s)\.'; + + // don't confuse = with other assignment shortcuts (e.g. +=) + $chars = preg_quote('+-*\=<>%&|', $delimiter); + $operators['='] = '(?<![' . $chars . '])\='; + + return $operators; + } + + /** + * We'll strip whitespace around certain keywords with regular expressions. + * This will prepare the given array by escaping all characters. + * + * @param string[] $keywords + * @param string $delimiter + * + * @return string[] + */ + protected function getKeywordsForRegex(array $keywords, $delimiter = '/') + { + // escape keywords for use in regex + $delimiter = array_fill(0, count($keywords), $delimiter); + $escaped = array_map('preg_quote', $keywords, $delimiter); + + // add word boundaries + array_walk($keywords, function ($value) { + return '\b' . $value . '\b'; + }); + + $keywords = array_combine($keywords, $escaped); + + return $keywords; + } + + /** + * Replaces all occurrences of array['key'] by array.key. + * + * @param string $content + * + * @return string + */ + protected function propertyNotation($content) + { + // PHP only supports $this inside anonymous functions since 5.4 + $minifier = $this; + $keywords = $this->keywordsReserved; + $callback = function ($match) use ($minifier, $keywords) { + $property = trim($minifier->extracted[$match[1]], '\'"'); + + /* + * Check if the property is a reserved keyword. In this context (as + * property of an object literal/array) it shouldn't matter, but IE8 + * freaks out with "Expected identifier". + */ + if (in_array($property, $keywords)) { + return $match[0]; + } + + /* + * See if the property is in a variable-like format (e.g. + * array['key-here'] can't be replaced by array.key-here since '-' + * is not a valid character there. + */ + if (!preg_match('/^' . $minifier::REGEX_VARIABLE . '$/u', $property)) { + return $match[0]; + } + + return '.' . $property; + }; + + /* + * Figure out if previous character is a variable name (of the array + * we want to use property notation on) - this is to make sure + * standalone ['value'] arrays aren't confused for keys-of-an-array. + * We can (and only have to) check the last character, because PHP's + * regex implementation doesn't allow unfixed-length look-behind + * assertions. + */ + preg_match('/(\[[^\]]+\])[^\]]*$/', static::REGEX_VARIABLE, $previousChar); + $previousChar = $previousChar[1]; + + /* + * Make sure word preceding the ['value'] is not a keyword, e.g. + * return['x']. Because -again- PHP's regex implementation doesn't allow + * unfixed-length look-behind assertions, I'm just going to do a lot of + * separate look-behind assertions, one for each keyword. + */ + $keywords = $this->getKeywordsForRegex($keywords); + $keywords = '(?<!' . implode(')(?<!', $keywords) . ')'; + + return preg_replace_callback('/(?<=' . $previousChar . '|\])' . $keywords . '\[\s*(([\'"])[0-9]+\\2)\s*\]/u', $callback, $content); + } + + /** + * Replaces true & false by !0 and !1. + * + * @param string $content + * + * @return string + */ + protected function shortenBools($content) + { + /* + * 'true' or 'false' could be used as property names (which may be + * followed by whitespace) - we must not replace those! + * Since PHP doesn't allow variable-length (to account for the + * whitespace) lookbehind assertions, I need to capture the leading + * character and check if it's a `.` + */ + $callback = function ($match) { + if (trim($match[1]) === '.') { + return $match[0]; + } + + return $match[1] . ($match[2] === 'true' ? '!0' : '!1'); + }; + $content = preg_replace_callback('/(^|.\s*)\b(true|false)\b(?!:)/', $callback, $content); + + // for(;;) is exactly the same as while(true), but shorter :) + $content = preg_replace('/\bwhile\(!0\){/', 'for(;;){', $content); + + // now make sure we didn't turn any do ... while(true) into do ... for(;;) + preg_match_all('/\bdo\b/', $content, $dos, PREG_OFFSET_CAPTURE | PREG_SET_ORDER); + + // go backward to make sure positional offsets aren't altered when $content changes + $dos = array_reverse($dos); + foreach ($dos as $do) { + $offsetDo = $do[0][1]; + + // find all `while` (now `for`) following `do`: one of those must be + // associated with the `do` and be turned back into `while` + preg_match_all('/\bfor\(;;\)/', $content, $whiles, PREG_OFFSET_CAPTURE | PREG_SET_ORDER, $offsetDo); + foreach ($whiles as $while) { + $offsetWhile = $while[0][1]; + + $open = substr_count($content, '{', $offsetDo, $offsetWhile - $offsetDo); + $close = substr_count($content, '}', $offsetDo, $offsetWhile - $offsetDo); + if ($open === $close) { + // only restore `while` if amount of `{` and `}` are the same; + // otherwise, that `for` isn't associated with this `do` + $content = substr_replace($content, 'while(!0)', $offsetWhile, strlen('for(;;)')); + break; + } + } + } + + return $content; + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/matthiasmullie/minify/src/Minify.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/matthiasmullie/minify/src/Minify.php new file mode 100644 index 0000000000..29e6eb8c00 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/matthiasmullie/minify/src/Minify.php @@ -0,0 +1,560 @@ +<?php + +/** + * Abstract minifier class. + * + * Please report bugs on https://github.com/matthiasmullie/minify/issues + * + * @author Matthias Mullie <minify@mullie.eu> + * @copyright Copyright (c) 2012, Matthias Mullie. All rights reserved + * @license MIT License + */ + +namespace MatthiasMullie\Minify; + +use MatthiasMullie\Minify\Exceptions\IOException; +use Psr\Cache\CacheItemInterface; + +/** + * Abstract minifier class. + * + * Please report bugs on https://github.com/matthiasmullie/minify/issues + * + * @author Matthias Mullie <minify@mullie.eu> + * @copyright Copyright (c) 2012, Matthias Mullie. All rights reserved + * @license MIT License + */ +abstract class Minify +{ + /** + * The data to be minified. + * + * @var string[] + */ + protected $data = array(); + + /** + * Array of patterns to match. + * + * @var string[] + */ + protected $patterns = array(); + + /** + * This array will hold content of strings and regular expressions that have + * been extracted from the JS source code, so we can reliably match "code", + * without having to worry about potential "code-like" characters inside. + * + * @internal + * + * @var string[] + */ + public $extracted = array(); + + /** + * Init the minify class - optionally, code may be passed along already. + */ + public function __construct(/* $data = null, ... */) + { + // it's possible to add the source through the constructor as well ;) + if (func_num_args()) { + call_user_func_array(array($this, 'add'), func_get_args()); + } + } + + /** + * Add a file or straight-up code to be minified. + * + * @param string|string[] $data + * + * @return static + */ + public function add($data /* $data = null, ... */) + { + // bogus "usage" of parameter $data: scrutinizer warns this variable is + // not used (we're using func_get_args instead to support overloading), + // but it still needs to be defined because it makes no sense to have + // this function without argument :) + $args = array($data) + func_get_args(); + + // this method can be overloaded + foreach ($args as $data) { + if (is_array($data)) { + call_user_func_array(array($this, 'add'), $data); + continue; + } + + // redefine var + $data = (string) $data; + + // load data + $value = $this->load($data); + $key = ($data != $value) ? $data : count($this->data); + + // replace CR linefeeds etc. + // @see https://github.com/matthiasmullie/minify/pull/139 + $value = str_replace(array("\r\n", "\r"), "\n", $value); + + // store data + $this->data[$key] = $value; + } + + return $this; + } + + /** + * Add a file to be minified. + * + * @param string|string[] $data + * + * @return static + * + * @throws IOException + */ + public function addFile($data /* $data = null, ... */) + { + // bogus "usage" of parameter $data: scrutinizer warns this variable is + // not used (we're using func_get_args instead to support overloading), + // but it still needs to be defined because it makes no sense to have + // this function without argument :) + $args = array($data) + func_get_args(); + + // this method can be overloaded + foreach ($args as $path) { + if (is_array($path)) { + call_user_func_array(array($this, 'addFile'), $path); + continue; + } + + // redefine var + $path = (string) $path; + + // check if we can read the file + if (!$this->canImportFile($path)) { + throw new IOException('The file "' . $path . '" could not be opened for reading. Check if PHP has enough permissions.'); + } + + $this->add($path); + } + + return $this; + } + + /** + * Minify the data & (optionally) saves it to a file. + * + * @param string[optional] $path Path to write the data to + * + * @return string The minified data + */ + public function minify($path = null) + { + $content = $this->execute($path); + + // save to path + if ($path !== null) { + $this->save($content, $path); + } + + return $content; + } + + /** + * Minify & gzip the data & (optionally) saves it to a file. + * + * @param string[optional] $path Path to write the data to + * @param int[optional] $level Compression level, from 0 to 9 + * + * @return string The minified & gzipped data + */ + public function gzip($path = null, $level = 9) + { + $content = $this->execute($path); + $content = gzencode($content, $level, FORCE_GZIP); + + // save to path + if ($path !== null) { + $this->save($content, $path); + } + + return $content; + } + + /** + * Minify the data & write it to a CacheItemInterface object. + * + * @param CacheItemInterface $item Cache item to write the data to + * + * @return CacheItemInterface Cache item with the minifier data + */ + public function cache(CacheItemInterface $item) + { + $content = $this->execute(); + $item->set($content); + + return $item; + } + + /** + * Minify the data. + * + * @param string[optional] $path Path to write the data to + * + * @return string The minified data + */ + abstract public function execute($path = null); + + /** + * Load data. + * + * @param string $data Either a path to a file or the content itself + * + * @return string + */ + protected function load($data) + { + // check if the data is a file + if ($this->canImportFile($data)) { + $data = file_get_contents($data); + + // strip BOM, if any + if (substr($data, 0, 3) == "\xef\xbb\xbf") { + $data = substr($data, 3); + } + } + + return $data; + } + + /** + * Save to file. + * + * @param string $content The minified data + * @param string $path The path to save the minified data to + * + * @throws IOException + */ + protected function save($content, $path) + { + $handler = $this->openFileForWriting($path); + + $this->writeToFile($handler, $content); + + @fclose($handler); + } + + /** + * Register a pattern to execute against the source content. + * + * If $replacement is a string, it must be plain text. Placeholders like $1 or \2 don't work. + * If you need that functionality, use a callback instead. + * + * @param string $pattern PCRE pattern + * @param string|callable $replacement Replacement value for matched pattern + */ + protected function registerPattern($pattern, $replacement = '') + { + // study the pattern, we'll execute it more than once + $pattern .= 'S'; + + $this->patterns[] = array($pattern, $replacement); + } + + /** + * Both JS and CSS use the same form of multi-line comment, so putting the common code here. + */ + protected function stripMultilineComments() + { + // First extract comments we want to keep, so they can be restored later + // PHP only supports $this inside anonymous functions since 5.4 + $minifier = $this; + $callback = function ($match) use ($minifier) { + $count = count($minifier->extracted); + $placeholder = '/*' . $count . '*/'; + $minifier->extracted[$placeholder] = $match[0]; + + return $placeholder; + }; + $this->registerPattern('/ + # optional newline + \n? + + # start comment + \/\* + + # comment content + (?: + # either starts with an ! + ! + | + # or, after some number of characters which do not end the comment + (?:(?!\*\/).)*? + + # there is either a @license or @preserve tag + @(?:license|preserve) + ) + + # then match to the end of the comment + .*?\*\/\n? + + /ixs', $callback); + + // Then strip all other comments + $this->registerPattern('/\/\*.*?\*\//s', ''); + } + + /** + * We can't "just" run some regular expressions against JavaScript: it's a + * complex language. E.g. having an occurrence of // xyz would be a comment, + * unless it's used within a string. Of you could have something that looks + * like a 'string', but inside a comment. + * The only way to accurately replace these pieces is to traverse the JS one + * character at a time and try to find whatever starts first. + * + * @param string $content The content to replace patterns in + * + * @return string The (manipulated) content + */ + protected function replace($content) + { + $contentLength = strlen($content); + $output = ''; + $processedOffset = 0; + $positions = array_fill(0, count($this->patterns), -1); + $matches = array(); + + while ($processedOffset < $contentLength) { + // find first match for all patterns + foreach ($this->patterns as $i => $pattern) { + list($pattern, $replacement) = $pattern; + + // we can safely ignore patterns for positions we've unset earlier, + // because we know these won't show up anymore + if (array_key_exists($i, $positions) == false) { + continue; + } + + // no need to re-run matches that are still in the part of the + // content that hasn't been processed + if ($positions[$i] >= $processedOffset) { + continue; + } + + $match = null; + if (preg_match($pattern, $content, $match, PREG_OFFSET_CAPTURE, $processedOffset)) { + $matches[$i] = $match; + + // we'll store the match position as well; that way, we + // don't have to redo all preg_matches after changing only + // the first (we'll still know where those others are) + $positions[$i] = $match[0][1]; + } else { + // if the pattern couldn't be matched, there's no point in + // executing it again in later runs on this same content; + // ignore this one until we reach end of content + unset($matches[$i], $positions[$i]); + } + } + + // no more matches to find: everything's been processed, break out + if (!$matches) { + // output the remaining content + $output .= substr($content, $processedOffset); + break; + } + + // see which of the patterns actually found the first thing (we'll + // only want to execute that one, since we're unsure if what the + // other found was not inside what the first found) + $matchOffset = min($positions); + $firstPattern = array_search($matchOffset, $positions); + $match = $matches[$firstPattern]; + + // execute the pattern that matches earliest in the content string + list(, $replacement) = $this->patterns[$firstPattern]; + + // add the part of the input between $processedOffset and the first match; + // that content wasn't matched by anything + $output .= substr($content, $processedOffset, $matchOffset - $processedOffset); + // add the replacement for the match + $output .= $this->executeReplacement($replacement, $match); + // advance $processedOffset past the match + $processedOffset = $matchOffset + strlen($match[0][0]); + } + + return $output; + } + + /** + * If $replacement is a callback, execute it, passing in the match data. + * If it's a string, just pass it through. + * + * @param string|callable $replacement Replacement value + * @param array $match Match data, in PREG_OFFSET_CAPTURE form + * + * @return string + */ + protected function executeReplacement($replacement, $match) + { + if (!is_callable($replacement)) { + return $replacement; + } + // convert $match from the PREG_OFFSET_CAPTURE form to the form the callback expects + foreach ($match as &$matchItem) { + $matchItem = $matchItem[0]; + } + + return $replacement($match); + } + + /** + * Strings are a pattern we need to match, in order to ignore potential + * code-like content inside them, but we just want all of the string + * content to remain untouched. + * + * This method will replace all string content with simple STRING# + * placeholder text, so we've rid all strings from characters that may be + * misinterpreted. Original string content will be saved in $this->extracted + * and after doing all other minifying, we can restore the original content + * via restoreStrings(). + * + * @param string[optional] $chars + * @param string[optional] $placeholderPrefix + */ + protected function extractStrings($chars = '\'"', $placeholderPrefix = '') + { + // PHP only supports $this inside anonymous functions since 5.4 + $minifier = $this; + $callback = function ($match) use ($minifier, $placeholderPrefix) { + // check the second index here, because the first always contains a quote + if ($match[2] === '') { + /* + * Empty strings need no placeholder; they can't be confused for + * anything else anyway. + * But we still needed to match them, for the extraction routine + * to skip over this particular string. + */ + return $match[0]; + } + + $count = count($minifier->extracted); + $placeholder = $match[1] . $placeholderPrefix . $count . $match[1]; + $minifier->extracted[$placeholder] = $match[1] . $match[2] . $match[1]; + + return $placeholder; + }; + + /* + * The \\ messiness explained: + * * Don't count ' or " as end-of-string if it's escaped (has backslash + * in front of it) + * * Unless... that backslash itself is escaped (another leading slash), + * in which case it's no longer escaping the ' or " + * * So there can be either no backslash, or an even number + * * multiply all of that times 4, to account for the escaping that has + * to be done to pass the backslash into the PHP string without it being + * considered as escape-char (times 2) and to get it in the regex, + * escaped (times 2) + */ + $this->registerPattern('/([' . $chars . '])(.*?(?<!\\\\)(\\\\\\\\)*+)\\1/s', $callback); + } + + /** + * This method will restore all extracted data (strings, regexes) that were + * replaced with placeholder text in extract*(). The original content was + * saved in $this->extracted. + * + * @param string $content + * + * @return string + */ + protected function restoreExtractedData($content) + { + if (!$this->extracted) { + // nothing was extracted, nothing to restore + return $content; + } + + $content = strtr($content, $this->extracted); + + $this->extracted = array(); + + return $content; + } + + /** + * Check if the path is a regular file and can be read. + * + * @param string $path + * + * @return bool + */ + protected function canImportFile($path) + { + $parsed = parse_url($path); + if ( + // file is elsewhere + isset($parsed['host']) + // file responds to queries (may change, or need to bypass cache) + || isset($parsed['query']) + ) { + return false; + } + + try { + return strlen($path) < PHP_MAXPATHLEN && @is_file($path) && is_readable($path); + } + // catch openbasedir exceptions which are not caught by @ on is_file() + catch (\Exception $e) { + return false; + } + } + + /** + * Attempts to open file specified by $path for writing. + * + * @param string $path The path to the file + * + * @return resource Specifier for the target file + * + * @throws IOException + */ + protected function openFileForWriting($path) + { + if ($path === '' || ($handler = @fopen($path, 'w')) === false) { + throw new IOException('The file "' . $path . '" could not be opened for writing. Check if PHP has enough permissions.'); + } + + return $handler; + } + + /** + * Attempts to write $content to the file specified by $handler. $path is used for printing exceptions. + * + * @param resource $handler The resource to write to + * @param string $content The content to write + * @param string $path The path to the file (for exception printing only) + * + * @throws IOException + */ + protected function writeToFile($handler, $content, $path = '') + { + if ( + !is_resource($handler) + || ($result = @fwrite($handler, $content)) === false + || ($result < strlen($content)) + ) { + throw new IOException('The file "' . $path . '" could not be written to. Check your disk space and file permissions.'); + } + } + + protected static function str_replace_first($search, $replace, $subject) + { + $pos = strpos($subject, $search); + if ($pos !== false) { + return substr_replace($subject, $replace, $pos, strlen($search)); + } + + return $subject; + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/mpratt/embera/src/Embera/Embera.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/mpratt/embera/src/Embera/Embera.php new file mode 100755 index 0000000000..7211b649b4 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/mpratt/embera/src/Embera/Embera.php @@ -0,0 +1,221 @@ +<?php +/** + * Embera.php + * + * @package Embera + * @author Michael Pratt <yo@michael-pratt.com> + * @link http://www.michael-pratt.com/ + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ + +namespace Embera; + +use Embera\Http\HttpClient; +use Embera\Http\OembedClient; +use Embera\Http\HttpClientInterface; +use Embera\Html\IgnoreTags; +use Embera\Html\ResponsiveEmbeds; +use Embera\ProviderCollection\ProviderCollectionInterface; +use Embera\ProviderCollection\DefaultProviderCollection; + +/** + * Embera + * The Main Class of this library. + */ +class Embera +{ + /** @var string Current Library Version */ + const VERSION = '2.0.41'; + + /** + * Constants describing how the library is + * going to handle fake responses. + * + * ALLOW_FAKE_RESPONSES is the default value. + */ + const ALLOW_FAKE_RESPONSES = 1; + const DISABLE_FAKE_RESPONSES = 2; + const ONLY_FAKE_RESPONSES = 3; + + /** @var array Configuration settings */ + protected $config = []; + + /** @var array Logged errors */ + protected $errors = []; + + /** @var array Closures to be used on oembed responses */ + protected $filters = []; + + /** @var ProviderCollectionInterface */ + protected $providerCollection; + + /** @var HttpClientInterface */ + protected $httpClient; + + /** + * Constructor + * + * @param array $config + * @param ProviderCollectionInterface $collection + * @param HttpClientInterface $httpClient + * @return void + */ + public function __construct(array $config = [], ProviderCollectionInterface $collection = null, HttpClientInterface $httpClient = null) + { + $this->config = array_merge([ + 'https_only' => false, + 'fake_responses' => self::ALLOW_FAKE_RESPONSES, + 'ignore_tags' => [ 'pre', 'code', 'a', 'img', 'iframe', 'oembed' ], + 'responsive' => false, + 'width' => 0, + 'height' => 0, + 'maxheight' => 0, + 'maxwidth' => 0, + 'referer' => '', + 'curl_params' => [], + 'file_get_contents_params' => [], + ], $config); + + $this->config['maxwidth'] = max($this->config['width'], $this->config['maxwidth']); + $this->config['maxheight'] = max($this->config['height'], $this->config['maxheight']); + unset($this->config['height'], $this->config['width']); + + $this->providerCollection = $collection; + if (!$collection) { + $this->providerCollection = new DefaultProviderCollection($this->config); + } + + $this->httpClient = $httpClient; + if (!$httpClient) { + $this->httpClient = new HttpClient($this->config); + } + + // Set the config just in case. + $this->providerCollection->setConfig($this->config); + $this->httpClient->setConfig($this->config); + } + + /** + * Embeds known/available services into the given text. + * + * @param mixed $text + * @return string + */ + public function autoEmbed($text) + { + if (is_string($text)) { + $table = []; + $providers = $this->getUrlData($text); + foreach ($providers as $url => $response) { + if (!empty($response['html'])) { + $table[$url] = $response['html']; + } + } + + if (!empty($table)) { + + if (!empty($this->config['ignore_tags']) && strpos($text, '>') !== false) { + $ignoreTags = new IgnoreTags($this->config['ignore_tags']); + return $ignoreTags->replace($text, $table); + } + + return strtr($text, $table); + } + + } else { + $this->errors[] = 'For auto-embedding purposes, the input must be a string'; + } + + return $text; + } + + /** + * Returns the oembed response from the given data. + * + * @param array|string $urls An array with urls or a string with urls. + * @return array + */ + public function getUrlData($urls) + { + $return = []; + foreach ($this->providerCollection->findProviders($urls) as $url => $provider) { + try { + + $oembedClient = new OembedClient($this->config, $this->httpClient); + $response = $oembedClient->getResponseFrom($provider); + + if ($this->config['responsive'] && !$provider->hasResponsiveSupport()) { + $responsive = new ResponsiveEmbeds(); + $response = $responsive->transform($response); + } + + $return[$url] = $this->applyFilters($response); + + } catch (\Exception $e) { + $this->errors[] = $e->getMessage(); + } + } + + return array_filter($return); + } + + /** + * Adds a filter to the oembed response + * + * @param callable $closure + * @return void + */ + public function addFilter(callable $closure) + { + $this->filters[] = $closure; + } + + /** + * Applies registered filters/closures + * to the oembed response. + * + * @param array $response + * @return array + */ + protected function applyFilters(array $response) + { + foreach ($this->filters as $closure) { + $response = $closure($response); + } + + return $response; + } + + /** + * Gets the last error found + * + * @return string + */ + public function getLastError() + { + return end($this->errors); + } + + /** + * Returns an array with all the errors + * + * @return array + */ + public function getErrors() + { + return $this->errors; + } + + /** + * Checks if there were errors + * + * @return bool + */ + public function hasErrors() + { + return (!empty($this->errors)); + } + +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/mpratt/embera/src/Embera/Provider/Biqnetwork.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/mpratt/embera/src/Embera/Provider/Biqnetwork.php new file mode 100644 index 0000000000..95397dbecf --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/mpratt/embera/src/Embera/Provider/Biqnetwork.php @@ -0,0 +1,56 @@ +<?php +/** + * Biqnetwork.php + * + * @package Embera + * @author Michael Pratt <yo@michael-pratt.com> + * @link http://www.michael-pratt.com/ + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ + +namespace Embera\Provider; + +use Embera\Url; + +/** + * Biqnetwork Provider + * + * @link https://cloud.biqapp.com + */ +class Biqnetwork extends ProviderAdapter implements ProviderInterface +{ + /** inline {@inheritdoc} */ + protected $endpoint = 'https://biqapp.com/api/v1/video/oembed'; + + /** inline {@inheritdoc} */ + protected static $hosts = [ + 'cloud.biqapp.com' + ]; + + /** inline {@inheritdoc} */ + protected $allowedParams = [ 'maxwidth', 'maxheight' ]; + + /** inline {@inheritdoc} */ + protected $httpsSupport = true; + + /** inline {@inheritdoc} */ + protected $responsiveSupport = false; + + /** inline {@inheritdoc} */ + public function validateUrl(Url $url) + { + return (bool) (preg_match('~cloud\.biqapp\.com/([^/]+)~i', (string) $url)); + } + + /** inline {@inheritdoc} */ + public function normalizeUrl(Url $url) + { + $url->convertToHttps(); + $url->removeQueryString(); + $url->removeLastSlash(); + + return $url; + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/mpratt/embera/src/Embera/Provider/BlueskySocial.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/mpratt/embera/src/Embera/Provider/BlueskySocial.php new file mode 100644 index 0000000000..deac3374ea --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/mpratt/embera/src/Embera/Provider/BlueskySocial.php @@ -0,0 +1,56 @@ +<?php +/** + * BlueskySocial.php + * + * @package Embera + * @author Michael Pratt <yo@michael-pratt.com> + * @link http://www.michael-pratt.com/ + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ + +namespace Embera\Provider; + +use Embera\Url; + +/** + * BlueskySocial Provider + * + * @link https://bsky.app + */ +class BlueskySocial extends ProviderAdapter implements ProviderInterface +{ + /** inline {@inheritdoc} */ + protected $endpoint = 'https://embed.bsky.app/oembed'; + + /** inline {@inheritdoc} */ + protected static $hosts = [ + 'bsky.app' + ]; + + /** inline {@inheritdoc} */ + protected $allowedParams = [ 'maxwidth', 'maxheight' ]; + + /** inline {@inheritdoc} */ + protected $httpsSupport = true; + + /** inline {@inheritdoc} */ + protected $responsiveSupport = true; + + /** inline {@inheritdoc} */ + public function validateUrl(Url $url) + { + return (bool) (preg_match('~bsky\.app/profile/([^/]+)/post/([^/]+)~i', (string) $url)); + } + + /** inline {@inheritdoc} */ + public function normalizeUrl(Url $url) + { + $url->convertToHttps(); + $url->removeQueryString(); + $url->removeLastSlash(); + + return $url; + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/mpratt/embera/src/Embera/Provider/Bunny.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/mpratt/embera/src/Embera/Provider/Bunny.php new file mode 100644 index 0000000000..fce55ee683 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/mpratt/embera/src/Embera/Provider/Bunny.php @@ -0,0 +1,88 @@ +<?php +/** + * Bunny.php + * + * @package Embera + * @author Michael Pratt <yo@michael-pratt.com> + * @link http://www.michael-pratt.com/ + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ + +namespace Embera\Provider; + +use Embera\Url; + +/** + * Bunny Provider + * + * @link https://iframe.mediadelivery.net|iframe.mediadelivery.net|video.bunnycdn.com|video.bunnycdn.com + */ +class Bunny extends ProviderAdapter implements ProviderInterface +{ + /** inline {@inheritdoc} */ + protected $endpoint = 'https://video.bunnycdn.com/OEmbed'; + + /** inline {@inheritdoc} */ + protected static $hosts = [ + '*.mediadelivery.net', + '*.bunnycdn.com' + ]; + + /** inline {@inheritdoc} */ + protected $allowedParams = [ 'maxwidth', 'maxheight' ]; + + /** inline {@inheritdoc} */ + protected $httpsSupport = true; + + /** inline {@inheritdoc} */ + protected $responsiveSupport = false; + + /** inline {@inheritdoc} */ + public function validateUrl(Url $url) + { + return (bool) (preg_match('~(mediadelivery\.net|bunnycdn\.com)/([^/]+)~i', (string) $url)); + } + + /** inline {@inheritdoc} */ + public function normalizeUrl(Url $url) + { + $url->convertToHttps(); + $url->removeQueryString(); + $url->removeLastSlash(); + + return $url; + } + + /** inline {@inheritdoc} */ + public function modifyResponse(array $response = []) + { + return $response; + } + + /** inline {@inheritdoc} */ + public function getFakeResponse() + { + preg_match('~v=([a-z0-9_\-]+)~i', (string) $this->url, $matches); + + $embedUrl = ''; + + $attr = []; + $attr[] = 'width="{width}"'; + $attr[] = 'height="{height}"'; + $attr[] = 'src="' . $embedUrl . '"'; + $attr[] = 'frameborder="0"'; + $attr[] = 'allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture"'; + $attr[] = 'allowfullscreen'; + + return [ + 'type' => '', + 'provider_name' => 'Bunny', + 'provider_url' => 'https://iframe.mediadelivery.net|iframe.mediadelivery.net|video.bunnycdn.com|video.bunnycdn.com', + 'title' => 'Unknown title', + 'html' => '<iframe ' . implode(' ', $attr). '>', + ]; + } + +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/mpratt/embera/src/Embera/Provider/Buttondown.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/mpratt/embera/src/Embera/Provider/Buttondown.php new file mode 100755 index 0000000000..d561c7a434 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/mpratt/embera/src/Embera/Provider/Buttondown.php @@ -0,0 +1,76 @@ + + * @link http://www.michael-pratt.com/ + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ + +namespace Embera\Provider; + +use Embera\Url; + +/** + * Buttondown Provider + * Buttondown is a small, elegant tool for producing newsletters. + * + * @link https://buttondown.email + * + */ +class Buttondown extends ProviderAdapter implements ProviderInterface +{ + /** inline {@inheritdoc} */ + protected $endpoint = 'https://buttondown.email/embed?format=json'; + + /** inline {@inheritdoc} */ + protected static $hosts = [ + 'buttondown.email', + 'buttondown.com' + ]; + + /** inline {@inheritdoc} */ + protected $httpsSupport = true; + + /** inline {@inheritdoc} */ + protected $responsiveSupport = true; + + /** inline {@inheritdoc} */ + public function validateUrl(Url $url) + { + return (bool) (preg_match('~buttondown\.(email|com)/([^/]+)$~i', (string) $url)); + } + + /** inline {@inheritdoc} */ + public function normalizeUrl(Url $url) + { + $url->convertToHttps(); + $url->removeWWW(); + $url->removeLastSlash(); + $url->removeQueryString(); + + return $url; + } + + /** inline {@inheritdoc} */ + public function getFakeResponse() + { + $embedUrl = $this->url . '?as_embed=true'; + + $attr = []; + $attr[] = 'scrolling="no"'; + $attr[] = 'style="width:100%!important;height:200px;position:relative;"'; + $attr[] = 'src="' . $embedUrl . '"'; + + return [ + 'type' => 'rich', + 'provider_name' => 'Buttondown', + 'provider_url' => 'https://buttondown.email', + 'title' => 'Unknown title', + 'html' => '', + ]; + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/mpratt/embera/src/Embera/Provider/Celero.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/mpratt/embera/src/Embera/Provider/Celero.php new file mode 100644 index 0000000000..9932f6aa6c --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/mpratt/embera/src/Embera/Provider/Celero.php @@ -0,0 +1,56 @@ + + * @link http://www.michael-pratt.com/ + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ + +namespace Embera\Provider; + +use Embera\Url; + +/** + * Celero Provider + * + * @link https://embeds.celero.io + */ +class Celero extends ProviderAdapter implements ProviderInterface +{ + /** inline {@inheritdoc} */ + protected $endpoint = 'https://api.celero.io/api/oembed'; + + /** inline {@inheritdoc} */ + protected static $hosts = [ + 'embeds.celero.io' + ]; + + /** inline {@inheritdoc} */ + protected $allowedParams = [ 'maxwidth', 'maxheight' ]; + + /** inline {@inheritdoc} */ + protected $httpsSupport = true; + + /** inline {@inheritdoc} */ + protected $responsiveSupport = true; + + /** inline {@inheritdoc} */ + public function validateUrl(Url $url) + { + return (bool) (preg_match('~embeds\.celero\.io/([^/]+)/([^/]+)~i', (string) $url)); + } + + /** inline {@inheritdoc} */ + public function normalizeUrl(Url $url) + { + $url->convertToHttps(); + $url->removeQueryString(); + $url->removeLastSlash(); + + return $url; + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/mpratt/embera/src/Embera/Provider/DailyMotion.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/mpratt/embera/src/Embera/Provider/DailyMotion.php new file mode 100755 index 0000000000..dd01932d97 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/mpratt/embera/src/Embera/Provider/DailyMotion.php @@ -0,0 +1,89 @@ + + * @link http://www.michael-pratt.com/ + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ + +namespace Embera\Provider; + +use Embera\Url; + +/** + * dailymotion.com Provider + * The latest news, sports, music and entertainment videos on Dailymotion. + * + * @link https://dailymotion.com + * @see https://developer.dailymotion.com/player/#player-oembed + */ +class DailyMotion extends ProviderAdapter implements ProviderInterface +{ + /** inline {@inheritdoc} */ + protected $endpoint = 'https://www.dailymotion.com/services/oembed?format=json'; + + /** inline {@inheritdoc} */ + protected $allowedParams = [ 'maxwidth', 'maxheight', 'callback', 'autoplay', 'syndication' ]; + + /** inline {@inheritdoc} */ + protected static $hosts = [ + '*.dailymotion.com', 'dai.ly' + ]; + + /** inline {@inheritdoc} */ + protected $httpsSupport = true; + + /** inline {@inheritdoc} */ + public function validateUrl(Url $url) + { + return (preg_match('~dailymotion\.com/video/(?:[^/]+)/?~i', (string) $url)); + } + + /** inline {@inheritdoc} */ + public function normalizeUrl(Url $url) + { + $url->convertToHttps(); + $url->addWWW(); + $url->removeLastSlash(); + $url->removeQueryString(); + + if (preg_match('~dailymotion\.com/(?:embed/)?(?:video|live)/([^/]+)/?~i', (string) $url, $matches)) { + $url->overwrite('https://www.dailymotion.com/video/' . $matches['1']); + } else if (preg_match('~dai\.ly/([^/]+)/?~i', (string) $url, $matches)) { + $url->overwrite('https://www.dailymotion.com/video/' . $matches['1']); + } + + return $url; + } + + /** inline {@inheritdoc} */ + public function getFakeResponse() + { + preg_match('~/video/([^/]+)~i', (string) $this->url, $matches); + @list($videoId, $videoTitle) = explode('_', $matches['1'], 2); + + + $embedUrl = 'http://www.dailymotion.com/embed/video/' . $videoId; + + $attr = []; + $attr[] = 'frameborder="0"'; + $attr[] = 'width="{width}"'; + $attr[] = 'height="{height}"'; + $attr[] = 'src="' . $embedUrl . '"'; + $attr[] = 'allowfullscreen'; + $attr[] = 'allow="autoplay; fullscreen; picture-in-picture; web-share"'; + + return [ + 'type' => 'video', + 'provider_name' => 'Dailymotion', + 'provider_url' => 'http://www.dailymotion.com', + 'title' => (!empty($videoTitle) ? str_replace(array('-', '_'), ' ', $videoTitle) : 'Unknown Title'), + 'html' => '', + ]; + } + +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/mpratt/embera/src/Embera/Provider/FITE.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/mpratt/embera/src/Embera/Provider/FITE.php new file mode 100644 index 0000000000..8f1c0067a2 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/mpratt/embera/src/Embera/Provider/FITE.php @@ -0,0 +1,69 @@ + + * @link http://www.michael-pratt.com/ + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ + +namespace Embera\Provider; + +use Embera\Url; + +/** + * FITE Provider + * Stream all the action to your big-screen TV! + * + * @link https://fite.tv + */ +class FITE extends ProviderAdapter implements ProviderInterface +{ + /** inline {@inheritdoc} */ + protected $endpoint = 'https://www.fite.tv/oembed?format=json'; + + /** inline {@inheritdoc} */ + protected static $hosts = [ + 'fite.tv', + 'triller.tv', + 'trillertv.com' + ]; + + /** inline {@inheritdoc} */ + protected $httpsSupport = true; + + /** inline {@inheritdoc} */ + public function validateUrl(Url $url) + { + return (bool) (preg_match('~(trillertv|triller|fite)\.(tv|com)/watch/(?:[^/]+)/([^/]+)/?~i', (string) $url)); + } + + /** inline {@inheritdoc} */ + public function normalizeUrl(Url $url) + { + $url->convertToHttps(); + $url->removeQueryString(); + + return $url; + } + + /** inline {@inheritdoc} */ + public function getFakeResponse() + { + preg_match('~(trillertv|triller|fite)\.(tv|com)/watch/(?:[^/]+)/([^/]+)/?~i', (string) $this->url, $matches); + + $html = ' + setErrorReporting(); + + $aRet = array (); + $aMessages = array (); + + $this->$sFunc(false, $aMessages); + + foreach ($aMessages as $sName => $r) + if ($sType == $r['type']) + $aRet[] = "$sName = " . $this->format_output($r['params']['real_val'], isset($this->aPhpSettings[$sName]) ? $this->aPhpSettings[$sName] : '') . " - " . $this->getMsgHTML($sName, $r); + + $this->restoreErrorReporting(); + + return $aRet; + } + + public function typeToTitle ($sType) + { + return $this->aType2Title[$sType]; + } + + protected function requirements() + { + echo '' . _t('_sys_audit_header_requirements') . ''; + $this->requirementsPHP(); + if (!defined('BX_DOL_INSTALL')) + $this->requirementsMySQL(); + $this->requirementsWebServer(); + $this->requirementsOS(); + $this->requirementsHardware(); + } + + protected function requirementsPHP($bEcho = true, &$aOutputMessages = null) + { + $sHttpCode = null; + $s = bx_file_get_contents('http://php.net/releases/index.php?serialize=1', array(), 'get', array(), $sHttpCode, array(), 20, array(CURLOPT_IPRESOLVE => CURL_IPRESOLVE_V4)); + $sLatestPhpVersion = $s && ($a = unserialize($s)) ? $a[5]['version'] : ''; + + if (version_compare(phpversion(), "5.4", ">=") == 1) + unset($this->aPhpSettings['short_open_tag']); + + $aMessages = array (); + + $sPhpVer = PHP_VERSION; + if (empty($sLatestPhpVersion)) + $aVer = array('type' => BX_DOL_AUDIT_UNDEF, 'msg' => _t('_sys_audit_msg_value_checking_failed'), 'params' => array ('real_val' => $sPhpVer)); + elseif (version_compare($sPhpVer, $this->sMinPhpVer, '<')) + $aVer = array('type' => BX_DOL_AUDIT_FAIL, 'msg' => _t('_sys_audit_msg_version_is_incompatible', $this->sMinPhpVer), 'params' => array ('real_val' => $sPhpVer)); + elseif (version_compare($sPhpVer, '5.3.0', '>=') && version_compare($sPhpVer, '5.4.0', '<')) + $aVer = array('type' => BX_DOL_AUDIT_WARN, 'msg' => _t('_sys_audit_msg_version_is_outdated', $sLatestPhpVersion), 'params' => array ('real_val' => $sPhpVer)); + else + $aVer = array('type' => BX_DOL_AUDIT_OK, 'params' => array ('real_val' => $sPhpVer)); + + $aMessages[_t('_sys_audit_version')] = $aVer; + + foreach ($this->aPhpSettings as $sName => $r) { + $a = $this->checkPhpSetting($sName, $r); + if ($a['res']) + $aMessages[$sName] = array('type' => BX_DOL_AUDIT_OK, 'params' => $a); + elseif (isset($r['warn']) && $r['warn']) + $aMessages[$sName] = array('type' => BX_DOL_AUDIT_WARN, 'msg' => _t('_sys_audit_msg_should_be', $r['op'], $this->format_output($r['val'], $r)), 'params' => $a); + else + $aMessages[$sName] = array('type' => BX_DOL_AUDIT_FAIL, 'msg' => _t('_sys_audit_msg_must_be', $r['op'], $this->format_output($r['val'], $r)), 'params' => $a); + } + + if (null !== $aOutputMessages) + $aOutputMessages = $aMessages; + + if ($bEcho) { + $s = ''; + foreach ($aMessages as $sName => $r) { + $s .= $this->getBlock($sName, $this->format_output($r['params']['real_val'], isset($this->aPhpSettings[$sName]) ? $this->aPhpSettings[$sName] : ''), $this->getMsgHTML($sName, $r)); + } + echo $this->getSection('PHP', '', $s); + } + } + + protected function requirementsMySQL($bEcho = true, &$aOutputMessages = null) + { + $sMysqlVer = BxDolDb::getInstance()->getServerInfo(); + if (preg_match ('/^(\d+)\.(\d+)\.(\d+)/', $sMysqlVer, $m)) { + $sMysqlVer = "{$m[1]}.{$m[2]}.{$m[3]}"; + if (version_compare($sMysqlVer, $this->sMinMysqlVer, '<')) + $aMessage = array('type' => BX_DOL_AUDIT_FAIL, 'msg' => _t('_sys_audit_msg_version_is_incompatible', $this->sMinMysqlVer)); + else + $aMessage = array('type' => BX_DOL_AUDIT_OK); + } else { + $aMessage = array('type' => BX_DOL_AUDIT_UNDEF, 'msg' => _t('_sys_audit_msg_value_checking_failed')); + } + + if (null !== $aOutputMessages) + $aOutputMessages['mysql'] = array($aMessage); + + if ($bEcho) { + $s = $this->getBlock(_t('_sys_audit_version'), $sMysqlVer, $this->getMsgHTML(_t('_sys_audit_version'), $aMessage)); + echo $this->getSection('MySQL', '', $s); + } + } + + protected function requirementsWebServer($bEcho = true, &$aOutputMessages = null) + { + $aMessages = array(); + foreach ($this->aRequiredApacheModules as $sName => $sNameCompiledName) + $aMessages[$sName] = $this->checkApacheModule($sName, $sNameCompiledName); + + if (null !== $aOutputMessages) + $aOutputMessages = $aMessages; + + if ($bEcho) { + $s = ''; + foreach ($aMessages as $sName => $r) { + $s .= $this->getBlock($sName, '', $this->getBlock('', '', $this->getMsgHTML($sName, $r), false)); + } + echo $this->getSection(_t('_sys_audit_section_webserver'), $_SERVER['SERVER_SOFTWARE'], $s); + } + } + + protected function requirementsOS() + { + $s = $this->getBlock(php_uname()); + echo $this->getSection(_t('_sys_audit_section_os'), '', $s); + } + + protected function requirementsHardware() + { + $s = $this->getBlock(_t('_sys_audit_msg_hardware_requirements')); + echo $this->getSection(_t('_sys_audit_section_hardware'), '', $s); + } + + protected function siteSetup() + { + $sFfmpegPath = defined('BX_SYSTEM_FFMPEG') ? BX_SYSTEM_FFMPEG : BX_DIRECTORY_PATH_PLUGINS . 'ffmpeg/ffmpeg.exe'; + + $sEmailToCkeckMailSending = class_exists('BxDolDb') && BxDolDb::getInstance() ? BxDolDb::getInstance()->getParam('site_email') : ''; + + $oUpgrader = new BxDolUpgrader(); + if (!($sLatestVer = $oUpgrader->getLatestVersionNumber())) + $sLatestVer = 'undefined'; + + $sVer = bx_get_ver(); + $aMessage = array('type' => BX_DOL_AUDIT_OK); + if (!version_compare($sVer, $sLatestVer, '>=')) + $aMessage = array('type' => BX_DOL_AUDIT_WARN, 'msg' => _t('_sys_audit_msg_version_is_outdated', $sLatestVer)); + + $s = $this->getBlock(_t('_sys_audit_version_script'), $sVer, $this->getMsgHTML(_t('_sys_audit_version_script'), $aMessage)); + + $s .= $this->getBlock(_t('_sys_audit_permissions'), '', _t('_sys_audit_msg_permissions')); + + $s .= $this->getBlock('ffmpeg', '', _t('_sys_audit_msg_ffmpeg', `{$sFfmpegPath} 2>&1`)); + + $s .= $this->getBlock(_t('_sys_audit_mail_sending'), '', _t('_sys_audit_msg_mail_sending')); + + $s .= $this->getBlock(_t('_sys_audit_cron_jobs'), '', _t('_sys_audit_msg_cron_jobs', `crontab -l 2>&1`)); + + $iCronTime = getParam('sys_cron_time'); + $s .= $this->getBlock(_t('_sys_audit_cron_jobs_exec_time'), '', !empty($iCronTime) ? bx_time_js($iCronTime, BX_FORMAT_DATE_TIME, true) : _t('_None')); + + echo '' . _t('_sys_audit_header_site_setup') . ''; + echo "$s"; + } + + protected function optimization() + { + echo '' . _t('_sys_audit_header_site_optimization') . ''; + + $this->optimizationPhp(); + + if (!defined('BX_DOL_INSTALL')) + $this->optimizationMySQL(); + + $this->optimizationWebServer(); + + if (!defined('BX_DOL_INSTALL')) + $this->optimizationScript(); + } + + protected function optimizationPhp() + { + $s = ''; + $aMessage = array(); + + $sAccel = $this->getPhpAccelerator(); + if (!$sAccel) + $aMessage = array('type' => BX_DOL_AUDIT_WARN, 'msg' => _t('_sys_audit_msg_php_accelerator_missing')); + else + $aMessage = array('type' => BX_DOL_AUDIT_OK); + $s .= $this->getBlock(_t('_sys_audit_php_accelerator'), $sAccel, $this->getMsgHTML(_t('_sys_audit_php_accelerator'), $aMessage)); + + $sSapi = php_sapi_name(); + if (0 === strcasecmp('cgi', $sSapi)) + $aMessage = array('type' => BX_DOL_AUDIT_WARN, 'msg' => _t('_sys_audit_msg_php_setup_inefficient')); + else + $aMessage = array('type' => BX_DOL_AUDIT_OK); + $s .= $this->getBlock(_t('_sys_audit_php_setup'), $sSapi, $this->getMsgHTML(_t('_sys_audit_php_setup'), $aMessage)); + + echo $this->getSection('PHP', '', $s); + } + + protected function optimizationMySQL() + { + $s = ''; + $oDb = BxDolDb::getInstance(); + + foreach ($this->aMysqlOptimizationSettings as $sName => $r) { + $a = $this->checkMysqlSetting($sName, $r, $oDb); + $aMessage = array('type' => BX_DOL_AUDIT_OK); + if (!$a['res']) + $aMessage = array('type' => BX_DOL_AUDIT_FAIL, 'msg' => _t('_sys_audit_msg_must_be', $r['op'], $this->format_output($r['val'], $r))); + $s .= $this->getBlock($sName, $this->format_output($a['real_val'], $r), $this->getMsgHTML($sName, $aMessage)); + } + + echo $this->getSection('MySQL', '', $s); + } + + protected function optimizationWebServer() + { + $s = ''; + + $sName = 'expires_module'; + $sApacheModuleChack = _t('_sys_audit_msg_optimization_apache_module', $sName, $this->getMsgHTML($sName, $this->checkApacheModule($sName))); + $s .= $this->getBlock(_t('_sys_audit_userside_caching'), '', _t('_sys_audit_msg_userside_caching', $this->getUrlForGooglePageSpeed('LeverageBrowserCaching'), $sApacheModuleChack)); + + $sName = 'deflate_module'; + $sApacheModuleChack = _t('_sys_audit_msg_optimization_apache_module', $sName, $this->getMsgHTML($sName, $this->checkApacheModule($sName))); + $s .= $this->getBlock(_t('_sys_audit_serverside_compression'), '', _t('_sys_audit_msg_serverside_compression', $sApacheModuleChack)); + + echo $this->getSection(_t('_sys_audit_section_webserver'), '', $s); + } + + protected function optimizationScript() + { + $s = ''; + foreach ($this->aOptimizationSettings as $sName => $a) { + + $sVal = ('always_on' == $a['enabled'] || getParam($a['enabled'])) ? 'On' : 'Off'; + if ($a['cache_engine']) + $sVal .= _t('_sys_audit_msg_x_based_cache_engine', getParam($a['cache_engine'])); + + if ('always_on' != $a['enabled'] && !getParam($a['enabled'])) + $aMessage = array('type' => BX_DOL_AUDIT_FAIL, 'msg' => _t('_sys_audit_msg_optimization_fail')); + elseif ($a['check_accel'] && !$this->getPhpAccelerator() && 'File' == getParam($a['cache_engine'])) + $aMessage = array('type' => BX_DOL_AUDIT_WARN, 'msg' => _t('_sys_audit_msg_optimization_warn')); + else + $aMessage = array('type' => BX_DOL_AUDIT_OK); + + $s .= $this->getBlock($sName, $sVal, $this->getMsgHTML($sName, $aMessage)); + } + + echo $this->getSection('UNA', '', $s); + } + + protected function manualCheck() + { + echo ''; + echo '' . _t('_sys_audit_header_manual_audit') . ''; + echo _t('_sys_audit_msg_manual_audit'); + } + + protected function checkPhpSetting($sName, $a) + { + $mixedVal = ini_get($sName); + $mixedVal = $this->format_input ($mixedVal, $a); + + switch ($a['op']) { + case 'without': + $aFuncsDisabled = explode(',', $mixedVal); + array_walk($aFuncsDisabled, function (&$sVal, $sKey) { + $sVal = trim($sVal); + }); + $aFuncsMustBeEnabled = explode(',', $a['val']); + $a = array_intersect($aFuncsDisabled, $aFuncsMustBeEnabled); + $bResult = !$a; + break; + case 'module': + $bResult = extension_loaded($a['val']); + $mixedVal = $bResult ? $a['val'] : ''; + break; + case '>': + $bResult = (isset($a['unlimited']) && $mixedVal == $a['unlimited']) ? true : ($mixedVal > $a['val']); + break; + case '>=': + $bResult = (isset($a['unlimited']) && $mixedVal == $a['unlimited']) ? true : ($mixedVal >= $a['val']); + break; + case '=': + default: + $bResult = ($mixedVal == $a['val']); + } + return array ('res' => $bResult, 'real_val' => $mixedVal); + } + + protected function checkMysqlSetting($sName, $a, $oDb) + { + $mixedVal = $oDb->getOption($sName); + $mixedVal = $this->format_input ($mixedVal, $a); + + switch ($a['op']) { + case '>': + $bResult = ($mixedVal > $a['val']); + break; + case '>=': + $bResult = ($mixedVal >= $a['val']); + break; + case 'strcasecmp': + $bResult = 0 === strcasecmp($mixedVal, $a['val']); + break; + case '=': + default: + $bResult = ($mixedVal == $a['val']); + } + return array ('res' => $bResult, 'real_val' => $mixedVal); + } + + protected function format_output ($mixedVal, $a) + { + if (isset($a['type']) && 'bytes' == $a['type']) + return function_exists('_t_format_size') ? _t_format_size($mixedVal) : $mixedVal; + if (isset($a['type']) && 'bool' == $a['type']) + return $mixedVal ? 'On' : 'Off'; + else + return $mixedVal; + } + + protected function format_input ($mixedVal, $a) + { + if (isset($a['type']) && 'bytes' == $a['type']) + return $this->format_bytes ($mixedVal); + else + return $mixedVal; + } + + protected function format_bytes($val) + { + return return_bytes($val); + } + + protected function checkApacheModule ($sModule, $sNameCompiledName = '') + { + $a = array ( + 'deflate_module' => 'mod_deflate', + 'expires_module' => 'mod_expires', + ); + if (!$sNameCompiledName && isset($a[$sModule])) + $sNameCompiledName = $a[$sModule]; + + if (function_exists('apache_get_modules')) { + + $aModules = apache_get_modules(); + $ret = in_array($sNameCompiledName, $aModules); + + } else { + + $sApachectlPath = trim(`which apachectl`); + if (!$sApachectlPath) + $sApachectlPath = trim(`which apache2ctl`); + if (!$sApachectlPath) + $sApachectlPath = trim(`which /usr/local/apache/bin/apachectl`); + if (!$sApachectlPath) + $sApachectlPath = trim(`which /usr/local/apache/bin/apache2ctl`); + if (!$sApachectlPath) { + return array('type' => BX_DOL_AUDIT_UNDEF); + } + $ret = (boolean)`$sApachectlPath -M 2>&1 | grep $sModule`; + if (!$ret) + $ret = (boolean)`$sApachectlPath -l 2>&1 | grep $sNameCompiledName`; + } + + $aMessage = array('type' => BX_DOL_AUDIT_OK); + if (!$ret) + $aMessage = array('type' => BX_DOL_AUDIT_FAIL, 'msg' => _t('_sys_audit_msg_apache_module_fail', $sModule)); + + return $aMessage; + } + + protected function getPhpAccelerator () + { + $aAccelerators = array ( + 'APC' => array('op' => 'module', 'val' => 'apc'), + 'XCache' => array('op' => 'module', 'val' => 'xcache'), + 'ZendOPcache' => array('op' => 'module', 'val' => 'Zend OPcache'), + ); + foreach ($aAccelerators as $sName => $r) { + $a = $this->checkPhpSetting($sName, $r); + if ($a['res']) + return $sName; + } + return false; + } + + protected function getUrlForGooglePageSpeed ($sRule) + { + if (defined('BX_DOL_URL_ROOT')) { + $sUrl = BX_DOL_URL_ROOT; + } + else { + $sUrl = 'http://'; + if ( + (isset($_SERVER['HTTPS']) && $_SERVER['HTTPS']) || + (isset($_SERVER['HTTP_X_FORWARDED_PROTO']) && 'https' == strtolower($_SERVER['HTTP_X_FORWARDED_PROTO'])) || + getenv('UNA_HTTPS') + ) + $sUrl = 'https://'; + $sUrl .= $_SERVER['HTTP_HOST'] . str_replace('/install/index.php', '', $_SERVER['PHP_SELF']); + } + return 'https://pagespeed.web.dev/report?url=' . $sUrl; + } + + protected function sendTestEmail () + { + $sEmailToCkeckMailSending = isset($_GET['email']) ? $_GET['email'] : getParam('site_email'); + $mixedRet = sendMail($sEmailToCkeckMailSending, 'Audit Test Email', 'Sample text for testingSample text for testing', '', array(), BX_EMAIL_SYSTEM); + if (!$mixedRet) { + $aMessage = array('type' => BX_DOL_AUDIT_FAIL, 'msg' => _t('_sys_audit_msg_mail_send_failed')); + return $this->getBlock('', '', $this->getMsgHTML(_t('_sys_audit_mail_sending'), $aMessage), false); + } else { + return _t('_sys_audit_msg_mail_sent', $sEmailToCkeckMailSending); + } + } + + protected function setErrorReporting () + { + if (version_compare(phpversion(), "5.3.0", ">=") == 1) + $this->iPhpErrorReporting = error_reporting(E_ALL & ~E_NOTICE & ~E_WARNING & ~E_DEPRECATED & ~E_STRICT); + else + $this->iPhpErrorReporting = error_reporting(E_ALL & ~E_NOTICE & ~E_WARNING); + } + + protected function restoreErrorReporting () + { + error_reporting($this->iPhpErrorReporting); + } + + protected function getSection($sTitle, $sTitleAddon, $sContent) + { + $s = '' . $sTitle . ': ' . $sTitleAddon; + $s .= ''; + $s .= $sContent; + $s .= ''; + return $s; + } + + protected function getBlock($sName, $sValue = '', $sMsg = '', $bWrapAsListItem = true) + { + $s = $bWrapAsListItem ? '' : ''; + if ($sName !== '') + $s .= "$sName "; + if ($sValue !== '') + $s .= " = $sValue "; + if ($sMsg) + $s .= ($s ? " - " : '') . $sMsg; + return $s . ($bWrapAsListItem ? '' : '') . "\n"; + } + + protected function getMsgHTML($sName, $a) + { + $s = ''; + $s .= '' . $this->aType2Title[$a['type']]. ' '; + if (isset($a['msg'])) + $s .= '(' . $a['msg'] . ')'; + return $s; + } +} + +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/js/agents.js b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/js/agents.js new file mode 100644 index 0000000000..30edf170b0 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/js/agents.js @@ -0,0 +1,130 @@ +/** + * Copyright (c) UNA, Inc - https://una.io + * MIT License - https://opensource.org/licenses/MIT + * + * @defgroup UnaStudio UNA Studio + * @{ + */ +function BxDolStudioPageAgents(oOptions) +{ + BxDolStudioPage.call(this, oOptions); + + this.sPageUrl = oOptions.sPageUrl; + this.sObjName = oOptions.sObjName == undefined ? 'oBxDolStudioPageAgents' : oOptions.sObjName; + + this.sActionUrlCmts = oOptions.sActionUrlCmts == undefined ? this.sActionUrl : oOptions.sActionUrlCmts; + this.sActionUrlGrid = oOptions.sActionUrlGrid == undefined ? this.sActionUrl : oOptions.sActionUrlGrid; + + /* + * Note. Are needed for Grid and don't used for now. + * + this.sObjNameGrid = oOptions.sObjNameGrid; + this.sParamsDivider = oOptions.sParamsDivider == undefined ? '#-#' : oOptions.sParamsDivider; + this.sTextSearchInput = oOptions.sTextSearchInput == undefined ? '' : oOptions.sTextSearchInput; + */ +} + +BxDolStudioPageAgents.prototype = Object.create(BxDolStudioPage.prototype); +BxDolStudioPageAgents.prototype.constructor = BxDolStudioPageAgents; + +BxDolStudioPageAgents.prototype.onChangeAutomatorType = function(oSelect) { + var aHide = []; + var aShow = []; + switch($(oSelect).val()) { + case 'event': + aHide = []; //['scheduler_time']; + aShow = []; //['alert_unit', 'alert_action']; + break; + + case 'scheduler': + aHide = []; //['alert_unit', 'alert_action']; + aShow = []; //['scheduler_time']; + break; + + default: + aHide = []; //['alert_unit', 'alert_action', 'scheduler_time']; + aShow = []; + } + + var sHide = ''; + aHide.forEach((sItem) => { + sHide += ".bx-form-advanced #bx-form-element-" + sItem + ","; + }); + + var sShow = ''; + aShow.forEach((sItem) => { + sShow += ".bx-form-advanced #bx-form-element-" + sItem + ","; + }); + + $(sHide.substring(0, sHide.length - 1)).bx_anim('hide', this.sAnimationEffect, 0); + $(sShow.substring(0, sShow.length - 1)).bx_anim('show', this.sAnimationEffect, 0); +}; + +BxDolStudioPageAgents.prototype.approveCode = function(oSource, iCmtId) { + var $this = this; + var oData = this._getDefaultData(); + oData = jQuery.extend({}, oData, {action: 'approveCode', Cmt: iCmtId}); + + oSource = $(oSource); + bx_loading_btn(oSource, true); + + jQuery.post ( + this.sActionUrlCmts, + oData, + function(oData) { + bx_loading_btn(oSource, false); + + processJsonData(oData); + }, + 'json' + ); +}; + +BxDolStudioPageAgents.prototype.providerAdd = function(oButton, sName) { + var oButton = $(oButton); + + var oSubentry = oButton.parents('#bx-form-element-' + sName).find('.bx-form-input-provider:first').clone(); + oSubentry.find("select").val(''); + oSubentry.find("input[type = 'hidden']").remove(); + + oButton.parents('.bx-form-input-provider-add:first').before(oSubentry); +}; + +BxDolStudioPageAgents.prototype.providerDelete = function(oButton) { + $(oButton).parents('.bx-form-input-provider:first').remove(); +}; + +BxDolStudioPageAgents.prototype.helperAdd = function(oButton, sName) { + var oButton = $(oButton); + + var oSubentry = oButton.parents('#bx-form-element-' + sName).find('.bx-form-input-helper:first').clone(); + oSubentry.find("select").val(''); + oSubentry.find("input[type = 'hidden']").remove(); + + oButton.parents('.bx-form-input-helper-add:first').before(oSubentry); +}; + +BxDolStudioPageAgents.prototype.helperDelete = function(oButton) { + $(oButton).parents('.bx-form-input-helper:first').remove(); +}; + +BxDolStudioPageAgents.prototype.assistantAdd = function(oButton, sName) { + var oButton = $(oButton); + + var oSubentry = oButton.parents('#bx-form-element-' + sName).find('.bx-form-input-assistant:first').clone(); + oSubentry.find("select").val(''); + oSubentry.find("input[type = 'hidden']").remove(); + + oButton.parents('.bx-form-input-assistant-add:first').before(oSubentry); +}; + +BxDolStudioPageAgents.prototype.assistantDelete = function(oButton) { + $(oButton).parents('.bx-form-input-assistant:first').remove(); +}; + +BxDolStudioPageAgents.prototype._getDefaultData = function() { + var oDate = new Date(); + return jQuery.extend({}, this._oRequestParams, {_t:oDate.getTime()}); +}; + +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/js/launcher.js b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/js/launcher.js new file mode 100644 index 0000000000..98dd729ac0 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/js/launcher.js @@ -0,0 +1,302 @@ +/** + * Copyright (c) UNA, Inc - https://una.io + * MIT License - https://opensource.org/licenses/MIT + * + * @defgroup UnaStudio UNA Studio + * @{ + */ +function BxDolStudioLauncher(oOptions) { + this.sActionsUrl = oOptions.sActionUrl; + this.sObjName = oOptions.sObjName == undefined ? 'oBxDolStudioLauncher' : oOptions.sObjName; + this.sAnimationEffect = oOptions.sAnimationEffect == undefined ? 'fade' : oOptions.sAnimationEffect; + this.iAnimationSpeed = oOptions.iAnimationSpeed == undefined ? 'fast' : oOptions.iAnimationSpeed; + this.bInit = oOptions.bInit == undefined ? true : oOptions.bInit; + + //--- Jitter Settings ---// + this.bJitterMode = false; + this.aJitterConf = { + item: '.bx-std-widget-icon', + elements: '.bx-std-widget-actions,.bx-std-widget-icon-jitter,.bx-std-widget-caption-jitter' + }; + + this.aSortingConf = { + parent: '.bx-std-widgets', + item: '.bx-std-widget', + placeholder: 'bx-std-widget bx-std-widget-empty' + }; + + if(this.bInit) + this.init(); +} + +BxDolStudioLauncher.prototype.init = function() { + var $this = this; + + $(document).ready(function() { + var hammertime = new Hammer($('.bx-std-widgets').get(0)); + hammertime.get('press').set({time: 1000}); + hammertime.on('press', function(oEvent) { + if(!$this.bJitterMode) + $this.enableJitter(); + else + $this.disableJitter(); + }); + + //--- Enable Sorting for Page Edit mode ---// + $($this.aSortingConf.parent).sortable({ + disabled: true, + handle: '.bx-std-widget-icon-jitter', + items: $this.aSortingConf.item, + placeholder: $this.aSortingConf.placeholder, + start: function(oEvent, oUi) { + oUi.item.addClass('bx-std-widget-dragging'); + }, + stop: function(oEvent, oUi) { + oUi.item.removeClass('bx-std-widget-dragging'); + $this.reorder(oUi.item); + } + }); + + //--- Check for Featured mode. + if($this._isFeatured()) + $('.bx-menu-tab-featured').addClass('bx-menu-tab-active'); + }); + + window.addEventListener('keydown', (e) => { + if(e.keyCode === 114 || (e.ctrlKey && e.keyCode === 70) || (e.metaKey && e.keyCode === 70)) { + e.preventDefault(); + + $('.bx-menu-tab-search .bx-form-input-text[name="search"]').focus(); + } + }); +}; + +BxDolStudioLauncher.prototype.browser = function(oLink, sType) { + var $this = this; + var oDate = new Date(); + + if(sType == undefined) + sType = ''; + + var oBrowser = $('#bx-std-launcher-browser'); + if(oBrowser.length > 0) { + var fBrowserShow = function() { + oBrowser.dolPopup({ + closeOnOuterClick: true, + pointer: { + el: '.bx-menu-breadcrumb .bx-menu-bc-' + (sType.length > 0 ? 'type' : 'home'), + align: 'left', + offset: '-16 0' + }, + onBeforeShow: function(oPopup) { + $this.browserChangeType(oLink, sType); + } + }); + } + + if(oBrowser.is(':visible')) + oBrowser.dolPopupHide({ + onHide: function() { + if(oBrowser.find('.bx-std-lb-menu .bx-std-pmen-item.bx-std-pmen-item-' + sType + '.bx-menu-tab-active').length == 0) + fBrowserShow(); + } + }); + else + fBrowserShow(); + + return false; + } + + $.get( + this.sActionsUrl, + { + action: 'launcher-browser', + type: sType, + _t: oDate.getTime() + }, + function(oData) { + processJsonData(oData); + }, + 'json' + ); + + return false; +}; + +BxDolStudioLauncher.prototype.browserChangeType = function(oLink, sType) { + var sMenuActive = 'bx-menu-tab-active'; + var sContentActive = 'bx-std-lbw-active'; + + var oMenuActive = $('.bx-std-launcher-browser .bx-std-lb-menu .bx-std-pmen-item.' + sMenuActive); + if(oMenuActive.hasClass('bx-std-pmen-item-' + sType)) + return; + + oMenuActive.removeClass(sMenuActive).siblings('.bx-std-pmen-item-' + sType).addClass(sMenuActive); + $('.bx-std-launcher-browser .bx-std-lb-content .bx-std-lb-widgets.' + sContentActive).removeClass(sContentActive).siblings('.bx-std-lbw-' + sType).addClass(sContentActive); +}; + +BxDolStudioLauncher.prototype.updateCache = function() { + var oDate = new Date(); + + $.get( + this.sActionsUrl, + { + action: 'launcher-update-cache', + _t:oDate.getTime() + } + ); +}; + +BxDolStudioLauncher.prototype.reorder = function(oDraggable) { + var oDate = new Date(); + + $.post( + this.sActionsUrl + '?' + oDraggable.parent('.bx-std-widgets').sortable('serialize', {key: 'items[]'}), + { + action: 'launcher-reorder', + page: this.sScrollCurrent, + _t:oDate.getTime() + }, + function(oData) { + if(oData.code != 0) { + bx_alert(oData.message); + return; + } + }, + 'json' + ); + + return true; +}; + +BxDolStudioLauncher.prototype.featured = function(sPageName, oLink) { + var $this = this; + var oDate = new Date(); + + $.get( + this.sActionsUrl, + { + action: 'page-featured', + page: sPageName, + _t: oDate.getTime() + }, + function(oData) { + $('.bx-popup-applied:visible').dolPopupHide(); + + if(oData.code != 0) { + bx_alert(oData.message); + return; + } + + var oSettings = $(oLink).parents('.bx-mod-popup-settings:first'); + if(oSettings.length > 0 && oData.widget_id != undefined && oData.widget.length > 0) { + $('#bx-std-widget-' + oData.widget_id).replaceWith(oData.widget); + if($this.bInit) + oBxDolStudioLauncher.enableJitter(); + } + }, + 'json' + ); + return true; +}; + +BxDolStudioLauncher.prototype.bookmark = function(sPageName, oLink) { + var oDate = new Date(); + + $.get( + this.sActionsUrl, + { + action: 'page-bookmark', + page: sPageName, + _t: oDate.getTime() + }, + function(oData) { + $('.bx-popup-applied:visible').dolPopupHide(); + + if(oData.code != 0) { + bx_alert(oData.message); + return; + } + }, + 'json' + ); + + return true; +}; + +BxDolStudioLauncher.prototype.rearrange = function(iWidgetId, oSelect) { + var oDate = new Date(); + var oSelect = $(oSelect); + var oPopup = oSelect.parents('.bx-popup'); + + bx_loading(oPopup, true); + + $.get( + this.sActionsUrl, + { + action: 'widget-rearrange', + widget_id: iWidgetId, + type: oSelect.val(), + _t: oDate.getTime() + }, + function(oData) { + bx_loading(oPopup, false); + + processJsonData(oData); + }, + 'json' + ); + + return true; +}; + +BxDolStudioLauncher.prototype.enableJitter = function() { + this._disableFeatured(); + $('.bx-menu-tab-featured').removeClass('bx-menu-tab-active'); + + $(this.aJitterConf.elements).fadeIn('fast'); + $(this.aJitterConf.item).removeClass('bx-std-widget-icon-trans'); + $(this.aSortingConf.parent).addClass('bx-std-jitter').sortable('option', 'disabled', false); + + this.bJitterMode = true; +}; + +BxDolStudioLauncher.prototype.disableJitter = function() { + $(this.aJitterConf.elements).fadeOut('fast'); + $(this.aJitterConf.item).addClass('bx-std-widget-icon-trans'); + $(this.aSortingConf.parent).removeClass('bx-std-jitter').sortable('option', 'disabled', true); + + this.bJitterMode = false; +}; + +BxDolStudioLauncher.prototype.enableFeatured = function() { + this.disableJitter(); + $('.bx-menu-tab-edit').removeClass('bx-menu-tab-active'); + + $.cookie('bx_studio_featured', '1', {path: '/'}); + + this._enableFeatured(); +}; + +BxDolStudioLauncher.prototype.disableFeatured = function() { + $.cookie('bx_studio_featured', '0', {path: '/'}); + + this._disableFeatured(); +}; + +BxDolStudioLauncher.prototype._isFeatured = function() { + return parseInt($.cookie('bx_studio_featured')) == 1; +}; + +BxDolStudioLauncher.prototype._enableFeatured = function() { + var $this = this; + + $('.bx-std-widget:not(.bx-std-widget-icon-featured)').bx_anim('hide', this.sAnimationEffect, this.iAnimationSpeed); +}; + +BxDolStudioLauncher.prototype._disableFeatured = function() { + var $this = this; + + $('.bx-std-widget:not(.bx-std-widget-icon-featured)').bx_anim('show', this.sAnimationEffect, this.iAnimationSpeed); +}; +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/js/page.js b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/js/page.js new file mode 100644 index 0000000000..911a1d52c0 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/js/page.js @@ -0,0 +1,99 @@ +/** + * Copyright (c) UNA, Inc - https://una.io + * MIT License - https://opensource.org/licenses/MIT + * + * @defgroup UnaStudio UNA Studio + * @{ + */ +function BxDolStudioPage(oOptions) { + this.sActionsUrl = oOptions.sActionUrl; + this.sObjName = oOptions.sObjName == undefined ? 'oBxDolStudioPage' : oOptions.sObjName; + this.sCodeMirror = oOptions.sCodeMirror == undefined ? '' : oOptions.sCodeMirror; + this.sAnimationEffect = oOptions.sAnimationEffect == undefined ? 'slide' : oOptions.sAnimationEffect; + this.iAnimationSpeed = oOptions.iAnimationSpeed == undefined ? 'slow' : oOptions.iAnimationSpeed; + this.oPopupOptions = { + fog: { + color: '#fff', + opacity: .7 + }, + closeOnOuterClick: false + }; + + var $this = this; + $(document).ready (function () { + if($this.sCodeMirror != '') + $this.initCodeMirror($this.sCodeMirror); + }); +} + +BxDolStudioPage.prototype.processJson = function (oData) { + bx_loading('bx-std-page-columns', false); + + processJsonData(oData); +}; + +BxDolStudioPage.prototype.togglePopup = function(sName, oLink) { + var $this = this; + + var sId = '#bx-std-pcap-menu-popup-' + sName; + if($(sId + ':visible').length > 0) { + $(sId).dolPopupHide(); + return; + } + + $(oLink).parent().addClass('bx-menu-tab-active'); + + var oPopupOptions = { + pointer:{ + el:$(oLink) + }, + onHide: function() { + $(oLink).parent().removeClass('bx-menu-tab-active'); + } + }; + + switch(sName) { + case 'assistant': + break; + + case 'help': + oPopupOptions = $.extend({}, oPopupOptions, { + onBeforeShow: function() { + var oPopup = $(sId); + var oPopupRss = oPopup.find('.RSSAggrCont'); + if(oPopupRss.contents().length) + return; + + oPopupRss.dolRSSFeed({ + onError: function() { + oPopupRss.html(_t('_adm_txt_show_help_content_empty')); + oPopup._dolPopupSetPosition(oPopupOptions); + }, + onShow: function() { + oPopup._dolPopupSetPosition(oPopupOptions); + } + }); + + oPopup._dolPopupSetPosition(oPopupOptions); + } + }); + break; + } + + if($(sId).html().length > 0) + $(sId).dolPopup(oPopupOptions); +}; + +BxDolStudioPage.prototype.initCodeMirror = function(sSelector) { + var oSelector = $(sSelector); + for(var i = 0; i < oSelector.length; i++) { + var e = CodeMirror.fromTextArea(oSelector.get(i), { + lineNumbers: true, + mode: "htmlmixed", + htmlMode: true, + matchBrackets: true + }); + } +}; + +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/options.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/options.php new file mode 100644 index 0000000000..1a93931ed3 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/options.php @@ -0,0 +1,36 @@ +checkAction()) !== false) { + echoJson($mixedResult); + exit; +} + +echo $oOptions->getCode(); +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/agents_assistant_codes.html b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/agents_assistant_codes.html new file mode 100644 index 0000000000..90f078f281 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/agents_assistant_codes.html @@ -0,0 +1,10 @@ + + + + __code_onclick__ + + + + __code_button__ + + \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/agents_assistant_info.html b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/agents_assistant_info.html new file mode 100644 index 0000000000..2f20eb672b --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/agents_assistant_info.html @@ -0,0 +1,19 @@ + + + + + __assistant_name__ + + __assistant_info__ + + + + __chat_name__ + + __chat_info__ + + + + + + \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/agents_automator_form_assistants.html b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/agents_automator_form_assistants.html new file mode 100644 index 0000000000..0d06acbb3b --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/agents_automator_form_assistants.html @@ -0,0 +1,11 @@ + + + + __input_select__ + + + + + + __btn_add__ + \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/css/agents.css b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/css/agents.css new file mode 100644 index 0000000000..7925405abe --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/css/agents.css @@ -0,0 +1,93 @@ +/**--- Automators ---**/ +.cmt .bx-menu-custom.bx-menu-custom-hor > li > span { + margin-right: 0; +} +.cmt .bx-base-general-unit-meta ul.bx-menu-custom li:first-child .bx-base-general-unit-meta-div { + display: none; +} +.bx-def-vanilla-html pre, +.cmt-body.bx-def-vanilla-html pre{ + max-height: 20rem; + + border-width: 0; + border-radius: 0.375rem; + + background-color: #1f2937; + + color: #e5e7eb; +} + +/*-- Automators form: Providers --*/ +.bx-form-input-provider { + display: -webkit-flex; + display: flex; + -webkit-align-items: center; + align-items: center; +} +.bx-form-input-provider-cell.bx-fi-pc-txt { + -webkit-flex: 1 1 auto; + -ms-flex: 1 1 auto; + flex: 1 1 auto; +} +.bx-form-input-provider-cell.bx-fi-pc-btn { + -webkit-flex: 0 0 auto; + -ms-flex: 0 0 auto; + flex: 0 0 auto; +} +.bx-form-input-provider-add { + text-align: right; +} +.bx-form-input-provider-add .bx-form-input-button { + display: inline-block; + float: none; +} + +/*-- Automators form: Helpers --*/ +.bx-form-input-helper { + display: -webkit-flex; + display: flex; + -webkit-align-items: center; + align-items: center; +} +.bx-form-input-helper-cell.bx-fi-hc-txt { + -webkit-flex: 1 1 auto; + -ms-flex: 1 1 auto; + flex: 1 1 auto; +} +.bx-form-input-helper-cell.bx-fi-hc-btn { + -webkit-flex: 0 0 auto; + -ms-flex: 0 0 auto; + flex: 0 0 auto; +} +.bx-form-input-helper-add { + text-align: right; +} +.bx-form-input-helper-add .bx-form-input-button { + display: inline-block; + float: none; +} + +/*-- Automators form: Assistants --*/ +.bx-form-input-assistant { + display: -webkit-flex; + display: flex; + -webkit-align-items: center; + align-items: center; +} +.bx-form-input-assistant-cell.bx-fi-ac-txt { + -webkit-flex: 1 1 auto; + -ms-flex: 1 1 auto; + flex: 1 1 auto; +} +.bx-form-input-assistant-cell.bx-fi-ac-btn { + -webkit-flex: 0 0 auto; + -ms-flex: 0 0 auto; + flex: 0 0 auto; +} +.bx-form-input-assistant-add { + text-align: right; +} +.bx-form-input-assistant-add .bx-form-input-button { + display: inline-block; + float: none; +} \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/css/menu_top.css b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/css/menu_top.css new file mode 100644 index 0000000000..13c153b8f4 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/css/menu_top.css @@ -0,0 +1,447 @@ +div.bx-std-menu-top-wrp { + position: relative; + display: -webkit-flex; + display: flex; + -webkit-justify-content: space-between; + justify-content: space-between; + -webkit-align-items: center; + align-items: center; + -webkit-flex-wrap: nowrap; + flex-wrap: nowrap; + + width: 100%; + height: 5rem; +} +div.bx-std-menu-top-wrp .bx-std-menu-top.bx-std-menu-top-center:first-child { + padding-left: 0.75rem; +} + +div.bx-std-menu-top {} +div.bx-std-menu-top.bx-std-menu-top-left, +div.bx-std-menu-top.bx-std-menu-top-center, +div.bx-std-menu-top.bx-std-menu-top-right { + -webkit-flex: 0 1 auto; + flex: 0 1 auto; +} +div.bx-std-menu-top.bx-std-menu-top-left, +div.bx-std-menu-top.bx-std-menu-top-right { + position: relative; + z-index: 2; + min-width: 10%; +} +div.bx-std-menu-top.bx-std-menu-top-center { + z-index: 1; + -webkit-flex-grow: 1; + flex-grow: 1; + height: 3.5rem; +} +div.bx-std-menu-top.bx-std-menu-top-center .bx-std-menu-top-center-cnt { + position: absolute; + left: 0; + width: 100vw; +} +div.bx-std-menu-top-center ul { + position: relative; + display: -webkit-flex; + display: flex; + -webkit-align-items: stretch; + align-items: stretch; + -webkit-flex-wrap: nowrap; + flex-wrap: nowrap; + +} +div.bx-std-menu-top-left { + padding-left: 1rem; + line-height: 4rem; + text-align: left; + font-size: 1.5rem; +} +div.bx-std-menu-top-right { + padding-right: 1rem; + text-align: right; +} + +/*--- Breadcrumb (Left) ---*/ +div.bx-std-menu-top .bx-menu-breadcrumb { + position: relative; + display: -webkit-flex; + display: flex; + -webkit-flex-wrap: nowrap; + flex-wrap: nowrap; + -webkit-align-items: center; + align-items: center; +} + +/*--- Widgets (Center) ---*/ +div.bx-std-menu-top .bx-menu-top-center { + display: flex; + justify-content: center; + align-items: center; + gap: 0.25rem; + + padding: 0; + margin: 0; + + list-style: none; +} + +div.bx-std-menu-top .bx-menu-breadcrumb li.bx-menu-bc-item, +div.bx-std-menu-top .bx-menu-top-center li { + position: relative; + display: -webkit-flex; + display: flex; + -webkit-justify-content: center; + justify-content: center; + -webkit-align-items: center; + align-items: center; + + width: 3.5rem; + height: 3.5rem; +} + +div.bx-std-menu-top .bx-menu-breadcrumb li.bx-menu-bc-div img { + height: 2.0rem; +} + +div.bx-std-menu-top .bx-menu-breadcrumb li.bx-menu-bc-item.bx-menu-bc-page { + width: auto; + padding-left: 0.5rem; + padding-right: 0.5rem; +} + +/* + * Vertical divider between static and dynamic menu items. + * +div.bx-std-menu-top .bx-menu-top-center li.bx-menu-item-static + li.bx-menu-item-dynamic { + border-left: 1px solid rgba(240, 240, 240, 0.2); +} +*/ + +.bx-menu-breadcrumb li.bx-menu-bc-item > a, +div.bx-std-menu-top .bx-menu-top-center li a { + display: block; + z-index: 2; + box-sizing: content-box; + + width: 2.5rem; + height: 2.5rem; +} +.bx-menu-breadcrumb li.bx-menu-bc-item > a { + display: -webkit-flex; + display: flex; + -webkit-align-items: center; + align-items: center; + + width: auto; +} +div.bx-std-menu-top .bx-menu-top-center li.bx-menu-tab-active a { + border-color: rgba(37, 99, 235, 0.8); +} +div.bx-std-menu-top .bx-menu-top-center li .bx-mi-bg { + position: absolute; + display: none; + z-index: 1; + + top: 0; + left: 0; + width: 100%; + height: 100%; + + filter: blur(6px); +} +div.bx-std-menu-top .bx-menu-top-center li.bx-menu-tab-active .bx-mi-bg { + display: block; +} +div.bx-std-menu-top .bx-menu-breadcrumb li.bx-menu-bc-item .bx-mi-icon, +div.bx-std-menu-top .bx-menu-top-center li .bx-mi-icon { + overflow: hidden; +} +div.bx-std-menu-top .bx-menu-breadcrumb li.bx-menu-bc-item .bx-mi-icon { + border-radius: 1.5rem; +} +div.bx-std-menu-top .bx-menu-breadcrumb li.bx-menu-bc-item .bx-mi-title { + text-align: center; + letter-spacing: -0.02em; + + font-size: 1.5rem; + font-weight: 500; + + color: rgb(243, 244, 246); +} +div.bx-std-menu-top .bx-menu-breadcrumb li.bx-menu-bc-item img, +div.bx-std-menu-top .bx-menu-breadcrumb li.bx-menu-bc-item:not(.bx-menu-tab-search) svg, +div.bx-std-menu-top .bx-menu-breadcrumb li.bx-menu-bc-item .sys-icon, +div.bx-std-menu-top .bx-menu-top-center li img, +div.bx-std-menu-top .bx-menu-top-center li .sys-icon { + display: block; + box-sizing: content-box; + + width: 2.5rem; + height: 2.5rem; + + margin: 0; +} + +div.bx-std-menu-top .bx-menu-top-center li img { + position: relative; + z-index: -1; +} + +div.bx-std-menu-top .bx-menu-top-center li .sys-icon { + font-size: 1.5rem; + color: rgba(255, 255, 255, 0.7); +} + +div.bx-std-menu-top .bx-menu-top-center li .bx-mi-title { + margin-top: 0.25rem; + + font-size: 0.75rem; + font-weight: normal; + color: rgba(255, 255, 255, 0.7); + + text-overflow: ellipsis; + overflow: hidden; +} +div.bx-std-menu-top .bx-menu-top-center li.bx-menu-tab-divider { + width: 0.25rem; + height: 1.75rem; +} + +/*--- Search box (Top Left\Center\Right) ---*/ +div.bx-std-menu-top ul li.bx-menu-tab-search { + overflow: visible; +} +div.bx-std-menu-top ul li.bx-menu-tab-search > div { + position: absolute; + display: -webkit-flex; + display: flex; + -webkit-align-items: center; + align-items: center; + -webkit-flex-wrap: nowrap; + flex-wrap: nowrap; + + width: 2.5rem; + height: 2.5rem; + right: 0; + + border-radius: 1.5rem; +} +div.bx-std-menu-top ul.bx-menu-breadcrumb li.bx-menu-tab-search > div { + left: 0.5rem; + right: auto; +} +div.bx-std-menu-top ul li.bx-menu-tab-search.bx-mt-active > div { + width: 13.75rem; +} +div.bx-std-menu-top ul li.bx-menu-tab-search .bx-form-input-text { + height: 2.5rem; + padding-left: 0.5rem; + padding-right: 0.5rem; + + border-width: 0; + background-color: transparent; + + font-style: normal; + font-weight: 500; +} + + +/*--- Toolbar (Right) ---*/ +div.bx-std-menu-top .bx-menu-toolbar { + position: relative; + display: -webkit-flex; + display: flex; + -webkit-flex-wrap: nowrap; + flex-wrap: nowrap; + -webkit-justify-content: flex-end; + justify-content: flex-end; +} + +div.bx-std-menu-top .bx-menu-toolbar li { + position: relative; + float: none; + display: block; + + height: 2.5rem; + min-width: 2.5rem; + + border-radius: 1.5rem; + background-color: rgba(17, 24, 39, 1); + + line-height: 2.5rem; + overflow: hidden; +} +div.bx-std-menu-top .bx-menu-toolbar li:not(.bx-menu-tab-search) a { + position: relative; + display: -webkit-flex; + display: flex; + -webkit-justify-content: center; + justify-content: center; + -webkit-align-items: center; + align-items: center; + + width: 100%; + height: 100%; + + border-radius: 1.5rem; +} + +div.bx-std-menu-top .bx-menu-toolbar li a:hover { + color: #ffffff; +} + +div.bx-std-menu-top .bx-menu-toolbar li svg g { + opacity: 0.7; +} +div.bx-std-menu-top .bx-menu-toolbar li:hover { + background-color: rgba(31, 41, 55, 1); +} +div.bx-std-menu-top .bx-menu-toolbar li:hover svg g { + opacity: 0.85; +} + +div.bx-std-menu-top i.sys-icon { + -webkit-transition: all 0.2s ease-in-out; + transition: all 0.2s ease-in-out; +} + +div.bx-std-menu-top-right li.bx-menu-tab-active i.sys-icon { + color: #ffe900; + text-shadow: 0 0 4px #ffe900; +} + +/*--- Account, Actions, Help and Settings popups ---*/ +body > .bx-popup-wrapper.bx-std-mod-popup-settings-wrapper, +#bx-std-pcap-menu-popup-help, +#bx-std-pcap-menu-popup-assistant, +#bx-std-pcap-menu-popup-actions, +#bx-std-pcap-menu-popup-account { + overflow: visible; +} +.bx-std-mod-popup-settings-wrapper .bx-popup-gap, +#bx-std-pcap-menu-popup-help .bx-popup-gap, +#bx-std-pcap-menu-popup-assistant .bx-popup-gap, +#bx-std-pcap-menu-popup-actions .bx-popup-gap, +#bx-std-pcap-menu-popup-account .bx-popup-gap { + margin-left: 0; + margin-right: 0; +} +#bx-std-pcap-menu-popup-help .bx-popup, +#bx-std-pcap-menu-popup-assistant .bx-popup, +#bx-std-pcap-menu-popup-assistant .bx-popup .bx-popup-header-color-bg, +#bx-std-pcap-menu-popup-actions .bx-popup, +#bx-std-pcap-menu-popup-account .bx-popup, +.bx-std-mod-popup-settings-wrapper.bx-popup-applied:not(.bx-popup-chain) .bx-popup { + border-width: 0; + background-color: #001529; +} +#bx-std-pcap-menu-popup-actions .bx-popup-content { + padding: 1.0rem; +} +#bx-std-pcap-menu-popup-account .bx-popup-content { + padding: 0.5rem 0; +} +#bx-std-pcap-menu-popup-account .bx-popup li { + position: relative; + height: 2.5rem; + margin: 0; + padding: 0 1rem; + + white-space: nowrap; + line-height: 2.5rem; + font-size: 0.875rem; + font-weight: 400; + overflow: hidden; +} +#bx-std-pcap-menu-popup-account .bx-popup li a { + position: relative; + display: -webkit-flex; + display: flex; + -webkit-align-items: center; + align-items: center; +} +#bx-std-pcap-menu-popup-account .bx-popup li svg { + margin-right: 0.75rem; +} + +.bx-std-mod-popup-settings-wrapper, +#bx-std-pcap-menu-popup-help .bx-popup, +#bx-std-pcap-menu-popup-help .bx-popup a, +#bx-std-pcap-menu-popup-help .bx-popup .sys-icon, +#bx-std-pcap-menu-popup-assistant .bx-popup, +#bx-std-pcap-menu-popup-assistant .bx-popup .bx-popup-header h2, +#bx-std-pcap-menu-popup-assistant .bx-popup .bx-popup-header .bx-icon, +#bx-std-pcap-menu-popup-assistant .bx-popup a, +#bx-std-pcap-menu-popup-assistant .bx-popup .sys-icon, +#bx-std-pcap-menu-popup-actions .bx-popup, +#bx-std-pcap-menu-popup-account .bx-popup li a, +#bx-std-pcap-menu-popup-account .bx-popup li .sys-icon { + color: rgba(255, 255, 255, 0.7); +} +#bx-std-pcap-menu-popup-account .bx-popup li svg g { + opacity: 0.7; +} +#bx-std-pcap-menu-popup-help .bx-popup a:hover, +#bx-std-pcap-menu-popup-assistant .bx-popup a:hover, +#bx-std-pcap-menu-popup-account .bx-popup li:hover a, +#bx-std-pcap-menu-popup-account .bx-popup li:hover a .sys-icon { + color: rgba(255, 255, 255, 0.85); +} +#bx-std-pcap-menu-popup-account .bx-popup li.bx-menu-tab-active { + background-color: rgba(24, 144, 255, 0.2); + box-shadow: inset 3px 0px 0px rgba(24, 144, 255, 1.0); +} +#bx-std-pcap-menu-popup-account .bx-popup li:hover svg g, +#bx-std-pcap-menu-popup-account .bx-popup li.bx-menu-tab-active svg g { + opacity: 0.85; +} + +.bx-std-mod-popup-settings-wrapper .bx-form-input-select { + border-color: rgb(55, 65, 81, 1.0); + background-color: rgb(17, 24, 39, 1.0); +} + +/*--- Assistant ---*/ +#bx-std-pcap-menu-popup-assistant .bx-popup .bx-popup-header { + border-bottom: 1px solid rgb(31 41 55); +} +#bx-std-pcap-menu-popup-assistant .bx-popup .bx-popup-content { + padding-top: 0; +} +.bx-std-pcap-assistant div.cmts { + max-height: calc(0.5 * 100vh); + overflow-y: auto; +} +.bx-std-pcap-assistant div.cmts > ul.cmts { + margin-top: 1rem; +} +.bx-std-pcap-assistant .cmt > .cmts { + display: none; +} +.bx-std-pcap-assistant .cmt .cmt-head .cmt-meta { + margin-right: 0; + color: rgb(156 163 175); +} +.bx-std-pcap-assistant .cmt .cmt-head ul li:first-child .bx-base-general-unit-meta-div { + display: none; +} +.bx-std-pcap-assistant .cmt .cmt-cont .cmt-body { + color: rgb(229, 231, 235); +} +.bx-std-pcap-assistant .cmt-reply.cmt-reply-bottom { + margin-bottom: 0; +} +.bx-std-pcap-assistant .bx-form-section-content { + display: flex; +} +.bx-std-pcap-assistant .bx-form-section-content > .bx-form-element-wrapper:first-child { + flex: 1 1 auto; +} +.bx-std-pcap-assistant .bx-form-section-content > .bx-form-element-wrapper:last-child { + flex: 0 0 auto; + margin: 0 0 0 1rem; +} +.bx-std-pcap-assistant .bx-form-value .bx-form-input-textarea { + height: 2.5rem; + background-color: rgb(31 41 55); +} \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/images/icons/mi-agt-assistants.svg b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/images/icons/mi-agt-assistants.svg new file mode 100644 index 0000000000..a4c85c2108 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/images/icons/mi-agt-assistants.svg @@ -0,0 +1,14 @@ + + + + + + + + + + + + + + diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/images/icons/mi-agt-automators.svg b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/images/icons/mi-agt-automators.svg new file mode 100644 index 0000000000..cc3f61139e --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/images/icons/mi-agt-automators.svg @@ -0,0 +1,14 @@ + + + + + + + + + + + + + + diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/images/icons/mi-agt-helpers.svg b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/images/icons/mi-agt-helpers.svg new file mode 100644 index 0000000000..4d8d000637 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/images/icons/mi-agt-helpers.svg @@ -0,0 +1,14 @@ + + + + + + + + + + + + + + diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/images/icons/mi-agt-providers.svg b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/images/icons/mi-agt-providers.svg new file mode 100644 index 0000000000..dc624487b4 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/images/icons/mi-agt-providers.svg @@ -0,0 +1,14 @@ + + + + + + + + + + + + + + diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/images/icons/mi-cog.svg b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/images/icons/mi-cog.svg new file mode 100644 index 0000000000..108cdb5514 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/images/icons/mi-cog.svg @@ -0,0 +1,14 @@ + + + + + + + + + + + + + + diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/images/icons/tmi-assistant.svg b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/images/icons/tmi-assistant.svg new file mode 100644 index 0000000000..7706171ba5 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/images/icons/tmi-assistant.svg @@ -0,0 +1,3 @@ + + + diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/images/icons/wi-bld-roles.svg b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/images/icons/wi-bld-roles.svg new file mode 100644 index 0000000000..ad78074073 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/images/icons/wi-bld-roles.svg @@ -0,0 +1,27 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/page_caption_assistant.html b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/page_caption_assistant.html new file mode 100644 index 0000000000..d55182f7f8 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/page_caption_assistant.html @@ -0,0 +1,3 @@ + + __content__ + \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/pgt_etemplates_creative_fld.html b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/pgt_etemplates_creative_fld.html new file mode 100644 index 0000000000..f9d110e668 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/pgt_etemplates_creative_fld.html @@ -0,0 +1,39 @@ + + __content_html__ + __content_data__ + + + \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/pgt_etemplates_creative_frm.html b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/pgt_etemplates_creative_frm.html new file mode 100644 index 0000000000..ad4ad02922 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/pgt_etemplates_creative_frm.html @@ -0,0 +1,3 @@ +__warning__ + +__form__ \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/scripts/BxBaseStudioAgents.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/scripts/BxBaseStudioAgents.php new file mode 100644 index 0000000000..1294fb1388 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/scripts/BxBaseStudioAgents.php @@ -0,0 +1,317 @@ +sSubpageUrl = BX_DOL_URL_STUDIO . 'agents.php?page='; + + $this->aPageJs = array_merge($this->aPageJs, ['agents.js']); + $this->aPageCss = array_merge($this->aPageCss, ['cmts.css', 'agents.css']); + + $this->sPageJsClass = 'BxDolStudioPageAgents'; + $this->sPageJsObject = 'oBxDolStudioPageAgents'; + $this->aPageJsOptions = [ + 'sActionUrl' => BX_DOL_URL_STUDIO . 'agents.php', + 'sPageUrl' => $this->sSubpageUrl + ]; + + $this->aMenuItems = [ + BX_DOL_STUDIO_AGENTS_TYPE_SETTINGS => ['icon' => 'mi-cog.svg', 'icon_bg' => true], + BX_DOL_STUDIO_AGENTS_TYPE_PROVIDERS => ['icon' => 'mi-agt-providers.svg', 'icon_bg' => true], + BX_DOL_STUDIO_AGENTS_TYPE_HELPERS => ['icon' => 'mi-agt-helpers.svg', 'icon_bg' => true], + BX_DOL_STUDIO_AGENTS_TYPE_ASSISTANTS => ['icon' => 'mi-agt-assistants.svg', 'icon_bg' => true], + BX_DOL_STUDIO_AGENTS_TYPE_AUTOMATORS => ['icon' => 'mi-agt-automators.svg', 'icon_bg' => true], + ]; + + $this->aGridObjects = [ + BX_DOL_STUDIO_AGENTS_TYPE_AUTOMATORS => 'sys_studio_agents_automators', + BX_DOL_STUDIO_AGENTS_TYPE_PROVIDERS => 'sys_studio_agents_providers', + BX_DOL_STUDIO_AGENTS_TYPE_ASSISTANTS => 'sys_studio_agents_assistants', + BX_DOL_STUDIO_AGENTS_TYPE_ASSISTANTS . '_chats' => 'sys_studio_agents_assistants_chats', + BX_DOL_STUDIO_AGENTS_TYPE_ASSISTANTS . '_files' => 'sys_studio_agents_assistants_files', + BX_DOL_STUDIO_AGENTS_TYPE_HELPERS => 'sys_studio_agents_helpers', + ]; + } + + public function getPageJsCode($aOptions = [], $bWrap = true) + { + return parent::getPageJsCode(array_merge($aOptions, $this->aPageJsOptions), $bWrap); + } + + public function getPageMenu($aMenu = [], $aMarkers = []) + { + $sJsObject = $this->getPageJsObject(); + + $aMenu = []; + foreach($this->aMenuItems as $sMenuItem => $aItem) + $aMenu[] = array_merge($aItem, [ + 'name' => $sMenuItem, + 'link' => $this->sSubpageUrl . $sMenuItem, + 'title' => _t('_adm_lmi_cpt_' . $sMenuItem), + 'selected' => $sMenuItem == $this->sPage + ]); + + return parent::getPageMenu($aMenu); + } + + protected function getSettings() + { + $oOptions = new BxTemplStudioOptions(BX_DOL_STUDIO_STG_TYPE_DEFAULT, [ + 'agents_general', + 'agents_usage', + ]); + + $this->aPageCss = array_merge($this->aPageCss, $oOptions->getCss()); + $this->aPageJs = array_merge($this->aPageJs, $oOptions->getJs()); + + return $oOptions->getCode(); + } + + protected function getAutomators() + { + $oTemplate = BxDolStudioTemplate::getInstance(); + + $this->aPageJsOptions['sPageUrl'] .= 'automators'; + + if(($iId = bx_get('id')) !== false) { + if(($oCmts = BxDolAI::getInstance()->getAutomatorCmtsObject($iId, $oTemplate)) !== false) { + $this->aPageJsOptions = array_merge($this->aPageJsOptions, [ + 'sPageUrl' => $this->sSubpageUrl . 'automators&id=' . $iId, + 'sActionUrlCmts' => bx_append_url_params(BX_DOL_URL_ROOT . 'cmts.php', [ + 'sys' => $oCmts->getSystemName(), + 'id' => $iId + ]) + ]); + + return $oCmts->getCommentsBlock(); + } + else + return MsgBox(_t('_error occured')); + } + + return $this->getGrid($this->aGridObjects[BX_DOL_STUDIO_AGENTS_TYPE_AUTOMATORS]); + } + + protected function getHelpers() + { + $oTemplate = BxDolStudioTemplate::getInstance(); + + $this->aPageJsOptions['sPageUrl'] .= 'helpers'; + + if(($iId = bx_get('id')) !== false) { + $this->aPageJsOptions = array_merge($this->aPageJsOptions, [ + 'sPageUrl' => $this->sSubpageUrl . 'helpers&id=' . $iId, + ]); + + $aHelper = BxDolAI::getInstance()->getHelperById($iId); + + $aForm = $this->_getHelpersForm('tune', $aHelper); + $oForm = new BxTemplFormView($aForm); + $oForm->initChecker(); + + if($oForm->isSubmittedAndValid()) { + if($oForm->update($iId) !== false) { + $sMessage = $oForm->getCleanValue('message'); + $oForm->aInputs['result']['value'] = BxDolAI::callHelper($iId, $sMessage); + } + } + + return $oForm->getCode(); + } + + return $this->getGrid($this->aGridObjects[BX_DOL_STUDIO_AGENTS_TYPE_HELPERS]); + } + + protected function getAssistants() + { + $oAi = BxDolAI::getInstance(); + $oTemplate = BxDolStudioTemplate::getInstance(); + + $this->aPageJsOptions['sPageUrl'] .= 'assistants'; + + $sSubPage = ''; + if(($sSubPage = bx_get('spage')) !== false) + $sSubPage = bx_process_input($sSubPage, BX_DATA_TEXT); + + $iAssistantId = 0; + if(($iAssistantId = bx_get('aid')) !== false) + $iAssistantId = bx_process_input($iAssistantId, BX_DATA_INT); + + $iChatId = 0; + if(($iChatId = bx_get('cid')) !== false) + $iChatId = bx_process_input($iChatId, BX_DATA_INT); + + if($iAssistantId && $iChatId) { + $aResult = []; + + $sAssistantUrl = $this->sSubpageUrl . 'assistants&spage=chats&aid=' . $iAssistantId; + $aAssistant = $oAi->getAssistantById($iAssistantId); + if(!empty($aAssistant) && is_array($aAssistant)) { + $aChat = $oAi->getAssistantChatById($iChatId); + if(!empty($aChat) && is_array($aChat)) + $aResult[] = $oTemplate->parseHtmlByName('agents_assistant_info.html', [ + 'assistant_name' => $aAssistant['name'], + 'assistant_info' => $aAssistant['description'], + 'bx_if:show_chat' => [ + 'condition' => true, + 'content' => [ + 'chat_name' => $aChat['name'], + 'chat_info' => $aChat['description'], + ] + ], + 'url_back' => $sAssistantUrl + ]); + } + + if(($oCmts = $oAi->getAssistantChatCmtsObject($iChatId, $oTemplate)) !== false) { + $this->aPageJsOptions = array_merge($this->aPageJsOptions, [ + 'sPageUrl' => $sAssistantUrl . '&cid=' . $iChatId, + 'sActionUrlCmts' => bx_append_url_params(BX_DOL_URL_ROOT . 'cmts.php', [ + 'sys' => $oCmts->getSystemName(), + 'id' => $iChatId + ]) + ]); + + $aResult[] = $oCmts->getCommentsBlock(); + } + else + $aResult[] = MsgBox(_t('_error occured')); + + return $aResult; + } + else if($iAssistantId) { + $aResult = []; + + $aAssistant = $oAi->getAssistantById($iAssistantId); + if(!empty($aAssistant) && is_array($aAssistant)) + $aResult[] = $oTemplate->parseHtmlByName('agents_assistant_info.html', [ + 'assistant_name' => $aAssistant['name'], + 'assistant_info' => $aAssistant['description'], + 'bx_if:show_chat' => [ + 'condition' => false, + 'content' => [ + 'chat_name' => '', + 'chat_info' => '', + ] + ], + 'url_back' => $this->aPageJsOptions['sPageUrl'] + ]); + + switch($sSubPage) { + case 'chats': + $aResult[] = $this->getGrid($this->aGridObjects[BX_DOL_STUDIO_AGENTS_TYPE_ASSISTANTS . '_chats']); + break; + + case 'files': + $aResult[] = $this->getGrid($this->aGridObjects[BX_DOL_STUDIO_AGENTS_TYPE_ASSISTANTS . '_files']); + break; + } + + return $aResult; + } + + return $this->getGrid($this->aGridObjects[BX_DOL_STUDIO_AGENTS_TYPE_ASSISTANTS]); + } + + protected function getProviders() + { + $this->aPageJsOptions = array_merge($this->aPageJsOptions, [ + 'sPageUrl' => $this->sSubpageUrl . 'providers', + 'sActionUrlGrid' => bx_append_url_params(BX_DOL_URL_ROOT . 'grid.php', [ + 'o' => 'sys_studio_agents_providers' + ]) + ]); + + return $this->getGrid($this->aGridObjects[BX_DOL_STUDIO_AGENTS_TYPE_PROVIDERS]); + } + + protected function getGrid($sObjectName, $bObject = false) + { + $oGrid = BxDolGrid::getObjectInstance($sObjectName); + if(!$oGrid) + return ''; + + return $bObject ? $oGrid : $oGrid->getCode(); + } + + protected function _getHelpersForm($sAction, $aHelper = []) + { + $aForm = array( + 'form_attrs' => array( + 'id' => 'bx_std_agents_helpers_' . $sAction, + 'action' => $this->aPageJsOptions['sPageUrl'], + 'method' => 'post', + ), + 'params' => array ( + 'db' => array( + 'table' => 'sys_agents_helpers', + 'key' => 'id', + 'submit_name' => 'do_submit', + ), + ), + 'inputs' => [ + 'prompt' => [ + 'type' => 'textarea', + 'name' => 'prompt', + 'caption' => _t('_sys_agents_helpers_field_prompt'), + 'value' => isset($aHelper['prompt']) ? $aHelper['prompt'] : '', + 'required' => '1', + 'checker' => [ + 'func' => 'Avail', + 'params' => [], + 'error' => _t('_sys_agents_helpers_field_prompt_err'), + ], + 'db' => [ + 'pass' => 'Xss', + ] + ], + 'message' => [ + 'type' => 'textarea', + 'name' => 'message', + 'caption' => _t('_sys_agents_helpers_field_message'), + 'value' => '', + 'required' => '1', + 'checker' => [ + 'func' => 'Avail', + 'params' => [], + 'error' => _t('_sys_agents_helpers_field_message_err'), + ], + ], + 'result' => [ + 'type' => 'textarea', + 'name' => 'result', + 'caption' => _t('_sys_agents_helpers_field_result'), + 'value' => '', + 'attrs' => [ + 'disabled' => 'disabled' + ] + ], + 'submit' => [ + 'type' => 'submit', + 'name' => 'do_submit', + 'value' => _t('_sys_submit'), + ], + ], + ); + + return $aForm; + } +} + +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/scripts/BxBaseStudioAgentsAssistants.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/scripts/BxBaseStudioAgentsAssistants.php new file mode 100644 index 0000000000..cc767f3e3d --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/scripts/BxBaseStudioAgentsAssistants.php @@ -0,0 +1,368 @@ +_sUrlPage = BX_DOL_URL_STUDIO . 'agents.php?page=assistants'; + + $this->_sFieldName = 'name'; + } + + public function getPageJsObject() + { + return 'oBxDolStudioPageAgents'; + } + + public function performActionAdd() + { + $sAction = 'add'; + + $oAI = BxDolAI::getInstance(); + + $aForm = $this->_getForm($sAction); + $oForm = new BxTemplFormView($aForm); + $oForm->initChecker(); + + if($oForm->isSubmittedAndValid()) { + $aValsToAdd = ['added' => time()]; + + $sName = $oForm->getCleanValue($this->_sFieldName); + $sName = BxDolAIAssistant::getName($sName); + BxDolForm::setSubmittedValue($this->_sFieldName, $sName, $oForm->aFormAttrs['method']); + + $iProfileId = $oForm->getCleanValue('profile_id'); + if(empty($iProfileId)) { + $iProfileId = (int)getParam('sys_agents_profile'); + if(empty($iProfileId)) + $iProfileId = current(bx_srv('system', 'get_options_agents_profile', [false], 'TemplServices'))['key']; + + $aValsToAdd['profile_id'] = $iProfileId; + } + + $oAIModel = $oAI->getModelObject($oForm->getCleanValue('model_id')); + if(($aAssistant = $oAIModel->getAssistant(['name' => $sName, 'prompt' => $oForm->getCleanValue('prompt')])) !== false) + $aValsToAdd = array_merge($aValsToAdd, [ + 'ai_vs_id' => $aAssistant['vector_store_id'], + 'ai_asst_id' => $aAssistant['assistant_id'] + ]); + + if(($iId = $oForm->insert($aValsToAdd)) !== false) + $aRes = ['grid' => $this->getCode(false), 'blink' => $iId]; + else + $aRes = ['msg' => _t('_sys_txt_error_occured')]; + + return echoJson($aRes); + } + + $sFormId = $oForm->getId(); + $sContent = BxTemplStudioFunctions::getInstance()->popupBox($sFormId . '_popup', _t('_sys_agents_assistants_popup_add'), $this->_oTemplate->parseHtmlByName('agents_automator_form.html', [ + 'form_id' => $sFormId, + 'form' => $oForm->getCode(true), + 'object' => $this->_sObject, + 'action' => $sAction + ])); + + return echoJson(['popup' => ['html' => $sContent, 'options' => ['closeOnOuterClick' => false]]]); + } + + public function performActionEdit() + { + $sAction = 'edit'; + + $iId = $this->_getId(); + $aHelper = $this->_oDb->getAssistantsBy(['sample' => 'id', 'id' => $iId]); + + $aForm = $this->_getFormEdit($sAction, $aHelper); + $oForm = new BxTemplFormView($aForm); + $oForm->initChecker(); + + if($oForm->isSubmittedAndValid()) { + $aValsToAdd = []; + + $sName = $oForm->getCleanValue($this->_sFieldName); + if($aHelper[$this->_sFieldName] != $sName) { + $sName = BxDolAIAssistant::getName($sName); + BxDolForm::setSubmittedValue($this->_sFieldName, $sName, $oForm->aFormAttrs['method']); + } + + $iProfileId = $oForm->getCleanValue('profile_id'); + if(empty($iProfileId)) { + $iProfileId = (int)getParam('sys_agents_profile'); + if(empty($iProfileId)) + $iProfileId = current(bx_srv('system', 'get_options_agents_profile', [false], 'TemplServices'))['key']; + + $aValsToAdd['profile_id'] = $iProfileId; + } + + if($oForm->update($iId, $aValsToAdd) !== false) + $aRes = ['grid' => $this->getCode(false), 'blink' => $iId]; + else + $aRes = ['msg' => _t('_sys_txt_error_occured')]; + + return echoJson($aRes); + } + + $sFormId = $oForm->getId(); + $sContent = BxTemplStudioFunctions::getInstance()->popupBox($sFormId . '_popup', _t('_sys_agents_assistants_popup_edit'), $this->_oTemplate->parseHtmlByName('agents_automator_form.html', [ + 'form_id' => $sFormId, + 'form' => $oForm->getCode(true), + 'object' => $this->_sObject, + 'action' => $sAction + ])); + + return echoJson(['popup' => ['html' => $sContent, 'options' => ['closeOnOuterClick' => false]]]); + } + + public function performActionCodes() + { + $sAction = 'codes'; + + $iId = $this->_getId(); + + $sContent = BxTemplStudioFunctions::getInstance()->transBox('bx_std_agents_assistants_codes', $this->_oTemplate->parseHtmlByName('agents_assistant_codes.html', [ + 'code_onclick' => '{onclick}', + 'code_button' => htmlspecialchars($this->_oTemplate->parseLink('javascript:void(0)', _t('_sys_agents_assistants_txt_add_knowledge'), [ + 'class' => 'bx-btn', + 'onclick' => '{onclick}' + ]), ENT_NOQUOTES) + ])); + $sContent = bx_replace_markers($sContent, ['onclick' => "javascript:bx_agents_action(this, 'asst', 'add_knowledge', {id: " . $iId . "})"]); + + + return echoJson(['popup' => ['html' => $sContent, 'options' => []]]); + } + + protected function _getCellModelId($mixedValue, $sKey, $aField, $aRow) + { + $aModel = $this->_oDb->getModelsBy(['sample' => 'id', 'id' => $mixedValue]); + if(!empty($aModel) && is_array($aModel)) + $mixedValue = $aModel['title']; + + return parent::_getCellDefault($mixedValue, $sKey, $aField, $aRow); + } + + protected function _getCellProfileId($mixedValue, $sKey, $aField, $aRow) + { + return parent::_getCellDefault(BxDolProfile::getInstanceMagic($mixedValue)->getDisplayName(), $sKey, $aField, $aRow); + } + + protected function _getCellAdded($mixedValue, $sKey, $aField, $aRow) + { + return parent::_getCellDefault(bx_time_js($mixedValue), $sKey, $aField, $aRow); + } + + protected function _getActionChats($sType, $sKey, $a, $isSmall = false, $isDisabled = false, $aRow = []) + { + $a['attr'] = array_merge($a['attr'], [ + "onclick" => "window.open('" . $this->_sUrlPage . '&spage=chats&aid=' . $aRow['id'] . "', '_self');" + ]); + + return $this->_getActionDefault ($sType, $sKey, $a, $isSmall, $isDisabled, $aRow); + } + + protected function _getActionFiles($sType, $sKey, $a, $isSmall = false, $isDisabled = false, $aRow = []) + { + $a['attr'] = array_merge($a['attr'], [ + "onclick" => "window.open('" . $this->_sUrlPage . '&spage=files&aid=' . $aRow['id'] . "', '_self');" + ]); + + return $this->_getActionDefault ($sType, $sKey, $a, $isSmall, $isDisabled, $aRow); + } + + protected function _addJsCss() + { + parent::_addJsCss(); + + $this->_oTemplate->addJs(['jquery.form.min.js']); + + $oForm = new BxTemplStudioFormView([]); + $oForm->addCssJs(); + } + + protected function _isCheckboxDisabled($aRow) + { + return false; + } + + protected function _getActionsDisabledBehavior($aRow) + { + return false; + } + + protected function _delete ($mixedId) + { + $iAssistantId = (int)$mixedId; + $aAssistant = $this->_oDb->getAssistantsBy(['sample' => 'id', 'id' => $iAssistantId]); + + $mixedResult = parent::_delete($mixedId); + if($mixedResult) { + $oAi = BxDolAI::getInstance(); + $oAIModel = $oAi->getModelObject($aAssistant['model_id']); + + $aChats = $this->_oDb->getChatsBy(['sample' => 'assistant_id', 'assistant_id' => $iAssistantId]); + foreach($aChats as $aChat) { + if(($oCmts = $oAi->getAssistantChatCmtsObject($aChat['id'])) !== false) + $oCmts->onObjectDelete(); + + if(!empty($aChat['ai_file_id'])) { + $oAIModel->callVectorStoresFilesDelete($aAssistant['ai_vs_id'], $aChat['ai_file_id']); + $oAIModel->callFilesDelete($aChat['ai_file_id']); + } + } + + $this->_oDb->deleteChats(['assistant_id' => $iAssistantId]); + + $this->_oDb->deleteAutomatorAssistants(['assistant_id' => $iAssistantId]); + + $oAIModel->callVectorStoresDelete($aAssistant['ai_vs_id']); + $oAIModel->callAssistantsDelete($aAssistant['ai_asst_id']); + } + + return $mixedResult; + } + + protected function _getFormEdit($sAction, $aHelper = []) + { + $aForm = $this->_getForm($sAction, $aHelper); + $aForm['form_attrs']['action'] .= '&id=' . $aHelper['id']; + + return $aForm; + } + + protected function _getForm($sAction, $aHelper = []) + { + $sJsObject = $this->getPageJsObject(); + + $aForm = [ + 'form_attrs' => [ + 'id' => 'bx_std_agents_assistants_' . $sAction, + 'action' => BX_DOL_URL_ROOT . bx_append_url_params('grid.php', ['o' => 'sys_studio_agents_assistants', 'a' => $sAction]), + 'method' => 'post', + ], + 'params' => [ + 'db' => [ + 'table' => 'sys_agents_assistants', + 'key' => 'id', + 'submit_name' => 'do_submit', + ], + ], + 'inputs' => [ + 'name' => [ + 'type' => 'text', + 'name' => 'name', + 'required' => '1', + 'caption' => _t('_sys_agents_assistants_field_name'), + 'value' => isset($aHelper['name']) ? $aHelper['name'] : '', + 'required' => '1', + 'checker' => [ + 'func' => 'Avail', + 'params' => [], + 'error' => _t('_sys_agents_form_field_err_enter'), + ], + 'db' => [ + 'pass' => 'Xss', + ] + ], + 'model_id' => [ + 'type' => 'select', + 'name' => 'model_id', + 'caption' => _t('_sys_agents_assistants_field_model_id'), + 'info' => '', + 'value' => isset($aHelper['model_id']) ? $aHelper['model_id'] : BxDolAI::getDefaultModel(), + 'values' => $this->_oDb->getModelsBy(['sample' => 'all_pairs', 'for_asst' => 1, 'active' => 1, 'hidden' => 0]), + 'required' => '1', + 'db' => [ + 'pass' => 'Int', + ] + ], + 'profile_id' => [ + 'type' => 'select', + 'name' => 'profile_id', + 'caption' => _t('_sys_agents_assistants_field_profile_id'), + 'info' => _t('_sys_agents_assistants_field_profile_id_inf'), + 'value' => isset($aHelper['profile_id']) ? $aHelper['profile_id'] : 0, + 'values' => bx_srv('system', 'get_options_agents_profile', [], 'TemplServices'), + 'required' => '0', + 'db' => [ + 'pass' => 'Int', + ] + ], + 'description' => [ + 'type' => 'textarea', + 'name' => 'description', + 'caption' => _t('_sys_agents_assistants_field_description'), + 'value' => isset($aHelper['description']) ? $aHelper['description'] : '', + 'required' => '1', + 'checker' => [ + 'func' => 'Avail', + 'params' => [], + 'error' => _t('_sys_agents_form_field_err_enter'), + ], + 'db' => [ + 'pass' => 'Xss', + ] + ], + 'prompt' => [ + 'type' => 'textarea', + 'name' => 'prompt', + 'caption' => _t('_sys_agents_assistants_field_prompt'), + 'value' => isset($aHelper['prompt']) ? $aHelper['prompt'] : '', + 'required' => '1', + 'checker' => [ + 'func' => 'Avail', + 'params' => [], + 'error' => _t('_sys_agents_assistants_field_prompt_err'), + ], + 'db' => [ + 'pass' => 'Xss', + ] + ], + 'submit' => [ + 'type' => 'input_set', + 0 => [ + 'type' => 'submit', + 'name' => 'do_submit', + 'value' => _t('_sys_submit'), + ], + 1 => [ + 'type' => 'reset', + 'name' => 'close', + 'value' => _t('_sys_close'), + 'attrs' => ['class' => 'bx-def-margin-sec-left', 'onclick' => '$(\'.bx-popup-applied:visible\').dolPopupHide();'], + ], + ], + ], + ]; + + return $aForm; + } + + protected function _getId() + { + $aIds = bx_get('ids'); + if(!empty($aIds) && is_array($aIds)) + return array_shift($aIds); + + $iId = (int)bx_get('id'); + if(!$iId) + return false; + + return $iId; + } +} + +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/scripts/BxBaseStudioAgentsAsstChats.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/scripts/BxBaseStudioAgentsAsstChats.php new file mode 100644 index 0000000000..5e2679c686 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/scripts/BxBaseStudioAgentsAsstChats.php @@ -0,0 +1,341 @@ +_sUrlPage = BX_DOL_URL_STUDIO . 'agents.php?page=assistants&spage=chats&aid=' . $this->_iAssistantId; + + $this->_sFieldName = 'name'; + } + + public function getPageJsObject() + { + return 'oBxDolStudioPageAgents'; + } + + public function performActionAdd() + { + $sAction = 'add'; + + $aForm = $this->_getForm($sAction); + $oForm = new BxTemplFormView($aForm); + $oForm->initChecker(); + + if($oForm->isSubmittedAndValid()) { + $aValsToAdd = ['assistant_id' => $this->_iAssistantId, 'added' => time()]; + + $sName = $oForm->getCleanValue($this->_sFieldName); + $sName = BxDolAIAssistant::getChatName($sName); + BxDolForm::setSubmittedValue($this->_sFieldName, $sName, $oForm->aFormAttrs['method']); + + if(($iId = $oForm->insert($aValsToAdd)) !== false) + $aRes = ['grid' => $this->getCode(false), 'blink' => $iId]; + else + $aRes = ['msg' => _t('_sys_txt_error_occured')]; + + return echoJson($aRes); + } + + $sFormId = $oForm->getId(); + $sContent = BxTemplStudioFunctions::getInstance()->popupBox($sFormId . '_popup', _t('_sys_agents_assistants_chats_popup_add'), $this->_oTemplate->parseHtmlByName('agents_automator_form.html', [ + 'form_id' => $sFormId, + 'form' => $oForm->getCode(true), + 'object' => $this->_sObject, + 'action' => $sAction + ])); + + return echoJson(['popup' => ['html' => $sContent, 'options' => ['closeOnOuterClick' => false]]]); + } + + public function performActionEdit() + { + $sAction = 'edit'; + + $iId = $this->_getId(); + $aChat = $this->_oDb->getChatsBy(['sample' => 'id', 'id' => $iId]); + + $aForm = $this->_getFormEdit($sAction, $aChat); + $oForm = new BxTemplFormView($aForm); + $oForm->initChecker(); + + if($oForm->isSubmittedAndValid()) { + $aValsToAdd = []; + + $sName = $oForm->getCleanValue($this->_sFieldName); + if($aChat[$this->_sFieldName] != $sName) { + $sName = BxDolAIAssistant::getChatName($sName); + BxDolForm::setSubmittedValue($this->_sFieldName, $sName, $oForm->aFormAttrs['method']); + } + + if($oForm->update($iId, $aValsToAdd) !== false) + $aRes = ['grid' => $this->getCode(false), 'blink' => $iId]; + else + $aRes = ['msg' => _t('_sys_txt_error_occured')]; + + return echoJson($aRes); + } + + $sFormId = $oForm->getId(); + $sContent = BxTemplStudioFunctions::getInstance()->popupBox($sFormId . '_popup', _t('_sys_agents_assistants_chats_popup_edit'), $this->_oTemplate->parseHtmlByName('agents_automator_form.html', [ + 'form_id' => $sFormId, + 'form' => $oForm->getCode(true), + 'object' => $this->_sObject, + 'action' => $sAction + ])); + + return echoJson(['popup' => ['html' => $sContent, 'options' => ['closeOnOuterClick' => false]]]); + } + + public function performActionStore() + { + $sAction = 'store'; + + $oAI = BxDolAI::getInstance(); + + $iId = $this->_getId(); + $aChat = $this->_oDb->getChatsBy(['sample' => 'id', 'id' => $iId]); + $aAssistant = $this->_oDb->getAssistantsBy(['sample' => 'id', 'id' => $aChat['assistant_id']]); + + $aComments = $oAI->getAssistantChatCmtsObject($iId)->getCommentsBy(['type' => 'object_id', 'object_id' => $iId]); + + $aMessages = []; + foreach($aComments as $aComment) + $aMessages[] = [ + 'role' => (int)$aComment['cmt_author_id'] == $this->_iProfileIdAi ? "assistant" : "user", + 'content' => $aComment['cmt_text'] + ]; + + $oAIModel = $oAI->getModelObject($aAssistant['model_id']); + + if(!empty($aChat['ai_file_id'])) { + $aResponse = $oAIModel->callVectorStoresFilesDelete($aAssistant['ai_vs_id'], $aChat['ai_file_id']); + if(!$aResponse) + return echoJson([]); + + $aResponse = $oAIModel->callFilesDelete($aChat['ai_file_id']); + if(!$aResponse) + return echoJson([]); + + $this->_oDb->updateChats(['ai_file_id' => '', 'stored' => 0], ['id' => $iId]); + } + + $aRes = []; + if(($sFile = $aChat['name'] . '.json') && ($aFile = $oAIModel->callFiles(['content' => json_encode($aMessages), 'name' => $sFile, 'mime' => 'application/json'])) !== false) { + if(($aResponse = $oAIModel->callVectorStoresFiles($aAssistant['ai_vs_id'], ['file_id' => $aFile['id']])) !== false) { + $iNow = time(); + $this->_oDb->insertFile(['name' => $sFile, 'assistant_id' => $aAssistant['id'], 'added' => $iNow, 'ai_file_id' => $aFile['id'], 'locked' => 1]); + $this->_oDb->updateChats(['type' => BX_DOL_AI_ASST_TYPE_PERMANENT, 'ai_file_id' => $aFile['id'], 'stored' => $iNow], ['id' => $iId]); + + $aRes = ['grid' => $this->getCode(false), 'blink' => $iId]; + } + } + + return echoJson($aRes); + } + + public function performActionUnstore() + { + $sAction = 'unstore'; + + $oAI = BxDolAI::getInstance(); + + $iId = $this->_getId(); + $aChat = $this->_oDb->getChatsBy(['sample' => 'id', 'id' => $iId]); + if(empty($aChat['ai_file_id'])) + return echoJson([]); + + $aAssistant = $this->_oDb->getAssistantsBy(['sample' => 'id', 'id' => $aChat['assistant_id']]); + + $oAIModel = $oAI->getModelObject($aAssistant['model_id']); + if(!$oAIModel->callVectorStoresFilesDelete($aAssistant['ai_vs_id'], $aChat['ai_file_id'])) + return echoJson([]); + + if(!$oAIModel->callFilesDelete($aChat['ai_file_id'])) + return echoJson([]); + + $this->_oDb->deleteFiles(['ai_file_id' => $aChat['ai_file_id']]); + $this->_oDb->updateChats(['ai_file_id' => '', 'stored' => 0], ['id' => $iId]); + + echoJson(['grid' => $this->getCode(false), 'blink' => $iId]); + } + + protected function _getCellType($mixedValue, $sKey, $aField, $aRow) + { + return parent::_getCellDefault(_t('_sys_agents_assistants_chats_txt_type_' . $mixedValue), $sKey, $aField, $aRow); + } + + protected function _getCellAdded($mixedValue, $sKey, $aField, $aRow) + { + return parent::_getCellDefault(bx_time_js($mixedValue), $sKey, $aField, $aRow); + } + + protected function _getCellStored($mixedValue, $sKey, $aField, $aRow) + { + return parent::_getCellDefault($mixedValue ? bx_time_js($mixedValue) : '', $sKey, $aField, $aRow); + } + + protected function _getActionChat($sType, $sKey, $a, $isSmall = false, $isDisabled = false, $aRow = []) + { + $a['attr'] = array_merge($a['attr'], [ + "onclick" => "window.open('" . $this->_sUrlPage . "&cid=" . $aRow['id'] . "', '_self');" + ]); + + return $this->_getActionDefault ($sType, $sKey, $a, $isSmall, $isDisabled, $aRow); + } + + protected function _getActionStore($sType, $sKey, $a, $isSmall = false, $isDisabled = false, $aRow = []) + { + $aChat = $this->_oDb->getChatsBy(['sample' => 'id', 'id' => $aRow['id']]); + if(!empty($aChat['ai_file_id'])) + return ''; + + return $this->_getActionDefault ($sType, $sKey, $a, $isSmall, $isDisabled, $aRow); + } + + protected function _getActionUnstore($sType, $sKey, $a, $isSmall = false, $isDisabled = false, $aRow = []) + { + $aChat = $this->_oDb->getChatsBy(['sample' => 'id', 'id' => $aRow['id']]); + if(empty($aChat['ai_file_id'])) + return ''; + + return $this->_getActionDefault ($sType, $sKey, $a, $isSmall, $isDisabled, $aRow); + } + + protected function _addJsCss() + { + parent::_addJsCss(); + + $this->_oTemplate->addJs(['jquery.form.min.js']); + + $oForm = new BxTemplStudioFormView([]); + $oForm->addCssJs(); + } + + protected function _isCheckboxDisabled($aRow) + { + return false; + } + + protected function _getActionsDisabledBehavior($aRow) + { + return false; + } + + protected function _delete ($mixedId) + { + $aChat = $this->_oDb->getChatsBy(['sample' => 'id', 'id' => (int)$mixedId]); + + $mixedResult = parent::_delete($mixedId); + if($mixedResult) + BxDolAIAssistant::getObjectInstance($aChat['assistant_id'])->deleteChat($aChat); + + return $mixedResult; + } + + protected function _getFormEdit($sAction, $aChat = []) + { + $aForm = $this->_getForm($sAction, $aChat); + $aForm['form_attrs']['action'] .= '&id=' . $aChat['id']; + + return $aForm; + } + + protected function _getForm($sAction, $aChat = []) + { + $sJsObject = $this->getPageJsObject(); + + $aForm = array( + 'form_attrs' => array( + 'id' => 'bx_std_agents_assistants_' . $sAction, + 'action' => BX_DOL_URL_ROOT . bx_append_url_params('grid.php', ['o' => 'sys_studio_agents_assistants_chats', 'a' => $sAction, 'aid' => $this->_iAssistantId]), + 'method' => 'post', + ), + 'params' => array ( + 'db' => array( + 'table' => 'sys_agents_assistants_chats', + 'key' => 'id', + 'submit_name' => 'do_submit', + ), + ), + 'inputs' => array( + 'name' => [ + 'type' => 'text', + 'name' => 'name', + 'required' => '1', + 'caption' => _t('_sys_agents_assistants_chats_field_name'), + 'value' => isset($aChat['name']) ? $aChat['name'] : '', + 'required' => '1', + 'checker' => [ + 'func' => 'Avail', + 'params' => [], + 'error' => _t('_sys_agents_form_field_err_enter'), + ], + 'db' => [ + 'pass' => 'Xss', + ] + ], + 'description' => [ + 'type' => 'textarea', + 'name' => 'description', + 'caption' => _t('_sys_agents_assistants_chats_field_description'), + 'value' => isset($aChat['description']) ? $aChat['description'] : '', + 'required' => '1', + 'checker' => [ + 'func' => 'Avail', + 'params' => [], + 'error' => _t('_sys_agents_form_field_err_enter'), + ], + 'db' => [ + 'pass' => 'Xss', + ] + ], + 'submit' => array( + 'type' => 'input_set', + 0 => array ( + 'type' => 'submit', + 'name' => 'do_submit', + 'value' => _t('_sys_submit'), + ), + 1 => array ( + 'type' => 'reset', + 'name' => 'close', + 'value' => _t('_sys_close'), + 'attrs' => array('class' => 'bx-def-margin-sec-left', 'onclick' => '$(\'.bx-popup-applied:visible\').dolPopupHide();'), + ), + ), + + ), + ); + + return $aForm; + } + + protected function _getId() + { + $aIds = bx_get('ids'); + if(!empty($aIds) && is_array($aIds)) + return array_shift($aIds); + + $iId = (int)bx_get('id'); + if(!$iId) + return false; + + return $iId; + } +} + +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/scripts/BxBaseStudioAgentsAsstFiles.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/scripts/BxBaseStudioAgentsAsstFiles.php new file mode 100644 index 0000000000..2bebc48aef --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/scripts/BxBaseStudioAgentsAsstFiles.php @@ -0,0 +1,236 @@ +_sUrlPage = BX_DOL_URL_STUDIO . 'agents.php?page=assistants&spage=files&aid=' . $this->_iAssistantId; + } + + public function getPageJsObject() + { + return 'oBxDolStudioPageAgents'; + } + + public function performActionAdd() + { + $sAction = 'add'; + + $aForm = $this->_getForm($sAction); + $oForm = new BxTemplFormView($aForm); + $oForm->initChecker(); + + if($oForm->isSubmittedAndValid()) { + $aValsToAdd = ['assistant_id' => $this->_iAssistantId, 'added' => time()]; + + if(!empty($_FILES['file']['tmp_name'])) { + $sName = $_FILES['file']['name']; + $sMime = $_FILES['file']['type']; + $iSize = $_FILES['file']['size']; + + $oHandle = fopen($_FILES['file']['tmp_name'], "r"); + $sContents = fread($oHandle, $iSize); + fclose($oHandle); + + $oAIModel = BxDolAI::getInstance()->getModelObject($this->_aAssistantInfo['model_id']); + if(($aFile = $oAIModel->callFiles(['content' => $sContents, 'name' => $sName, 'mime' => $sMime])) !== false) { + if(($aResponse = $oAIModel->callVectorStoresFiles($this->_aAssistantInfo['ai_vs_id'], ['file_id' => $aFile['id']])) !== false) { + $aValsToAdd = array_merge($aValsToAdd, [ + 'name' => $sName, + 'ai_file_id' => $aFile['id'], + 'ai_file_size' => $iSize + ]); + } + } + } + + if(($iId = $oForm->insert($aValsToAdd)) !== false) + $aRes = ['grid' => $this->getCode(false), 'blink' => $iId]; + else + $aRes = ['msg' => _t('_sys_txt_error_occured')]; + + return echoJson($aRes); + } + + $sFormId = $oForm->getId(); + $sContent = BxTemplStudioFunctions::getInstance()->popupBox($sFormId . '_popup', _t('_sys_agents_assistants_files_popup_add'), $this->_oTemplate->parseHtmlByName('agents_automator_form.html', [ + 'form_id' => $sFormId, + 'form' => $oForm->getCode(true), + 'object' => $this->_sObject, + 'action' => $sAction + ])); + + return echoJson(['popup' => ['html' => $sContent, 'options' => ['closeOnOuterClick' => false]]]); + } + + public function performActionSync() + { + $sAction = 'sync'; + + $oAIModel = BxDolAI::getInstance()->getModelObject($this->_aAssistantInfo['model_id']); + if(($aFiles = $oAIModel->callVectorStoresFilesList($this->_aAssistantInfo['ai_vs_id'])) === false) + return echoJson([]); + + foreach($aFiles as $aFile) { + $aFileInfo = $oAIModel->callFilesRetrieve($aFile['id']); + + $this->_oDb->updateFiles([ + 'ai_file_size' => is_array($aFileInfo) && !empty($aFileInfo['bytes']) ? $aFileInfo['bytes'] : 0, + 'ai_file_status' => $aFile['status'] + ], ['ai_file_id' => $aFile['id']]); + } + + return echoJson(['grid' => $this->getCode(false)]); + } + + public function performActionDelete() + { + $sAction = 'delete'; + + $iId = $this->_getId(); + + $aFile = $this->_oDb->getFilesBy(['sample' => 'id', 'id' => $iId]); + if(empty($aFile) || !is_array($aFile)) + return echoJson([]); + + return parent::performActionDelete(); + } + + protected function _getCellSize($mixedValue, $sKey, $aField, $aRow) + { + return parent::_getCellDefault(!empty($aRow['ai_file_size']) ? _t_format_size($aRow['ai_file_size']) : _t('_undefined'), $sKey, $aField, $aRow); + } + + protected function _getCellStatus($mixedValue, $sKey, $aField, $aRow) + { + return parent::_getCellDefault(_t('_sys_agents_assistants_files_txt_status_' . $aRow['ai_file_status']), $sKey, $aField, $aRow); + } + + protected function _getCellAdded($mixedValue, $sKey, $aField, $aRow) + { + return parent::_getCellDefault(bx_time_js($mixedValue), $sKey, $aField, $aRow); + } + + protected function _getActionDelete($sType, $sKey, $a, $isSmall = false, $isDisabled = false, $aRow = []) + { + if((int)$aRow['locked'] != 0) + return ''; + + return $this->_getActionDefault ($sType, $sKey, $a, $isSmall, $isDisabled, $aRow); + } + + protected function _addJsCss() + { + parent::_addJsCss(); + + $this->_oTemplate->addJs(['jquery.form.min.js']); + + $oForm = new BxTemplStudioFormView([]); + $oForm->addCssJs(); + } + + protected function _isCheckboxDisabled($aRow) + { + return false; + } + + protected function _getActionsDisabledBehavior($aRow) + { + return false; + } + + protected function _delete ($mixedId) + { + $iFileId = (int)$mixedId; + $aFile = $this->_oDb->getFilesBy(['sample' => 'id', 'id' => $iFileId]); + + $mixedResult = parent::_delete($mixedId); + if($mixedResult && !empty($aFile['ai_file_id'])) { + $oAi = BxDolAI::getInstance(); + + $oAIModel = $oAi->getModelObject($this->_aAssistantInfo['model_id']); + $oAIModel->callVectorStoresFilesDelete($this->_aAssistantInfo['ai_vs_id'], $aFile['ai_file_id']); + $oAIModel->callFilesDelete($aFile['ai_file_id']); + } + + return $mixedResult; + } + + protected function _getForm($sAction, $aFiles = []) + { + $sJsObject = $this->getPageJsObject(); + + $aForm = array( + 'form_attrs' => array( + 'id' => 'bx_std_agents_assistants_files_' . $sAction, + 'action' => BX_DOL_URL_ROOT . bx_append_url_params('grid.php', ['o' => 'sys_studio_agents_assistants_files', 'a' => $sAction, 'aid' => $this->_iAssistantId]), + 'method' => 'post', + ), + 'params' => array ( + 'db' => array( + 'table' => 'sys_agents_assistants_files', + 'key' => 'id', + 'submit_name' => 'do_submit', + ), + ), + 'inputs' => array( + 'file' => [ + 'type' => 'file', + 'name' => 'file', + 'required' => '1', + 'caption' => _t('_sys_agents_assistants_files_field_file'), + 'value' => '', + 'checker' => [ + 'func' => 'Avail', + 'params' => '', + 'error' => _t('_sys_agents_form_field_err_enter'), + ] + ], + 'submit' => array( + 'type' => 'input_set', + 0 => array ( + 'type' => 'submit', + 'name' => 'do_submit', + 'value' => _t('_sys_submit'), + ), + 1 => array ( + 'type' => 'reset', + 'name' => 'close', + 'value' => _t('_sys_close'), + 'attrs' => array('class' => 'bx-def-margin-sec-left', 'onclick' => '$(\'.bx-popup-applied:visible\').dolPopupHide();'), + ), + ), + + ), + ); + + return $aForm; + } + + protected function _getId() + { + $aIds = bx_get('ids'); + if(!empty($aIds) && is_array($aIds)) + return array_shift($aIds); + + $iId = (int)bx_get('id'); + if(!$iId) + return false; + + return $iId; + } +} + +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/scripts/BxBaseStudioAgentsAutomators.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/scripts/BxBaseStudioAgentsAutomators.php new file mode 100644 index 0000000000..c6edadccbc --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/scripts/BxBaseStudioAgentsAutomators.php @@ -0,0 +1,862 @@ +_sUrlPage = BX_DOL_URL_STUDIO . 'agents.php?page=automators'; + + $this->_sFieldName = 'name'; + } + + public function getPageJsObject() + { + return 'oBxDolStudioPageAgents'; + } + + public function performActionAdd() + { + $sAction = 'add'; + + $oAI = BxDolAI::getInstance(); + + $aForm = $this->_getForm($sAction); + $oForm = new BxTemplFormView($aForm); + $oForm->initChecker(); + + if($oForm->isSubmittedAndValid()) { + $aValsToAdd = [ + 'added' => time() + ]; + + $sName = $oForm->getCleanValue($this->_sFieldName); + $sName = $this->_getAutomatorName($sName); + BxDolForm::setSubmittedValue($this->_sFieldName, $sName, $oForm->aFormAttrs['method']); + + $iProfileId = $oForm->getCleanValue('profile_id'); + if(empty($iProfileId)) { + $iProfileId = (int)getParam('sys_agents_profile'); + if(empty($iProfileId)) + $iProfileId = current(bx_srv('system', 'get_options_agents_profile', [false], 'TemplServices'))['key']; + + $aValsToAdd['profile_id'] = $iProfileId; + } + + $sSchedulerTime = $oForm->getCleanValue('scheduler_time'); + if(!empty($sSchedulerTime)) + $aValsToAdd['params'] = json_encode(['scheduler_time' => $sSchedulerTime]); + + $iModel = $oForm->getCleanValue('model_id'); + $sType = $oForm->getCleanValue('type'); + $aProviders = $oForm->getCleanValue('providers'); + $bProviders = !empty($aProviders) && is_array($aProviders); + $aHelpers = $oForm->getCleanValue('helpers'); + $bHelpers = !empty($aHelpers) && is_array($aHelpers); + $aAssistants = $oForm->getCleanValue('assistants'); + $bAssistants = !empty($aAssistants) && is_array($aAssistants); + $sMessage = $oForm->getCleanValue('message'); + $bMessage = !empty($sMessage); + $sMessageAdd = ''; + $sMessageResponse = ''; + + $oAIModel = $oAI->getModelObject($iModel); + + $sInstructions = $oAI->getAutomatorInstruction('profile', $iProfileId); + if($bProviders) + $sInstructions .= $oAI->getAutomatorInstruction('providers', $aProviders); + if($bHelpers) + $sInstructions .= $oAI->getAutomatorInstruction('helpers', $aHelpers); + if($bAssistants) + $sInstructions .= $oAI->getAutomatorInstruction('assistants', $aAssistants); + + $bIsValid = true; + $aResponseInit = []; + switch($sType) { + case BX_DOL_AI_AUTOMATOR_EVENT: + if(($aResponseInit = $oAIModel->getResponseInit($sType, $sMessage)) !== false) { + $oAIModel->setParams($aResponseInit['params']); + + $sMessageAdd = $aResponseInit['params']['trigger']; + + $aValsToAdd = array_merge($aValsToAdd, $aResponseInit); + if(!empty($aValsToAdd['params']) && is_array($aValsToAdd['params'])) + $aValsToAdd['params'] = json_encode($aValsToAdd['params']); + } + else { + $oForm->aInputs['message']['error'] = _t('_sys_agents_automators_err_event_not_found'); + $bIsValid = false; + } + break; + + case BX_DOL_AI_AUTOMATOR_SCHEDULER: + case BX_DOL_AI_AUTOMATOR_WEBHOOK: + if(($aResponseInit = $oAIModel->getResponseInit($sType, $sMessage)) !== false) { + $oAIModel->setParams($aResponseInit['params']); + + $aValsToAdd = array_merge($aValsToAdd, $aResponseInit); + if(!empty($aValsToAdd['params']) && is_array($aValsToAdd['params'])) + $aValsToAdd['params'] = json_encode($aValsToAdd['params']); + } + else { + $oForm->aInputs['message']['error'] = _t('_sys_agents_automators_err_event_not_found'); + $bIsValid = false; + } + break; + } + + if($bIsValid) { + if(($sResponse = $oAIModel->getResponse($sType, $sMessage . $sInstructions . $sMessageAdd, $oAIModel->getParams())) !== false) { + $sMessageResponse = $sResponse; + } + else { + $oForm->aInputs['message']['error'] = _t('_sys_agents_automators_err_cannot_get_code'); + $bIsValid = false; + } + } + + if($bIsValid) { + if(($iId = $oForm->insert($aValsToAdd)) !== false) { + if($bProviders) + foreach($aProviders as $iProviderId) + $this->_oDb->insertAutomatorProvider([ + 'automator_id' => $iId, + 'provider_id' => $iProviderId + ]); + + if($bHelpers) + foreach($aHelpers as $iHelperId) + $this->_oDb->insertAutomatorHelper([ + 'automator_id' => $iId, + 'helper_id' => $iHelperId + ]); + + if($bAssistants) + foreach($aAssistants as $iAssistantId) + $this->_oDb->insertAutomatorAssistant([ + 'automator_id' => $iId, + 'assistant_id' => $iAssistantId + ]); + + if(($oCmts = BxDolCmts::getObjectInstance($this->_sCmts, $iId)) !== null) { + if($bMessage) { + $iProfileId = bx_get_logged_profile_id(); + + $aResult = $oCmts->addAuto([ + 'cmt_author_id' => $iProfileId, + 'cmt_parent_id' => 0, + 'cmt_text' => $sMessage + ]); + + if(!empty($aResult['id'])) + $this->_oDb->updateAutomators(['message_id' => $aResult['id']], ['id' => $iId]); + + sleep(1); + $oCmts->addAuto([ + 'cmt_author_id' => $iProfileId, + 'cmt_parent_id' => 0, + 'cmt_text' => $sInstructions + ]); + } + + if($sMessageResponse) { + sleep(1); + $oCmts->addAuto([ + 'cmt_author_id' => $this->_iProfileIdAi, + 'cmt_parent_id' => 0, + 'cmt_text' => $sMessageResponse + ]); + } + } + + $aRes = ['grid' => $this->getCode(false), 'blink' => $iId]; + } + else + $aRes = ['msg' => _t('_sys_txt_error_occured')]; + + return echoJson($aRes); + } + } + + $sFormId = $oForm->getId(); + $sContent = BxTemplStudioFunctions::getInstance()->popupBox($sFormId . '_popup', _t('_sys_agents_automators_popup_add'), $this->_oTemplate->parseHtmlByName('agents_automator_form.html', [ + 'form_id' => $sFormId, + 'form' => $oForm->getCode(true), + 'object' => $this->_sObject, + 'action' => $sAction + ])); + + return echoJson(['popup' => ['html' => $sContent, 'options' => ['closeOnOuterClick' => false]]]); + } + + public function performActionEdit() + { + $sAction = 'edit'; + + $oAI = BxDolAI::getInstance(); + + $iId = $this->_getId(); + $aAutomator = $oAI->getAutomator($iId); + $aAutomator['providers'] = $this->_oDb->getAutomatorsBy(['sample' => 'providers_by_id_pairs', 'id' => $iId]); + $aAutomator['helpers'] = $this->_oDb->getAutomatorsBy(['sample' => 'helpers_by_id_pairs', 'id' => $iId]); + + $aForm = $this->_getFormEdit($sAction, $aAutomator); + $oForm = new BxTemplFormView($aForm); + $oForm->initChecker(); + + if($oForm->isSubmittedAndValid()) { + $aValsToAdd = []; + + $sName = $oForm->getCleanValue($this->_sFieldName); + if($aAutomator[$this->_sFieldName] != $sName) { + $sName = $this->_getAutomatorName($sName); + BxDolForm::setSubmittedValue($this->_sFieldName, $sName, $oForm->aFormAttrs['method']); + } + + /** + * Process Providers + */ + $aProvidersIds = $oForm->getCleanValue('providers_ids'); + $bProvidersIds = !empty($aProvidersIds) && is_array($aProvidersIds); + $aProvidersValues = $oForm->getCleanValue('providers'); + $bProvidersValues = !empty($aProvidersValues) && is_array($aProvidersValues); + + //--- Providers: Remove deleted + if(!empty($aAutomator['providers']) && is_array($aAutomator['providers'])) + $this->_oDb->deleteAutomatorProvidersById(array_diff(array_keys($aAutomator['providers']), $bProvidersIds ? $aProvidersIds : [])); + + //--- Providers: Update existed + if($bProvidersIds) + foreach($aProvidersIds as $iIndex => $iApId) + $this->_oDb->updateAutomatorProvider(['provider_id' => (int)$aProvidersValues[$iIndex]], ['id' => (int)$iApId]); + + //--- Providers: Add new + $iProvidersIds = $bProvidersIds ? count($aProvidersIds) : 0; + $iProvidersValues = $bProvidersValues ? count($aProvidersValues) : 0; + if($iProvidersValues > $iProvidersIds) { + $aProvidersValues = array_slice($aProvidersValues, $iProvidersIds); + foreach($aProvidersValues as $iProvidersValue) + $this->_oDb->insertAutomatorProvider([ + 'automator_id' => $iId, + 'provider_id' => (int)$iProvidersValue, + ]); + } + + /** + * Process Helpers + */ + $aHelpersIds = $oForm->getCleanValue('helpers_ids'); + $bHelpersIds = !empty($aHelpersIds) && is_array($aHelpersIds); + $aHelpersValues = $oForm->getCleanValue('helpers'); + $bHelpersValues = !empty($aHelpersValues) && is_array($aHelpersValues); + + //--- Helpers: Remove deleted + if(!empty($aAutomator['helpers']) && is_array($aAutomator['helpers'])) + $this->_oDb->deleteAutomatorHelpersById(array_diff(array_keys($aAutomator['helpers']), $bHelpersIds ? $aHelpersIds : [])); + + //--- Helpers: Update existed + if($bHelpersIds) + foreach($aHelpersIds as $iIndex => $iAhId) + $this->_oDb->updateAutomatorHelper(['helper_id' => (int)$aHelpersValues[$iIndex]], ['id' => (int)$iAhId]); + + //--- Helpers: Add new + $iHelpersIds = $bHelpersIds ? count($aHelpersIds) : 0; + $iHelpersValues = $bHelpersValues ? count($aHelpersValues) : 0; + if($iHelpersValues > $iHelpersIds) { + $aHelpersValues = array_slice($aHelpersValues, $iHelpersIds); + foreach($aHelpersValues as $iHelpersValue) + $this->_oDb->insertAutomatorHelper([ + 'automator_id' => $iId, + 'helper_id' => (int)$iHelpersValue, + ]); + } + + /** + * Process Assistants + */ + $aAssistantsIds = $oForm->getCleanValue('assistants_ids'); + $bAssistantsIds = !empty($aAssistantsIds) && is_array($aAssistantsIds); + $aAssistantsValues = $oForm->getCleanValue('assistants'); + $bAssistantsValues = !empty($aAssistantsValues) && is_array($aAssistantsValues); + + //--- Assistants: Remove deleted + if(!empty($aAutomator['assistants']) && is_array($aAutomator['assistants'])) + $this->_oDb->deleteAutomatorAssistantsById(array_diff(array_keys($aAutomator['assistants']), $bAssistantsIds ? $aAssistantsIds : [])); + + //--- Assistants: Update existed + if($bAssistantsIds) + foreach($aAssistantsIds as $iIndex => $iAhId) + $this->_oDb->updateAutomatorAssistant(['assistant_id' => (int)$aAssistantsValues[$iIndex]], ['id' => (int)$iAhId]); + + //--- Assistants: Add new + $iAssistantsIds = $bAssistantsIds ? count($aAssistantsIds) : 0; + $iAssistantsValues = $bAssistantsValues ? count($aAssistantsValues) : 0; + if($iAssistantsValues > $iAssistantsIds) { + $aAssistantsValues = array_slice($aAssistantsValues, $iAssistantsIds); + foreach($aAssistantsValues as $iAssistantsValue) + $this->_oDb->insertAutomatorAssistant([ + 'automator_id' => $iId, + 'helper_id' => (int)$iAssistantsValue, + ]); + } + + $iProfileId = $oForm->getCleanValue('profile_id'); + if(empty($iProfileId)) { + $iProfileId = (int)getParam('sys_agents_profile'); + if(empty($iProfileId)) + $iProfileId = current(bx_srv('system', 'get_options_agents_profile', [false], 'TemplServices'))['key']; + + $aValsToAdd['profile_id'] = $iProfileId; + } + + $sSchedulerTime = $oForm->getCleanValue('scheduler_time'); + if(!empty($sSchedulerTime)) + $aValsToAdd['params'] = json_encode(['scheduler_time' => $sSchedulerTime]); + + if($oForm->update($iId, $aValsToAdd) !== false) { + if(($oCmts = BxDolCmts::getObjectInstance($this->_sCmts, $iId)) !== null) { + $sInstructions = $oAI->getAutomatorInstruction('profile', $iProfileId); + + $aProviders = $this->_oDb->getAutomatorsBy(['sample' => 'providers_by_id_pairs', 'id' => $iId]); + if(!empty($aProviders) && is_array($aProviders)) + $sInstructions .= $oAI->getAutomatorInstruction('providers', array_values($aProviders)); + + $aHelpers = $this->_oDb->getAutomatorsBy(['sample' => 'helpers_by_id_pairs', 'id' => $iId]); + if(!empty($aHelpers) && is_array($aHelpers)) + $sInstructions .= $oAI->getAutomatorInstruction('helpers', array_values($aHelpers)); + + $aAssistants = $this->_oDb->getAutomatorsBy(['sample' => 'assistants_by_id_pairs', 'id' => $iId]); + if(!empty($aAssistants) && is_array($aAssistants)) + $sInstructions .= $oAI->getAutomatorInstruction('assistants', array_values($aAssistants)); + + $oCmts->addAuto([ + 'cmt_author_id' => $iProfileId, + 'cmt_parent_id' => 0, + 'cmt_text' => $sInstructions + ]); + + if(($sResponse = $oAI->getModelObject($aAutomator['model_id'])->getResponse($aAutomator['type'], $sInstructions, $aAutomator['params'])) !== false) { + sleep(1); + $oCmts->addAuto([ + 'cmt_author_id' => $this->_iProfileIdAi, + 'cmt_parent_id' => 0, + 'cmt_text' => $sResponse + ]); + } + } + + $aRes = ['grid' => $this->getCode(false), 'blink' => $iId]; + } + else + $aRes = ['msg' => _t('_sys_txt_error_occured')]; + + return echoJson($aRes); + } + + $sFormId = $oForm->getId(); + $sContent = BxTemplStudioFunctions::getInstance()->popupBox($sFormId . '_popup', _t('_sys_agents_automators_popup_edit'), $this->_oTemplate->parseHtmlByName('agents_automator_form.html', [ + 'form_id' => $sFormId, + 'form' => $oForm->getCode(true), + 'object' => $this->_sObject, + 'action' => $sAction + ])); + + return echoJson(['popup' => ['html' => $sContent, 'options' => ['closeOnOuterClick' => false]]]); + } + + protected function _getCellSwitcher ($mixedValue, $sKey, $aField, $aRow) + { + if(empty($aRow['code']) || $aRow['status'] != BX_DOL_AI_AUTOMATOR_STATUS_READY) + return parent::_getCellDefault('', $sKey, $aField, $aRow); + + return parent::_getCellSwitcher ($mixedValue, $sKey, $aField, $aRow); + } + + protected function _getCellModelId($mixedValue, $sKey, $aField, $aRow) + { + $aModel = $this->_oDb->getModelsBy(['sample' => 'id', 'id' => $mixedValue]); + if(!empty($aModel) && is_array($aModel)) + $mixedValue = $aModel['title']; + + return parent::_getCellDefault($mixedValue, $sKey, $aField, $aRow); + } + + protected function _getCellProfileId($mixedValue, $sKey, $aField, $aRow) + { + return parent::_getCellDefault(BxDolProfile::getInstanceMagic($mixedValue)->getDisplayName(), $sKey, $aField, $aRow); + } + + protected function _getCellType($mixedValue, $sKey, $aField, $aRow) + { + return parent::_getCellDefault(_t('_sys_agents_automators_field_type_' . $mixedValue), $sKey, $aField, $aRow); + } + + protected function _getCellData($sKey, $aField, $aRow) + { + if($sKey == 'message_id' && ($iCmtId = (int)$aRow[$sKey]) != 0 && ($oCmts = BxDolAI::getInstance()->getAutomatorCmtsObject($aRow['id'])) !== false) { + $aCmt = $oCmts->getCommentSimple($iCmtId); + if(!empty($aCmt) && is_array($aCmt)) + $aRow[$sKey] = $aCmt['cmt_text']; + } + + return parent::_getCellData($sKey, $aField, $aRow); + } + + protected function _getCellAdded($mixedValue, $sKey, $aField, $aRow) + { + return parent::_getCellDefault(bx_time_js($mixedValue), $sKey, $aField, $aRow); + } + + protected function _getCellStatus($mixedValue, $sKey, $aField, $aRow) + { + return parent::_getCellDefault(_t('_sys_agents_automators_field_status_' . $mixedValue), $sKey, $aField, $aRow); + } + + protected function _getActionTune($sType, $sKey, $a, $isSmall = false, $isDisabled = false, $aRow = []) + { + $a['attr'] = array_merge($a['attr'], [ + "onclick" => "window.open('" . $this->_sUrlPage . '&id=' . $aRow['id'] . "', '_self');" + ]); + + return $this->_getActionDefault ($sType, $sKey, $a, $isSmall, $isDisabled, $aRow); + } + + protected function _addJsCss() + { + parent::_addJsCss(); + + $this->_oTemplate->addJs(['jquery.form.min.js']); + + $oForm = new BxTemplStudioFormView([]); + $oForm->addCssJs(); + } + + protected function _isCheckboxDisabled($aRow) + { + return false; + } + + protected function _getActionsDisabledBehavior($aRow) + { + return false; + } + + protected function _delete ($mixedId) + { + $mixedResult = parent::_delete($mixedId); + if($mixedResult) { + $this->_oDb->deleteAutomatorProviders(['automator_id' => (int)$mixedId]); + $this->_oDb->deleteAutomatorHelpers(['automator_id' => (int)$mixedId]); + $this->_oDb->deleteAutomatorAssistants(['automator_id' => (int)$mixedId]); + + if(($oCmts = BxDolAI::getInstance()->getAutomatorCmtsObject($mixedId)) !== false) + $oCmts->onObjectDelete(); + } + + return $mixedResult; + } + + protected function _getFormEdit($sAction, $aAutomator = []) + { + $aForm = $this->_getForm($sAction, $aAutomator); + $aForm['form_attrs']['action'] .= '&id=' . $aAutomator['id']; + + unset($aForm['inputs']['type']); + unset($aForm['inputs']['message']); + + return $aForm; + } + + protected function _getForm($sAction, $aAutomator = []) + { + $sJsObject = $this->getPageJsObject(); + + $sType = isset($aAutomator['type']) ? $aAutomator['type'] : 'event'; + + if(!empty($aAutomator['params']) && is_string($aAutomator['params'])) + $aAutomator['params'] = json_decode($aAutomator['params'], true); + + $aForm = array( + 'form_attrs' => array( + 'id' => 'bx_std_agents_automators_' . $sAction, + 'action' => BX_DOL_URL_ROOT . 'grid.php?o=sys_studio_agents_automators&a=' . $sAction, + 'method' => 'post', + ), + 'params' => array ( + 'db' => array( + 'table' => 'sys_agents_automators', + 'key' => 'id', + 'submit_name' => 'do_submit', + ), + ), + 'inputs' => array( + 'name' => [ + 'type' => 'text', + 'name' => 'name', + 'caption' => _t('_sys_agents_automators_field_name'), + 'value' => isset($aAutomator['name']) ? $aAutomator['name'] : '', + 'required' => '1', + 'checker' => [ + 'func' => 'Avail', + 'params' => [], + 'error' => _t('_sys_agents_form_field_err_enter'), + ], + 'db' => [ + 'pass' => 'Xss', + ], + ], + 'model_id' => [ + 'type' => 'select', + 'name' => 'model_id', + 'caption' => _t('_sys_agents_automators_field_model_id'), + 'info' => '', + 'value' => isset($aAutomator['model_id']) ? $aAutomator['model_id'] : BxDolAI::getDefaultModel(), + 'values' => $this->_oDb->getModelsBy(['sample' => 'all_pairs', 'active' => 1, 'hidden' => 0]), + 'required' => '1', + 'checker' => [ + 'func' => 'Avail', + 'params' => [], + 'error' => _t('_sys_agents_form_field_err_select'), + ], + 'db' => [ + 'pass' => 'Int', + ], + ], + 'profile_id' => [ + 'type' => 'select', + 'name' => 'profile_id', + 'caption' => _t('_sys_agents_automators_field_profile_id'), + 'info' => _t('_sys_agents_automators_field_profile_id_inf'), + 'value' => isset($aAutomator['profile_id']) ? $aAutomator['profile_id'] : 0, + 'values' => bx_srv('system', 'get_options_agents_profile', [], 'TemplServices'), + 'required' => '0', + 'db' => [ + 'pass' => 'Int', + ] + ], + 'type' => [ + 'type' => 'select', + 'name' => 'type', + 'caption' => _t('_sys_agents_automators_field_type'), + 'info' => '', + 'value' => $sType, + 'values' => [ + 'event' => _t('_sys_agents_automators_field_type_event'), + 'scheduler' => _t('_sys_agents_automators_field_type_scheduler'), + 'webhook' => _t('_sys_agents_automators_field_type_webhook'), + ], + 'attrs' => [ + 'onchange' => $this->getPageJsObject() . '.onChangeAutomatorType(this)', + ], + 'required' => '1', + 'db' => [ + 'pass' => 'Xss', + ] + ], + 'alert_unit' => [ + 'type' => 'hidden', + 'name' => 'alert_unit', + 'caption' => _t('_sys_agents_automators_field_alert_unit'), + 'value' => isset($aAutomator['alert_unit']) ? $aAutomator['alert_unit'] : '', + 'tr_attrs' => [ + 'style' => $sType != 'event' ? 'display:none' : '' + ], + 'db' => [ + 'pass' => 'Xss', + ], + ], + 'alert_action' => [ + 'type' => 'hidden', + 'name' => 'alert_action', + 'caption' => _t('_sys_agents_automators_field_alert_action'), + 'value' => isset($aAutomator['alert_action']) ? $aAutomator['alert_action'] : '', + 'tr_attrs' => [ + 'style' => $sType != 'event' ? 'display:none' : '' + ], + 'db' => [ + 'pass' => 'Xss', + ], + ], + 'scheduler_time' => [ + 'type' => 'hidden', + 'name' => 'scheduler_time', + 'caption' => _t('_sys_agents_automators_field_scheduler_time'), + 'value' => isset($aAutomator['params']['scheduler_time']) ? $aAutomator['params']['scheduler_time'] : '', + 'tr_attrs' => [ + 'style' => $sType != 'scheduler' ? 'display:none' : '' + ], + ], + 'providers' => [ + 'type' => 'custom', + 'name' => 'providers', + 'caption' => _t('_sys_agents_automators_field_providers'), + 'value' => '', + ], + 'helpers' => [ + 'type' => 'custom', + 'name' => 'helpers', + 'caption' => _t('_sys_agents_automators_field_helpers'), + 'value' => '', + ], + 'assistants' => [ + 'type' => 'custom', + 'name' => 'assistants', + 'caption' => _t('_sys_agents_automators_field_assistants'), + 'value' => '', + ], + 'message' => [ + 'type' => 'textarea', + 'name' => 'message', + 'caption' => _t('_sys_agents_automators_field_message'), + 'required' => '1', + 'checker' => [ + 'func' => 'Avail', + 'params' => [], + 'error' => _t('_sys_agents_automators_field_message_err'), + ], + ], + 'submit' => array( + 'type' => 'input_set', + 0 => array ( + 'type' => 'submit', + 'name' => 'do_submit', + 'value' => _t('_sys_submit'), + ), + 1 => array ( + 'type' => 'reset', + 'name' => 'close', + 'value' => _t('_sys_close'), + 'attrs' => array('class' => 'bx-def-margin-sec-left', 'onclick' => '$(\'.bx-popup-applied:visible\').dolPopupHide();'), + ), + ), + + ), + ); + + if(isset($aForm['inputs']['providers'])) { + $oForm = new BxTemplFormView([]); + + $sProviders = 'providers'; + $aProviders = array_map(function($sTitle) { + return _t($sTitle); + }, ['' => '_sys_please_select'] + $this->_oDb->getProvidersBy(['sample' => 'all_pairs', 'active' => 1])); + + $aTmplVarsProviders = []; + if(!empty($aAutomator[$sProviders]) && is_array($aAutomator[$sProviders])) { + foreach($aAutomator[$sProviders] as $iApId => $iProviderId) { + $aInputSelect = [ + 'type' => 'select', + 'name' => $sProviders . '[]', + 'values' => $aProviders, + 'value' => (int)$iProviderId, + 'attrs' => [ + 'class' => 'bx-def-margin-sec-top-auto' + ] + ]; + $sInput = $oForm->genInput($aInputSelect); + + $aInputHidden = [ + 'type' => 'hidden', + 'name' => $sProviders . '_ids[]', + 'value' => (int)$iApId, + ]; + $sInput .= $oForm->genInput($aInputHidden); + + $aTmplVarsProviders[] = ['js_object' => $sJsObject, 'input_select' => $sInput]; + } + } + else { + $aInputSelect = [ + 'type' => 'select', + 'name' => $sProviders . '[]', + 'values' => $aProviders, + 'value' => '', + 'attrs' => [ + 'class' => 'bx-def-margin-sec-top-auto' + ] + ]; + + $aTmplVarsProviders = [ + ['js_object' => $sJsObject, 'input_select' => $oForm->genInput($aInputSelect)], + ]; + } + + $aInputButton = [ + 'type' => 'button', + 'name' => $sProviders . '_add', + 'value' => _t('_sys_agents_automators_field_providers_add'), + 'attrs' => [ + 'class' => 'bx-def-margin-sec-top', + 'onclick' => $sJsObject . ".providerAdd(this, '" . $sProviders . "');" + ] + ]; + + $aForm['inputs'][$sProviders]['content'] = $this->_oTemplate->parseHtmlByName('agents_automator_form_providers.html', [ + 'bx_repeat:providers' => $aTmplVarsProviders, + 'btn_add' => $oForm->genInputButton($aInputButton) + ]); + } + + if(isset($aForm['inputs']['helpers'])) { + $oForm = new BxTemplFormView([]); + + $sHelpers = 'helpers'; + $aHelpers = array_map(function($sTitle) { + return _t($sTitle); + }, ['' => '_sys_please_select'] + $this->_oDb->getHelpersBy(['sample' => 'all_pairs', 'active' => 1])); + + $aTmplVarsHelpers = []; + if(!empty($aAutomator[$sHelpers]) && is_array($aAutomator[$sHelpers])) { + foreach($aAutomator[$sHelpers] as $iAhId => $iHelperId) { + $aInputSelect = [ + 'type' => 'select', + 'name' => $sHelpers . '[]', + 'values' => $aHelpers, + 'value' => (int)$iHelperId, + 'attrs' => [ + 'class' => 'bx-def-margin-sec-top-auto' + ] + ]; + $sInput = $oForm->genInput($aInputSelect); + + $aInputHidden = [ + 'type' => 'hidden', + 'name' => $sHelpers . '_ids[]', + 'value' => (int)$iAhId, + ]; + $sInput .= $oForm->genInput($aInputHidden); + + $aTmplVarsHelpers[] = ['js_object' => $sJsObject, 'input_select' => $sInput]; + } + } + else { + $aInputSelect = [ + 'type' => 'select', + 'name' => $sHelpers . '[]', + 'values' => $aHelpers, + 'value' => '', + 'attrs' => [ + 'class' => 'bx-def-margin-sec-top-auto' + ] + ]; + + $aTmplVarsHelpers = [ + ['js_object' => $sJsObject, 'input_select' => $oForm->genInput($aInputSelect)], + ]; + } + + $aInputButton = [ + 'type' => 'button', + 'name' => $sHelpers . '_add', + 'value' => _t('_sys_agents_automators_field_helpers_add'), + 'attrs' => [ + 'class' => 'bx-def-margin-sec-top', + 'onclick' => $sJsObject . ".helperAdd(this, '" . $sHelpers . "');" + ] + ]; + + $aForm['inputs'][$sHelpers]['content'] = $this->_oTemplate->parseHtmlByName('agents_automator_form_helpers.html', [ + 'bx_repeat:helpers' => $aTmplVarsHelpers, + 'btn_add' => $oForm->genInputButton($aInputButton) + ]); + } + + if(isset($aForm['inputs']['assistants'])) { + $oForm = new BxTemplFormView([]); + + $sAssistants = 'assistants'; + $aAssistants = array_map(function($sTitle) { + return _t($sTitle); + }, ['' => '_sys_please_select'] + $this->_oDb->getAssistantsBy(['sample' => 'all_pairs', 'active' => 1])); + + $aTmplVarsAssistants = []; + if(!empty($aAutomator[$sAssistants]) && is_array($aAutomator[$sAssistants])) { + foreach($aAutomator[$sAssistants] as $iAhId => $iAssistantId) { + $aInputSelect = [ + 'type' => 'select', + 'name' => $sAssistants . '[]', + 'values' => $aAssistants, + 'value' => (int)$iAssistantId, + 'attrs' => [ + 'class' => 'bx-def-margin-sec-top-auto' + ] + ]; + $sInput = $oForm->genInput($aInputSelect); + + $aInputHidden = [ + 'type' => 'hidden', + 'name' => $sAssistants . '_ids[]', + 'value' => (int)$iAhId, + ]; + $sInput .= $oForm->genInput($aInputHidden); + + $aTmplVarsAssistants[] = ['js_object' => $sJsObject, 'input_select' => $sInput]; + } + } + else { + $aInputSelect = [ + 'type' => 'select', + 'name' => $sAssistants . '[]', + 'values' => $aAssistants, + 'value' => '', + 'attrs' => [ + 'class' => 'bx-def-margin-sec-top-auto' + ] + ]; + + $aTmplVarsAssistants = [ + ['js_object' => $sJsObject, 'input_select' => $oForm->genInput($aInputSelect)], + ]; + } + + $aInputButton = [ + 'type' => 'button', + 'name' => $sAssistants . '_add', + 'value' => _t('_sys_agents_automators_field_assistants_add'), + 'attrs' => [ + 'class' => 'bx-def-margin-sec-top', + 'onclick' => $sJsObject . ".assistantAdd(this, '" . $sAssistants . "');" + ] + ]; + + $aForm['inputs'][$sAssistants]['content'] = $this->_oTemplate->parseHtmlByName('agents_automator_form_assistants.html', [ + 'bx_repeat:assistants' => $aTmplVarsAssistants, + 'btn_add' => $oForm->genInputButton($aInputButton) + ]); + } + + return $aForm; + } + + protected function _getId() + { + $aIds = bx_get('ids'); + if(!empty($aIds) && is_array($aIds)) + return array_shift($aIds); + + $iId = (int)bx_get('id'); + if(!$iId) + return false; + + return $iId; + } + + protected function _getAutomatorName($sName) + { + return uriGenerate($sName, 'sys_agents_automators', 'name', ['lowercase' => false]); + } +} + +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/scripts/BxBaseStudioAgentsHelpers.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/scripts/BxBaseStudioAgentsHelpers.php new file mode 100644 index 0000000000..0ae340ef8a --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/scripts/BxBaseStudioAgentsHelpers.php @@ -0,0 +1,318 @@ +_sUrlPage = BX_DOL_URL_STUDIO . 'agents.php?page=helpers'; + + $this->_sFieldName = 'name'; + } + + public function getPageJsObject() + { + return 'oBxDolStudioPageAgents'; + } + + public function performActionAdd() + { + $sAction = 'add'; + + $aForm = $this->_getForm($sAction); + $oForm = new BxTemplFormView($aForm); + $oForm->initChecker(); + + if($oForm->isSubmittedAndValid()) { + $aValsToAdd = ['added' => time()]; + + $sName = $oForm->getCleanValue($this->_sFieldName); + $sName = $this->_getHelperName($sName); + BxDolForm::setSubmittedValue($this->_sFieldName, $sName, $oForm->aFormAttrs['method']); + + $iProfileId = $oForm->getCleanValue('profile_id'); + if(empty($iProfileId)) { + $iProfileId = (int)getParam('sys_agents_profile'); + if(empty($iProfileId)) + $iProfileId = current(bx_srv('system', 'get_options_agents_profile', [false], 'TemplServices'))['key']; + + $aValsToAdd['profile_id'] = $iProfileId; + } + + $bIsValid = true; + if($bIsValid) { + if(($iId = $oForm->insert($aValsToAdd)) !== false) { + $aRes = ['grid' => $this->getCode(false), 'blink' => $iId]; + } + else + $aRes = ['msg' => _t('_sys_txt_error_occured')]; + + return echoJson($aRes); + } + } + + $sFormId = $oForm->getId(); + $sContent = BxTemplStudioFunctions::getInstance()->popupBox($sFormId . '_popup', _t('_sys_agents_helpers_popup_add'), $this->_oTemplate->parseHtmlByName('agents_automator_form.html', [ + 'form_id' => $sFormId, + 'form' => $oForm->getCode(true), + 'object' => $this->_sObject, + 'action' => $sAction + ])); + + return echoJson(['popup' => ['html' => $sContent, 'options' => ['closeOnOuterClick' => false]]]); + } + + public function performActionEdit() + { + $sAction = 'edit'; + + $iId = $this->_getId(); + $aHelper = $this->_oDb->getHelpersBy(['sample' => 'id', 'id' => $iId]); + + $aForm = $this->_getFormEdit($sAction, $aHelper); + $oForm = new BxTemplFormView($aForm); + $oForm->initChecker(); + + if($oForm->isSubmittedAndValid()) { + $aValsToAdd = []; + + $sName = $oForm->getCleanValue($this->_sFieldName); + if($aHelper[$this->_sFieldName] != $sName) { + $sName = $this->_getHelperName($sName); + BxDolForm::setSubmittedValue($this->_sFieldName, $sName, $oForm->aFormAttrs['method']); + } + + $iProfileId = $oForm->getCleanValue('profile_id'); + if(empty($iProfileId)) { + $iProfileId = (int)getParam('sys_agents_profile'); + if(empty($iProfileId)) + $iProfileId = current(bx_srv('system', 'get_options_agents_profile', [false], 'TemplServices'))['key']; + + $aValsToAdd['profile_id'] = $iProfileId; + } + + if($oForm->update($iId, $aValsToAdd) !== false) + $aRes = ['grid' => $this->getCode(false), 'blink' => $iId]; + else + $aRes = ['msg' => _t('_sys_txt_error_occured')]; + + return echoJson($aRes); + } + + $sFormId = $oForm->getId(); + $sContent = BxTemplStudioFunctions::getInstance()->popupBox($sFormId . '_popup', _t('_sys_agents_helpers_popup_edit'), $this->_oTemplate->parseHtmlByName('agents_automator_form.html', [ + 'form_id' => $sFormId, + 'form' => $oForm->getCode(true), + 'object' => $this->_sObject, + 'action' => $sAction + ])); + + return echoJson(['popup' => ['html' => $sContent, 'options' => ['closeOnOuterClick' => false]]]); + } + + protected function _getCellModelId($mixedValue, $sKey, $aField, $aRow) + { + $aModel = $this->_oDb->getModelsBy(['sample' => 'id', 'id' => $mixedValue]); + if(!empty($aModel) && is_array($aModel)) + $mixedValue = $aModel['title']; + + return parent::_getCellDefault($mixedValue, $sKey, $aField, $aRow); + } + + protected function _getCellProfileId($mixedValue, $sKey, $aField, $aRow) + { + return parent::_getCellDefault(BxDolProfile::getInstanceMagic($mixedValue)->getDisplayName(), $sKey, $aField, $aRow); + } + + protected function _getCellAdded($mixedValue, $sKey, $aField, $aRow) + { + return parent::_getCellDefault(bx_time_js($mixedValue), $sKey, $aField, $aRow); + } + + protected function _getActionTune($sType, $sKey, $a, $isSmall = false, $isDisabled = false, $aRow = []) + { + $a['attr'] = array_merge($a['attr'], [ + "onclick" => "window.open('" . $this->_sUrlPage . '&id=' . $aRow['id'] . "', '_self');" + ]); + + return $this->_getActionDefault ($sType, $sKey, $a, $isSmall, $isDisabled, $aRow); + } + + protected function _addJsCss() + { + parent::_addJsCss(); + + $this->_oTemplate->addJs(['jquery.form.min.js']); + + $oForm = new BxTemplStudioFormView([]); + $oForm->addCssJs(); + } + + protected function _isCheckboxDisabled($aRow) + { + return false; + } + + protected function _getActionsDisabledBehavior($aRow) + { + return false; + } + + protected function _delete ($mixedId) + { + $mixedResult = parent::_delete($mixedId); + if($mixedResult) + $this->_oDb->deleteAutomatorHelpers(['helper_id' => (int)$mixedId]); + + return $mixedResult; + } + + protected function _getFormEdit($sAction, $aHelper = []) + { + $aForm = $this->_getForm($sAction, $aHelper); + $aForm['form_attrs']['action'] .= '&id=' . $aHelper['id']; + + return $aForm; + } + + protected function _getForm($sAction, $aHelper = []) + { + $sJsObject = $this->getPageJsObject(); + + $aForm = array( + 'form_attrs' => array( + 'id' => 'bx_std_agents_helpers_' . $sAction, + 'action' => BX_DOL_URL_ROOT . 'grid.php?o=sys_studio_agents_helpers&a=' . $sAction, + 'method' => 'post', + ), + 'params' => array ( + 'db' => array( + 'table' => 'sys_agents_helpers', + 'key' => 'id', + 'submit_name' => 'do_submit', + ), + ), + 'inputs' => array( + 'name' => [ + 'type' => 'text', + 'name' => 'name', + 'required' => '1', + 'caption' => _t('_sys_agents_helpers_field_name'), + 'value' => isset($aHelper['name']) ? $aHelper['name'] : '', + 'required' => '1', + 'checker' => [ + 'func' => 'Avail', + 'params' => [], + 'error' => _t('_sys_agents_form_field_err_enter'), + ], + 'db' => [ + 'pass' => 'Xss', + ] + ], + 'model_id' => [ + 'type' => 'select', + 'name' => 'model_id', + 'caption' => _t('_sys_agents_helpers_field_model_id'), + 'info' => '', + 'value' => isset($aHelper['model_id']) ? $aHelper['model_id'] : BxDolAI::getDefaultModel(), + 'values' => $this->_oDb->getModelsBy(['sample' => 'all_pairs', 'active' => 1, 'hidden' => 0]), + 'required' => '1', + 'db' => [ + 'pass' => 'Int', + ] + ], + 'profile_id' => [ + 'type' => 'select', + 'name' => 'profile_id', + 'caption' => _t('_sys_agents_helpers_field_profile_id'), + 'info' => _t('_sys_agents_helpers_field_profile_id_inf'), + 'value' => isset($aHelper['profile_id']) ? $aHelper['profile_id'] : 0, + 'values' => bx_srv('system', 'get_options_agents_profile', [], 'TemplServices'), + 'required' => '0', + 'db' => [ + 'pass' => 'Int', + ] + ], + 'description' => [ + 'type' => 'textarea', + 'name' => 'description', + 'caption' => _t('_sys_agents_helpers_field_description'), + 'value' => isset($aHelper['description']) ? $aHelper['description'] : '', + 'required' => '1', + 'checker' => [ + 'func' => 'Avail', + 'params' => [], + 'error' => _t('_sys_agents_form_field_err_enter'), + ], + 'db' => [ + 'pass' => 'Xss', + ] + ], + 'prompt' => [ + 'type' => 'textarea', + 'name' => 'prompt', + 'caption' => _t('_sys_agents_helpers_field_prompt'), + 'value' => isset($aHelper['prompt']) ? $aHelper['prompt'] : '', + 'required' => '1', + 'checker' => [ + 'func' => 'Avail', + 'params' => [], + 'error' => _t('_sys_agents_helpers_field_prompt_err'), + ], + 'db' => [ + 'pass' => 'Xss', + ] + ], + 'submit' => array( + 'type' => 'input_set', + 0 => array ( + 'type' => 'submit', + 'name' => 'do_submit', + 'value' => _t('_sys_submit'), + ), + 1 => array ( + 'type' => 'reset', + 'name' => 'close', + 'value' => _t('_sys_close'), + 'attrs' => array('class' => 'bx-def-margin-sec-left', 'onclick' => '$(\'.bx-popup-applied:visible\').dolPopupHide();'), + ), + ), + + ), + ); + + return $aForm; + } + + protected function _getId() + { + $aIds = bx_get('ids'); + if(!empty($aIds) && is_array($aIds)) + return array_shift($aIds); + + $iId = (int)bx_get('id'); + if(!$iId) + return false; + + return $iId; + } + + protected function _getHelperName($sName) + { + return uriGenerate($sName, 'sys_agents_helpers', 'name', ['lowercase' => false]); + } +} + +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/scripts/BxBaseStudioAgentsProviders.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/scripts/BxBaseStudioAgentsProviders.php new file mode 100644 index 0000000000..dc93c3bd4c --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/scripts/BxBaseStudioAgentsProviders.php @@ -0,0 +1,343 @@ +_sUrlPage = BX_DOL_URL_STUDIO . 'agents.php?page=providers'; + + $this->_sFieldName = 'name'; + } + + public function getPageJsObject() + { + return 'oBxDolStudioPageAgents'; + } + + public function performActionAdd() + { + $sAction = 'add'; + + $aProvider = []; + if(($iTypeId = bx_get('type_id')) !== false && $iTypeId > 0) { + $aProvider = [ + 'type_id' => (int)$iTypeId, + 'options' => $this->_oDb->getProviderOptionsBy(['sample' => 'provider_type_id', 'provider_type_id' => $iTypeId]) + ]; + } + + $aForm = $this->_getForm($sAction, $aProvider); + $oForm = new BxTemplFormView($aForm); + $oForm->initChecker(); + + if($oForm->isSubmittedAndValid()) { + $aValsToAdd = [ + 'profile_id' => bx_get_logged_profile_id(), + 'added' => time(), + 'active' => 1 + ]; + + $sName = $oForm->getCleanValue($this->_sFieldName); + $sName = $this->_getProviderName($sName); + BxDolForm::setSubmittedValue($this->_sFieldName, $sName, $oForm->aFormAttrs['method']); + + if(($iId = $oForm->insert($aValsToAdd)) !== false) { + if(!empty($aProvider['options']) && is_array($aProvider['options'])) + foreach($aProvider['options'] as $aOption) + $this->_oDb->insertProviderValue([ + 'provider_id' => $iId, + 'option_id' => $aOption['id'], + 'value' => $oForm->getCleanValue($aOption['name']) + ]); + + $aRes = ['grid' => $this->getCode(false), 'blink' => $iId]; + } + else + $aRes = ['msg' => _t('_sys_txt_error_occured')]; + + return echoJson($aRes); + } + + $sFormId = $oForm->getId(); + $sContent = BxTemplStudioFunctions::getInstance()->popupBox($sFormId . '_popup_' . $sAction, _t('_sys_agents_providers_popup_add'), $this->_oTemplate->parseHtmlByName('agents_provider_form.html', [ + 'form_id' => $sFormId, + 'form' => $oForm->getCode(true), + 'object' => $this->_sObject, + 'action' => $sAction + ])); + + return echoJson(['popup' => ['html' => $sContent, 'options' => ['closeOnOuterClick' => false]]]); + } + + public function performActionEdit() + { + $sAction = 'edit'; + + $iId = $this->_getId(); + + $oAIProvider = BxDolAI::getInstance()->getProviderObject($iId); + if(!$oAIProvider) + return echoJson([]); + + $aProviderInfo = $oAIProvider->getInfo(); + + $aForm = $this->_getFormEdit($sAction, $aProviderInfo); + $oForm = new BxTemplFormView($aForm); + $oForm->initChecker(); + + if($oForm->isSubmittedAndValid()) { + $sName = $oForm->getCleanValue($this->_sFieldName); + if($aProviderInfo[$this->_sFieldName] != $sName) { + $sName = $this->_getProviderName($sName); + BxDolForm::setSubmittedValue($this->_sFieldName, $sName, $oForm->aFormAttrs['method']); + } + + if($oForm->update($iId) === false) + return echoJson(['msg' => _t('_sys_txt_error_occured')]); + + if(!empty($aProviderInfo['options']) && is_array($aProviderInfo['options'])) + foreach($aProviderInfo['options'] as $aOption) + $this->_oDb->insertProviderValue([ + 'provider_id' => $iId, + 'option_id' => $aOption['id'], + 'value' => $oForm->getCleanValue($aOption['name']) + ]); + + return echoJson(['grid' => $this->getCode(false), 'blink' => $iId]); + } + + $sFormId = $oForm->getId(); + $sContent = BxTemplStudioFunctions::getInstance()->popupBox($sFormId . '_popup_' . $sAction, _t('_sys_agents_providers_popup_edit'), $this->_oTemplate->parseHtmlByName('agents_provider_form.html', [ + 'form_id' => $sFormId, + 'form' => $oForm->getCode(true), + 'object' => $this->_sObject, + 'action' => $sAction + ])); + + return echoJson(['popup' => ['html' => $sContent, 'options' => ['closeOnOuterClick' => false]]]); + } + + public function performActionInfo() + { + $sAction = 'view'; + + $iId = $this->_getId(); + + $oAIProvider = BxDolAI::getInstance()->getProviderObject($iId); + if(!$oAIProvider) + return echoJson([]); + + $aProviderInfo = $oAIProvider->getInfo(); + + $aForm = $this->_getFormView($sAction, $aProviderInfo); + $oForm = new BxTemplFormView($aForm); + $oForm->initChecker($aProviderInfo); + + $sFormId = $oForm->getId(); + $sContent = BxTemplStudioFunctions::getInstance()->popupBox($sFormId . '_popup_' . $sAction, _t('_sys_agents_providers_popup_view'), $this->_oTemplate->parseHtmlByName('agents_provider_form.html', [ + 'form_id' => $oForm->getId(), + 'form' => $oForm->getCode(true), + 'object' => $this->_sObject, + 'action' => $sAction + ])); + + echoJson(['popup' => ['html' => $sContent, 'options' => ['closeOnOuterClick' => true, 'removeOnClose' => true]]]); + } + + protected function _getCellAdded($mixedValue, $sKey, $aField, $aRow) + { + return parent::_getCellDefault(bx_time_js($mixedValue), $sKey, $aField, $aRow); + } + + protected function _addJsCss() + { + parent::_addJsCss(); + + $this->_oTemplate->addJs(['jquery.form.min.js']); + + $oForm = new BxTemplStudioFormView([]); + $oForm->addCssJs(); + } + + protected function _isCheckboxDisabled($aRow) + { + return false; + } + + protected function _getActionsDisabledBehavior($aRow) + { + return false; + } + + protected function _delete ($mixedId) + { + $mixedResult = parent::_delete($mixedId); + if($mixedResult) { + $this->_oDb->deleteProviderValues(['provider_id' => (int)$mixedId]); + + $this->_oDb->deleteAutomatorProviders(['provider_id' => (int)$mixedId]); + } + + return $mixedResult; + } + + protected function _getFormView($sAction, $aProvider = []) + { + $aForm = $this->_getForm($sAction, $aProvider); + $aForm['params']['view_mode'] = 1; + + return $aForm; + } + + protected function _getFormEdit($sAction, $aProvider = []) + { + $aForm = $this->_getForm($sAction, $aProvider); + $aForm['form_attrs']['action'] .= '&id=' . $aProvider['id']; + + return $aForm; + } + + protected function _getForm($sAction, $aProvider = []) + { + $bProvider = !empty($aProvider) && is_array($aProvider); + + $aForm = [ + 'form_attrs' => [ + 'id' => 'bx_std_agents_providers_' . $sAction, + 'action' => BX_DOL_URL_ROOT . 'grid.php?o=sys_studio_agents_providers&a=' . $sAction, + 'method' => 'post', + ], + 'params' => [ + 'db' => [ + 'table' => 'sys_agents_providers', + 'key' => 'id', + 'submit_name' => 'do_submit', + ], + ], + 'inputs' => [ + 'controls' => [ + 'type' => 'input_set', + 0 => [ + 'type' => 'submit', + 'name' => 'do_submit', + 'value' => _t('_sys_submit'), + ], + 1 => [ + 'type' => 'reset', + 'name' => 'close', + 'value' => _t('_sys_close'), + 'attrs' => ['class' => 'bx-def-margin-sec-left', 'onclick' => '$(\'.bx-popup-applied:visible\').dolPopupHide();'], + ], + ], + + ], + ]; + + if($sAction == 'add' && !$bProvider) { + $aForm['inputs'] = bx_array_insert_before([ + 'type_id' => [ + 'type' => 'select', + 'name' => 'type_id', + 'caption' => _t('_sys_agents_providers_field_type_id'), + 'info' => '', + 'value' => isset($aProvider['type_id']) ? $aProvider['type_id'] : 0, + 'values' => array_map(function($sTitle) { + return _t($sTitle); + }, ['' => '_sys_please_select'] + $this->_oDb->getProviderTypesBy(['sample' => 'all_pairs', 'active' => 1])), + 'required' => '1', + 'db' => [ + 'pass' => 'Int', + ] + ], + ], $aForm['inputs'], 'controls'); + + $aForm['inputs']['controls'][0] = array_merge($aForm['inputs']['controls'][0], [ + 'name' => 'do_select', + 'value' => _t('_sys_select') + ]); + } + else { + $aInputsAdd = [ + 'type_id' => [ + 'type' => 'hidden', + 'name' => 'type_id', + 'value' => isset($aProvider['type_id']) ? $aProvider['type_id'] : 0, + 'db' => [ + 'pass' => 'Int', + ] + ], + 'name' => [ + 'type' => 'text', + 'name' => 'name', + 'caption' => _t('_sys_agents_providers_field_name'), + 'value' => isset($aProvider['name']) ? $aProvider['name'] : '', + 'required' => '1', + 'checker' => [ + 'func' => 'Avail', + 'params' => [], + 'error' => _t('_sys_agents_form_field_err_enter'), + ], + 'db' => [ + 'pass' => 'Xss', + ], + ], + ]; + + if(!empty($aProvider['options']) && is_array($aProvider['options'])) + foreach($aProvider['options'] as $aOption) { + if($aOption['type'] == 'value' && empty($aOption['value'])) + continue; + + $aInputsAdd[$aOption['name']] = [ + 'type' => $aOption['type'], + 'name' => $aOption['name'], + 'caption' => _t($aOption['title']), + 'info' => _t($aOption['description']), + 'value' => isset($aOption['value']) ? $aOption['value'] : '', + 'checker' => !empty($aOption['check_type']) ? [ + 'func' => $aOption['check_type'], + 'params' => !empty($aOption['check_params']) ? unserialize($aOption['check_params']) : '', + 'error' => _t($aOption['check_error']), + ] : null, + ]; + } + + $aForm['inputs'] = bx_array_insert_before($aInputsAdd, $aForm['inputs'], 'controls'); + } + + return $aForm; + } + + protected function _getId() + { + $aIds = bx_get('ids'); + if(!empty($aIds) && is_array($aIds)) + return array_shift($aIds); + + $iId = (int)bx_get('id'); + if(!$iId) + return false; + + return $iId; + } + + protected function _getProviderName($sName) + { + return uriGenerate($sName, 'sys_agents_providers', 'name', ['lowercase' => false]); + } +} + +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/scripts/BxBaseStudioOptions.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/scripts/BxBaseStudioOptions.php new file mode 100644 index 0000000000..cfe3005152 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/scripts/BxBaseStudioOptions.php @@ -0,0 +1,777 @@ +getJsObject(); + + $aCategories = []; + $iCategories = $this->oDb->getCategories(['type' => 'by_type_name_key_name', 'type_name' => $this->sType, 'category_name' => $this->sCategory, 'hidden' => 0], $aCategories); + if($iCategories > 0) + $aCategories = array_keys($aCategories); + + $bMix = false; + $aOptions2Mixes = []; + if($this->bMixes) { + if(!empty($this->sMix)) + $aMixesBrowse = ['type' => 'by_name', 'value' => $this->sMix]; + else if(is_string($this->sCategory)) + $aMixesBrowse = ['type' => 'by_type_category', 'mix_type' => $this->sType, 'mix_category' => $this->sCategory, 'active' => 1]; + else + $aMixesBrowse = ['type' => 'by_type', 'value' => $this->sType, 'active' => 1]; + + $aMix = array(); + $this->oDb->getMixes($aMixesBrowse, $aMix, false); + if(!empty($aMix) && is_array($aMix)) { + $this->aMix = $aMix; + $this->sMix = $aMix['name']; + + $bMix = true; + $this->oDb->getMixesOptions(['type' => 'by_mix_id_pair_option_value', 'value' => $this->aMix['id']], $aOptions2Mixes, false); + } + else + $this->sMix = BX_DOL_STUDIO_STG_MIX_DEFAULT; + } + + $bWrap = count($aCategories) > 1; + $aForm = [ + 'form_attrs' => [ + 'id' => 'adm-settings-form' . ($bWrap ? '-categorized' : ''), + 'name' => 'adm-settings-form', + 'action' => bx_append_url_params($this->sBaseUrl, ['type' => $this->sType]), + 'method' => 'post', + 'enctype' => 'multipart/form-data', + 'target' => 'adm-settings-iframe', + 'onsubmit' => 'return ' . $sJsObject . '.onSubmit(this)' + ], + 'params' => [ + 'db' => [ + 'table' => 'sys_options', + 'key' => 'id', + 'uri' => '', + 'uri_title' => '', + 'submit_name' => 'save' + ], + ], + 'inputs' => [] + ]; + + if($bMix) + $aForm['inputs']['mix_id'] = [ + 'type' => 'hidden', + 'name' => 'mix_id', + 'value' => $this->aMix['id'], + 'db' => [ + 'pass' => 'Int', + ], + ]; + + foreach($aCategories as $sCategory) { + $aFields = []; + + if(empty($sCategory)) + continue; + + $aCategory = array(); + $iCategory = $this->oDb->getCategories(['type' => 'by_name', 'value' => $sCategory], $aCategory); + if($iCategory != 1) + continue; + + $aOptions = array(); + $iOptions = $this->oDb->getOptions(['type' => 'by_category_id', 'value' => $aCategory['id']], $aOptions); + + foreach($aOptions as $aOption) + $aFields[$aOption['name']] = $this->field($aOption, $aOptions2Mixes); + + if($bWrap) { + $aCategory['selected'] = $aCategory['name'] == $sCategorySelected; + $aFields = $this->header($aCategory, $aFields); + } + + $aForm['inputs'] = array_merge($aForm['inputs'], $aFields); + } + + $aForm['inputs'] = array_merge( + $aForm['inputs'], (!$bWrap ? [] : [ + 'header_save' => [ + 'type' => 'block_header', + ], + ]), [ + 'categories' => [ + 'type' => 'hidden', + 'name' => 'categories', + 'value' => implode(',', $aCategories), + 'db' => [ + 'pass' => 'Xss', + ], + ] + ], ($this->isReadOnly() ? [] : [ + 'save' => [ + 'type' => 'submit', + 'name' => 'save', + 'value' => _t("_adm_btn_settings_save") + ], + ]) + ); + + $oForm = new BxTemplStudioFormView($aForm, $oTemplate); + $oForm->initChecker(); + + if($oForm->isSubmittedAndValid()) { + echo $this->saveChanges($oForm); + exit; + } + + $bTmplVarsMixes = false; + $aTmplVarsMixes = []; + if($this->bMixes) { + if(is_string($this->sCategory)) + $aMixesBrowse = ['type' => 'by_type_category', 'mix_type' => $this->sType, 'mix_category' => $this->sCategory]; + else + $aMixesBrowse = ['type' => 'by_type', 'value' => $this->sType]; + + $aMixes = []; + $this->oDb->getMixes($aMixesBrowse, $aMixes, false); + $aMixes = array_merge([['name' => BX_DOL_STUDIO_STG_MIX_DEFAULT, 'title' => _t('_adm_stg_txt_mix_' . BX_DOL_STUDIO_STG_MIX_DEFAULT)]], $aMixes); + + foreach($aMixes as $aMix) + $aTmplVarsMixes[] = [ + 'value' => $aMix['name'], + 'title' => $aMix['title'], + 'bx_if:show_checked_mix' => [ + 'condition' => !empty($this->sMix) && $aMix['name'] == $this->sMix, + 'content' => [] + ] + ]; + + $bTmplVarsMixes = !empty($aTmplVarsMixes); + } + + $bMixSelected = !empty($this->sMix) && !empty($this->aMix); + + $aTmplVarsButton = []; + if($bMixSelected) + $aTmplVarsButton = [ + 'js_object' => $sJsObject, + 'id' => $this->aMix['id'] + ]; + + return $oTemplate->parseHtmlByName('options.html', [ + 'base_url' => $this->sBaseUrl, + 'param_prefix' => $this->sParamPrefix, + 'js_object' => $sJsObject, + 'type' => $this->sType, + 'category' => is_array($this->sCategory) ? json_encode($this->sCategory) : $this->sCategory, + 'mix' => $this->sMix, + 'bx_if:show_manage' => [ + 'condition' => $this->bManage, + 'content' => [ + 'js_object' => $sJsObject, + ] + ], + 'bx_if:show_mixes' => [ + 'condition' => $this->bMixes, + 'content' => [ + 'js_object' => $sJsObject, + 'bx_if:show_select_mix' => [ + 'condition' => $bTmplVarsMixes, + 'content' => [ + 'js_object' => $sJsObject, + 'bx_repeat:mixes' => $aTmplVarsMixes, + ] + ], + 'bx_if:show_publish_mix' => [ + 'condition' => $bMixSelected && (int)$this->aMix['published'] == 0, + 'content' => $aTmplVarsButton + ], + 'bx_if:show_hide_mix' => [ + 'condition' => $bMixSelected && (int)$this->aMix['published'] != 0, + 'content' => $aTmplVarsButton + ], + 'bx_if:show_export_mix' => [ + 'condition' => $bMixSelected, + 'content' => $aTmplVarsButton + ], + 'bx_if:show_delete_mix' => [ + 'condition' => $bMixSelected, + 'content' => $aTmplVarsButton + ], + ] + ], + 'form' => $oForm->getCode() + ]); + } + + public function getPopupCodeImport($sType) + { + $oTemplate = BxDolStudioTemplate::getInstance(); + $sJsObject = $this->getJsObject(); + + $sForm = 'adm-settings-import-form'; + $aForm = [ + 'form_attrs' => [ + 'id' => $sForm, + 'name' => $sForm, + 'action' => bx_append_url_params($this->sBaseUrl, [$this->sParamPrefix . '_action' => 'import']), + 'method' => 'post', + 'enctype' => 'multipart/form-data' + ], + 'params' => [ + 'db' => [ + 'submit_name' => 'save' + ], + ], + 'inputs' => [ + 'file' => [ + 'type' => 'file', + 'name' => 'file', + 'caption' => '', + 'value' => '', + ], + 'controls' => [ + 'type' => 'input_set', [ + 'type' => 'submit', + 'name' => 'save', + 'value' => _t('_adm_btn_settings_import'), + ], [ + 'type' => 'button', + 'name' => 'cancel', + 'value' => _t('_adm_txt_confirm_cancel'), + 'attrs' => [ + 'class' => 'bx-def-margin-sec-left-auto', + 'onclick' => '$(".bx-popup-applied:visible").dolPopupHide()' + ] + ] + ] + ] + ]; + + $oForm = new BxTemplStudioFormView($aForm); + $oForm->initChecker(); + + if($oForm->isSubmittedAndValid()) { + $sError = _t('_adm_stg_err_cannot_perform'); + $sErrorWf = _t('_adm_stg_err_import_wrong_format'); + + $aFile = $_FILES['file']; + if(empty($aFile['tmp_name'])) + return ['code' => '1', 'message' => $sError]; + + $sFile = $aFile['tmp_name']; + $rHandle = @fopen($sFile, "r"); + if(!$rHandle) + return ['code' => '2', 'message' => $sError]; + + $sContents = fread($rHandle, filesize($sFile)); + fclose($rHandle); + + $aContent = json_decode($sContents, true); + if(!is_array($aContent) || empty($aContent['meta']) || empty($aContent['data'])) + return ['code' => '3', 'message' => $sErrorWf]; + + if(empty($aContent['meta']['type']) || strcmp($aContent['meta']['type'], $sType) != 0) + return ['code' => '4', 'message' => $sErrorWf]; + + $iData = 0; + foreach($aContent['data']['types'] as $aType) { + if(empty($aType['categories']) || !is_array($aType['categories'])) + continue; + + foreach($aType['categories'] as $aCategory) { + if(empty($aCategory['options']) || !is_array($aCategory['options'])) + continue; + + foreach($aCategory['options'] as $sOptName => $sOptValue) { + setParam($sOptName, $sOptValue); + $iData += 1; + } + } + } + + $this->clearCache(); + return [ + 'message' => _t('_adm_stg_msg_imported', $iData), + 'eval' => $sJsObject . '.onImport(oData);' + ]; + } + + return [ + 'popup' => BxTemplStudioFunctions::getInstance()->popupBox('adm-stg-import-popup', _t('_adm_stg_txt_import_popup'), $oTemplate->parseHtmlByName('options_manage_popup.html', [ + 'js_object' => $sJsObject, + 'form_id' => $sForm, + 'form' => $oForm->getCode(true), + ])) + ]; + } + + public function getPopupCodeCreateMix() + { + $oTemplate = BxDolStudioTemplate::getInstance(); + $sJsObject = $this->getJsObject(); + + $sForm = 'adm-settings-create-mix-form'; + $aForm = [ + 'form_attrs' => [ + 'id' => $sForm, + 'name' => $sForm, + 'action' => bx_append_url_params($this->sBaseUrl, [$this->sParamPrefix . '_action' => 'create-mix']), + 'method' => 'post', + 'enctype' => 'multipart/form-data' + ], + 'params' => [ + 'db' => [ + 'table' => 'sys_options_mixes', + 'key' => 'id', + 'uri' => 'name', + 'uri_title' => 'title', + 'submit_name' => 'save' + ], + ], + 'inputs' => [ + 'type' => [ + 'type' => 'hidden', + 'name' => 'type', + 'value' => $this->sType + ], + 'category' => [ + 'type' => 'hidden', + 'name' => 'category', + 'value' => is_array($this->sCategory) ? json_encode($this->sCategory) : $this->sCategory, + ], + 'title' => [ + 'type' => 'text', + 'name' => 'title', + 'caption' => _t('_adm_stg_txt_mix_title'), + 'info' => _t('_adm_stg_txt_mix_title_inf'), + 'value' => '', + 'required' => true, + 'checker' => [ + 'func' => 'avail', + 'params' => [], + 'error' => _t('_adm_stg_txt_mix_title_err') + ], + 'db' => ['pass' => 'Xss'] + ], + 'dark' => [ + 'type' => 'switcher', + 'name' => 'dark', + 'caption' => _t('_adm_stg_txt_mix_dark'), + 'info' => '', + 'value' => '1', + 'db' => ['pass' => 'Int'] + ], + 'duplicate' => [ + 'type' => 'select', + 'name' => 'duplicate', + 'caption' => _t('_adm_stg_txt_mix_duplicate'), + 'info' => _t('_adm_stg_txt_mix_duplicate_inf'), + 'values' => [ + ['key' => '', 'value' => _t('_None')] + ], + 'value' => '', + ], + 'controls' => [ + 'type' => 'input_set', [ + 'type' => 'submit', + 'name' => 'save', + 'value' => _t('_adm_btn_settings_save'), + ], [ + 'type' => 'button', + 'name' => 'cancel', + 'value' => _t('_adm_txt_confirm_cancel'), + 'attrs' => [ + 'class' => 'bx-def-margin-sec-left-auto', + 'onclick' => '$(".bx-popup-applied:visible").dolPopupHide()' + ] + ] + ] + ] + ]; + + if(is_string($this->sCategory)) + $aMixesBrowse = ['type' => 'by_type_category', 'mix_type' => $this->sType, 'mix_category' => $this->sCategory]; + else + $aMixesBrowse = ['type' => 'by_type', 'value' => $this->sType]; + + $aMixes = []; + $this->oDb->getMixes($aMixesBrowse, $aMixes, false); + foreach($aMixes as $aMix) + $aForm['inputs']['duplicate']['values'][] = ['key' => $aMix['name'], 'value' => $aMix['title']]; + + $oForm = new BxTemplStudioFormView($aForm); + $oForm->initChecker(); + + if($oForm->isSubmittedAndValid()) { + $iId = $oForm->insert([ + 'type' => $this->sType, + 'category' => is_string($this->sCategory) ? $this->sCategory : '', + 'name' => $oForm->generateUri() + ]); + + if($iId === false) + return ['code' => '1', 'message' => _t('_adm_stg_err_cannot_perform')]; + + $this->oDb->updateMixes(['active' => 0], [ + 'type' => $this->sType, + 'category' => is_string($this->sCategory) ? $this->sCategory : '', + 'active' => 1 + ]); + $this->oDb->updateMixes(['active' => 1], ['id' => $iId]); + + $aDuplicate = []; + $this->oDb->getMixes(['type' => 'by_name', 'value' => $oForm->getCleanValue('duplicate')], $aDuplicate, false); + if(!empty($aDuplicate) && is_array($aDuplicate)) + $this->oDb->duplicateMixesOptions($aDuplicate['id'], $iId); + + $this->clearCache(); + return ['eval' => $sJsObject . '.onMixCreate(oData);']; + } + + return [ + 'popup' => BxTemplStudioFunctions::getInstance()->popupBox('adm-stg-create-mix-popup', _t('_adm_stg_txt_create_mix_popup'), $oTemplate->parseHtmlByName('options_create_mix.html', [ + 'js_object' => $sJsObject, + 'form_id' => $sForm, + 'form' => $oForm->getCode(true), + ])) + ]; + } + + public function getPopupCodeImportMix() + { + $oTemplate = BxDolStudioTemplate::getInstance(); + $sJsObject = $this->getJsObject(); + + $sForm = 'adm-settings-import-mix-form'; + $aForm = [ + 'form_attrs' => [ + 'id' => $sForm, + 'name' => $sForm, + 'action' => bx_append_url_params($this->sBaseUrl, [$this->sParamPrefix . '_action' => 'import-mix']), + 'method' => 'post', + 'enctype' => 'multipart/form-data' + ], + 'params' => [ + 'db' => [ + 'table' => 'sys_options_mixes', + 'key' => 'id', + 'uri' => 'name', + 'uri_title' => 'title', + 'submit_name' => 'save' + ], + ], + 'inputs' => [ + 'type' => [ + 'type' => 'hidden', + 'name' => 'type', + 'value' => $this->sType + ], + 'category' => [ + 'type' => 'hidden', + 'name' => 'category', + 'value' => is_array($this->sCategory) ? json_encode($this->sCategory) : $this->sCategory, + ], + 'file' => [ + 'type' => 'file', + 'name' => 'file', + 'caption' => '', + 'value' => '', + ], + 'controls' => [ + 'type' => 'input_set', [ + 'type' => 'submit', + 'name' => 'save', + 'value' => _t('_adm_btn_settings_import'), + ], [ + 'type' => 'button', + 'name' => 'cancel', + 'value' => _t('_adm_txt_confirm_cancel'), + 'attrs' => [ + 'class' => 'bx-def-margin-sec-left-auto', + 'onclick' => '$(".bx-popup-applied:visible").dolPopupHide()' + ] + ] + ] + ] + ]; + + $oForm = new BxTemplStudioFormView($aForm); + $oForm->initChecker(); + + if($oForm->isSubmittedAndValid()) { + $sError = _t('_adm_stg_err_cannot_perform'); + + $aFile = $_FILES['file']; + if(empty($aFile['tmp_name'])) + return ['code' => '1', 'message' => $sError]; + + $sFile = $aFile['tmp_name']; + $rHandle = @fopen($sFile, "r"); + if(!$rHandle) + return ['code' => '2', 'message' => $sError]; + + $sContents = fread($rHandle, filesize($sFile)); + fclose($rHandle); + + $aContent = json_decode($sContents, true); + if(!is_array($aContent) || empty($aContent['mix']) || empty($aContent['options'])) + return ['code' => '3', 'message' => $sError]; + + $aMix = []; + $this->oDb->getMixes(['type' => 'by_name', 'value' => $aContent['mix']['name']], $aMix, false); + if(!empty($aMix) && is_array($aMix)) + return ['code' => '4', 'message' => _t('_adm_stg_err_mix_already_exists')]; + + $iId = $oForm->insert([ + 'type' => $aContent['mix']['type'], + 'category' => $aContent['mix']['category'], + 'name' => $aContent['mix']['name'], + 'title' => $aContent['mix']['title'] + ]); + if($iId === false) + return ['code' => '5', 'message' => $sError]; + + foreach($aContent['options'] as $sKey => $sValue) + $this->oDb->insertMixesOptions([ + 'option' => $sKey, + 'mix_id' => $iId, + 'value' => $sValue + ]); + + $this->oDb->updateMixes(['active' => 0], [ + 'type' => $this->sType, + 'category' => is_string($this->sCategory) ? $this->sCategory : '', + 'active' => 1 + ]); + $this->oDb->updateMixes(['active' => 1], ['id' => $iId]); + + $this->clearCache(); + return ['eval' => $sJsObject . '.onMixImport(oData);']; + } + + return [ + 'popup' => BxTemplStudioFunctions::getInstance()->popupBox('adm-stg-import-mix-popup', _t('_adm_stg_txt_import_mix_popup'), $oTemplate->parseHtmlByName('options_import_mix.html', [ + 'js_object' => $sJsObject, + 'form_id' => $sForm, + 'form' => $oForm->getCode(true), + ])) + ]; + } + + protected function header($aCategory, $aFields) + { + return array_merge([ + 'category_' . $aCategory['id'] . '_beg' => [ + 'type' => 'block_header', + 'name' => 'category_' . $aCategory['id'] . '_beg', + 'caption' => _t($aCategory['caption']), + 'collapsable' => true, + 'collapsed' => !$aCategory['selected'] + ] + ], + $aFields + ); + } + + protected function field($aItem, $aItems2Mixes) + { + $mixedValue = isset($aItems2Mixes[$aItem['name']]) ? $aItems2Mixes[$aItem['name']] : $aItem['value']; + + $sMethod = 'getCustomValue' . bx_gen_method_name(trim(str_replace($this->sType, '', $aItem['name']), '_')); + if(method_exists($this, $sMethod)) + $mixedValue = $this->$sMethod($aItem, $mixedValue); + + $aAttributes = array(); + if($this->isReadOnly()) + $aAttributes = array_merge($aAttributes, [ + 'disabled' => 'disabled' + ]); + + $aField = []; + switch($aItem['type']) { + case 'value': + $aField = [ + 'type' => 'text', + 'name' => $aItem['name'], + 'caption' => _t($aItem['caption']), + 'info' => _t($aItem['info']), + 'value' => $mixedValue, + 'attrs' => array_merge($aAttributes, ['readonly' => 'readonly']), + 'db' => ['pass' => 'Xss'], + ]; + break; + case 'digit': + $aField = [ + 'type' => 'text', + 'name' => $aItem['name'], + 'caption' => _t($aItem['caption']), + 'info' => _t($aItem['info']), + 'value' => $mixedValue, + 'attrs' => $aAttributes, + 'db' => ['pass' => 'Xss'], + ]; + break; + case 'text': + $aField = [ + 'type' => 'textarea', + 'name' => $aItem['name'], + 'caption' => _t($aItem['caption']), + 'info' => _t($aItem['info']), + 'value' => $mixedValue, + 'attrs' => $aAttributes, + 'db' => ['pass' => 'XssHtml'], + ]; + break; + case 'code': + $aField = [ + 'type' => 'textarea', + 'code' => true, + 'name' => $aItem['name'], + 'caption' => _t($aItem['caption']), + 'info' => _t($aItem['info']), + 'value' => $mixedValue, + 'attrs' => $aAttributes, + 'db' => ['pass' => 'XssHtml'], + ]; + break; + case 'checkbox': + $aField = [ + 'type' => 'checkbox', + 'name' => $aItem['name'], + 'caption' => _t($aItem['caption']), + 'info' => _t($aItem['info']), + 'value' => 'on', + 'checked' => $mixedValue == 'on', + 'attrs' => $aAttributes, + 'db' => ['pass' => 'Xss'], + ]; + break; + case 'list': + case 'rlist': + $aField = [ + 'type' => 'checkbox_set', + 'name' => $aItem['name'], + 'caption' => _t($aItem['caption']), + 'info' => _t($aItem['info']), + 'value' => !empty($mixedValue) ? explode(',', $mixedValue) : [], + 'reverse' => $aItem['type'] == 'rlist', + 'attrs' => $aAttributes, + 'db' => ['pass' => 'Xss'], + ]; + + if (BxDolService::isSerializedService($aItem['extra'])) + $aField['values'] = BxDolService::callSerialized($aItem['extra']); + else + foreach(explode(',', $aItem['extra']) as $sValue) + $aField['values'][$sValue] = $sValue; + break; + case 'select': + $aField = [ + 'type' => 'select', + 'name' => $aItem['name'], + 'caption' => _t($aItem['caption']), + 'info' => _t($aItem['info']), + 'value' => $mixedValue, + 'values' => [], + 'attrs' => $aAttributes, + 'db' => ['pass' => 'Xss'], + ]; + + if (BxDolService::isSerializedService($aItem['extra'])) + $aField['values'] = BxDolService::callSerialized($aItem['extra']); + else + foreach(explode(',', $aItem['extra']) as $sValue) + $aField['values'][] = ['key' => $sValue, 'value' => $sValue]; + break; + case 'file': + $aField = [ + 'type' => 'file', + 'name' => $aItem['name'], + 'caption' => _t($aItem['caption']), + 'info' => _t($aItem['info']), + 'value' => $mixedValue, + 'attrs' => $aAttributes, + 'db' => ['pass' => 'Xss'] + ]; + break; + case 'image': + //--- Concatenation integer values as strings is required to get unique content id + $iContentId = (int)($aItem['id'] . ($this->bMixes && isset($this->aMix['id']) ? $this->aMix['id'] : 0)); + + $aField = [ + 'type' => 'files', + 'name' => $aItem['name'], + 'storage_object' => $this->sStorage, + 'storage_private' => 0, + 'images_transcoder' => $this->sTranscoder, + 'uploaders' => ['sys_settings_html5'], + 'upload_buttons_titles' => ['HTML5' => _t('_sys_uploader_button_name_single')], + 'multiple' => false, + 'content_id' => $iContentId, + 'ghost_template' => BxTemplStudioFunctions::getInstance()->getDefaultGhostTemplate($aItem['name']), + 'caption' => _t($aItem['caption']), + 'info' => _t($aItem['info']), + 'value' => $mixedValue, + 'attrs' => $aAttributes, + 'db' => ['pass' => 'Xss'] + ]; + break; + case 'rgb': + case 'rgba': + $aField = [ + 'type' => $aItem['type'], + 'name' => $aItem['name'], + 'caption' => _t($aItem['caption']), + 'info' => _t($aItem['info']), + 'value' => $mixedValue, + 'attrs' => $aAttributes, + 'db' => ['pass' => 'Xss'], + ]; + break; + case 'datetime': + $aField = [ + 'type' => 'datetime', + 'name' => $aItem['name'], + 'caption' => _t($aItem['caption']), + 'info' => _t($aItem['info']), + 'value' => $mixedValue, + 'attrs' => $aAttributes, + 'db' => ['pass' => 'DateTimeUtc'], + ]; + break; + } + + return $aField; + } +} + +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/scripts/BxBaseStudioPage.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/scripts/BxBaseStudioPage.php new file mode 100644 index 0000000000..95f94def91 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/scripts/BxBaseStudioPage.php @@ -0,0 +1,243 @@ +aPageCss = [ + 'page.css', + 'page-media-tablet.css', + 'page-media-desktop.css', + 'page_columns.css', + 'menu_top.css' + ]; + + $this->aPageJs = [ + 'jquery.anim.js', + 'jquery.jfeed.pack.js', + 'jquery.dolRSSFeed.js', + 'page.js' + ]; + + $this->sPageJsClass = 'BxDolStudioPage'; + $this->sPageJsObject = 'oBxDolStudioPage'; + } + + public function getPageIndex() + { + if(!is_array($this->aPage) || empty($this->aPage)) + return BX_PAGE_DEFAULT; + + if(!$this->bPageMultiple) + return !empty($this->aPage['index']) ? (int)$this->aPage['index'] : BX_PAGE_DEFAULT; + else + return !empty($this->aPage[$this->sPageSelected]['index']) ? (int)$this->aPage[$this->sPageSelected]['index'] : BX_PAGE_DEFAULT; + + $this->aMarkers = array_merge($this->aMarkers, array( + 'js_object' => $this->getPageJsObject(), + )); + } + + public function getPageJs() + { + return $this->aPageJs; + } + + public function getPageJsClass() + { + return $this->sPageJsClass; + } + + public function getPageJsObject() + { + return $this->sPageJsObject; + } + + public function getPageJsCode($aOptions = array(), $bWrap = true) + { + $sJsClass = $this->getPageJsClass(); + $sJsObject = $this->getPageJsObject(); + if(empty($sJsClass) || empty($sJsObject)) + return ''; + + $sOptions = '{}'; + if(!empty($aOptions)) + $sOptions = json_encode($aOptions); + + $sContent = 'var ' . $sJsObject . ' = new ' . $sJsClass . '(' . $sOptions . ');'; + if($bWrap) + $sContent = BxDolStudioTemplate::getInstance()->_wrapInTagJsCode($sContent); + + return $sContent; + } + + public function getPageCss() + { + return $this->aPageCss; + } + + public function getPageHeader() + { + if(empty($this->aPage) || !is_array($this->aPage)) + return ''; + + return _t(!$this->bPageMultiple ? $this->aPage['caption'] : $this->aPage[$this->sPageSelected]['caption']); + } + + public function getPageBreadcrumb() + { + $bPageHome = $this->aPage['name'] == 'home'; + $bWidgetType = !empty($this->aPage['wid_type']); + + $aMarkers = array('js_object_launcher' => BxTemplStudioLauncher::getInstance()->getPageJsObject()); + if($bWidgetType) + $aMarkers['widget_type'] = $this->aPage['wid_type']; + + $this->addMarkers($aMarkers); + + $aMenuItems = []; + $aMenuItems['home'] = [ + 'name' => 'home', + 'icon' => 'bc-home.svg', + 'link' => BX_DOL_URL_STUDIO, + //'onclick' => bx_replace_markers('return {js_object_launcher}.browser(this)', $this->aMarkers), + 'title' => '' + ]; + + /** + * Hidden for now. + */ + if(false && $bWidgetType) + $aMenuItems['type'] = [ + 'name' => 'type', + 'icon' => $this->getPageTypeIcon(), + 'link' => $this->getPageTypeUrl(), + 'onclick' => bx_replace_markers("return {js_object_launcher}.browser(this, '{widget_type}')", $this->aMarkers), + 'title' => '' + ]; + + if(!$bPageHome) + $aMenuItems['page'] = [ + 'name' => 'page', + 'icon' => '', //$this->aPage['icon'], + 'link' => $this->getPageUrl(), + 'title' => _t($this->aPage['caption']) + ]; + + $oMenu = new BxTemplStudioMenu([ + 'template' => 'page_breadcrumb.html', + 'menu_items' => $aMenuItems + ]); + $sMenu = $oMenu->getCode(); + + return BxDolStudioTemplate::getInstance()->parseHtmlByContent($sMenu, [ + 'bx_if:show_search' => [ + 'condition' => $bPageHome && getParam('sys_std_show_header_left_search') == 'on', + 'content' => [true] + ] + ]); + } + + public function getPageCaption() + { + if(($sAssistant = $this->getPageCaptionAssistant()) != '') { + $sAssistant = BxTemplStudioFunctions::getInstance()->popupBox('bx-std-pcap-menu-popup-assistant', _t('_adm_txt_assistant_popup_title'), $sAssistant, true); + + BxDolStudioTemplate::getInstance()->addInjection('injection_header', 'text', $sAssistant); + } + + return ''; + } + + public function getPageAttributes() + { + return ''; + } + + public function getPageMenu($aMenu = array(), $aMarkers = array()) + { + $oMenu = $this->getPageMenuObject($aMenu, $aMarkers); + return $oMenu->getCode(); + } + + public function getPageCode($sPage = '', $bWrap = true) { + if(empty($this->aPage) || !is_array($this->aPage)) { + $this->setError('_sys_txt_not_found'); + return false; + } + + return ''; + } + + protected function getPageMenuObject($aMenu = array(), $aMarkers = array()) + { + $oMenu = new BxTemplStudioMenu(array('template' => 'menu_side.html', 'menu_items' => $aMenu)); + if(!empty($aMarkers)) + $oMenu->addMarkers($aMarkers); + + return $oMenu; + } + + protected function getPageCaptionHelp() + { + $sContent = BxDolRss::getObjectInstance($this->sPageRssHelpObject)->getHolder($this->sPageRssHelpId, $this->iPageRssHelpLength, 0, false); + + $oTemplate = BxDolStudioTemplate::getInstance(); + $oTemplate->addJsTranslation('_adm_txt_show_help_content_empty'); + return $oTemplate->parseHtmlByName('page_caption_help.html', array( + 'content' => $sContent + )); + } + + protected function getPageCaptionAssistant() + { + if(!$this->_bShowHeaderRightAssistant) + return ''; + + $oAssistant = BxDolAIAssistant::getObjectInstance($this->iPageAssistantId); + if(!$oAssistant) + return ''; + + $oTemplate = BxDolStudioTemplate::getInstance(); + + $sContent = $oAssistant->getAskChat($this->iPageAssistantChatName, '', $oTemplate); + if(!$sContent) + return ''; + + return $oTemplate->parseHtmlByName('page_caption_assistant.html', [ + 'content' => $sContent + ]); + } + + protected function getJsResult($sMessage, $bTranslate = true, $bRedirect = false, $sRedirect = '', $sOnResult = '') + { + return bx_get_js_result(array( + 'message' => $sMessage, + 'translate' => $bTranslate, + 'redirect' => $bRedirect === true && !empty($sRedirect) ? $sRedirect : $bRedirect, + 'eval' => $sOnResult + )); + } + + protected function getJsResultBy($aParams) + { + return bx_get_js_result($aParams); + } +} + +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/scripts/BxBaseStudioPolyglot.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/scripts/BxBaseStudioPolyglot.php new file mode 100644 index 0000000000..4fab17e992 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/scripts/BxBaseStudioPolyglot.php @@ -0,0 +1,285 @@ +aPageCss = array_merge($this->aPageCss, ['forms.css', 'paginate.css', 'polyglot.css']); + $this->aPageJs = array_merge($this->aPageJs, ['polyglot.js']); + $this->sPageJsClass = 'BxDolStudioPolyglot'; + $this->sPageJsObject = 'oBxDolStudioPolyglot'; + + $this->sSubpageUrl = BX_DOL_URL_STUDIO . 'polyglot.php?page='; + + $this->aMenuItems = array( + BX_DOL_STUDIO_PGT_TYPE_SETTINGS => array('icon' => 'cogs'), + BX_DOL_STUDIO_PGT_TYPE_KEYS => array('icon' => 'key'), + BX_DOL_STUDIO_PGT_TYPE_ETEMPLATES => array('icon' => 'far envelope'), + /* + * Isn't used for now. + * + BX_DOL_STUDIO_PGT_TYPE_ETEMPLATES_HF => array('icon' => 'far sticky-note'), + * + */ + BX_DOL_STUDIO_PGT_TYPE_ETEMPLATES_CREATIVE => array('icon' => 'far object-group') + ); + + $this->aGridObjects = array( + 'keys' => 'sys_studio_lang_keys', + 'etemplates' => 'sys_studio_lang_etemplates', + ); + + $this->aHtmlIds = [ + 'etc_builder_id' => 'adm-pgt-etc-builder', + ]; + } + + public function getPageJsCode($aOptions = array(), $bWrap = true) + { + $aOptions = array_merge($aOptions, array( + 'sActionUrl' => BX_DOL_URL_STUDIO . 'polyglot.php' + )); + + return parent::getPageJsCode($aOptions, $bWrap); + } + + public function getPageMenu($aMenu = array(), $aMarkers = array()) + { + $sJsObject = $this->getPageJsObject(); + + $aMenu = array(); + foreach($this->aMenuItems as $sMenuItem => $aItem) + $aMenu[] = array( + 'name' => $sMenuItem, + 'icon' => $aItem['icon'], + 'link' => $this->sSubpageUrl . $sMenuItem, + 'title' => _t('_adm_lmi_cpt_' . $sMenuItem), + 'selected' => $sMenuItem == $this->sPage + ); + + return parent::getPageMenu($aMenu); + } + + protected function getSettings() + { + $oOptions = new BxTemplStudioOptions(BX_DOL_STUDIO_STG_TYPE_DEFAULT, BX_DOL_STUDIO_STG_CATEGORY_LANGUAGES); + + $this->aPageCss = array_merge($this->aPageCss, $oOptions->getCss()); + $this->aPageJs = array_merge($this->aPageJs, $oOptions->getJs()); + return BxDolStudioTemplate::getInstance()->parseHtmlByName('polyglot.html', array( + 'content' => $oOptions->getCode(), + 'js_content' => '' + )); + } + + protected function getKeys() + { + return $this->getGrid($this->aGridObjects['keys']); + } + + protected function getEtemplates() + { + return $this->getGrid($this->aGridObjects['etemplates']); + } + + protected function getEtemplatesHf() + { + $oTemplate = BxDolStudioTemplate::getInstance(); + + $sFormId = 'adm-dsg-et-hf-form'; + $sIFrameId = 'adm-dsg-et-hf-iframe'; + + $aForm = array( + 'form_attrs' => array( + 'id' => $sFormId, + 'name' => $sFormId, + 'action' => BX_DOL_URL_STUDIO . 'polyglot.php', + 'method' => 'post', + 'enctype' => 'multipart/form-data', + 'target' => $sIFrameId + ), + 'params' => array( + 'db' => array( + 'table' => '', + 'key' => '', + 'uri' => '', + 'uri_title' => '', + 'submit_name' => 'save' + ), + ), + 'inputs' => array( + 'page' => array( + 'type' => 'hidden', + 'name' => 'page', + 'value' => $this->sPage + ), + 'et_hf_header' => array( + 'type' => 'textarea', + 'code' => true, + 'name' => 'et_hf_header', + 'caption' => _t('_adm_stg_cpt_option_site_email_html_template_header'), + 'info' => _t('_adm_pgt_txt_et_hf_inf'), + 'value' => getParam('site_email_html_template_header'), + 'db' => array ( + 'pass' => 'Xss', + ), + ), + 'et_hf_footer' => array( + 'type' => 'textarea', + 'code' => true, + 'name' => 'et_hf_footer', + 'caption' => _t('_adm_stg_cpt_option_site_email_html_template_footer'), + 'info' => _t('_adm_pgt_txt_et_hf_inf'), + 'value' => getParam('site_email_html_template_footer'), + 'db' => array ( + 'pass' => 'Xss', + ), + ), + 'save' => array( + 'type' => 'submit', + 'name' => 'save', + 'value' => _t('_adm_pgt_btn_et_hf_submit'), + ) + ) + ); + + $oForm = new BxTemplStudioFormView($aForm, $oTemplate); + $oForm->initChecker(); + + if($oForm->isSubmittedAndValid()) { + echo $this->submitEtemplatesHf($oForm); + exit; + } + + $oTemplate->addJs(array('codemirror/codemirror.min.js')); + $oTemplate->addCss(BX_DIRECTORY_PATH_PLUGINS_PUBLIC . 'codemirror/|codemirror.css'); + + return $oTemplate->parseHtmlByName('polyglot.html', array( + 'content' => $oTemplate->parseHtmlByName('pgt_etemplates_hf.html', array( + 'warning' => '', + 'iframe_id' => $sIFrameId, + 'form' => $oForm->getCode() + )), + 'js_content' => $this->getPageJsCode(array( + 'sCodeMirror' => 'textarea[name=et_hf_header],textarea[name=et_hf_footer]' + )) + )); + } + + protected function getEtemplatesCreative() + { + $oTemplate = BxDolStudioTemplate::getInstance(); + + $sFormId = 'adm-dsg-et-creative-form'; + $sIFrameId = 'adm-dsg-et-creative-iframe'; + + $sContent = ''; + $sContent .= getParam('site_email_html_template_header'); + $sContent .= $this->sEtcContent; + $sContent .= getParam('site_email_html_template_footer'); + + $aForm = [ + 'form_attrs' => [ + 'id' => $sFormId, + 'name' => $sFormId, + 'action' => BX_DOL_URL_STUDIO . 'polyglot.php', + 'method' => 'post', + 'enctype' => 'multipart/form-data', + 'target' => $sIFrameId + ], + 'params' => [ + 'db' => [ + 'table' => '', + 'key' => '', + 'uri' => '', + 'uri_title' => '', + 'submit_name' => 'save' + ], + ], + 'inputs' => [ + 'page' => [ + 'type' => 'hidden', + 'name' => 'page', + 'value' => $this->sPage + ], + 'content' => [ + 'type' => 'custom', + 'name' => 'content', + 'caption' => '', + 'content' => $oTemplate->parseHtmlByName('pgt_etemplates_creative_fld.html', [ + 'html_id' => $this->aHtmlIds['etc_builder_id'], + 'content_html' => $sContent, + 'content_data' => json_encode([ + 'pages' => [ + ['component' => $sContent] + ] + ]) + ]), + 'required' => '0', + 'db' => [ + 'pass' => 'XssHtml', + ], + ], + 'save' => [ + 'type' => 'submit', + 'name' => 'save', + 'value' => _t('_adm_pgt_btn_et_hf_submit'), + ] + ] + ]; + + $oForm = new BxTemplStudioFormView($aForm, $oTemplate); + $oForm->initChecker(); + + if($oForm->isSubmittedAndValid()) { + echo $this->submitEtemplatesCreative($oForm); + exit; + } + + $oTemplate->addJs([ + 'grapesjs/grapes.min.js', + 'grapesjs/grapesjs-preset-newsletter.min.js' + ]); + $oTemplate->addCss([ + BX_DIRECTORY_PATH_PLUGINS_PUBLIC . 'grapesjs/|grapes.min.css' + ]); + + return $oTemplate->parseHtmlByName('polyglot.html', [ + 'content' => $oTemplate->parseHtmlByName('pgt_etemplates_creative_frm.html', [ + 'warning' => '', + 'iframe_id' => $sIFrameId, + 'form' => $oForm->getCode() + ]), + 'js_content' => $this->getPageJsCode() + ]); + } + + protected function getGrid($sObjectName) + { + $oGrid = BxDolGrid::getObjectInstance($sObjectName); + if(!$oGrid) + return ''; + + return BxDolStudioTemplate::getInstance()->parseHtmlByName('polyglot.html', array( + 'content' => $oGrid->getCode(), + 'js_content' => '' + )); + } +} + +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/scripts/BxBaseStudioStore.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/scripts/BxBaseStudioStore.php new file mode 100644 index 0000000000..5591a04cbc --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/scripts/BxBaseStudioStore.php @@ -0,0 +1,1108 @@ +addJsTranslation(array('_adm_btn_queued_submit')); + return array_merge(parent::getPageJs(), array('fancybox/jquery.fancybox.pack.js', 'store.js')); + } + + function getPageJsObject() + { + return 'oBxDolStudioStore'; + } + + function getPageMenu($aMenu = array(), $aMarkers = array()) + { + $sJsObject = $this->getPageJsObject(); + $oTemplate = BxDolStudioTemplate::getInstance(); + + $aMenu = []; + $aMenuItems = [ + 'goodies' => ['icon' => 'mi-str-home.svg', 'icon_bg' => true], + 'latest' => ['icon' => 'mi-str-latest.svg', 'icon_bg' => true], + 'featured' => ['icon' => 'mi-str-featured.svg', 'icon_bg' => true], + 'popular' => ['icon' => 'mi-str-popular.svg', 'icon_bg' => true], + 'categories' => ['icon' => 'mi-str-categories.svg', 'icon_bg' => true], + 'search' => ['icon' => 'mi-str-search.svg', 'icon_bg' => true], + 'purchases' => ['icon' => 'mi-str-purchases.svg', 'icon_bg' => true], + 'updates' => ['icon' => 'mi-str-updates.svg', 'icon_bg' => true], + 'checkout' => ['icon' => 'mi-str-checkout.svg', 'icon_bg' => true], + 'downloaded' => ['icon' => 'mi-str-downloaded.svg', 'icon_bg' => true] + ]; + foreach($aMenuItems as $sMenuItem => $aItem) + $aMenu[] = array_merge($aItem, [ + 'name' => $sMenuItem, + 'link' => $this->getBaseUrl($sMenuItem), + 'title' => _t('_adm_lmi_cpt_' . $sMenuItem), + 'selected' => $sMenuItem == $this->sPage + ]); + + $iCounter = BxDolStudioCart::getInstance()->getCount(); + + $aMarkers = array( + 'checkout_counter' => $oTemplate->parseHtmlByName('menu_side_counter.html', array( + 'bx_if:hide_counter' => array( + 'condition' => $iCounter <= 0, + 'content' => array() + ), + 'counter' => $iCounter + )) + ); + + return parent::getPageMenu($aMenu, $aMarkers); + } + + function getPageCode($sPage = '', $bWrap = true) + { + $sResult = parent::getPageCode($sPage, $bWrap); + if($sResult === false) + return false; + + $sMethod = 'get' . ucfirst($this->sPage) . 'List'; + if(!method_exists($this, $sMethod)) + return ''; + + return $this->$sMethod() . $sResult; + } + + function getPageContent() + { + $sMethod = 'get' . ucfirst($this->sPage) . 'List'; + if(!method_exists($this, $sMethod)) + return ''; + + return $this->$sMethod(false); + } + + protected function getGoodiesList() + { + $sJsObject = $this->getPageJsObject(); + $oTemplate = BxDolStudioTemplate::getInstance(); + + $mixedResult = $this->authorizeClient(); + if($mixedResult === true) { + $aProducts = $this->loadGoodies(); + + $sContent = ""; + $sContent .= $this->displayNonOwnerNotification(); + + $sContent .= $this->getBlocksLine(array( + array( + 'caption' => '_adm_block_cpt_categories', + 'actions' => array(), + 'items' => $this->getCategoriesList(false) + ), + array( + 'caption' => '_adm_block_cpt_tags', + 'actions' => array(), + 'items' => $this->getTagsList(false) + ) + )); + + foreach($aProducts as $aBlock) { + $aBlock['items'] = $oTemplate->parseHtmlByName('str_products.html', array( + 'list' => $this->displayProducts($aBlock['items']), + 'paginate' => '' + )); + + $sContent .= $this->getBlockCode($aBlock); + } + } + else + $sContent = $this->getBlockCode(array( + 'caption' => '_adm_block_cpt_goodies', + 'items' => $mixedResult, + )); + + return $oTemplate->parseHtmlByName('store.html', array( + 'js_object' => $sJsObject, + 'content' => $sContent + )); + } + + protected function getLatestList($bWrapInBlock = true) + { + return $this->getBrowsingList('latest', $bWrapInBlock); + } + + protected function getFeaturedList($bWrapInBlock = true) + { + return $this->getBrowsingList('featured', $bWrapInBlock); + } + + protected function getPopularList($bWrapInBlock = true) + { + return $this->getBrowsingList('popular', $bWrapInBlock); + } + + protected function getBrowsingList($sType, $bWrapInBlock = true) + { + $sJsObject = $this->getPageJsObject(); + $oTemplate = BxDolStudioTemplate::getInstance(); + + $mixedResult = $this->authorizeClient(); + if($mixedResult === true) { + $iStart = (int)bx_get('str_start'); + $iPerPage = (int)bx_get('str_per_page'); + if(empty($iPerPage)) + $iPerPage = $this->iPerPageDefault; + + $aProducts = $this->{'load' . bx_gen_method_name($sType)}($iStart, $iPerPage + 1); + + $oPaginate = new BxTemplPaginate(array( + 'start' => $iStart, + 'per_page' => $iPerPage, + 'on_change_page' => $sJsObject . ".changePagePaginate(this, '" . $sType . "', null, {start}, {per_page})" + )); + $oPaginate->setNumFromDataArray($aProducts); + + $sContent = $oTemplate->parseHtmlByName('str_products.html', array( + 'list' => $this->displayProducts($aProducts), + 'paginate' => $oPaginate->getSimplePaginate() + )); + } + else + $sContent = $mixedResult; + + if(!$bWrapInBlock) + return $sContent; + + return $oTemplate->parseHtmlByName('store.html', array( + 'js_object' => $sJsObject, + 'content' => $this->getBlockCode(array( + 'caption' => '_adm_block_cpt_' . $sType, + 'items' => $sContent + )) + )); + } + + protected function getCategoriesList($bWrapInBlock = true) + { + return $this->getLabelsList('categories', $bWrapInBlock); + } + + protected function getCategoryList($bWrapInBlock = true) + { + $sKey = 'value'; + if(bx_get($sKey) === false) + $sKey = 'str_value'; + + $aValue = array(); + $aValue['value'] = (int)bx_get($sKey); + if(bx_get('title') !== false) + $aValue['title'] = bx_process_input(urldecode(bx_get('title'))); + + return $this->getLabelList('category', $aValue, $bWrapInBlock); + } + + protected function getTagsList($bWrapInBlock = true) + { + return $this->getLabelsList('tags', $bWrapInBlock); + } + + protected function getTagList($bWrapInBlock = true) + { + $sKey = 'value'; + if(bx_get($sKey) === false) + $sKey = 'str_value'; + + return $this->getLabelList('tag', bx_process_input(bx_get($sKey)), $bWrapInBlock); + } + + protected function getLabelsList($sType, $bWrapInBlock = true) + { + $mixedResult = $this->authorizeClient(); + if($mixedResult === true) { + $aLabels = $this->{'load' . bx_gen_method_name($sType)}(); + $sContent = $this->{'display' . bx_gen_method_name($sType)}($aLabels); + } + else + $sContent = $mixedResult; + + if(!$bWrapInBlock) + return $sContent; + + return BxDolStudioTemplate::getInstance()->parseHtmlByName('store.html', array( + 'js_object' => $this->getPageJsObject(), + 'content' => $this->getBlockCode(array( + 'caption' => '_adm_block_cpt_' . $sType, + 'items' => $sContent + )) + )); + } + + protected function getLabelList($sType, $mixedValue, $bWrapInBlock = true) + { + $sJsObject = $this->getPageJsObject(); + $oTemplate = BxDolStudioTemplate::getInstance(); + + $iStart = (int)bx_get('str_start'); + $iPerPage = (int)bx_get('str_per_page'); + if(empty($iPerPage)) + $iPerPage = $this->iPerPageDefault; + + $bArray = is_array($mixedValue); + $sValue = $bArray ? $mixedValue['value'] : $mixedValue; + $sTitle = $bArray && !empty($mixedValue['title']) ? $mixedValue['title'] : $sValue; + + $sMethod = 'load' . bx_gen_method_name($sType); + $aProducts = $this->$sMethod($sValue, $iStart, $iPerPage + 1); + + $oPaginate = new BxTemplPaginate(array( + 'start' => $iStart, + 'per_page' => $iPerPage, + 'on_change_page' => $sJsObject . ".changePagePaginate(this, '" . $sType . "', '" . $sValue . "', {start}, {per_page})" + )); + $oPaginate->setNumFromDataArray($aProducts); + + $sContent = $oTemplate->parseHtmlByName('str_products.html', array( + 'list' => $this->displayProducts($aProducts), + 'paginate' => $oPaginate->getSimplePaginate() + )); + + if(!$bWrapInBlock) + return $sContent; + + return $oTemplate->parseHtmlByName('store.html', array( + 'js_object' => $sJsObject, + 'content' => $this->getBlockCode(array( + 'caption' => array('_adm_block_cpt_' . $sType, $sTitle), + 'items' => $sContent, + )) + )); + } + + protected function getSearchList($bWrapInBlock = true) + { + $sJsObject = $this->getPageJsObject(); + $oTemplate = BxDolStudioTemplate::getInstance(); + + $mixedResult = $this->authorizeClient(); + if($mixedResult === true) { + //--- Search form + $aForm = array( + 'form_attrs' => array( + 'id' => 'adm-str-search-form', + 'name' => 'adm-str-search-form', + 'action' => '', + 'method' => 'post' + ), + 'params' => array( + 'db' => array( + 'table' => '', + 'key' => '', + 'uri' => '', + 'uri_title' => '', + 'submit_name' => 'search' + ), + ), + 'inputs' => array( + 'page' => array( + 'type' => 'hidden', + 'name' => 'page', + 'value' => $this->sPage + ), + 'keyword' => array( + 'type' => 'text', + 'name' => 'keyword', + 'caption' => '', + 'value' => '', + 'attrs' => array( + 'placeholder' => bx_html_attribute(_t('_sys_search_placeholder')) + ), + 'db' => array ( + 'pass' => 'Xss', + ) + ), + 'search' => array( + 'type' => 'submit', + 'name' => 'search', + 'value' => _t('_adm_btn_store_search'), + ) + ) + ); + + $oForm = new BxTemplStudioFormView($aForm); + $oForm->initChecker(); + + $sResults = ''; + if($oForm->isSubmittedAndValid()) { + $sKeyword = $oForm->getCleanValue('keyword'); + + $iStart = (int)bx_get('str_start'); + $iPerPage = (int)bx_get('str_per_page'); + if(empty($iPerPage)) + $iPerPage = 999; + + $aProducts = $this->loadSearch($sKeyword, $iStart, $iPerPage + 1); + $sResults = empty($aProducts) || !is_array($aProducts) ? MsgBox(_t('_Empty')) : $oTemplate->parseHtmlByName('str_products.html', array( + 'list' => $this->displayProducts($aProducts), + 'paginate' => '' + )); + } + + $sContent = $oTemplate->parseHtmlByName('str_search.html', array( + 'form' => $oForm->getCode(), + 'bx_if:show_results' => array( + 'condition' => !empty($sResults), + 'content' => array( + 'results' => $sResults + ) + ) + )); + } + else + $sContent = $mixedResult; + + if(!$bWrapInBlock) + return $sContent; + + return $oTemplate->parseHtmlByName('store.html', array( + 'js_object' => $sJsObject, + 'content' => $this->getBlockCode(array( + 'caption' => '_adm_block_cpt_search', + 'items' => $sContent + )) + )); + } + + protected function getPurchasesList() + { + $oTemplate = BxDolStudioTemplate::getInstance(); + + $aProducts = $this->loadPurchases(); + return $oTemplate->parseHtmlByName('store.html', array( + 'js_object' => $this->getPageJsObject(), + 'content' => $this->getBlockCode(array( + 'caption' => '_adm_block_cpt_purchases', + 'items' => $oTemplate->parseHtmlByName('str_products.html', array( + 'list' => $this->displayProducts($aProducts), + 'paginate' => '' + )) + )) + )); + } + + protected function getUpdatesList() + { + $oTemplate = BxDolStudioTemplate::getInstance(); + + $aUpdates = $this->loadUpdates(); + return $oTemplate->parseHtmlByName('store.html', array( + 'js_object' => $this->getPageJsObject(), + 'content' => $this->getBlockCode(array( + 'caption' => '_adm_block_cpt_updates', + 'items' => $oTemplate->parseHtmlByName('str_products.html', array( + 'list' => $this->displayUpdates($aUpdates), + 'paginate' => '' + )) + )) + )); + } + + protected function getCheckoutList() + { + $sJsObject = $this->getPageJsObject(); + $oTemplate = BxDolStudioTemplate::getInstance(); + + //--- Empty cart by vendor if the payment was accepted. + $mixedVendor = bx_get('vendor'); + $mixedProducts = bx_get('products'); + if($mixedVendor !== false && $mixedProducts !== false) { + $oCart = BxDolStudioCart::getInstance(); + + $aProducts = explode(',', base64_decode($mixedProducts)); + foreach($aProducts as $iId) + $oCart->delete($mixedVendor, $iId); + + return $this->getMessage('_adm_block_cpt_checkout', '_adm_msg_modules_success_checkouted'); + } + + $aVendors = $this->loadCheckout(); + if(empty($aVendors)) + return $this->getMessage('_adm_block_cpt_checkout', '_Empty'); + + $sContent = ''; + foreach($aVendors as $iVendor => $aInfo) { + $fTotal = 0; + $sVendor = $sCurrency = ''; + if(!empty($aInfo['products']) && is_array($aInfo['products'])) + foreach($aInfo['products'] as $aProduct) { + $iCount = isset($aInfo['counts'][$aProduct['id']]) ? (int)$aInfo['counts'][$aProduct['id']] : 1; + $fTotal += $iCount * $aProduct['price_single']; + + if($sVendor == '' && isset($aProduct['author_name'])) + $sVendor = $aProduct['author_name']; + + if($sCurrency == '' && isset($aProduct['author_currency_sign'])) + $sCurrency = $aProduct['author_currency_sign']; + } + + $aMenu = array( + array('id' => 'checkout-' . $iVendor, 'name' => 'checkout-' . $iVendor, 'link' => 'javascript:void(0)', 'onclick' => $sJsObject . ".checkoutCart(" . $iVendor . ", this);", 'target' => '_self', 'title' => '_adm_action_cpt_checkout', 'active' => 1), + array('id' => 'delete-all-' . $iVendor, 'name' => 'delete-all-' . $iVendor, 'link' => 'javascript:void(0)', 'onclick' => $sJsObject . ".deleteAllFromCart(" . $iVendor . ", this)", 'target' => '_self', 'title' => '_adm_action_cpt_delete_all', 'active' => 1) + ); + $oMenu = new BxTemplMenu(array('object'=> 'adm-std-checkout', 'template' => 'menu_buttons_hor.html', 'menu_items' => $aMenu)); + + $sContent .= $this->getBlockCode(array( + 'caption' => _t('_adm_block_cpt_checkout_by_vendor_csign', $sVendor, $sCurrency, $fTotal), + 'items' => $oTemplate->parseHtmlByName('str_products.html', array( + 'list' => $this->displayProducts($aInfo['products'], array('is_shopping_cart' => true, 'counts' => $aInfo['counts'])), + 'paginate' => '' + )), + 'panel_bottom' => $oMenu->getCode() + )); + } + + return $oTemplate->parseHtmlByName('store.html', array( + 'js_object' => $sJsObject, + 'content' => $sContent + )); + } + + protected function getDownloadedList() + { + $sJsObject = $this->getPageJsObject(); + $oTemplate = BxDolStudioTemplate::getInstance(); + + $sContent = $sModules = $sUpdates = ""; + $aProducts = $this->loadDownloaded(); + + //--- Prepare modules. + $bCacheImage = getParam('sys_template_cache_image_enable') == 'on'; + foreach($aProducts['modules'] as $aModule) { + $sIcon = BxDolStudioUtils::getModuleIcon($aModule, 'store'); + $bIcon = ($bCacheImage && substr($sIcon, 0, 10) == 'data:image') || strpos($sIcon, '.') !== false; + + $bInstalled = $aModule['installed']; + $bQueued = !$bInstalled && $this->oDb->isQueued('action', $aModule['dir']); + + $sModules .= $oTemplate->parseHtmlByName('str_product_v1.html', array( + 'js_object' => $sJsObject, + 'name' => $aModule['name'], + 'bx_if:no_icon' => array ( + 'condition' => !$bIcon, + 'content' => array( + 'icon' => $sIcon + ), + ), + 'bx_if:icon' => array ( + 'condition' => $bIcon, + 'content' => array( + 'icon_url' => $sIcon, + ), + ), + 'title' => $aModule['title'], + 'vendor' => strtolower($aModule['vendor']) == 'boonex' ? 'UNA INC' : $aModule['vendor'], + 'version' => $aModule['version'], + 'dir' => $aModule['dir'], + 'bx_if:hide_install' => array( + 'condition' => $bInstalled || $bQueued, + 'content' => array() + ), + 'bx_if:hide_queued' => array( + 'condition' => !$bQueued, + 'content' => array() + ), + 'bx_if:hide_installed' => array( + 'condition' => !$bInstalled || $bQueued, + 'content' => array() + ) + )); + } + + //--- Prepare updates. + foreach($aProducts['updates'] as $aUpdate) { + $sIcon = BxDolStudioUtils::getModuleIcon(array('type' => $aUpdate['module_type'], 'name' => $aUpdate['module_name'], 'dir' => $aUpdate['module_dir']), 'store'); + $bIcon = ($bCacheImage && substr($sIcon, 0, 10) == 'data:image') || strpos($sIcon, '.') !== false; + + $sUpdates .= $oTemplate->parseHtmlByName('str_update_v1.html', array( + 'js_object' => $sJsObject, + 'name' => $aUpdate['module_name'], + 'bx_if:no_icon' => array ( + 'condition' => !$bIcon, + 'content' => array( + 'icon' => $sIcon + ), + ), + 'bx_if:icon' => array ( + 'condition' => $bIcon, + 'content' => array( + 'icon_url' => $sIcon, + ), + ), + 'title' => $aUpdate['title'], + 'vendor' => strtolower($aUpdate['vendor']) == 'boonex' ? 'UNA INC' : $aUpdate['vendor'], + 'versions' => _t('_adm_str_txt_update_from_to', $aUpdate['version_from'], $aUpdate['version_to']), + 'dir' => $aUpdate['dir'] + )); + } + + if(!empty($sModules)) + $sContent .= $this->getBlockCode(array( + 'type' => BX_DB_DEF, + 'caption' => '_adm_block_cpt_downloaded_modules', + 'items' => $oTemplate->parseHtmlByName('str_products.html', array( + 'list' => $sModules, + 'paginate' => '' + )), + )); + + if(!empty($sUpdates)) + $sContent .= $this->getBlockCode(array( + 'type' => BX_DB_DEF, + 'caption' => '_adm_block_cpt_downloaded_updates', + 'items' => $oTemplate->parseHtmlByName('str_products.html', array( + 'list' => $sUpdates, + 'paginate' => '' + )), + )); + + return $oTemplate->parseHtmlByName('store.html', array( + 'js_object' => $sJsObject, + 'content' => $sContent + )); + } + + protected function getMessage($sCaption, $sContent, $aActions = array()) + { + return BxDolStudioTemplate::getInstance()->parseHtmlByName('store.html', array( + 'js_object' => $this->getPageJsObject(), + 'content' => $this->getBlockCode(array( + 'caption' => $sCaption, + 'actions' => $aActions, + 'items' => MsgBox(_t($sContent)) + )) + )); + } + + protected function getProduct($sModuleName) + { + $bShowRating = true; + $sJsObject = $this->getPageJsObject(); + $oTemplate = BxDolStudioTemplate::getInstance(); + + $aProduct = $this->loadProduct($sModuleName); + if(empty($aProduct) || !is_array($aProduct)) + return array('code' => BX_DOL_STUDIO_IU_RC_FAILED, 'message' => (!empty($aProduct) ? $aProduct : _t('_adm_str_err_no_product_info'))); + + $aDownloaded = $this->getDownloadedModules(false); + + $bFree = (int)$aProduct['is_free'] == 1; + $bPurchased = (int)$aProduct['is_purchased'] == 1; + + $bPurchaseSingle = !$bFree && !$bPurchased && (float)$aProduct['price_single'] != 0; + $bInCart = $bPurchaseSingle && BxDolStudioCart::getInstance()->exists($aProduct['author_id'], $aProduct['id']); + + $bPurchaseRecurring = !$bFree && !$bPurchased && (float)$aProduct['price_recurring'] != 0; + + $bDownloadable = (int)$aProduct['is_file'] == 1; + $bDownloaded = array_key_exists($sModuleName, $aDownloaded); + $bDownload = ($bFree || $bPurchased) && $bDownloadable; + + $bDiscount = !empty($aProduct['discount_single']); + $sVersion = $bDownloaded && version_compare(strtolower($aDownloaded[$sModuleName]['version']), strtolower($aProduct['version'])) != 0 ? _t('_adm_str_txt_pv_version_mask', $aDownloaded[$sModuleName]['version'], $aProduct['version']) : $aProduct['version']; + + $iScreenshots = 0; + $aScreenshots = array(); + $bScreenshots = is_array($aProduct['screenshots']) && !empty($aProduct['screenshots']); + if($bScreenshots) { + $iScreenshots = count($aProduct['screenshots']); + foreach($aProduct['screenshots'] as $aScreenshot) + $aScreenshots[] = array( + 'view_url' => $aProduct['url'], + 'image_url' => $aScreenshot['big'] + ); + } + + $bTmplVarsRate = $bShowRating; + if($bTmplVarsRate) + $aTmplVarsRate = array( + 'rate' => $this->getVoteStars($aProduct) + ); + + $aTmplVarsVotes = array(); + $bTmplVarsVotes = $bShowRating && (int)$aProduct['votes_cnt'] > 0; + if($bTmplVarsVotes) + $aTmplVarsVotes = array( + 'count' => (int)$aProduct['votes_cnt'] + ); + + $sContent = $oTemplate->parseHtmlByname('str_product_view.html', array( + 'id' => $aProduct['id'], + 'title' => $aProduct['title'], + 'url' => $aProduct['url'], + 'author_name' => $aProduct['author_name'], + 'author_url' => $aProduct['author_url'], + 'version' => $sVersion, + 'bx_if:show_price_single' => array( + 'condition' => $bFree || (float)$aProduct['price_single'] != 0, + 'content' => array( + 'price_single' => !$bFree ? _t('_adm_str_txt_price_single', $aProduct['author_currency_sign'], $aProduct['price_single']) : _t('_adm_str_txt_price_free'), + 'bx_if:show_discount' => array( + 'condition' => !$bFree && $bDiscount, + 'content' => array( + 'discount_single' => $bDiscount ? _t('_adm_str_txt_pv_discount_off_csign', $aProduct['discount_single']['percent'], $aProduct['author_currency_sign'], $aProduct['discount_single']['save']) : '' + ) + ) + ) + ), + 'bx_if:show_price_recurring' => array( + 'condition' => (float)$aProduct['price_recurring'] != 0, + 'content' => array( + 'price_recurring' => _t('_adm_str_txt_price_recurring', $aProduct['author_currency_sign'], $aProduct['price_recurring'], _t('_adm_str_txt_per_' . $aProduct['duration_recurring'])) + ) + ), + 'bx_if:show_rate' => array( + 'condition' => $bTmplVarsRate, + 'content' => $aTmplVarsRate + ), + 'bx_if:show_votes' => array( + 'condition' => $bTmplVarsVotes, + 'content' => $aTmplVarsVotes + ), + 'category' => $aProduct['category'], + 'category_url' => $aProduct['category_url'], + 'tags' => implode(', ', explode(',', $aProduct['tags'])), + 'reviews' => _t('_adm_str_txt_pv_stats_reviews', $aProduct['reviews_cnt']), + 'reviews_url' => $aProduct['reviews_url'], + 'votes' => _t('_adm_str_txt_pv_stats_votes', $aProduct['votes_cnt']), + 'views' => _t('_adm_str_txt_pv_stats_views', $aProduct['views_cnt']), + 'created' => bx_time_js($aProduct['created']), + 'updated' => bx_time_js($aProduct['updated']), + 'description' => $aProduct['description'], + 'bx_if:show_screenshots' => array( + 'condition' => $bScreenshots, + 'content' => array( + 'width' => 222 * $iScreenshots - 20, + 'bx_repeat:screenshots' => $aScreenshots + ) + ), + 'bx_if:show_purchase' => array( + 'condition' => $bPurchaseSingle || $bPurchaseRecurring, + 'content' => array( + 'bx_if:show_purchase_single' => array( + 'condition' => $bPurchaseSingle && !$bInCart, + 'content' => array( + 'js_object' => $sJsObject, + 'id' => $aProduct['id'], + 'vendor_id' => $aProduct['author_id'], + 'price_single' => _t('_adm_str_txt_price_single', $aProduct['author_currency_sign'], $aProduct['price_single']) + ) + ), + 'bx_if:show_checkout_single' => array( + 'condition' => $bPurchaseSingle, + 'content' => array( + 'js_object' => $sJsObject, + 'id' => $aProduct['id'], + 'vendor_id' => $aProduct['author_id'], + 'bx_if:show_as_hidden' => array( + 'condition' => !$bInCart, + 'content' => array() + ) + ) + ), + 'bx_if:show_purchase_recurring' => array( + 'condition' => $bPurchaseRecurring, + 'content' => array( + 'js_object' => $sJsObject, + 'id' => $aProduct['id'], + 'vendor_id' => $aProduct['author_id'], + 'price_recurring' => _t('_adm_str_txt_price_recurring', $aProduct['author_currency_sign'], $aProduct['price_recurring'], _t('_adm_str_txt_per_' . $aProduct['duration_recurring'])) + ) + ) + ) + ), + 'bx_if:show_download' => array( + 'condition' => $bDownload && !$bDownloaded, + 'content' => array( + 'js_object' => $sJsObject, + 'file_id' => $aProduct['file_id'], + ) + ), + 'bx_if:show_download_disabled' => array( + 'condition' => $bDownload && $bDownloaded, + 'content' => array() + ), + )); + + return [ + 'code' => BX_DOL_STUDIO_IU_RC_SUCCESS, + 'message' => '', + 'popup' => BxTemplStudioFunctions::getInstance()->popupBox('bx-std-str-popup-product', $aProduct['title'], $sContent, true), + 'screenshots' => $iScreenshots + ]; + } + + protected function getFile($iFileId) + { + $mixedResult = $this->loadFile($iFileId); + if($mixedResult === true) + return array('code' => BX_DOL_STUDIO_IU_RC_SUCCESS, 'message' => _t('_adm_str_msg_download_successfully')); + + if(is_string($mixedResult)) + return array('code' => BX_DOL_STUDIO_IU_RC_FAILED, 'message' => (!empty($mixedResult) ? $mixedResult : _t('_adm_str_err_download_failed'))); + + if(is_array($mixedResult)) + return array_merge(array('code' => BX_DOL_STUDIO_IU_RC_FAILED, 'message' => _t('_adm_str_err_download_failed')), $mixedResult); + } + + protected function getUpdate($sModuleName, $bApplyUpdate = false) + { + $aResult = array(); + + $mixedResult = $this->loadUpdate($sModuleName, $bApplyUpdate); + if($mixedResult === true) + $aResult = array('code' => BX_DOL_STUDIO_IU_RC_SUCCESS, 'message' => _t('_adm_str_msg_download' . ($bApplyUpdate ? '_and_install' : '') . '_successfully')); + else if(is_string($mixedResult)) + $aResult = array('code' => BX_DOL_STUDIO_IU_RC_FAILED, 'message' => (!empty($mixedResult) ? $mixedResult : _t('_adm_str_err_download_failed'))); + else if(is_array($mixedResult)) + $aResult = array_merge(array('code' => BX_DOL_STUDIO_IU_RC_FAILED, 'message' => _t('_adm_str_err_download_failed')), $mixedResult); + + $aResult['reload'] = 3000; + return $aResult; + } + + protected function displayProducts($mixedItems, $aParams = array()) + { + $bShowRating = false; + + if(!is_array($mixedItems)) + return MsgBox($mixedItems); + + $sJsObject = $this->getPageJsObject(); + $oTemplate = BxDolStudioTemplate::getInstance(); + + $aDownloaded = $this->getDownloadedModules(); + $bShoppingCart = isset($aParams['is_shopping_cart']) && $aParams['is_shopping_cart']; + + $sResult = ''; + foreach($mixedItems as $aItem) { + $bFree = (int)$aItem['is_free'] == 1; + $bPurchased = (int)$aItem['is_purchased'] == 1; + + $bPurchaseSingle = !$bShoppingCart && !$bFree && !$bPurchased && (float)$aItem['price_single'] != 0; + $bInCart = $bPurchaseSingle && BxDolStudioCart::getInstance()->exists($aItem['author_id'], $aItem['id']); + + $bPurchaseRecurring = !$bShoppingCart && !$bFree && !$bPurchased && (float)$aItem['price_recurring'] != 0; + + $bDownloadable = (int)$aItem['is_file'] == 1; + $bDownloaded = in_array($aItem['name'], $aDownloaded); + $bDownload = !$bShoppingCart && ($bFree || $bPurchased) && $bDownloadable; + $bQueued = $this->oDb->isQueued('download', $aItem['name']); + + $sPrice = !$bFree ? _t('_adm_str_txt_price_single', $aItem['author_currency_sign'], $aItem['price_single']) : _t('_adm_str_txt_price_free'); + $sDiscount = !$bFree && !empty($aItem['discount_single']) ? _t('_adm_str_txt_discount_csign', $aItem['author_currency_sign'], $aItem['discount_single']['price']) : ''; + + $sIcon = !empty($aItem['thumbnail']['small']) ? $aItem['thumbnail']['small'] : BxDolStudioUtils::getIconDefault(BX_DOL_MODULE_TYPE_MODULE); + $bIcon = strpos($sIcon, '.') !== false; + + $sImage = ''; + $bImage = $bImageRaw = false; + if(empty($aItem['cover_raw'])) { + if(!empty($aItem['cover']['medium'])) + $sImage = $aItem['cover']['medium']; + else if(!empty($aItem['cover']['large'])) + $sImage = $aItem['cover']['large']; + else if(!empty($aItem['cover']['big'])) + $sImage = $aItem['cover']['big']; + + $bImage = !empty($sImage) && strpos($sImage, '.') !== false; + } + else { + $sImage = $aItem['cover_raw']; + $bImageRaw = true; + } + + $aTmplVarsRate = array(); + $bTmplVarsRate = $bShowRating && !$bShoppingCart; + if($bTmplVarsRate) + $aTmplVarsRate = array( + 'rate' => $this->getVoteStars($aItem) + ); + + $aTmplVarsVotes = array(); + $bTmplVarsVotes = $bShowRating && !$bShoppingCart && (int)$aItem['votes_cnt'] > 0; + if($bTmplVarsVotes) + $aTmplVarsVotes = array( + 'count' => (int)$aItem['votes_cnt'] + ); + + $sResult .= $oTemplate->parseHtmlByName('str_product_v2.html', array( + 'js_object' => $sJsObject, + 'id' => $aItem['id'], + 'name' => $aItem['name'], + 'url' => $aItem['url'], + 'description_plain_attr' => bx_html_attribute($aItem['description_plain']), + 'bx_if:no_icon' => array ( + 'condition' => !$bIcon, + 'content' => array( + 'icon' => $sIcon + ), + ), + 'bx_if:icon' => array ( + 'condition' => $bIcon, + 'content' => array( + 'icon_url' => $sIcon, + ), + ), + 'bx_if:no_image' => array ( + 'condition' => !$bImage && !$bImageRaw, + 'content' => array( + 'description_plain' => $aItem['description_plain'], + 'strecher' => mb_strlen($aItem['description_plain']) > 240 ? '' : str_repeat(' ', round((240 - mb_strlen($aItem['description_plain'])) / 6)) + ), + ), + 'bx_if:image' => array ( + 'condition' => $bImage, + 'content' => array( + 'image_url' => $sImage, + 'strecher' => str_repeat(' ', 40) + ), + ), + 'bx_if:image_raw' => array ( + 'condition' => $bImageRaw, + 'content' => array( + 'image_raw' => $sImage, + ), + ), + 'title' => $aItem['title'], + 'bx_if:show_vendor' => array( + 'condition' => !$bShoppingCart, + 'content' => array( + 'vendor_name' => $aItem['author_name'], + 'vendor_url' => $aItem['author_url'], + 'bx_if:show_version' => array( + 'condition' => !empty($aItem['file_version']), + 'content' => array( + 'version' => $aItem['file_version'], + ) + ), + ) + ), + 'bx_if:show_count_price' => array( + 'condition' => $bShoppingCart, + 'content' => array( + 'count' => isset($aParams['counts'][$aItem['id']]) ? (int)$aParams['counts'][$aItem['id']] : 1, + 'price_single' => $sPrice, + 'discount_single' => $sDiscount, + ) + ), + 'bx_if:show_rate' => array( + 'condition' => $bTmplVarsRate, + 'content' => $aTmplVarsRate + ), + 'bx_if:show_votes' => array( + 'condition' => $bTmplVarsVotes, + 'content' => $aTmplVarsVotes + ), + 'bx_if:show_purchase_single' => array( + 'condition' => $bPurchaseSingle && !$bInCart, + 'content' => array( + 'js_object' => $sJsObject, + 'id' => $aItem['id'], + 'vendor_id' => $aItem['author_id'], + 'price_single' => _t('_adm_str_txt_price_single', $aItem['author_currency_sign'], $aItem['price_single']) + ) + ), + 'bx_if:show_checkout_single' => array( + 'condition' => $bPurchaseSingle, + 'content' => array( + 'js_object' => $sJsObject, + 'id' => $aItem['id'], + 'vendor_id' => $aItem['author_id'], + 'bx_if:show_as_hidden' => array( + 'condition' => !$bInCart, + 'content' => array() + ) + ) + ), + 'bx_if:show_purchase_recurring' => array( + 'condition' => $bPurchaseRecurring, + 'content' => array( + 'js_object' => $sJsObject, + 'id' => $aItem['id'], + 'vendor_id' => $aItem['author_id'], + 'price_recurring' => _t('_adm_str_txt_price_recurring', $aItem['author_currency_sign'], $aItem['price_recurring'], _t('_adm_str_txt_per_' . $aItem['duration_recurring'] . '_short')) + ) + ), + 'bx_if:show_download' => array( + 'condition' => $bDownload && !$bQueued && !$bDownloaded, + 'content' => array( + 'js_object' => $sJsObject, + 'file_id' => $aItem['file_id'] + ) + ), + 'bx_if:show_download_disabled' => array( + 'condition' => $bDownload && !$bQueued && $bDownloaded, + 'content' => array() + ), + 'bx_if:show_queued_disabled' => array( + 'condition' => $bDownload && $bQueued && !$bDownloaded, + 'content' => array() + ), + 'bx_if:show_delete' => array( + 'condition' => $bShoppingCart, + 'content' => array( + 'js_object' => $sJsObject, + 'id' => $aItem['id'], + 'vendor_id' => $aItem['author_id'] + ) + ) + )); + } + + return $sResult; + } + + protected function displayUpdates($mixedItems, $aParams = array()) + { + if(!is_array($mixedItems)) + return MsgBox($mixedItems); + + if(empty($mixedItems)) + return MsgBox(_t('_Empty')); + + $sJsObject = $this->getPageJsObject(); + $oTemplate = BxDolStudioTemplate::getInstance(); + + $sResult = ''; + foreach($mixedItems as $aItem) { + $bDownloadable = (int)$aItem['is_file'] == 1; + $bQueued = $this->oDb->isQueued('download', $aItem['name']); + + $sIcon = !empty($aItem['thumbnail']['big']) ? $aItem['thumbnail']['big'] : BxDolStudioUtils::getIconDefault(BX_DOL_MODULE_TYPE_MODULE); + $bIcon = strpos($sIcon, '.') !== false; + + $sImage = !empty($aItem['cover']['big']) ? $aItem['cover']['big'] : ''; + $bImage = strpos($sImage, '.') !== false; + + $sResult .= $oTemplate->parseHtmlByName('str_update_v2.html', array( + 'js_object' => $sJsObject, + 'id' => $aItem['id'], + 'name' => $aItem['name'], + 'url' => $aItem['url'], + 'bx_if:no_icon' => array ( + 'condition' => !$bIcon, + 'content' => array( + 'icon' => $sIcon + ), + ), + 'bx_if:icon' => array ( + 'condition' => $bIcon, + 'content' => array( + 'icon_url' => $sIcon, + ), + ), + 'bx_if:no_image' => array ( + 'condition' => !$bImage, + 'content' => array( + 'note' => $aItem['description_plain'], + 'strecher' => mb_strlen($aItem['description_plain']) > 240 ? '' : str_repeat(' ', round((240 - mb_strlen($aItem['description_plain'])) / 6)) + ), + ), + 'bx_if:image' => array ( + 'condition' => $bImage, + 'content' => array( + 'image_url' => $sImage, + 'strecher' => str_repeat(' ', 40) + ), + ), + 'title' => $aItem['title'], + 'vendor' => $aItem['author_name'], + 'versions' => _t('_adm_str_txt_update_from_to', $aItem['file_version'], $aItem['file_version_to']), + 'bx_if:show_download' => array( + 'condition' => $bDownloadable && !$bQueued, + 'content' => array( + 'caption' => _t('_adm_btn_install_submit'), + 'on_click' => $sJsObject . ".getUpdateAndInstall('" . $aItem['name'] . "', this)" + ) + ), + 'bx_if:show_queued_disabled' => array( + 'condition' => $bDownloadable && $bQueued, + 'content' => array() + ) + )); + } + + return $sResult; + } + + protected function displayCategories($aCategories) + { + foreach($aCategories['bx_repeat:cats'] as $iKey => $aItem) + $aCategories['bx_repeat:cats'][$iKey]['url'] = $this->getBaseUrl(array('page' => 'category', 'value' => $aItem['value'], 'title' => urlencode($aItem['name']))); + + return BxDolStudioTemplate::getInstance()->parseHtmlByName('str_lbl_categories.html', $aCategories); + } + + protected function displayTags($aTags) + { + foreach($aTags['bx_repeat:units'] as $iKey => $aItem) + $aTags['bx_repeat:units'][$iKey]['href'] = $this->getBaseUrl(array('page' => 'tag', 'value' => $aItem['keyword'])); + + return BxDolStudioTemplate::getInstance()->parseHtmlByName('str_lbl_tags.html', $aTags); + } + + protected function displayNonOwnerNotification() + { + if(BxDolStudioOAuth::isAuthorizedOwner()) + return; + + $oSession = BxDolSession::getInstance(); + if($oSession->getValue($this->sSessionKeyNonOwnerNotified) === true) + return; + + $oSession->setValue($this->sSessionKeyNonOwnerNotified, true); + return $this->getJsResultBy(array( + 'message' => '_adm_msg_oauth_non_owner_logged', + 'translate' => array(BX_DOL_MARKET_URL_ROOT), + 'on_page_load' => true + )); + } + + private function getDownloadedModules($bNamesOnly = true) + { + $aModules = BxDolStudioInstallerUtils::getInstance()->getModules(false); + + return $bNamesOnly ? array_keys($aModules) : $aModules; + } + + private function getVoteStars($aItem) + { + $aTmplVarsStars = array(); + for($i = (int)$aItem['rate_min']; $i <= (int)$aItem['rate_max']; $i++) + $aTmplVarsStars[] = array('value' => $i); + + return BxDolStudioTemplate::getInstance()->parseHtmlByName('str_vote_stars.html', array( + 'id' => $aItem['id'], + 'value' => (float)$aItem['rate'], + 'bx_repeat:stars' => $aTmplVarsStars, + 'bx_repeat:slider' => $aTmplVarsStars, + )); + } +} + +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/scripts/BxBaseStudioWidget.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/scripts/BxBaseStudioWidget.php new file mode 100644 index 0000000000..da1d5dc531 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/scripts/BxBaseStudioWidget.php @@ -0,0 +1,331 @@ +aPageCodeNoWrap = array(); + } + + public function getPageCss() + { + return array_merge(parent::getPageCss(), array( + 'launcher.css' + )); + } + + public function getPageJs() + { + return array_merge(parent::getPageJs(), array( + 'launcher.js' + )); + } + + public function getPageCaption() + { + if(empty($this->aPage) || !is_array($this->aPage)) + return ''; + + $sResult = parent::getPageCaption(); + + $this->updateHistory(); + + $oTemplate = BxDolStudioTemplate::getInstance(); + $oFunctions = BxTemplStudioFunctions::getInstance(); + + $bActions = false; + $sActions = $this->getPageCaptionActions(); + if(($bActions = strlen($sActions)) > 0) + $sActions = $oFunctions->transBox('bx-std-pcap-menu-popup-actions', $sActions, true); + + $bHelp = false; + $sHelp = $this->getPageCaptionHelp(); + if(($bHelp = strlen($sHelp)) > 0) + $sHelp = $oFunctions->transBox('bx-std-pcap-menu-popup-help', $sHelp, true); + + $oTemplate->addInjection('injection_header', 'text', $sActions . $sHelp); + + //--- Menu Right ---// + $aItemsRight = []; + + if($bHelp) + $aItemsRight['help'] = [ + 'name' => 'help', + 'icon' => 'tmi-help.svg', + 'onclick' => BX_DOL_STUDIO_PAGE_JS_OBJECT . ".togglePopup('help', this)", + 'title' => '_adm_txt_show_help' + ]; + + if($this->_bShowHeaderRightAssistant) + $aItemsRight['assistant'] = [ + 'name' => 'assistant', + 'icon' => 'tmi-assistant.svg', + 'link' => 'javascript:void(0);', + 'onclick' => BX_DOL_STUDIO_PAGE_JS_OBJECT . ".togglePopup('assistant', this)", + 'title' => '_adm_tmi_cpt_assistant' + ]; + + if($bActions) + $aItemsRight['actions'] = [ + 'name' => 'actions', + 'icon' => 'tmi-actions.svg', + 'onclick' => BX_DOL_STUDIO_PAGE_JS_OBJECT . ".togglePopup('actions', this)", + 'title' => '_adm_txt_show_actions' + ]; + + if($this->_bShowHeaderRightSite) + $aItemsRight['site'] = [ + 'name' => 'site', + 'icon' => 'tmi-site.svg', + 'link' => '{url_root}', + 'title' => '_adm_tmi_cpt_site' + ]; + + $aItemsRight['account'] = [ + 'name' => 'account', + 'icon' => 'tmi-account.svg', + 'link' => 'javascript:void(0);', + 'onclick' => 'bx_menu_popup_inline(\'#bx-std-pcap-menu-popup-account\', this);', + 'title' => '_adm_tmi_cpt_account' + ]; + + $oTopMenu = BxTemplStudioMenuTop::getInstance(); + $oTopMenu->setPageName($this->aPage['name']); + $oTopMenu->setContent(BX_DOL_STUDIO_MT_LEFT, $this->getPageBreadcrumb()); + $oTopMenu->setSelected(BX_DOL_STUDIO_MT_CENTER, $this->aPage['name']); + $oTopMenu->setContent(BX_DOL_STUDIO_MT_RIGHT, array( + 'template' => 'menu_top_toolbar.html', + 'menu_items' => $aItemsRight + )); + + return $sResult; + } + + public function getPageCode($sPage = '', $bWrap = true) + { + $sResult = parent::getPageCode($sPage, $bWrap); + if($sResult === false) + return false; + + if(!empty($this->aPage['wid_type']) && !BxDolStudioRolesUtils::getInstance()->isActionAllowed('use ' . $this->aPage['wid_type'])) { + $this->setError('_Access denied'); + return false; + } + + if(empty($sPage)) + $sPage = $this->sPage; + + $sMethod = 'get' . bx_gen_method_name($sPage); + if(method_exists($this, $sMethod)) { + $mixedContent = $this->$sMethod(); + if(!$bWrap || in_array($sPage, $this->aPageCodeNoWrap)) + $sResult .= $mixedContent; + else if(is_string($mixedContent)) + $sResult .= $this->getBlockCode(array( + 'content' => $mixedContent + )); + else if(is_array($mixedContent)) + foreach($mixedContent as $sBlock) + $sResult .= $this->getBlockCode(array( + 'content' => $sBlock + )); + else if(is_a($mixedContent, 'BxDolPage')) + $sResult .= $mixedContent->getCode(); + } + + return $sResult . BxTemplStudioLauncher::getInstance()->getPageJsCode(array( + 'bInit' => false + )); + } + + + /** + * Block related methods + */ + public function getBlocksLine($aBlocks) + { + $aTmplVarsBlocks = array(); + foreach ($aBlocks as $aBlock) { + $aTmplVarsBlocks[] = array( + 'content' => $this->getBlockCode($aBlock) + ); + } + + return BxDolStudioTemplate::getInstance()->parseHtmlByName('page_blocks_line.html', array( + 'count' => count($aTmplVarsBlocks), + 'bx_repeat:blocks' => $aTmplVarsBlocks + )); + } + public function getBlockCode($aBlock) + { + $aTypeI2S = [ + BX_DB_CONTENT_ONLY => 'cnt', + BX_DB_DEF => 'cnt-ttl-bg bg-white rounded-2xl', + BX_DB_NO_CAPTION => 'cnt-bg bg-white rounded-2xl' + ]; + $iType = isset($aBlock['type'], $aTypeI2S[$aBlock['type']]) ? $aBlock['type'] : BX_DB_NO_CAPTION; + + $sContent = ''; + if(!empty($aBlock['content'])) + $sContent = $aBlock['content']; + else if(!empty($aBlock['items'])) + $sContent = $aBlock['items']; + + return BxDolStudioTemplate::getInstance()->parseHtmlByName('page_block.html', array( + 'type' => $aTypeI2S[$iType], + 'caption' => !in_array($iType, [BX_DB_CONTENT_ONLY, BX_DB_NO_CAPTION]) ? $this->getBlockCaption($aBlock) : '', + 'panel_top' => $this->getBlockPanelTop($aBlock), + 'items' => $sContent, + 'panel_bottom' => $this->getBlockPanelBottom($aBlock) + )); + } + + public function getBlockCaption($aBlock) + { + if(empty($aBlock) || !is_array($aBlock) || (empty($aBlock['caption']) && empty($aBlock['actions']))) + return ''; + + $aTmplActions = array(); + if(!empty($aBlock['actions']) && is_array($aBlock['actions'])) + foreach($aBlock['actions'] as $aAction) { + $sCaption = is_array($aAction['caption']) ? call_user_func_array('_t', $aAction['caption']) : _t($aAction['caption']); + + $bOnClick = !empty($aAction['onclick']); + $aOnClick = $bOnClick ? array('onclick' => $aAction['onclick']) : array(); + + $aTmplActions[] = array( + 'name' => $aAction['name'], + 'url' => $aAction['url'], + 'title' => $sCaption, + 'bx_if:show_onclick' => array( + 'condition' => $bOnClick, + 'content' => $aOnClick + ), + 'caption' => $sCaption + ); + } + + return BxDolStudioTemplate::getInstance()->parseHtmlByName('block_caption.html', array( + 'caption' => is_array($aBlock['caption']) ? call_user_func_array('_t', $aBlock['caption']) : _t($aBlock['caption']), + 'bx_if:show_actions' => array( + 'condition' => !empty($aTmplActions), + 'content' => array( + 'bx_repeat:actions' => $aTmplActions + ) + ), + )); + } + + public function getBlockPanelTop($aBlock) + { + if(empty($aBlock) || !is_array($aBlock) || empty($aBlock['panel_top'])) + return ''; + + return BxDolStudioTemplate::getInstance()->parseHtmlByName('block_panel_top.html', array( + 'content' => $aBlock['panel_top'] + )); + } + + public function getBlockPanelBottom($aBlock) + { + if(empty($aBlock) || !is_array($aBlock) || empty($aBlock['panel_bottom'])) + return ''; + + return BxDolStudioTemplate::getInstance()->parseHtmlByName('block_panel_bottom.html', array( + 'content' => $aBlock['panel_bottom'] + )); + } + + + /** + * Internal methods. + */ + protected function getPageCaptionActions() + { + $sActions = $this->getPageActions(); + if(empty($sActions)) + return ""; + + return BxDolStudioTemplate::getInstance()->parseHtmlByName('page_caption_actions.html', array( + 'content' => $sActions + )); + } + + protected function getPageActions($iWidgetId = 0) + { + if(empty($this->aActions)) + return ""; + + $aMarkers = array( + 'widget_id' => $iWidgetId, + ); + + if(!empty($iWidgetId)) { + $aWidget = BxDolStudioWidgetsQuery::getInstance()->getWidgets(array('type' => 'by_id', 'value' => $iWidgetId)); + if(!empty($aWidget) && is_array($aWidget)) + $aMarkers['widget_type'] = $aWidget['type']; + } + + $aForm = array( + 'form_attrs' => array( + 'id' => 'adm-page-actions', + 'name' => 'adm-page-actions', + 'action' => '', + 'method' => 'post', + ), + 'params' => array(), + 'inputs' => array() + ); + + foreach($this->aActions as $aAction) { + if($aAction['name'] == 'rearrange' && (empty($iWidgetId) || getParam('sys_std_show_launcher_left') != 'on')) + continue; + + $aInput = array( + 'type' => $aAction['type'], + 'name' => $aAction['name'], + 'caption' => _t($aAction['caption']) + ); + + switch($aAction['type']) { + case 'switcher': + $aInput['checked'] = $aAction['checked']; + $aInput['attrs']['onchange'] = bx_replace_markers($aAction['onchange'], $aMarkers); + break; + + case 'select': + $aInput['value'] = bx_replace_markers($aAction['value'], $aMarkers); + $aInput['values'] = $aAction['values']; + $aInput['attrs']['onchange'] = bx_replace_markers($aAction['onchange'], $aMarkers); + break; + } + + $aForm['inputs'][$aInput['name']] = $aInput; + } + + $oForm = new BxTemplStudioFormView($aForm); + return $oForm->getCode(); + } + + protected function getPageMenuObject($aMenu = array(), $aMarkers = array()) + { + $oMenu = parent::getPageMenuObject($aMenu, $aMarkers); + $oMenu->setInlineIcons(false); + + return $oMenu; + } +} + +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/scripts/BxBaseStudioWidgets.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/scripts/BxBaseStudioWidgets.php new file mode 100644 index 0000000000..edf7fcb70f --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/scripts/BxBaseStudioWidgets.php @@ -0,0 +1,158 @@ + $aType) { + if(!$oUtils->isActionAllowed('use ' . $sName, $iAccountId)) + continue; + + $aTypeData = unserialize($aType['Data']); + + $aMenuItems[] = array( + 'name' => $sName, + 'title' => _t($aType['LKey']), + 'link' => bx_append_url_params($this->sPageUrl, array( + 'type' => $sName + )), + 'icon' => !empty($aTypeData['icon']) ? $aTypeData['icon'] : '', + 'selected' => $sName == $this->_sType + ); + } + + return parent::getPageMenu($aMenuItems); + } + + public function getPageCode($sPage = '', $bWrap = true) + { + $sResult = parent::getPageCode($sPage, $bWrap); + if($sResult === false) + return false; + + $aWidgetsParams = array( + 'featured' => $this->isFeatured(), + 'notices' => $this->aWidgetsNotices + ); + + if(!$this->bPageMultiple) + return $this->wrapWidgets($this->aPage['name'], $this->getWidgets($this->aPage['name'], $this->aWidgets, $aWidgetsParams)); + + $sContent = ""; + foreach($this->aWidgets as $sPage => $aWidgets) + $sContent .= $this->wrapWidgets($sPage, $this->getWidgets($sPage, $aWidgets, $aWidgetsParams), $sPage != $this->sPageSelected); + + return $sContent; + } + + public function getPageCaption() + { + if(empty($this->aPage) || !is_array($this->aPage)) + return ''; + + $sResult = parent::getPageCaption(); + + //--- Menu Right ---// + $aItemsRight = array( + 'template' => 'menu_top_toolbar.html', + 'menu_items' => array( + 'tour' => array( + 'name' => 'tour', + 'icon' => 'tmi-help.svg', + 'link' => 'javascript:void(0);', + 'onclick' => 'glTour.start()', + 'title' => '_adm_tmi_cpt_tour' + ), + 'assistant' => array( + 'name' => 'assistant', + 'icon' => 'tmi-assistant.svg', + 'link' => 'javascript:void(0);', + 'onclick' => BX_DOL_STUDIO_PAGE_JS_OBJECT . ".togglePopup('assistant', this)", + 'title' => '_adm_tmi_cpt_assistant' + ), + 'site' => array( + 'name' => 'site', + 'icon' => 'tmi-site.svg', + 'link' => '{url_root}', + 'title' => '_adm_tmi_cpt_site' + ), + 'account' => array( + 'name' => 'account', + 'icon' => 'tmi-account.svg', + 'link' => 'javascript:void(0);', + 'onclick' => 'bx_menu_popup_inline(\'#bx-std-pcap-menu-popup-account\', this);', + 'title' => '_adm_tmi_cpt_account' + ) + ) + ); + + if(!$this->_bShowHeaderRightSite) + unset($aItemsRight['menu_items']['site']); + + if(!$this->_bShowHeaderRightAssistant) + unset($aItemsRight['menu_items']['assistant']); + + if($this->_sType != BX_DOL_STUDIO_WTYPE_DEFAULT || getParam('site_tour_studio') != 'on') + unset($aItemsRight['menu_items']['tour']); + + $oTopMenu = BxTemplStudioMenuTop::getInstance(); + $oTopMenu->setPageName($this->aPage['name']); + $oTopMenu->setContent(BX_DOL_STUDIO_MT_LEFT, $this->getPageBreadcrumb()); + $oTopMenu->setContent(BX_DOL_STUDIO_MT_RIGHT, $aItemsRight); + + return $sResult; + } + + protected function wrapWidgets($sName, $sContent, $bHidden = false) + { + return BxDolStudioTemplate::getInstance()->parseHtmlByName('widgets_page.html', array( + 'page' => $sName, + 'bx_if:page_hidden' => array( + 'condition' => $bHidden, + 'content' => array() + ), + 'content' => $sContent + )); + } + + protected function getWidgets($sPage, $aWidgets, $aParams = array()) + { + $oFunction = BxTemplStudioFunctions::getInstance(); + + $aTmplVars = array(); + foreach($aWidgets as $aWidget) { + $sWidget = $oFunction->getWidget($aWidget, $aParams); + if(empty($sWidget)) + continue; + + $aTmplVars[] = array( + 'widget' => $sWidget, + ); + } + + return BxDolStudioTemplate::getInstance()->parseHtmlByName('widgets.html', array( + 'bx_repeat:widgets' => $aTmplVars + )); + } +} + +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/scripts_templ/BxTemplStudioAgentsAssistants.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/scripts_templ/BxTemplStudioAgentsAssistants.php new file mode 100644 index 0000000000..b4f2b993cc --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/scripts_templ/BxTemplStudioAgentsAssistants.php @@ -0,0 +1,19 @@ + + + + + + + + + + + + __strecher__ + + + + + __image_raw__ + + + + + + + + + + + + + + + + + + + + + + __title__ + + + + __vendor_name__ + + + __count__ __price_single__ __discount_single__ + + • __rate__ + __count__ + + + + + + + + + + + + + + + + + + + + + + + __price_single__ + + + style="display:none;"> + + + + __price_recurring__ + + + + + + \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/_page_toolbar.html b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/_page_toolbar.html new file mode 100644 index 0000000000..2d1469390f --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/_page_toolbar.html @@ -0,0 +1,36 @@ + + + + + + + + + + + + + + + __main_logo__ + + + + + + + + + + + __sys_toolbar_search__ + + + + + + + + + + \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/_page_toolbar_search.html b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/_page_toolbar_search.html new file mode 100644 index 0000000000..2af06f834a --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/_page_toolbar_search.html @@ -0,0 +1,12 @@ + + __sys_site_search__ + + + + + + + + + + diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/agents_comment_content.html b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/agents_comment_content.html new file mode 100644 index 0000000000..65fd2e4abd --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/agents_comment_content.html @@ -0,0 +1,8 @@ + + __text__ + + + + __attached__ + +__counters__ \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/agents_form.html b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/agents_form.html new file mode 100644 index 0000000000..408f575c8a --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/agents_form.html @@ -0,0 +1,24 @@ + + + __form__ + + + \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/agents_popup.html b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/agents_popup.html new file mode 100644 index 0000000000..348ddd2ceb --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/agents_popup.html @@ -0,0 +1,3 @@ + + __content__ + \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/block_join.html b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/block_join.html new file mode 100644 index 0000000000..ef31505ad8 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/block_join.html @@ -0,0 +1,14 @@ + + __content__ + __content__ + + + + + + + + + __agreement__ + + \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/block_login.html b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/block_login.html new file mode 100644 index 0000000000..c73ef46eea --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/block_login.html @@ -0,0 +1,34 @@ + + __custom_html_before__ + __content__ + __content__ + __custom_html_after__ + + + + + + + + + __agreement__ + + + + + \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/category_list_multi.html b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/category_list_multi.html new file mode 100644 index 0000000000..965a0f23a5 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/category_list_multi.html @@ -0,0 +1,5 @@ + + + __name__ (__num__) + + \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/css/_mixins.less b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/css/_mixins.less new file mode 100644 index 0000000000..053408a604 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/css/_mixins.less @@ -0,0 +1,75 @@ +@import '_remixins.less'; + +.radius(@val) { + @rem-val: (unit(@val) / @base-font-size-px); + border-radius:~"@{rem-val}rem"; + background-clip: padding-box; +} + +.border (@width: 1px, @type: solid, @color: #ccc) { + @rem-w: (unit(@width) / @base-font-size-px); + border: ~"@{width} @{type} @{color}"; + border: ~"@{rem-w}rem @{type} @{color}"; +} +.border-top (@width: 1px, @type: solid, @color: #ccc) { + @rem-w: (unit(@width) / @base-font-size-px); + border-top: ~"@{width} @{type} @{color}"; + border-top: ~"@{rem-w}rem @{type} @{color}"; +} +.border-bottom (@width: 1px, @type: solid, @color: #ccc) { + @rem-w: (unit(@width) / @base-font-size-px); + border-bottom: ~"@{width} @{type} @{color}"; + border-bottom: ~"@{rem-w}rem @{type} @{color}"; +} +.border-left (@width: 1px, @type: solid, @color: #ccc) { + @rem-w: (unit(@width) / @base-font-size-px); + border-left: ~"@{width} @{type} @{color}"; + border-left: ~"@{rem-w}rem @{type} @{color}"; +} +.border-right (@width: 1px, @type: solid, @color: #ccc) { + @rem-w: (unit(@width) / @base-font-size-px); + border-right: ~"@{width} @{type} @{color}"; + border-right: ~"@{rem-w}rem @{type} @{color}"; +} + +.drop-shadow (@x: 0px, @y: 1px, @blur: 2px, @spread: 0px, @color: rgba(0, 0, 0, .25)) { + @rem-x: (unit(@x) / @base-font-size-px); + @rem-y: (unit(@y) / @base-font-size-px); + @rem-b: (unit(@blur) / @base-font-size-px); + @rem-s: (unit(@spread) / @base-font-size-px); + -webkit-box-shadow: ~"@{rem-x}rem @{rem-y}rem @{rem-b}rem @{rem-s}rem @{color}"; + -moz-box-shadow: ~"@{rem-x}rem @{rem-y}rem @{rem-b}rem @{rem-s}rem @{color}"; + box-shadow: ~"@{rem-x}rem @{rem-y}rem @{rem-b}rem @{rem-s}rem @{color}"; +} + +.box-sizing (@type: border-box) { + -webkit-box-sizing: @type; + -moz-box-sizing: @type; + -ms-box-sizing: @type; + box-sizing: @type; +} + +.background-color (@color) { + background-color: @color; +} +.column-width (@width) { + @rem-w: (unit(@width) / @base-font-size-px); + -webkit-column-width: ~"@{rem-w}rem"; + -moz-column-width: ~"@{rem-w}rem"; + -ms-column-width: ~"@{rem-w}rem"; + column-width: ~"@{rem-w}rem"; +} +.column-width-raw (@width) { + -webkit-column-width: @width; + -moz-column-width: @width; + -ms-column-width: @width; + column-width: @width; +} + +.blur(@val) { + -webkit-filter: blur(@val); + -moz-filter: blur(@val); + -o-filter: blur(@val); + -ms-filter: blur(@val); + filter: blur(@val); +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/css/common.css b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/css/common.css new file mode 100644 index 0000000000..b546e188a1 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/css/common.css @@ -0,0 +1,963 @@ +* { + -webkit-font-smoothing: antialiased; + -webkit-text-size-adjust: 100%; + -moz-text-size-adjust: 100%; + -ms-text-size-adjust: 100%; + text-size-adjust: 100%; +} + +a { + text-decoration:none; + outline:none; + color:#3e8685; /* 26.13.13: prev val #387877; */ +} + +a:hover { + text-decoration:none; +} + +a > img { + border:none; +} + +html { + height:100%; +} +/*-- Tailwind overwrite --*/ +html.hidden { + display: block !important; +} +body { + min-height: 100%; + min-height: 100vh; + padding: 0; + margin: 0; +} + +blockquote { + /* NOTE: this style was copied to editor.css */ + border-left: 2px solid #ccc; + padding-left: 10px; +} + +.bx-tl-content pre, +.bx-base-text-entity-content pre, +.bx-content-description pre, +.cmt-body pre { + /* NOTE: this style was copied to editor.css */ + padding: 5px; + border: 1px solid green; + background-color: white; + color: #009900; + display: block; + margin: 0; + overflow-x: auto; +} + +.bx-main { + position: relative; + display: -webkit-flex; + display: flex; + -webkit-flex-direction: column; + flex-direction: column; + min-height: 100%; + min-height: 100vh; +} + +/*-- Application mode: Sidebar --*/ +.bx-main.bx-pt-application .bx-main-column .bx-menu-panel .bx-def-thumb-size { + width: 2rem; + height: 2rem; +} +.bx-main.bx-pt-application .bx-main-column.narrow.bx-mc-narrowed .bx-menu-panel .bx-profile-avatar-cnt { + -webkit-justify-content:center; + justify-content:center; +} +.bx-main.bx-pt-application .bx-main-column.narrow.bx-mc-narrowed .bx-mc-cnt { + padding-left: 0; + padding-right: 0; +} + +/*-- Application mode: Toolbar --*/ +.bx-main.bx-pt-application .bx-toolbar-content { + position: relative; + display: -webkit-flex; + display: flex; + -webkit-align-items: center; + align-items: center; +} +.bx-main.bx-pt-application .bx-toolbar-content .bx-toolbar-item.bx-ti-left { + -webkit-flex: 0 0 auto; + -ms-flex: 0 0 auto; + flex: 0 0 auto; +} +.bx-main.bx-pt-application .bx-toolbar-content .bx-toolbar-item.bx-ti-left .bx-menu-item-main-menu { + display: none; +} +.bx-main.bx-pt-application .bx-toolbar-content .bx-toolbar-item.bx-ti-menu { + -webkit-flex: 2 1 auto; + -ms-flex: 2 1 auto; + flex: 2 1 auto; +} +.bx-main.bx-pt-application .bx-toolbar-content .bx-toolbar-item.bx-ti-right { + -webkit-flex: 0 1 0%; + -ms-flex: 0 1 0%; + flex: 0 1 0%; +} + +.bx-clear { + clear:both; + float:none; + display:block; + width: 0px; + height: 0px; + font-size:1px; +} + +.bx-clearfix:before, +.bx-clearfix:after { + content:""; + display:table; +} +.bx-clearfix:after { + clear:both; +} + +.bx-anchor-invisible, +.bx-anchor { + -webkit-background-clip:content-box; + background-clip:content-box; +} +.bx-anchor-invisible { + display:block; + height:0px; + width:0px; + overflow:hidden; +} + +.bx-bullet:before { + content: "\00A0\00b7\00A0"; + + color: #999999; +} +.bx-bullet-narrow:before { + content: "\00b7"; + + color: #999999; +} + +.bx-tag b, +.bx-tag s { + text-decoration: none; + font-weight: normal; +} + +.sys-icon-a { + width:1.5rem; + height:1.5rem; +} + +.sys-icon-emoji{ + font-weight: normal !important; +} + +.sys-icon-image, +.sys-icon-svg{ + display: inline-block; + width: 1.5rem; + height: 1.5rem; + background-size: contain; + background-position: center; + background-repeat: no-repeat; +} + +.bx-search-site { + width:20rem; + margin-left:auto; + margin-right:auto; +} +.bx-search-site .sys-search-results-quick { + padding-top: 0.5rem +} +.bx-search-site .sys-search-results-quick .bx-btn.sys-agents-ask { + display: flex; + float: none; + + width: 100%; + margin-bottom: 0.5rem; +} +.bx-agents-popup .cmts { + max-height: calc(0.5 * 100vh); + overflow-y: auto; +} +.bx-acl-err-msg { + padding: 0 10%; +} + +/* --------------- design boxes */ + +.bx-db-container { + position:relative; +} +.bx-db-header { + display: -webkit-box; + display: -webkit-flex; + display: -ms-flexbox; + display: flex; + + -webkit-box-align: center; + -webkit-align-items: center; + -ms-flex-align: center; + align-items: center; + + -webkit-flex-wrap: nowrap; + -ms-flex-wrap: nowrap; + flex-wrap: nowrap; +} +.bx-db-container.bx-dbc-nopadding > .bx-db-header { + padding-left: 0; + padding-right: 0; +} +.bx-db-container.bx-dbc-nobg > .bx-db-divider { + display: none; +} +.bx-db-title { + -webkit-flex: 1 1 auto; + -ms-flex: 1 1 auto; + flex: 1 1 auto; + + white-space: nowrap; + text-overflow: ellipsis; + overflow: hidden; + + line-height: 1.5; + font-size: 1.0rem; + font-weight: 600; +} + +.bx-db-menu { + -webkit-flex: 1 2 auto; + -ms-flex: 1 2 auto; + flex: 1 2 auto; + + max-width: 75%; +} + +.bx-media-phone .bx-db-menu { + max-width: 65%; +} + +.bx-db-menu-tab { + margin-left: 5px; + padding-top: 1px; + padding-bottom: 1px; + text-align: right; + overflow-x: auto; +} +.bx-db-menu-tab.bx-db-menu-tab-more-auto { + overflow-x: visible; +} + +.bx-db-menu-tab .bx-menu-custom-hor:not(.bx-menu-more-auto) { + width: max-content; +} +.bx-db-menu-tab-active { + text-decoration:underline; +} + +.bx-db-menu-tab-btn a { + text-decoration:none; +} + +.bx-db-menu-tab-btn a.bx-btn { + display: inline-block; + float: none; +} + +.bx-db-menu .sys-icon-a { + vertical-align:middle; +} + +.bx-db-menu-popup { + text-align: left; +} + +.bx-db-content { + position: relative; +} + +.bx-content-padding-block { + padding: 1rem; +} + +.bx-db-content .bx-db-help { + position: absolute; + top: 0; + right: 0; + width: 2.0rem; + height: 2.0rem; + border-radius: 2rem; + background-color: rgba(0, 0, 0, 0.1); + line-height: 2rem; + text-align: center; +} + +.bx-db-help-popup { + max-width: 25rem; + max-height: 25rem; + overflow: auto; +} + +/*--- Design Boxes Menu ---*/ +.bx-db-menu ul li { + border-radius: 0; + + white-space: nowrap; +} +.bx-db-menu ul.bx-menu-hor, +.bx-db-menu ul.bx-menu-custom.bx-menu-custom-hor, +.bx-db-menu ul.bx-menu-custom.bx-menu-custom-hor.bx-menu-more-auto:not(.bx-menu-submenu-more-auto) { + display: -webkit-inline-flex; + display: inline-flex; + -webkit-justify-content: flex-end; + justify-content: flex-end; +} +.bx-db-menu ul.bx-menu-hor > li, +.bx-db-menu ul.bx-menu-custom.bx-menu-custom-hor > li { + display: block; + + -webkit-flex: 0 1 auto; + -ms-flex: 0 1 auto; + flex: 0 1 auto; + + padding: 0 0.5rem; + + border-bottom: 1px solid transparent; +} +.bx-db-menu .bx-menu-custom.bx-menu-custom-hor > li > span { + display: block; + + margin: 0; + padding: 0; +} +.bx-db-menu ul.bx-menu-hor > li a.bx-btn, +.bx-db-menu ul.bx-menu-custom.bx-menu-custom-hor > li a.bx-btn { + display: inline-block; + float: none; +} +.bx-db-menu ul.bx-menu-hor > li a > span, +.bx-db-menu ul.bx-menu-custom.bx-menu-custom-hor > li a > span { + vertical-align: middle; +} +.bx-db-menu ul > li:not(.bx-menu-item-more-auto) a .sys-icon, +.bx-db-menu ul > li:not(.bx-menu-item-more-auto) a .sys-icon-image { + display: none; +} +.bx-db-menu ul.bx-menu-submenu-more-auto { + line-height: normal; +} +.bx-db-menu ul li:not(.bx-menu-item-more-auto) a span, +.bx-db-menu .bx-menu-item-more-popup ul.bx-menu-custom.bx-menu-submenu-more-auto li:not(.bx-menu-item-more-auto) a span, +.bx-db-menu .bx-popup .bx-db-menu-popup ul.bx-menu-custom.bx-menu-custom-ver li a > span, +.bx-db-menu .bx-popup .bx-db-menu-popup ul.bx-menu-ver li a > div > span { + margin: 0; +} +.bx-db-menu ul.bx-menu-hor li.bx-menu-tab-active, +.bx-db-menu ul.bx-menu-custom.bx-menu-custom-hor li.bx-menu-tab-active { + border-bottom: 0; +} +.bx-db-menu ul.bx-menu-custom-ver li.bx-menu-item-more-auto { + display: none; +} + +/* --------------- popup boxes */ + +html.bx-popup-lock, body.bx-popup-lock { + overflow: hidden; +} + +body > .bx-popup-wrapper { + max-height:100%; + overflow-x:hidden; + overflow-y:auto; + /* -webkit-overflow-scrolling:touch; */ +} + +.bx-popup-transitions { + -webkit-transition: opacity 0.2s ease-in-out, -webkit-transform 0.2s ease-in-out; + transition: opacity 0.2s ease-in-out, transform 0.2s ease-in-out; +} + +.bx-popup-inactive { + -webkit-opacity: 0; + opacity: 0; + + -webkit-transform: scale(0.75); + transform: scale(0.75); +} + +.bx-popup-active { + max-height:100%; + overflow-y:auto; + + -webkit-opacity: 1; + opacity: 1; + + -webkit-transform: scale(1); + transform: scale(1); + + -webkit-transition: opacity 0.2s ease-in-out, -webkit-transform 0.2s ease-in-out; + transition: opacity 0.2s ease-in-out, transform 0.2s ease-in-out; +} + +.bx-popup-width { + width: 500px; +} + +.bx-popup-width-small { + width: 14rem; +} + +.bx-popup-border { + border:1px solid #383d66; +} + +.bx-popup-color-bg { + background-color:#fff; +} + +.bx-popup-fog { + position: fixed; + top: 0; + left: 0; + opacity: 0.7; + background-color: #ffffff; + -webkit-backface-visibility: hidden; +} + +.bx-popup { + overflow:hidden; +} + +.bx-popup-header { + position: relative; +} +.bx-popup-header-color-bg { + background-color: #3b8686; +} + +.bx-popup-header .bx-db-menu-tab-btn { + padding-top:16px; +} + +.bx-popup-header h2 { + margin:0; + text-align:center; + color:#FFFFFF; +} + +.bx-popup-box-pointer { + display:none; + position:relative; + top:10px; + width:13px; + height:7px; + overflow:hidden; +} + +.bx-popup-box-pointer > i { + display:block; + position:absolute; + top:-5px; + width:0px; + height:0px; + border-width:6px; + border-style:solid; + border-top-color:transparent; + border-right-color:transparent; + border-left-color:transparent; +} + +.bx-popup-image-container { + position: relative; +} + +.bx-popup-image-btn { + position: absolute; + right: 0; + top: 0; +} + +.bx-popup-image-wrapper img { + display: block; +} + +.bx-popup-element-close:hover, +.bx-popup-element-close { + position: absolute; + top: 0; + right: 0; + text-decoration: none; + font-size: 1.75rem !important; +} + +.bx-popup-slide-wrapper { + width:100%; + + background-color: rgba(255, 255, 255, 0.9); +} +.bx-popup-slide-wrapper li { + text-align:right; +} + +.bx-popup-trans-wrapper .bx-popup-close-wrapper { + display: -webkit-flex; + display: flex; + -webkit-justify-content: flex-end; + justify-content: flex-end; +} +.bx-popup-trans-wrapper .bx-popup-close-wrapper .bx-popup-element-close { + position: relative; + line-height: 1.2rem; +} +.bx-popup-image-wrapper .bx-popup-close-wrapper, +.bx-popup-image-wrapper .bx-popup-element-close { + display:none; +} + +#bx-popup-alert, +#bx-popup-confirm, +#bx-popup-prompt { + max-width: 500px; + max-width: 31.25rem; +} + +.popup_alert_actions .bx-btn, +.popup_confirm_actions .bx-btn, +.popup_prompt_actions .bx-btn { + float: none; +} + +/* --------------- full screen popup */ +.bx-popup-full-screen.bx-popup-trans-wrapper, +.bx-popup-full-screen.bx-popup-box-wrapper, +.bx-popup-full-screen .bx-popup-trans, +.bx-popup-full-screen .bx-popup-box { + position:fixed !important; + top:0 !important; + left:0 !important; + bottom:0 !important; + right:0 !important; + width:100%; + width:100vw; + height:100%; + height:100vh; + overflow:auto; +} + +.bx-popup-full-screen .bx-popup-trans > div, +.bx-popup-full-screen .bx-popup-box > div { + border-radius:0; + -moz-border-radius:0; + -webkit-border-radius:0; +} + +.bx-popup-full-screen.bx-popup-trans-wrapper .bx-popup-border, +.bx-popup-full-screen.bx-popup-box-wrapper .bx-popup-border { + border:none; +} + +.bx-popup-full-screen.bx-popup-trans-wrapper .bx-popup, +.bx-popup-full-screen.bx-popup-box-wrapper .bx-popup { + -moz-box-shadow:none; + -webkit-box-shadow:none; + box-shadow:none; +} + +.bx-popup-full-screen .bx-popup-width { + width:100%; +} + +.bx-popup-full-screen .bx-popup .bx-popup-close-wrapper { + display: flex !important; +} + +/* --------------- notification boxes */ +.bx-popup-inline-holder { + padding-top: 70px; + padding-top: 4.375rem; +} +.bx-popup-inline { + width: 100%; +} +.bx-popup-inline .bx-popup { + position: relative; + + width: 100%; + height: 4.25rem; + + border-width: 1px 0px 1px 0px; + border-color: #000000; + border-radius: 0px; + + background-color: rgba(85, 85, 85, .9); + + color: #ffffff; +} +.bx-popup-inline .bx-popup .bx-popup-content { + position: relative; + display: flex; + + height: 100%; + + padding: 0px 3.75rem; + + align-items: center; +} +.bx-popup-inline .bx-popup .bx-popup-content > * { + max-height: 100%; +} +.bx-popup-inline .bx-popup .bx-popup-actions { + position: absolute; + display: flex; + + height: 100%; + top: 0px; + + align-items: center; +} +.bx-popup-inline .bx-popup .bx-pa-left { + left: 0px; +} +.bx-popup-inline .bx-popup .bx-pa-right { + right: 0px; +} +.bx-popup-inline .bx-popup .bx-popup-actions a { + text-decoration: none; + font-size: 1.75rem; + color: #9c9c9c; +} + +/* --------------- chain notifications */ +div.bx-popup-chain { + position: relative; + max-width: 22.5rem; +} +div.bx-popup-chain-cnt { + position: relative; +} +div.bx-popup-chain-item { + position: relative; + width: 100%; + overflow: hidden; +} +div.bx-popup-chain-item-actions { + position: absolute; + top: 0px; +} +div.bx-popup-cia-left { + left: 0px; +} +div.bx-popup-cia-right { + right: 0px; +} +div.bx-popup-chain-item-actions a { + line-height: initial; + text-decoration: none; +} +div.bx-popup-chain-item-actions .sys-icon { + display: inline-block; + width: 1.5rem; + height: 1.5rem; + line-height: 1.5rem; + text-align: center; +} +div.bx-popup-chain-item .bx-loading-ajax { + height: auto; +} + +/* --------------- message box */ +.bx-msg-box-container { + padding:0px 5px; + text-align:center; +} + +.bx-msg-box { + display:inline-block; + margin-right:auto; + margin-left:auto; + + text-align:center; + font-size:1rem; + padding:10px; + text-transform:uppercase; +} + +/* --------------- loading indicator */ + +.bx-loading-ajax { + position:absolute; + width:100px; + height:100px; + margin-left:auto; + margin-right:auto; + + background-color: transparent; + + border-radius:10px; + -moz-border-radius:10px; + -webkit-border-radius:10px; + + text-align:center; + color:#CCCCCC; +} +.bx-loading-ajax.static { + position: static; +} +.bx-loading-ajax svg { + box-sizing: content-box; + width: 50px; + height: 50px; + padding: 25px; +} + +.bx-loading-ajax-btn { + position: relative; + display: inline-block; + vertical-align: top; + + min-width: 2.0rem; + + margin-left: 5px; +} + +@-moz-document url-prefix() { + button.bx-btn .bx-loading-ajax-btn { + top: -1px; + } +} + +button.bx-btn:focus, +button.bx-btn:focus .bx-loading-ajax-btn { + outline: 0; +} + +.bx-form-element-wrapper .bx-loading-ajax { + width: 4rem; + height: 4rem; +} + + +/* --------------- SVG loading indicator */ +svg .outer, +svg .inner{ + -webkit-transform-origin: 50% 50%; + -moz-transform-origin: 50% 50%; + transform-origin: 50% 50%; +} +svg .outer{ + -webkit-animation: clockwise 5s infinite linear; + -moz-animation: clockwise 5s infinite linear; + animation: clockwise 5s infinite linear; + + +} +svg .inner{ + -webkit-animation: counter-clockwise 2s infinite linear; + -moz-animation: counter-clockwise 2s infinite linear; + animation: counter-clockwise 2s infinite linear; + +} +svg .colored .inner .p1 { + fill:#2AB191; +} +svg .colored .inner .p2, +svg .colored .outer .p1 { + fill:#4990E2; +} +svg .colored .outer .p2 { + fill:#EE6666; +} +svg .gray .inner .p1, +svg .gray .inner .p2, +svg .gray .outer .p1, +svg .gray .outer .p2 { + fill:#4A4A4A; +} + +@-webkit-keyframes counter-clockwise { + 0% { -webkit-transform: rotate(0deg); } + 100% { -webkit-transform: rotate(360deg); } +} +@-webkit-keyframes clockwise { + 0% { -webkit-transform: rotate(360deg); } + 100% { -webkit-transform: rotate(0deg); } +} +@-moz-keyframes counter-clockwise { + 0% { -moz-transform: rotate(0deg); } + 100% { -moz-transform: rotate(360deg); } +} +@-moz-keyframes clockwise { + 0% { -moz-transform: rotate(360deg); } + 100% { -moz-transform: rotate(0deg); } +} + +@keyframes counter-clockwise { + 0% { transform: rotate(0deg); } + 100% { transform: rotate(360deg); } +} +@keyframes clockwise { + 0% { transform: rotate(360deg); } + 100% { transform: rotate(0deg); } +} + +/* --------------- button */ +.bx-btn-height { + height: 2.2rem; + line-height: 2.2rem; +} +.bx-btn-border { + border: none; +} +.bx-btn:active, +.bx-btn:hover { + background-color: #79bd9a; + text-decoration:none; +} +.bx-btn img { + width:1.2rem; + height:1.2rem; + max-width: none; + + background-size: contain; + background-repeat: no-repeat; + background-position:center center; +} +.bx-btn .bx-def-valign-center{ + height: 100%; +} +.bx-btn u { + margin-left: 10px; + text-decoration: none; +} +.bx-btn u:first-child { + margin-left: 0px; +} +.bx-btn .sys-icon { + font-size:1.2em; +} +.bx-btn .sys-icon-bigger { + font-size:1.4em; +} + +.bx-btn-small-height { + height: 1.6rem; + line-height: 1.5rem; +} + +.bx-btn-small-border { + border: none; +} + +.bx-btn.bx-btn-primary { + background-color: #357877; +} +.bx-btn.bx-btn-primary:hover, +.bx-btn.bx-btn-primary:active { + background-color: #3a8686; +} + +.bx-btn.bx-btn-symbol { + font-family: "Times New Roman", Georgia, Serif; + font-size:1.3rem; + line-height:32px; +} +.bx-btn.bx-btn-symbol:hover { + text-decoration:none; +} +.bx-btn.bx-btn-symbol-small { + font-size:1rem; +} + +.bx-btn-group .bx-btn { + margin-left:0px; + margin-right:0px; +} +.bx-btn-group .bx-btn:not(:first-child):after { + content:""; + position:absolute; + display:block; + top:0px; + left:-0.05em; + width:0.1em; + height:100%; + background-color:rgba(255,255,255,0.1); +} +.bx-btn-group .bx-btn + .bx-btn:not(:last-child) { + border-radius:0px; + -moz-border-radius:0px; + -webkit-border-radius:0px; +} +.bx-btn-group .bx-btn:first-child { + -webkit-border-top-right-radius: 0px; + -webkit-border-bottom-right-radius: 0px; + -moz-border-radius-topright: 0px; + -moz-border-radius-bottomright: 0px; + border-top-right-radius: 0px; + border-bottom-right-radius: 0px; +} +.bx-btn-group .bx-btn:last-child { + -webkit-border-top-left-radius: 0px; + -webkit-border-bottom-left-radius: 0px; + -moz-border-radius-topleft: 0px; + -moz-border-radius-bottomleft: 0px; + border-top-left-radius: 0px; + border-bottom-left-radius: 0px; +} + +/* --------------- button at the end of cut string */ + +.bx-str-limit { + margin-left:0.5rem; + cursor:pointer; +} + +/* --------------- categories */ + +.bx-category-list-item { + line-height: 1.5rem; +} +.bx-category-list-item-selected { + font-weight: bold; +} + +/* --------------- Show More */ +.bx-overflow-ready { + max-height: 250px; + overflow: hidden; +} +.bx-overflow-ready.bx-or-cmt { + max-height: 80px; +} +.bx-overflow:before { + position: absolute; + bottom: 0; + width: 100%; + height: 20%; + + content: ''; +} + +.bx-show-more { + padding-top: 0.25rem; + padding-bottom: 0.25rem; + + text-align: center +} + +/* --------------- Flickity: Tailwind overwrite */ +.flickity-enabled .flickity-viewport .flickity-slider img, +.flickity-enabled .flickity-viewport .flickity-slider video { + display: inline; + max-width: none; +} \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/css/cover.css b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/css/cover.css new file mode 100644 index 0000000000..ddddb76017 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/css/cover.css @@ -0,0 +1,124 @@ +.bx-cover-gap { + position:relative; +} +.bx-media-phone .bx-cover-gap { + padding-left: 0; + padding-right: 0; +} + +.bx-cover-wrapper { + position:relative; + background-image: url(../images/cover.svg); + background-color: #eee; + background-repeat: no-repeat; + background-position: center center; + -webkit-background-size: cover; + -moz-background-size: cover; + -o-background-size: cover; + background-size: cover; + overflow: hidden; +} + +.bx-image-edit-buttons{ + position: absolute; + left:1rem; + top:1rem; + z-index: 100; +} +.bx-image-edit-buttons .bx-btn.bx-btn-small{ + padding: 0.375rem 0.5rem; +} +.bx-base-pofile-cover-thumb .bx-image-edit-buttons{ + display: flex; + width: 100%; + justify-content: center; + left:0px; + bottom:1rem; + top:auto; +} +.bx-image-edit-move{ + cursor:move; + position: relative; + z-index: 99; +} +.bg-cover{ + background-size: 100% auto !important; +} +.bx-image-edit-move-info{ + display: flex; + align-items: center; + position: absolute; + opacity: 0.5; + background-color: #000; + -webkit-backface-visibility: hidden; + padding: 0.5rem 1rem; + border-radius: 1rem; + color:#fff; + letter-spacing: 1px; +} +.bx-image-edit-move-info i{ + color:#fff; + font-size: 1.25rem; + margin-right: 1rem; +} +.bx-image-edit-buttons-no-image .bx-image-edit-buttons-edit{ + display: none; +} + +.bx-image-edit-buttons .bx-uploader-html5-drop-area{ + display: none; +} + +.bx-cover-gradient { + position: absolute; + width: 100%; + height: 100%; + pointer-events: none; + background: url(data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiA/Pgo8c3ZnIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgd2lkdGg9IjEwMCUiIGhlaWdodD0iMTAwJSIgdmlld0JveD0iMCAwIDEgMSIgcHJlc2VydmVBc3BlY3RSYXRpbz0ibm9uZSI+CiAgPGxpbmVhckdyYWRpZW50IGlkPSJncmFkLXVjZ2ctZ2VuZXJhdGVkIiBncmFkaWVudFVuaXRzPSJ1c2VyU3BhY2VPblVzZSIgeDE9IjAlIiB5MT0iMCUiIHgyPSIwJSIgeTI9IjEwMCUiPgogICAgPHN0b3Agb2Zmc2V0PSIwJSIgc3RvcC1jb2xvcj0iIzAwMDAwMCIgc3RvcC1vcGFjaXR5PSIwIi8+CiAgICA8c3RvcCBvZmZzZXQ9IjEwMCUiIHN0b3AtY29sb3I9IiMwMDAwMDAiIHN0b3Atb3BhY2l0eT0iMC4xNyIvPgogIDwvbGluZWFyR3JhZGllbnQ+CiAgPHJlY3QgeD0iMCIgeT0iMCIgd2lkdGg9IjEiIGhlaWdodD0iMSIgZmlsbD0idXJsKCNncmFkLXVjZ2ctZ2VuZXJhdGVkKSIgLz4KPC9zdmc+); + background: -moz-linear-gradient(top, rgba(0,0,0,0) 0%, rgba(0,0,0,0.17) 100%); + background: -webkit-linear-gradient(top, rgba(0,0,0,0) 0%,rgba(0,0,0,0.17) 100%); + background: linear-gradient(to bottom, rgba(0,0,0,0) 0%,rgba(0,0,0,0.17) 100%); + filter: progid:DXImageTransform.Microsoft.gradient( startColorstr='#00000000', endColorstr='#2b000000',GradientType=0 ); +} + +.bx-cover { + position: relative; + z-index: 2; + display: -webkit-flex; + display: flex; + -webkit-align-items: center; + align-items: center; + min-height: 40vh; + text-align: center; +} + +.bx-cover-cnt { + width: 100%; +} + +.bx-cover-title { + font-weight:bold; + vertical-align:middle; + text-shadow:-1px 0px 0px rgba(0, 0, 0, .3), 1px 0px 0px rgba(0, 0, 0, .3), 0px -1px 0px rgba(0, 0, 0, .3), 0px 1px 0px rgba(0, 0, 0, .3); +} + +.bx-cover-title .bx-btn { + display:inline-block; + float:none; +} + +.bx-cover-image img { + width:6.25rem; + height:6.25rem; + background-size: cover; + vertical-align: middle; +} + +.bx-cover-title .sys-icon, +.bx-cover-title span { + vertical-align: middle; +} + +.bx-cover-homepage { + background-image: url(../images/cover-homepage.svg); +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/css/default.less b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/css/default.less new file mode 100644 index 0000000000..451de4ccc2 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/css/default.less @@ -0,0 +1,750 @@ +@import (reference) '_mixins.less'; + +.bx-def-page-width { + max-width:@bx-page-width; + width: 100%; +} + +.bx-def-box-sizing { + .box-sizing(border-box); +} + +.bx-def-align-center { + display: -webkit-flex !important; + display: flex !important; + + -webkit-justify-content: center; + justify-content: center; + + -webkit-align-items: center; + align-items: center; +} + +.bx-def-valign-center { + display: -webkit-flex !important; + display: flex !important; + + -webkit-align-items: center; + align-items: center; +} + +/* margins */ +.bx-def-centered { + margin: 0px auto; +} + +.bx-def-margin { + .margin(@bx-margin); +} +.bx-def-margin-neg { + .margin(-@bx-margin); +} +.bx-def-margin-lefttopright { + .margin-left(@bx-margin); + .margin-top(@bx-margin); + .margin-right(@bx-margin); +} +.bx-def-margin-rightbottomleft { + .margin-right(@bx-margin); + .margin-bottom(@bx-margin); + .margin-left(@bx-margin); +} +.bx-def-margin-leftright { + .margin-left(@bx-margin); + .margin-right(@bx-margin); +} +.bx-def-margin-leftright-neg { + .margin-left(-@bx-margin); + .margin-right(-@bx-margin); +} +.bx-def-margin-topbottom { + .margin-top(@bx-margin); + .margin-bottom(@bx-margin); +} +.bx-def-margin-topbottom-neg { + .margin-top(-@bx-margin); + .margin-bottom(-@bx-margin); +} +.bx-def-margin-top { + .margin-top(@bx-margin); +} +.bx-def-margin-top-auto { + .margin-top(@bx-margin); + &:first-child { + .margin-top(0px); + } +} +.bx-def-margin-right { + .margin-right(@bx-margin); +} +.bx-def-margin-bottom { + .margin-bottom(@bx-margin); +} +.bx-def-margin-bottom-neg { + .margin-bottom(-@bx-margin); +} +.bx-def-margin-left { + .margin-left(@bx-margin); +} +.bx-def-margin-left-auto { + .margin-left(@bx-margin); + &:first-child { + .margin-left(0); + } +} +.bx-def-margin-right-auto { + .margin-right(@bx-margin); + /* &:last-child { + .margin-right(0); + }*/ +} + +.bx-def-margin-sec { + .margin(@bx-margin-sec); +} +.bx-def-margin-sec-neg { + .margin(-@bx-margin-sec); +} +.bx-def-margin-sec-lefttopright { + .margin-left(@bx-margin-sec); + .margin-top(@bx-margin-sec); + .margin-right(@bx-margin-sec); +} +.bx-def-margin-sec-lefttopright-neg { + .margin-left(-@bx-margin-sec); + .margin-top(-@bx-margin-sec); + .margin-right(-@bx-margin-sec); +} +.bx-def-margin-sec-bottom-neg { + .margin-bottom(-@bx-margin-sec); +} +.bx-def-margin-sec-rightbottomleft { + .margin-right(@bx-margin-sec); + .margin-bottom(@bx-margin-sec); + .margin-left(@bx-margin-sec); +} +.bx-def-margin-sec-leftright { + .margin-left(@bx-margin-sec); + .margin-right(@bx-margin-sec); +} +.bx-def-margin-sec-leftright-neg { + .margin-left(-@bx-margin-sec); + .margin-right(-@bx-margin-sec); +} +.bx-def-margin-sec-topbottom { + .margin-top(@bx-margin-sec); + .margin-bottom(@bx-margin-sec); +} +.bx-def-margin-sec-top { + .margin-top(@bx-margin-sec); +} +.bx-def-margin-sec-top-neg { + .margin-top(-@bx-margin-sec); +} +.bx-def-margin-sec-top-auto { + .margin-top(@bx-margin-sec); + &:first-child { + .margin-top(0); + } +} +.bx-def-margin-sec-right { + .margin-right(@bx-margin-sec); +} +.bx-def-margin-sec-bottom { + .margin-bottom(@bx-margin-sec); +} +.bx-def-margin-sec-left { + .margin-left(@bx-margin-sec); +} +.bx-def-margin-sec-left-auto { + .margin-left(@bx-margin-sec); + &:first-child { + .margin-left(0); + } +} +.bx-def-margin-sec-right-auto { + .margin-right(@bx-margin-sec); + &:last-child { + .margin-right(0); + } +} + +.bx-def-margin-thd { + .margin(@bx-margin-thd); +} +.bx-def-margin-thd-neg { + .margin(-@bx-margin-thd); +} +.bx-def-margin-thd-rightbottomleft { + .margin-right(@bx-margin-thd); + .margin-bottom(@bx-margin-thd); + .margin-left(@bx-margin-thd); +} +.bx-def-margin-thd-leftright { + .margin-left(@bx-margin-thd); + .margin-right(@bx-margin-thd); +} +.bx-def-margin-thd-leftright-neg { + .margin-left(-@bx-margin-thd); + .margin-right(-@bx-margin-thd); +} +.bx-def-margin-thd-topbottom { + .margin-top(@bx-margin-thd); + .margin-bottom(@bx-margin-thd); +} +.bx-def-margin-thd-top { + .margin-top(@bx-margin-thd); +} +.bx-def-margin-thd-top-auto { + .margin-top(@bx-margin-thd); + &:first-child { + .margin-top(0); + } +} +.bx-def-margin-thd-right { + .margin-right(@bx-margin-thd); +} +.bx-def-margin-thd-bottom { + .margin-bottom(@bx-margin-thd); +} +.bx-def-margin-thd-left { + .margin-left(@bx-margin-thd); +} +.bx-def-margin-thd-left-auto { + .margin-left(@bx-margin-thd); + &:first-child { + .margin-left(0); + } +} + +/* paddings */ +.bx-def-padding { + .padding(@bx-padding); +} +.bx-def-padding-lefttopright { + .padding-left(@bx-padding); + .padding-top(@bx-padding); + .padding-right(@bx-padding); +} +.bx-def-padding-rightbottomleft { + .padding-right(@bx-padding); + .padding-bottom(@bx-padding); + .padding-left(@bx-padding); +} +.bx-def-padding-leftright { + .padding-left(@bx-padding); + .padding-right(@bx-padding); +} +.bx-def-padding-topbottom { + .padding-top(@bx-padding); + .padding-bottom(@bx-padding); +} +.bx-def-padding-top { + .padding-top(@bx-padding); +} +.bx-def-padding-right { + .padding-right(@bx-padding); +} +.bx-def-padding-bottom { + .padding-bottom(@bx-padding); +} +.bx-def-padding-left { + .padding-left(@bx-padding); +} + +.bx-def-padding-sec { + .padding(@bx-padding-sec); +} +.bx-def-padding-sec-rightbottomleft { + .padding-right(@bx-padding-sec); + .padding-bottom(@bx-padding-sec); + .padding-left(@bx-padding-sec); +} +.bx-def-padding-sec-topbottom { + .padding-top(@bx-padding-sec); + .padding-bottom(@bx-padding-sec); +} +.bx-def-padding-sec-leftright { + .padding-left(@bx-padding-sec); + .padding-right(@bx-padding-sec); +} +.bx-def-padding-sec-top { + .padding-top(@bx-padding-sec); +} +.bx-def-padding-sec-right { + .padding-right(@bx-padding-sec); +} +.bx-def-padding-sec-bottom { + .padding-bottom(@bx-padding-sec); +} +.bx-def-padding-sec-left { + .padding-left(@bx-padding-sec); +} + +.bx-def-padding-thd { + .padding(@bx-padding-thd); +} +.bx-def-padding-thd-rightbottomleft { + .padding-right(@bx-padding-thd); + .padding-bottom(@bx-padding-thd); + .padding-left(@bx-padding-thd); +} +.bx-def-padding-thd-topbottom { + .padding-top(@bx-padding-thd); + .padding-bottom(@bx-padding-thd); +} +.bx-def-padding-thd-leftright { + .padding-left(@bx-padding-thd); + .padding-right(@bx-padding-thd); +} +.bx-def-padding-thd-top { + .padding-top(@bx-padding-thd); +} +.bx-def-padding-thd-right { + .padding-right(@bx-padding-thd); +} +.bx-def-padding-thd-bottom { + .padding-bottom(@bx-padding-thd); +} +.bx-def-padding-thd-left { + .padding-left(@bx-padding-thd); +} + +/* colors */ +.bx-def-color-bg-block { + .background-color (@bx-color-block); +} +.bx-def-color-bg-box { + .background-color (@bx-color-box); +} +.bx-def-color-bg-box-active, +.bx-def-color-bg-box-hover:hover { + .background-color (@bx-color-box-hover); +} +.bx-def-color-bg-sec { + .background-color (@bx-color-sec); +} + +.bx-def-color-bg-hl, +.bx-def-color-bg-hl-even:nth-child(even), +.bx-def-color-bg-hl-hover:hover { + .background-color (@bx-color-hl); +} + +.bx-def-color-bg-active { + .background-color (@bx-color-active); +} + +.bx-btn.bx-btn-disabled:active, +.bx-btn.bx-btn-disabled:hover, +.bx-btn.bx-btn-disabled, +.bx-btn.bx-btn-small.bx-btn-disabled:active, +.bx-btn.bx-btn-small.bx-btn-disabled:hover, +.bx-btn.bx-btn-small.bx-btn-disabled, +.bx-btn.bx-btn-primary.bx-btn-disabled:active, +.bx-btn.bx-btn-primary.bx-btn-disabled:hover, +.bx-btn.bx-btn-primary.bx-btn-disabled { + .background-color (@bx-color-disabled); +} + +/* hr */ +.bx-def-hr, +.bx-def-hr-auto { + margin-left:0; + margin-right:0; + padding:0; + border:0px; + border-top:@bx-border-width @bx-border-type @bx-border-color-hr; +} +.bx-def-hr-auto:first-child { + display: none; +} + +/* border for common layout elements likedesign boxes, pads, menu items, etc */ +.bx-def-border { + border:@bx-border-width @bx-border-type @bx-border-color; +} +.bx-def-border-rightbottomleft { + border-right:@bx-border-width @bx-border-type @bx-border-color; + border-bottom:@bx-border-width @bx-border-type @bx-border-color; + border-left:@bx-border-width @bx-border-type @bx-border-color; +} +.bx-def-border-top { + border-top:@bx-border-width @bx-border-type @bx-border-color; +} +.bx-def-border-top-auto { + border-top:@bx-border-width @bx-border-type @bx-border-color; + &:first-child { + border-top:none; + } +} +.bx-def-border-right { + border-right:@bx-border-width @bx-border-type @bx-border-color; +} +.bx-def-border-bottom { + border-bottom:@bx-border-width @bx-border-type @bx-border-color; +} +.bx-def-border-left { + border-left:@bx-border-width @bx-border-type @bx-border-color; +} +.bx-def-border-right { + border-right:@bx-border-width @bx-border-type @bx-border-color; +} + +/* shadow */ +.bx-def-shadow { + .drop-shadow (0px, 1px, 3px, 0px, rgba(51, 51, 51, 0.1)); +} + +/* round corders */ +.bx-def-round-corners { + .radius(@bx-round-corners-radius); +} + +/* blur */ +.bx-def-blur { + .blur(2px); +} + +/* fonts */ + +/* NOTE: bx-def-font, h1, h2, h3 styles were copied to editor.css */ + +.bx-def-font-inputs { + font-family:@bx-font-family; + font-weight:400; + .font-size(@bx-font-size-default); +} + +.bx-def-font-color, +.bx-def-font-color:hover { + color:@bx-font-color-default; +} + +.bx-def-font-grayed { + color:@bx-font-color-grayed; +} + +.bx-def-font-contrasted:after, +.bx-def-font-contrasted:before, +.bx-def-font-contrasted { + color:@bx-font-color-contrasted; +} + +.bx-def-font-small { + .font-size(@bx-font-size-small); +} + +.bx-def-font-middle { + .font-size(@bx-font-size-middle); +} + +.bx-def-font-large { + .font-size(@bx-font-size-large); +} + +.bx-def-font-light { + font-weight: 300; +} + +.bx-def-font-normal { + font-weight: 400; +} + +.bx-def-font-semibold { + font-weight: 600; +} + +.bx-def-font-bold { + font-weight: 700; +} + +.bx-def-font-extrabold { + font-weight: 900; +} + +.bx-def-font-align-center { + text-align: center; +} + +h1, +.bx-def-font-h1 { + .font-size(@bx-font-size-h1); + font-weight:700; +} + +h2, +.bx-def-font-h2 { + .font-size(@bx-font-size-h2); + font-weight:700; +} + +h3, +.bx-def-font-h3 { + .font-size(@bx-font-size-h3); + font-weight:500; +} + +.bx-def-vanilla-html { + margin-left: auto; + margin-right: auto; +} +.bx-layout-column-thin .bx-def-vanilla-html, +.bx-layout-column-half .bx-def-vanilla-html, +.bx-layout-column-wide .bx-def-vanilla-html { + max-width: none; +} +.bx-layout-column-fullwidth .bx-base-text-entity-content.bx-def-vanilla-html { + margin-top: 1.5rem; + margin-bottom: 1.5rem; +} +.bx-def-vanilla-html.bx-def-constraint-pre pre { + max-width: none; + overflow: auto; +} + +/* image/thumbnail/gallery default styles */ + +.bx-def-icon, +.bx-def-thumb, +.bx-def-ava, +.bx-def-ava-big { + overflow:hidden; +} + +.bx-def-ava-big-size { + .width(@bx-size-avatar-big); + .height(@bx-size-avatar-big); +} +.bx-def-ava-big-size-max-height { + .max-height(@bx-size-avatar-big); +} +.bx-def-ava-big-size-min-height { + .min-height(@bx-size-avatar-big); +} +.bx-def-ava-big-size-left-indent { + .margin-left(@bx-size-avatar-big + @bx-margin); +} + + +.bx-def-ava-size { + .width(@bx-size-avatar); + .height(@bx-size-avatar); +} +.bx-def-ava-size-max-height { + .max-height(@bx-size-avatar); +} +.bx-def-ava-size-min-height { + .min-height(@bx-size-avatar); +} +.bx-def-ava-size-left-indent { + .margin-left(@bx-size-avatar + @bx-margin); +} + + +.bx-def-thumb-size { + .width(@bx-size-thumb); + .height(@bx-size-thumb); +} +.bx-def-thumb-size-max-height { + .max-height(@bx-size-thumb); +} +.bx-def-thumb-size-min-height { + .min-height(@bx-size-thumb); +} +.bx-def-thumb-size-left-indent { + .margin-left(@bx-size-thumb + @bx-margin); +} + +.bx-def-icon-size { + .width(@bx-size-icon); + .height(@bx-size-icon); +} +.bx-def-icon-size-max-height { + .max-height(@bx-size-icon); +} +.bx-def-icon-size-min-height { + .min-height(@bx-size-icon); +} +.bx-def-icon-size-left-indent { + .margin-left(@bx-size-icon + @bx-margin); +} + +/*--- Unit ---*/ +.bx-def-unit { + position:relative; + white-space:nowrap; +} +.bx-def-unit-info { + .box-sizing(border-box); + + text-overflow:ellipsis; + overflow:hidden; +} +.bx-def-unit .bx-def-unit-line .bx-def-ui-div:first-child { + display: none; +} + +/*-- Unit: Tailwind overwrite --*/ +.bx-def-unit.absolute { + position: relative; +} +.bx-def-unit.absolute .bx-def-unit-img { + position: absolute; + top: 0px; + left: 0px; +} +.bx-def-unit.absolute .bx-def-unit-info { + display: -webkit-flex; + display: flex; + -webkit-align-items: center; + align-items: center; +} +.bx-def-unit.absolute .bx-def-unit-info-cnt { + width: 100%; +} +.bx-def-unit.absolute .bx-def-unit-line { + text-overflow:ellipsis; + overflow:hidden; +} + +/*--- Alerts ---*/ +.bx-def-unit-alert, +.bx-def-unit-alert-small, +.bx-def-unit-alert-middle { + display:block; + position:absolute; + box-sizing: content-box; + top: 0; + right: -2px; + text-align:center; + color:white; +} +.bx-def-unit-alert { + .min-width(@bx-font-size-default); + .height(@bx-font-size-default); + .line-height(@bx-font-size-default); + .radius(@bx-font-size-default); + .font-size(@bx-font-size-middle - 2); + .padding(4px); +} +.bx-def-unit-alert-small { + .min-width(@bx-font-size-small + 2); + .height(@bx-font-size-small + 2); + .line-height(@bx-font-size-small + 2); + .radius(@bx-font-size-default); + .font-size(@bx-font-size-small); + .padding(1px); +} +.bx-def-unit-alert-middle { + .min-width(@bx-font-size-middle - 2); + .height(@bx-font-size-middle - 2); + .line-height(@bx-font-size-middle - 2); + .radius(@bx-font-size-middle - 2); + .font-size(@bx-font-size-middle - 2); + .padding(3px); +} + +.bx-def-unit-live-search { + text-align: left; + overflow: hidden; +} + +.bx-def-unit-live-search .bx-def-unit-img:not(.empty) { + background-size:cover; + background-repeat:no-repeat; + background-position:center center; +} +.bx-def-unit-live-search .bx-def-unit-img-empty { + position: relative; + display: -webkit-flex; + display: flex; + -webkit-align-items: center; + align-items: center; + -webkit-justify-content: center; + justify-content: center; +} +.bx-def-unit-live-search .bx-def-unit-img-empty i { + font-size: 1.2rem; +} + + + +.bx-def-gal-img-column { + .column-width-raw(100%); +} + +.bx-def-gal-img-size { + .width(@bx-size-gallery-img-width); + .height(@bx-size-gallery-img-height); +} + +.bx-def-gal-div-size { + width:100%; + .height(@bx-size-gallery-img-height); +} +.bx-def-gal-unit-column { + .column-width-raw(100%); +} +.bx-def-gal-unit-size { + display:inline-block; + width:100%; + height:auto; + vertical-align:top; + overflow:hidden; + .box-sizing(); +} + + +/* label */ + +.bx-def-label { + .box-sizing(border-box); + + min-width: 1.5rem; + .padding-left(@bx-padding-sec); + .padding-right(@bx-padding-sec); + + .radius(@bx-round-corners-radius-label); + + background-color: @bx-color-label; + + line-height: 1.5rem; + font-size: @bx-font-size-small; +} +.bx-def-label, +.bx-def-label a, +.bx-def-label .sys-icon { + color: @bx-font-color-grayed; +} + +.bx-def-label.menu { + .radius(@bx-round-corners-radius-label-menu); + + background-color: @bx-color-label-menu; +} + +.bx-def-label.menu, +.bx-def-label.menu a, +.bx-def-label.menu .sys-icon { + color: @bx-font-color-contrasted; +} + + +/* z-index */ + +.bx-def-z-index-front { + z-index:100; +} + +.bx-def-z-index-nav { + z-index:5000; +} + +.bx-def-z-index-overlay { + z-index:9700; +} + +.bx-def-z-index-modal { + z-index:10000; +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/css/forms.css b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/css/forms.css new file mode 100644 index 0000000000..ab33579c6a --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/css/forms.css @@ -0,0 +1,691 @@ + +.bx-form-advanced-wrapper .bx-form-section-wrapper:first-child { + margin-top:0; +} + +.bx-form-advanced-wrapper .bx-form-section-wrapper:last-child { + margin-bottom:0; +} + +.bx-form-advanced-wrapper .bx-form-section-divider:first-child { + border:none; + padding:0; +} + +.bx-form-advanced-wrapper .bx-form-section-divider:first-child .bx-form-section-content { + padding-top:0; +} + +.bx-form-advanced-wrapper .bx-form-section-divider:last-child .bx-form-section-content { + padding-bottom:0; +} + +.bx-form-section-wrapper { + position:relative; +} + +.bx-form-section { + margin:0; +} + +.bx-form-section-header .bx-form-section-title { + display: -webkit-flex; + display: flex; + -webkit-align-items: center; + align-items: center; + -webkit-flex-wrap: nowrap; + flex-wrap: nowrap; + + line-height: 1.5rem; + text-transform: uppercase; +} + +.bx-form-section-header .bx-form-section-title .sys-icon { + color: inherit; +} + +.bx-form-section-header .bx-form-section-title u { + cursor: pointer; +} + +.bx-form-section-header .bx-form-section-title span { + white-space: nowrap; + text-transform: none; + font-size: 0.75rem; +} + +.bx-form-section-hidden .bx-form-section-content { + display:none; +} + +.bx-form-caption { + margin-bottom:5px; +} + +.bx-form-required { + color:red; +} + +.bx-form-warn { + color:red; + font-style:italic; +} + +.bx-form-option-info { + display: inline-flex; + flex-direction: column; +} + +.bx-form-info { + +} + +/* section toggler */ + +.bx-form-collapsable .bx-form-section-toggler { + display: -webkit-flex; + display: flex; + -webkit-align-items: center; + align-items: center; + -webkit-justify-content: center; + justify-content: center; + + width: 1.25rem; + height: 1.25rem; + + text-decoration:none; + + -moz-transform: rotate(180deg); + -webkit-transform: rotate(180deg); + -ms-transform: rotate(180deg); + -o-transform: rotate(180deg); + + -webkit-transition: all 0.5s ease; + -moz-transition: all 0.5s ease; + -ms-transition: all 0.5s ease; + -o-transition: all 0.5s ease; + + line-height: 1.25rem; +} + +.bx-form-collapsed .bx-form-section-toggler { + -moz-transform: rotate(0deg); + -webkit-transform: rotate(0deg); + -ms-transform: rotate(0deg); + -o-transform: rotate(0deg); +} + +.bx-form-section-toggler .sys-icon { + font-size: 0.875rem; +} + +/* form inputs */ +.bx-form-input-wrapper { + position: relative; +} + +.bx-form-input-disabled {} + +.bx-form-input-slider, +.bx-form-input-doublerange, +.bx-form-input-select_multiple, +.bx-form-input-select, +.bx-form-input-radio_set, +.bx-form-input-checkbox_set, +.bx-form-input-number, +.bx-form-input-time, +.bx-form-input-datepicker, +.bx-form-input-datetime, +.bx-form-input-textarea, +.bx-form-input-wrapper-password, +.bx-form-input-text, +.bx-form-input-price, +.bx-form-input-wrapper-price span { + + height:40px; + height:2.5rem; + width:100%; + + -moz-box-sizing: border-box; + -ms-box-sizing: border-box; + -webkit-box-sizing: border-box; + box-sizing: border-box; + + -webkit-appearance: none; + -moz-appearance: none; + appearance: none; + + padding:7px 3px 7px 3px; + padding:0.2rem 0.4rem; + + vertical-align:middle; + + border:2px solid #79bd9a; + border:0.125rem solid #79bd9a; + + -webkit-border-radius:0.3rem; + -moz-border-radius:0.3rem; + border-radius:0.3rem; + + outline:none; + + -ms-filter: "progid:DXImageTransform.Microsoft.Alpha(Opacity=90)"; + filter: alpha(opacity=90); + -moz-opacity: 0.9; + -khtml-opacity: 0.9; + opacity: 0.9; +} + +.bx-form-input-slider:focus, +.bx-form-input-doublerange:focus, +.bx-form-input-number:focus, +.bx-form-input-time:focus, +.bx-form-input-datepicker:focus, +.bx-form-input-datetime:focus, +.bx-form-input-textarea:focus, +.bx-form-input-text:focus, +.bx-form-input-price:focus, +.bx-form-input-wrapper-password.bx-form-input-focus { + border-color:#6caa8a; + + -ms-filter: "progid:DXImageTransform.Microsoft.Alpha(Opacity=100)"; + filter: alpha(opacity=100); + -moz-opacity: 1.0; + -khtml-opacity: 1.0; + opacity: 1.0; + + -webkit-transition: all 0.2s linear; + -moz-transition: all 0.2s linear; + -o-transition: all 0.2s linear; + transition: all 0.2s linear; +} +.bx-form-input-wrapper-password { + padding: 0 2.125rem 0 0; +} +.bx-form-input-wrapper-password > a { + position: absolute; + z-index: 1000; + + display: -webkit-flex; + display: flex; + -webkit-align-items: center; + align-items: center; + -webkit-justify-content: center; + justify-content: center; + + top: 0; + right: 0; + height: 100%; + + margin: 0 0.5rem; +} +.bx-form-input-password { + position: relative; + + -moz-box-sizing: border-box; + -ms-box-sizing: border-box; + -webkit-box-sizing: border-box; + box-sizing: border-box; + + width: 100%; + height: 100%; + + margin: 0; + padding: 7px 3px 7px 3px; + padding: 0.2rem 0.4rem; + + border: 0; + background-color: transparent; +} +.bx-form-input-password:focus { + border-color: transparent; + outline: none; + box-shadow: none; +} + +.bx-form-input-select_multiple, +.bx-form-input-radio_set, +.bx-form-input-checkbox_set { + height:auto; +} + +.bx-form-value .bx-form-input-radio_set, +.bx-form-value .bx-form-input-checkbox_set { + line-height: 2.0; +} + +.bx-form-value .bx-form-input-radio_set input, +.bx-form-value .bx-form-input-checkbox_set input, +.bx-form-value .bx-form-input-radio_set label, +.bx-form-value .bx-form-input-checkbox_set label { + display: inline-block; + vertical-align: middle; +} + +.bx-form-value .bx-form-input-radio_set label, +.bx-form-value .bx-form-input-checkbox_set label { + padding-left: 0.75rem; +} + +.bx-form-input-textarea { + padding:0.5rem; + height:150px; + height:10rem; + + line-height:normal; +} + +.bx-form-input-wrapper-dateselect select{ + min-width:70px; +} +.bx-form-input-wrapper-dateselect select.month{ + min-width:120px; +} + +.bx-form-input-datetime { + width:10.2rem; +} + +.bx-form-datepicker-modal { + z-index:10001 !important; +} + +.bx-form-input-number, +.bx-form-input-time +{ + width:6rem; +} + +.bx-form-input-wrapper-file .bx-btn { + float: none; +} +.bx-form-input-file { + position: fixed; + top: -1000px; + + border: none; + background-color: transparent; + visibility: hidden; +} + +.bx-form-input-wrapper-slider, +.bx-form-input-wrapper-doublerange { + position:relative; +} + +.bx-form-input-wrapper-slider .ui-slider, +.bx-form-input-wrapper-doublerange .ui-slider { + position:absolute; + top:0px; + right:0px; +} + +.bx-form-input-wrapper-slider .ui-slider .ui-slider-handle, +.bx-form-input-wrapper-doublerange .ui-slider .ui-slider-handle { + z-index: 1; +} + +/* price */ +.bx-form-element .bx-form-value .bx-form-input-wrapper-price { + display: -webkit-flex; + display: flex; + -webkit-align-items: stretch; + align-items: stretch; +} +.bx-form-element .bx-form-value .bx-form-input-wrapper-price span { + display: -webkit-flex; + display: flex; + -webkit-align-items: center; + align-items: center; + + width: auto; + border-right-width: 0; + border-top-right-radius: 0; + border-bottom-right-radius: 0; +} +.bx-form-input-wrapper-price span { + background-color: rgba(249, 250, 251, 1.0); +} +.bx-form-element .bx-form-value .bx-form-input-price:not(:first-child) { + border-top-left-radius: 0; + border-bottom-left-radius: 0; +} + +/* privacy group chooser */ +.bx-form-input-wrapper-pgc { + position: relative; +} + +.bx-form-input-pgc { + position: absolute; + display: -webkit-flex; + display: flex; + -webkit-align-items: center; + align-items: center; + -webkit-justify-content: center; + justify-content: center; + top: -1.375rem; + right: 0; + width: 1rem; + height: 1rem; +} + +.bx-form-input-pgc-popup .bx-form-input-wrapper-input_set { + display: -webkit-flex; + display: flex; + -webkit-flex-wrap: nowrap; + flex-wrap: nowrap; + -webkit-align-items: center; + align-items: center; +} + +/* help popup */ +.bx-form-input-help-popup { + max-width: 25rem; + max-height: 25rem; + overflow: auto; +} + +/* switcher element */ +.bx-switcher-cont input { + display: none !important; +} + +/* oneline element */ +.bx-form-element-wrapper-oneline .bx-form-element { + display: -webkit-flex; + display: flex; + -webkit-flex-flow: row nowrap; + flex-flow: row nowrap; + -webkit-align-items: center; + align-items: center; + -webkit-justify-content: flex-start; + justify-content: flex-start; +} +.bx-form-value-oneline, +.bx-form-caption-oneline { + float: none; +} +.bx-form-caption-oneline { + margin-bottom: 0; +} + +.bx-form-input-wrapper-submit .bx-btn { + float: none; +} +.bx-form-input-wrapper-input_set .bx-btn { + float:left; +} + +/* extra features */ + +.bx-form-right-line-aligned { + float:right; + margin-top: 5px; +} + +/* view mode */ +.bx-form-row-view-wrapper > div { + position: relative; + display: inline-block; + width: 100%; + + vertical-align: bottom; + white-space: normal; + text-overflow: ellipsis; + overflow: hidden; +} +.bx-form-row-view-ratevalue{ + display: flex !important; + justify-content: flex-start; +} +.bx-form-row-view-ratevalue .bx-form-row-view-value{ + flex-grow: 2; +} +.bx-form-row-view-wrapper-textarea > div { + vertical-align:top; +} + +.bx-form-row-view-caption { + font-weight:bold; +} + + +/**************************************** +* Custom reCaptcha Theme +****************************************/ +.bx-form-input-captcha-custom { + background-color: #b71800; + padding: 0.5em; + border-radius: 1em; + position: relative; + overflow: auto; + max-width: 480px; + font: 0.75em/1em Helvetica, Arial, sans-serif; + color: #ffffff; +} +.bx-form-input-captcha-custom a { + color: #ffffff; + text-decoration: none; +} +.bx-form-input-captcha-custom img, +.bx-form-input-captcha-custom #recaptcha_image { + width: 100% !important; + height: auto !important; + -webkit-border-radius: 0.5em; + -moz-border-radius: 0.5em; + border-radius: 0.5em; + -moz-background-clip: padding; + -webkit-background-clip: padding-box; + background-clip: padding-box; +} +.bx-form-input-captcha-custom .solution { + position: relative; + float: left; + width: 75%; +} +.bx-form-input-captcha-custom .solution-cnt { + margin-top: 0.5em; + padding: 1.2em 1em; + -webkit-border-radius: 0.5em; + -moz-border-radius: 0.5em; + border-radius: 0.5em; + -moz-background-clip: padding; + -webkit-background-clip: padding-box; + background-clip: padding-box; + background-color: #fbe098; + color: #000000; + display: block; +} +.bx-form-input-captcha-custom .solution-cnt input { + display: block; + width: calc(90% - 2px); + margin: 0.35em auto; + -webkit-appereance: none; + border: 1px solid #f7c236; + font: inherit; + font-size: 150%; + outline: none; +} +.bx-form-input-captcha-custom .solution-cnt input:focus { + border-color: #b71800; +} +.bx-form-input-captcha-custom .options { + position: relative; + float: right; + width: 25%; + +} +.bx-form-input-captcha-custom .options-cnt { + margin-top: 0.5em; + padding-left: 0.5em; + -webkit-border-radius: 0.5em; + -moz-border-radius: 0.5em; + border-radius: 0.5em; + -moz-background-clip: padding; + -webkit-background-clip: padding-box; + background-clip: padding-box; +} +.bx-form-input-captcha-custom .options-cnt a { + background-color: #c5523d; + display: block; + padding: 0.5em 1.0em; + border-top: 1px solid #000000; + border-left: 1px solid #000000; + border-right: 1px solid #000000; +} +.bx-form-input-captcha-custom .options-cnt a:first-child { + border-radius: 0.5em 0.5em 0 0; +} +.bx-form-input-captcha-custom .options-cnt a:last-child { + border-radius: 0 0 0.5em 0.5em; + border-bottom: 1px solid #000000; +} + + +/**************************************** +* Overwrite 3d Party MiniColors plug-in +****************************************/ +.bx-form-input-wrapper.bx-form-input-wrapper-text .minicolors-theme-bootstrap .minicolors-swatch { + top: 6px; + left: 6px; + + width: 25px; + width: 1.5625rem; + height: 25px; + height: 1.5625rem; + + border-radius: 20px; + border-radius: 1.25rem; +} + +/* auto-siggestion input */ + +.bx-form-value .bx-form-input-autotoken { + float:left; + padding:0px; + height:auto; + box-shadow: none; + padding: 2px; +} +.bx-form-value .bx-form-input-autotoken b { + cursor:pointer; + display:block; + float:left; + padding-right: 1.5em; + margin:0.1em; + font-weight:normal; + border-radius: 1.25rem; +} +.bx-form-value .bx-form-input-autotoken b.val-wo-icon { + padding-left: 1.5em; +} +.bx-form-value .bx-form-input-autotoken b:hover { + opacity:0.7; +} +.bx-form-value .bx-form-input-autotoken b:after { + font-family: 'sys-user', 'sys-user-fal'; + content: "\f00d"; + position:absolute; + padding:0 0.5em; + margin-left: 0.25em; + font-size:0.7em; + font-weight:bold; +} +.bx-form-value .bx-form-input-autotoken.bx-form-input-disabled b { + cursor: default; +} +.bx-form-value .bx-form-input-autotoken.bx-form-input-disabled b:after{ + display: none; +} +.bx-form-value .bx-form-input-autotoken input { + border:0; + margin:0; + padding:0 0 0 5px; + width:auto; + float:left; + box-shadow: none; +} +.bx-form-value .bx-form-input-autotoken .bx-def-thumb-size { + width: 2.5rem; + height: 2.5rem; + line-height: 2.5rem; + float:left; +} +.bx-form-value .bx-form-input-autotoken .bx-base-pofile-unit-wo-info { + display: inline-block; + vertical-align: middle; + + margin-right: 8px; + margin-right: 0.5rem; +} +.bx-form-value .bx-form-input-labels-sel b { + display:inline-block; + line-height:1.5rem; + font-size:85%; + padding-right:1em; + margin-top:0.625rem; + font-style:normal; +} +.bx-form-value .bx-form-input-labels-sel b:after { + display:none; +} +.select2-container { + width:100% !important; +} + +/* Location field */ + +.bx-form-input-location-cont:not(.minimized) .bx-form-input-location-country, +.bx-form-input-location-cont:not(.minimized) .bx-form-input-location-zip, +.bx-form-input-location-cont:not(.minimized) .bx-form-input-location-state, +.bx-form-input-location-cont:not(.minimized) .bx-form-input-location-city { + width:49%; +} + +.bx-form-input-location-street { + width:83%; +} + +.bx-form-input-location-street_number { + width:15%; +} + +.bx-form-input-location-street_number, +.bx-form-input-location-street, +.bx-form-input-location-state, +.bx-form-input-location-city { + margin-bottom:0.25rem; +} + +.bx-form-input-location-cont .bx-form-input-location-status-cont { + float:none; + width:98%; + line-height:normal; +} +.bx-form-input-location-cont.minimized .bx-form-input-location-status-cont { + display: flex; + flex-direction: column; + width: auto; +} +.bx-form-input-location-status { + float:left; +} +.bx-form-input-location-copyright { + float:right; +} +.bx-form-input-location-cont.minimized .bx-form-input-location-copyright { + float: none; + margin-top: 0.25rem; +} + +.bx-form-input-location-auto-cont { + display:table; +} +.bx-form-input-location-auto-cont > div { + display:table-cell; + vertical-align:middle; +} +.combodate { + display: flex; +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/css/general.css b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/css/general.css new file mode 100644 index 0000000000..d7a3559fd1 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/css/general.css @@ -0,0 +1,686 @@ + +.bx-page-image-container img, +.bx-page-html-container img { + max-width:100%; + height:auto; +} +.bx-page-html-container { + overflow:hidden; +} + +/* --------------- toolbar */ + +.bx-toolbar-anim { + -webkit-transition: all .25s ease-in-out; + -moz-transition: all .25s ease-in-out; + -o-transition: all .25s ease-in-out; + transition: all .25s ease-in-out +} + +.bx-toolbar-reset { + -webkit-transform: translateY(0); + -ms-transform: translateY(0); + transform: translateY(0) +} + +.bx-toolbar-up { + -webkit-transform: translateY(-100%); + -ms-transform: translateY(-100%); + transform: translateY(-100%) +} + +#bx-toolbar { + position:fixed; + width:100%; + height:48px; + height:3rem; +} + +.bx-toolbar-content { + display: -webkit-flex; + display: flex; + z-index: 500; + + -webkit-justify-content: flex-start; + justify-content: flex-start; + + -webkit-align-items: center; + align-items: center; + + -webkit-flex-flow: row nowrap; + flex-flow: row nowrap; +} +.bx-toolbar-content .bx-toolbar-item { + position: relative; + -webkit-flex: 0 1 auto; + -ms-flex: 0 1 auto; + flex: 0 1 auto; +} +.bx-toolbar-content .bx-toolbar-item.bx-ti-stretcher { + -webkit-flex-grow: 1; + flex-grow: 1; + white-space: nowrap; +} + +.bx-toolbar-content .bx-toolbar-item.bx-ti-logo { + white-space: nowrap; +} + +.bx-toolbar-content .bx-toolbar-item.bx-ti-logo img { + display: block; +} + +#bx-menu-toolbar-1-container, +#bx-menu-toolbar-2-container { + position:relative; +} + +#bx-logo-container { + -moz-box-sizing: border-box; + -ms-box-sizing: border-box; + box-sizing: border-box; + + height: 3rem; + margin:0 1.0rem; + + text-align: center; + font-size: 2rem; +} + +#bx-logo-container a { + position: relative; + display: block; + + text-decoration: none; +} + +#bx-logo-container a span { + position: relative; + display: block; + + max-width: 100%; + + line-height: 48px; + line-height: 3rem; + + white-space: nowrap; + overflow: hidden; + text-overflow: ellipsis; +} + +#bx-logo { + vertical-align:middle; +} + +/* --------------- Submenu */ +.bx-menu-main-bar-gap { + position: relative; +} +.bx-media-tablet .bx-menu-main-bar-gap.bx-def-page-width, +.bx-media-phone .bx-menu-main-bar-gap.bx-def-page-width { + width: 100%; +} +.bx-media-phone .bx-menu-main-bar-gap { + padding-left: 0; + padding-right: 0; +} +.bx-menu-main-bar-wrapper { + position: relative; + + border-top-left-radius: 0; + border-top-right-radius: 0; +} +.bx-menu-main-bar-wrapper:before, +.bx-menu-main-bar-wrapper:after { + display: block; + content: ""; + position: absolute; + top: 0; + width: 1.0rem; + height: 100%; + z-index: 1; +} +.bx-menu-main-bar-wrapper:before { + left: 0px; +} +.bx-menu-main-bar-wrapper:after { + right: 0px; +} +.bx-media-phone .bx-menu-main-bar-wrapper { + border-left-width: 0; + border-right-width: 0; + border-bottom-left-radius: 0; + border-bottom-right-radius: 0; +} +.bx-media-phone .bx-menu-main-bar-wrapper:before { + border-bottom-left-radius: 0; +} +.bx-media-phone .bx-menu-main-bar-wrapper:after { + border-bottom-right-radius: 0; +} + +.bx-menu-main-bar { + text-align: center; + + -webkit-overflow-scrolling: touch; +} +.bx-menu-main-bar:not(.bx-menu-more-auto) { + overflow-x: auto; +} + +.bx-menu-main-bar-cnt { + height: 2.5rem; +} +.bx-menu-main-bar-gap.bx-menu-main-bar-hidden, +.bx-menu-main-bar-wrapper.bx-menu-main-bar-hidden, +.bx-menu-main-bar.bx-menu-main-bar-hidden { + display: none; +} + + +/* --------------- content */ + +#bx-content-wrapper { + position: relative; + -webkit-flex-grow: 3; + flex-grow: 3; +} + +/* --------------- footer */ + +#bx-footer-wrapper { + position: relative; + + -webkit-flex-grow: 0; + flex-grow: 0; + + width: 100%; + bottom: 0; +} +#bx-footer-wrapper .bx-def-hr { + margin-top: 0px; +} +#bx-menu-bottom ul { + text-align: center; +} +#bx-menu-bottom ul li { + line-height: 2rem; +} +.bx-menu-switch-language-inline { + float: none; + clear: both; +} +.bx-menu-switch-language-inline .bx-menu-hor { + text-align: center; +} +.bx-menu-switch-language-inline .bx-menu-hor li { + float: none; + display: inline-block; +} + +/* --------------- System objects like Views, Votes, Comments, etc, */ +.sys-action-counter.sys-ac-hidden { + display: none; +} +.sys-action-counter.sys-action-counter-iconset .sys-ac-link { + padding-left: 0.75rem; +} +.bx-media-phone .sys-action-counter.sys-action-counter-iconset .sys-ac-link, +.bx-media-tablet .bx-layout-column-thin .sys-action-counter.sys-action-counter-iconset .sys-ac-link, +.bx-media-tablet .bx-layout-column-half .sys-action-counter.sys-action-counter-iconset .sys-ac-link { + padding-left: 1.0rem; +} + +.sys-action-counter.sys-action-counter-iconset .bx-def-icon-size { + width: 1.5rem; + height: 1.5rem; +} +.sys-action-counter.sys-action-counter-iconset .bx-base-pofile-unit-wo-info, +.sys-action-counter.sys-action-counter-iconset .sys-action-counter-icon { + margin-left: -0.5rem; +} +.bx-media-phone .sys-action-counter.sys-action-counter-iconset .bx-base-pofile-unit-wo-info, +.bx-media-phone .sys-action-counter.sys-action-counter-iconset .sys-action-counter-icon, +.bx-media-tablet .bx-layout-column-thin .sys-action-counter.sys-action-counter-iconset .bx-base-pofile-unit-wo-info, +.bx-media-tablet .bx-layout-column-thin .sys-action-counter.sys-action-counter-iconset .sys-action-counter-icon, +.bx-media-tablet .bx-layout-column-half .sys-action-counter.sys-action-counter-iconset .bx-base-pofile-unit-wo-info, +.bx-media-tablet .bx-layout-column-half .sys-action-counter.sys-action-counter-iconset .sys-action-counter-icon { + margin-left: -0.75rem; +} + +/* --------------- 'Add to Homescreen' popup */ +.ath-container { + color: #333; +} + +/* --------------- Account */ +div.bx-account-unit-online { + position: absolute; + right: 0; + bottom: 0; + width: 0.625rem; + height: 0.625rem; + border: 1px solid #ffffff; + border-radius: 0.625rem; + background-color: #7ed321; +} + +/* --------------- Mentions */ + +.bx-mention-row{ + display: flex !important; + align-items: center; +} + +.bx-mention-row img { + width:1rem; + height:1rem; + vertical-align:middle; + +} + +.bx-mention-row span { + vertical-align:middle; + margin-right: 10px; +} + +/* --------------- Profile Avatar */ +.bx-profile-avatar { + overflow: hidden; +} + +.bx-profile-avatar-cnt { + display: -webkit-flex; + display: flex; + -webkit-align-items: center; + align-items: center; + -webkit-justify-content: flex-start; + justify-content: flex-start; +} + +.bx-profile-avatar .bx-def-ava-size { + width: 3.75rem; + height: 3.75rem; +} + +.bx-profile-avatar .bx-def-ava-size, +.bx-profile-avatar div.bx-def-unit-img p.bx-base-pofile-unit-thumb.bx-def-ava-size { + line-height: 3.5rem; + font-size: 2.325rem; +} + +.bx-profile-avatar .bx-pa-img, +.bx-profile-avatar .bx-pa-actions { + -webkit-flex: 0 2 auto; + flex: 0 2 auto; +} + +.bx-profile-avatar .bx-pa-info { + -webkit-flex: 1 1 auto; + flex: 1 1 auto; + overflow: hidden; +} + +.bx-profile-avatar .bx-pa-info-cnt { + display: -webkit-flex; + display: flex; + -webkit-align-items: flex-start; + align-items: flex-start; + -webkit-flex-direction: column; + flex-direction: column; +} + +.bx-profile-avatar .bx-pai-line, +.bx-profile-avatar .bx-pai-line a { + max-width: 100%; +} +.bx-profile-avatar .bx-pai-line a { + display: inline-block; + overflow: hidden; + text-overflow: ellipsis; +} + +.bx-profile-avatar .bx-pa-action { + width: 2rem; + height: 2rem; + + border-radius: 2rem; +} +.bx-profile-avatar .bx-pa-action .sys-icon { + display: inline-block; + text-align: center; + line-height: 1.5rem; + width: 1.5rem; + height: 1.5rem; + font-size: 1.0rem; +} + +.bx-profile-avatar-switcher .bx-def-hr { + display: none; +} +.bx-profile-avatar-switcher .sys-profile-switch-row { + padding-left: 0px; + padding-right: 0px; +} + + +/* --------------- Profile Stats */ +.bx-profile-stats { + overflow: hidden; +} + +.bx-profile-stats .bx-ps-user-cnt { + display: -webkit-flex; + display: flex; + -webkit-align-items: center; + align-items: center; + -webkit-justify-content: flex-start; + justify-content: flex-start; +} + +.bx-profile-stats .bx-ps-user-cnt .bx-def-ava-size { + width: 3.75rem; + height: 3.75rem; +} + +.bx-profile-stats .bx-ps-user-cnt .bx-def-ava-size, +.bx-profile-stats .bx-ps-user-cnt div.bx-def-unit-img p.bx-base-pofile-unit-thumb.bx-def-ava-size { + line-height: 3.5rem; + font-size: 2.325rem; +} + +.bx-profile-stats .bx-ps-user-img { + -webkit-flex: 0 2 auto; + flex: 0 2 auto; +} + +.bx-profile-stats .bx-ps-user-info { + -webkit-flex: 1 1 auto; + flex: 1 1 auto; + overflow: hidden; +} + +.bx-profile-stats .bx-ps-user-info-cnt { + display: -webkit-flex; + display: flex; + -webkit-align-items: flex-start; + align-items: flex-start; + -webkit-flex-direction: column; + flex-direction: column; +} +.bx-profile-stats .bx-ps-user-line, +.bx-profile-stats .bx-ps-user-line a { + max-width: 100%; +} +.bx-profile-stats .bx-ps-user-line a { + display: inline-block; + overflow: hidden; + text-overflow: ellipsis; +} + +.bx-menu-vertical-more-less li.bx-psmi-show-more:hover, +.bx-menu-vertical-more-less li.bx-psmi-show-less:hover { + background-color: transparent; +} + + +/* --------------- Join/Login Forms */ + +.sys-jf .bx-form-advanced .bx-form-element .bx-form-input-submit.bx-btn, +.sys-lf .bx-form-advanced .bx-form-element .bx-form-input-submit.bx-btn { + width: 100%; + -webkit-justify-content: center; + justify-content: center; + text-align: center; +} +#bx-form-element-submit_text .bx-form-value { + text-align: right; +} +.sys-jf-login .bx-btn, +.sys-lf-join .bx-btn { + display: block; +} + + +/* --------------- Create Post Form */ + +.sys-create-post-form { + position: relative; +} + +.sys-create-post-form .bx-loading-ajax { + display: -webkit-flex; + display: flex; + -webkit-align-items: center; + align-items: center; + -webkit-justify-content: center; + justify-content: center; + + top: 0; + width: 100%; + height: 100%; +} + +.sys-cpf-header { + position: relative; + display: -webkit-flex; + display: flex; + -webkit-justify-content: space-between; + justify-content: space-between; + + height: 3.125rem; + + border-bottom: 2px solid rgba(0,0,0,0.1); +} +.sys-cpf-title, +.sys-cpf-submenu { + position: relative; + -webkit-flex: 0 1 auto; + -ms-flex: 0 1 auto; + flex: 1 1 auto; + line-height: 3.125rem; +} +.sys-cpf-title, +.sys-cpf-submenu-cnt { + height: 3.125rem; +} + +.sys-cpf-title { + -webkit-flex-grow: 3; + flex-grow: 3; + + max-width: 20%; + + white-space: nowrap; + font-size: 1rem; + font-weight: 400; +} +.sys-cpf-title-cnt { + white-space: nowrap; + overflow: hidden; + text-overflow:ellipsis; +} +.sys-cpf-submenu { + max-width: 80%; +} +.bx-media-phone .sys-cpf-title { + max-width: 30%; +} +.bx-media-phone .sys-cpf-submenu { + max-width: 70%; +} +.sys-cpf-submenu-cnt ul.bx-menu-custom.bx-menu-custom-hor.bx-menu-more-auto:not(.bx-menu-submenu-more-auto) { + display: -webkit-flex; + display: flex; + -webkit-justify-content: flex-end; + justify-content: flex-end; +} +.sys-cpf-submenu-cnt ul.bx-menu-submenu-more-auto { + line-height: normal; +} +.sys-cpf-submenu-cnt ul li { + border-radius: 0; + + white-space: nowrap; +} +.sys-cpf-submenu-cnt ul:not(.bx-menu-submenu-more-auto) > li { + -webkit-flex: 0 1 auto; + -ms-flex: 0 1 auto; + flex: 0 1 auto; + + height: 3.125rem; + border-bottom: 2px solid transparent; + + line-height: 3.125rem; +} +.sys-cpf-submenu-cnt ul li > span { + margin: 0; + padding: 0; +} +.sys-cpf-submenu-cnt ul li:not(.bx-menu-item-more-auto) a .sys-icon { + display: none; +} +.sys-cpf-submenu-cnt ul li:not(.bx-menu-item-more-auto) a span, +.sys-cpf-submenu-cnt ul.bx-menu-custom.bx-menu-custom-ver.bx-menu-submenu-more-auto li:not(.bx-menu-item-more-auto) a span { + margin: 0; +} +.sys-cpf-submenu-cnt ul li.bx-menu-tab-active { + border-bottom: 2px solid #364f6b; +} +.sys-cpf-form { + position: relative; +} +.sys-cpf-form:not(.sys-cpf-loading) { + -webkit-animation: sys-cpf-scale-in 0.4s cubic-bezier(0.37, 0.82, 0.2, 1); + animation: sys-cpf-scale-in 0.4s cubic-bezier(0.37, 0.82, 0.2, 1); +} +.sys-cpf-form .bx-uploader-ghost .bx-base-general-icon-wrapper img { + max-width: 9.375rem; +} +.sys-cpf-close { + position: absolute; + display: none; + + right: 0; + bottom: 0; +} + +@keyframes sys-cpf-scale-in { + 0% { + opacity: 0; + transform: scale(0.9); + } + 100% { + opacity: 1; + transform: scale(1.0); + } +} + +@-webkit-keyframes sys-cpf-scale-in { + 0% { + opacity: 0; + transform: scale(0.9); + } + 100% { + opacity: 1; + transform: scale(1.0); + } +} + +/* --------------- Account Unit */ +.bx-account-unit .bx-def-unit-img, +.bx-account-unit-wo-info .bx-def-unit-img { + position: relative; + overflow: visible; +} + + +/* --------------- Author Info */ +.sys-author-profile ul.bx-menu-custom.bx-menu-custom-hor { + webkit-align-items: center; + align-items: center; + -webkit-flex-wrap: wrap; + flex-wrap: wrap; + + line-height: 0.625rem; +} +.sys-author-profile ul.bx-menu-custom.bx-menu-custom-hor > li.bx-menu-item-nl { + display: none; +} +.sys-author-profile .bx-menu-custom.bx-menu-custom-hor > li > span { + margin-right: 0; +} +.sys-author-profile .bx-menu-custom.bx-menu-custom-hor > li > span.bx-base-profile-unit-meta-item { + padding: 0.25rem; + white-space: nowrap; +} +.sys-author-profile .bx-menu-custom.bx-menu-custom-hor > li:first-child .bx-base-general-unit-meta-div { + display: none; +} + +/* --------------- Author Info */ + +audio.bx-player-embed, +video.bx-player-embed { + width:100vw; + height:100vh; +} + +/* --------------- Search */ + +.bx-sys-search-results-pages { + text-align:left; + line-height:150%; +} + +.bx-page-block-container .bx-search-results:first-child { + padding-top:0; +} + +/* --------------- Content loader placeholder */ + +@-webkit-keyframes bxPlaceHolderShimmer { + 0% { + background-position: -468px 0; + } + 100% { + background-position: 468px 0; + } +} + +@keyframes bxPlaceHolderShimmer { + 0% { + background-position: -468px 0; + } + 100% { + background-position: 468px 0; + } +} + +.bx-cont-ph-inline, +.bx-cont-ph { + -webkit-animation-duration: 1s; + animation-duration: 1s; + -webkit-animation-fill-mode: forwards; + animation-fill-mode: forwards; + -webkit-animation-iteration-count: infinite; + animation-iteration-count: infinite; + -webkit-animation-name: bxPlaceHolderShimmer; + animation-name: bxPlaceHolderShimmer; + -webkit-animation-timing-function: linear; + animation-timing-function: linear; + background: #f6f7f8; + background: -webkit-gradient(linear, left top, right top, color-stop(8%, #eeeeee), color-stop(18%, #dddddd), color-stop(33%, #eeeeee)); + background: -webkit-linear-gradient(left, #eeeeee 8%, #dddddd 18%, #eeeeee 33%); + background: linear-gradient(to right, #eeeeee 8%, #dddddd 18%, #eeeeee 33%); + -webkit-background-size: 800px 104px; + background-size: 800px 104px; + position: relative; +} + +.bx-cont-ph-inline { + display:inline-block; +} +.bx-embeded-image{ + display: none; +} \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/css/score.css b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/css/score.css new file mode 100644 index 0000000000..d0c2f5d925 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/css/score.css @@ -0,0 +1,60 @@ +/*-- +import url(../../../../../../../template/css/score.css); +--*/ + +/*--- Voted By ---*/ +div.bx-score-by-list {} +div.bx-score-by-list-cnt { + max-height: 12.5rem; + min-width: 13.75rem; + overflow: auto; +} +div.bx-score-by-list div.bx-base-pofile-unit { + float: none; + margin-right: 0px; + margin-bottom: 0px; +} +div.bx-score-by-item { + display: -webkit-flex; + display: flex; + align-items: center; + -webkit-align-items: center; + flex-wrap: nowrap; + -webkit-flex-wrap: nowrap; +} +div.bx-score-by-item .bx-score-bi-user, +div.bx-score-by-item .bx-score-bi-info, +div.bx-score-by-item .bx-score-bi-vote { + -webkit-flex: 0 1 auto; + -ms-flex: 0 1 auto; + flex: 0 1 auto; +} +div.bx-score-by-item .bx-score-bi-info { + -webkit-flex-grow: 3; + flex-grow: 3; +} +div.bx-score-by-item .bx-score-bi-vote { + width: 1.25rem; + height: 1.25rem; +} + + +/*--- Counter Styles ---*/ +.bx-score-counter-wrapper.bx-sc-hidden { + display: none; +} +.bx-score-counter .bx-score-counter-label .bx-score-counter-text { + width: auto; + height: auto; + margin-left: 0.5rem; + margin-right: 0.5rem; +} +.bx-base-general-entity-actions .bx-menu-custom-hor.bx-menu-more-auto .bx-score-counter-holder { + border-width: 0; +} +.bx-base-general-entity-actions .bx-menu-custom-hor.bx-menu-more-auto .bx-score-counter-holder.bx-score-ch-divided { + margin-left: 0.125rem; +} +.bx-base-general-entity-actions .bx-menu-custom-hor.bx-menu-more-auto .bx-score-counter-holder .bx-score-counter-label { + padding: 0; +} \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/css/vote.css b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/css/vote.css new file mode 100644 index 0000000000..878388f115 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/css/vote.css @@ -0,0 +1,240 @@ +.bx-vote .sys-action-element-holder .sys-action-do-icon svg, +.bx-vote-counter .bx-vote-counter-label .bx-vote-counter-icon svg { + width: 1.25rem; + height: 1.25rem; +} +.bx-vote .bx-vote-counter .bx-vote-counter-label { + padding: 0; +} +.bx-vote .bx-vote-counter .bx-vote-counter-label .bx-vote-counter-text { + margin: 0; +} + +/*----------------------------------*/ +/*--- Likes based Element Styles ---*/ +/*----------------------------------*/ +.bx-vote-counter-likes span.bx-vote-counter-text { + width: auto; + height: auto; +} + +/*--------------------------------------*/ +/*--- Reactions based Element Styles ---*/ +/*--------------------------------------*/ +.bx-vote-counter-wrapper-reactions .bx-vote-counter { + display: inline-block; +} +.bx-vote-counter-wrapper-reactions.bx-vote-counter-wrapper-reactions-compound { + position: relative; +} +.bx-vote-counter-wrapper-reactions.bx-vote-counter-wrapper-reactions-compound .bx-vote-counter { + display: block; +} +.bx-vote-counter-wrapper-reactions.bx-vote-counter-wrapper-reactions-divided a.bx-vote-counter { + margin-right: 0.5rem; +} +.bx-media-phone .bx-vote-counter-wrapper-reactions.bx-vote-counter-wrapper-reactions-compound .sys-ac-link, +.bx-media-tablet .bx-layout-column-thin .bx-vote-counter-wrapper-reactions.bx-vote-counter-wrapper-reactions-compound .sys-ac-link, +.bx-media-tablet .bx-layout-column-half .bx-vote-counter-wrapper-reactions.bx-vote-counter-wrapper-reactions-compound .sys-ac-link { + padding-left: 1.0rem; +} +.bx-vote-counter-wrapper-reactions.bx-vote-counter-wrapper-reactions-compound a.bx-vote-counter.total-count, +.bx-vote-counter-wrapper-reactions.bx-vote-counter-wrapper-reactions-compound span.bx-vote-counter.total-count { + width: auto; + height: auto; + margin-left: 0.5rem; + margin-right: 0.5rem; +} +.bx-vote-counter-wrapper-reactions.bx-vote-counter-wrapper-reactions-compound a.bx-vote-counter.total-count .sys-action-counter-text:first-child, +.bx-vote-counter-wrapper-reactions.bx-vote-counter-wrapper-reactions-compound span.bx-vote-counter.total-count .sys-action-counter-text:first-child { + margin-left: 0; +} +.bx-vote-counter-wrapper-reactions.bx-vote-counter-wrapper-reactions-compound span.bx-vote-counter:not(.total-count) { + margin-left: -0.5rem; +} +.bx-media-phone .bx-vote-counter-wrapper-reactions.bx-vote-counter-wrapper-reactions-compound span.bx-vote-counter:not(.total-count), +.bx-media-tablet .bx-layout-column-thin .bx-vote-counter-wrapper-reactions.bx-vote-counter-wrapper-reactions-compound span.bx-vote-counter:not(.total-count), +.bx-media-tablet .bx-layout-column-half .bx-vote-counter-wrapper-reactions.bx-vote-counter-wrapper-reactions-compound span.bx-vote-counter:not(.total-count) { + margin-left: -0.75rem; +} +.bx-vote-counter-wrapper-reactions.bx-vote-counter-wrapper-reactions-compound .bx-vote-counter-label { + padding: 0; +} +.bx-vote-counter-wrapper-reactions.bx-vote-counter-wrapper-reactions-compound span.bx-vote-counter:not(.total-count) span.bx-vote-counter-text { + display: none; +} +.bx-vote-counter-wrapper-reactions.bx-vc-hidden, +.bx-vote-counter-wrapper-reactions .bx-vote-counter.bx-vc-hidden { + display: none; +} +.bx-menu-object-sys_vote_reactions_do li.bx-menu-item { + padding: 0.25rem; +} +.bx-menu-object-sys_vote_reactions_do li.bx-menu-item .sys-icon { + width: 2rem; + height: 2rem; + font-size: 1.5rem; +} + +/*----------------------------------*/ +/*--- Stars based Element Styles ---*/ +/*----------------------------------*/ +.bx-vote-stars { + -webkit-flex-direction: column; + flex-direction: column; + -webkit-align-items: flex-start; + align-items: flex-start; +} +.bx-vote-stars .bx-vote-element-holder a.bx-vote-button, +.bx-vote-stars .bx-vote-element-holder i.bx-vote-star, +.bx-vote-stars .bx-vote-element-holder span.bx-vote-star { + position: relative; + display: inline-block; + vertical-align: top; + height: 1rem; + width: 1rem; + margin: 0; + padding: 0; + text-align: center; +} + + +/*--- Voted By ---*/ +div.bx-vote-by-list {} +div.bx-vote-by-list-cnt { + max-height: 12.5rem; + min-width: 13.75rem; + overflow: auto; +} +div.bx-vote-by-list div.bx-base-pofile-unit { + float: none; + margin-right: 0px; + margin-bottom: 0px; +} +.bx-vote-bls-header { + display: -webkit-flex; + display: flex; + + margin: -1.25rem -1.25rem 0 -1.25rem; +} +.bx-vote-bls-content { + margin-left: -0.5rem; + margin-right: -0.5rem; +} +.bx-vote-bls-title, +.bx-vote-bls-submenu { + -webkit-flex: 0 1 auto; + -ms-flex: 0 1 auto; + flex: 0 1 auto; + line-height: 3.125rem; +} +.bx-vote-bls-title, +.bx-vote-bls-submenu-cnt, +.bx-vote-bls-filler { + height: 3.125rem; +} +.bx-vote-bls-title, +.bx-vote-bls-filler { + -webkit-flex-grow: 3; + flex-grow: 3; + + border-bottom: 2px solid rgba(232, 232, 232, 1.0); +} +.bx-vote-bls-title { + display: none; + + white-space: nowrap; + font-size: 1rem; + font-weight: 400; +} +.bx-vote-bls-submenu { + overflow-x: auto; + overflow-y: hidden; + + -webkit-overflow-scrolling: touch; +} +.bx-vote-bls-submenu-cnt { + box-sizing: border-box; + padding: 0 0.5rem; + border-bottom-width: 2px; + border-bottom-style: solid; +} +.bx-vote-bls-submenu::-webkit-scrollbar { + width: 0.5rem; +} +.bx-vote-bls-submenu::-webkit-scrollbar-track { + -webkit-border-radius: 0.5rem; + border-radius: 0.5rem; + + background-color: rgba(0, 0, 0, 0.1); +} +.bx-vote-bls-submenu::-webkit-scrollbar-thumb { + -webkit-border-radius: 0.5rem; + border-radius: 0.5rem; + + background: rgba(255, 255, 255, 0.9); + -webkit-box-shadow: inset 0 0 1px rgba(0, 0, 0, 0.5); +} +.bx-vote-bls-submenu::-webkit-scrollbar-thumb:window-inactive { + background: rgba(255, 255, 255, 0.4); +} +.bx-vote-bls-submenu-cnt ul { + display: -webkit-flex; + display: flex; +} +.bx-vote-bls-submenu-cnt ul li { + -webkit-flex: 0 1 auto; + -ms-flex: 0 1 auto; + flex: 0 1 auto; + box-sizing: border-box; + height: 3.125rem; + + border-bottom: 2px solid transparent; + border-radius: 0; + + line-height: 3.0rem; + white-space: nowrap; +} +.bx-vote-bls-submenu-cnt ul li .bx-stl-mil, +.bx-vote-bls-submenu-cnt ul li .bx-stl-mil-wo-gaps { + border-width: 0; +} +.bx-vote-bls-submenu-cnt ul li.bx-menu-inter-pas .bx-menu-item-cnt, +.bx-vote-bls-submenu-cnt ul li.bx-menu-inter-act .bx-menu-item-inter { + line-height: 3.0rem; +} +.bx-vote-bls-submenu-cnt ul li a.bx-menu-item-inter, +.bx-vote-bls-submenu-cnt ul li div.bx-menu-item-inter { + padding-top: 0; + padding-bottom: 0; +} +.bx-vote-bls-submenu-cnt ul li.bx-menu-inter-act > div { + font-weight: bold; +} +.bx-vote-bls-content .bx-vote-by-list:not(.bx-vote-bl-summary) { + display: none; +} +.bx-vote-bls-content .bx-vote-by-items { + padding-left: 0.5rem; + padding-right: 0.5rem; +} +.bx-vote-bls-content .bx-vote-by-item { + position: relative; + display: -webkit-flex; + display: flex; + -webkit-justify-content: space-between; + justify-content: space-between; + -webkit-align-items: center; + align-items: center; +} +.bx-vote-bls-content .bx-vote-by-item:first-child { + padding-top: 1rem; +} +.bx-vote-bls-content .bx-vote-by-item:last-child { + padding-bottom: 0; +} + +.bx-vote-bls-content .bx-vote-by-item:before, +.bx-vote-bls-content .bx-vote-by-item:after { + display: none; +} \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/logo_main.html b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/logo_main.html new file mode 100644 index 0000000000..0214084529 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/logo_main.html @@ -0,0 +1,8 @@ + + __logo__ + + + + + + \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/menu_icon.html b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/menu_icon.html new file mode 100644 index 0000000000..fcea8e9d9d --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/menu_icon.html @@ -0,0 +1,3 @@ + + +__icon__ \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/score_counter_wrapper.html b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/score_counter_wrapper.html new file mode 100644 index 0000000000..8238afdf1b --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/score_counter_wrapper.html @@ -0,0 +1,6 @@ + + + __counter__ + __script__ + + \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/score_element_block.html b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/score_element_block.html new file mode 100644 index 0000000000..34e12bc74e --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/score_element_block.html @@ -0,0 +1,21 @@ + + + + __do_vote__ + + style="display:none">__counter__ + + + + style="display:none">__counter__ + + + __do_vote__ + + style="display:none">__counter__ + + + + __legend__ + __script__ + \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/score_element_inline.html b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/score_element_inline.html new file mode 100644 index 0000000000..687cc216b5 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/score_element_inline.html @@ -0,0 +1,7 @@ + + + __do_vote__ style="display:none">__counter__ + style="display:none">__counter__ + __do_vote__ style="display:none">__counter__ + __script__ + \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseAuditGrid.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseAuditGrid.php new file mode 100644 index 0000000000..76492c5635 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseAuditGrid.php @@ -0,0 +1,242 @@ +_oTemplate->addCss(array_merge($aCssCalendar, ['manage_tools.css'])); + $this->_oTemplate->addJs(array_merge($aJsCalendar, ['BxDolAuditManageTools.js', 'BxDolGrid.js'])); + $this->_oTemplate->addJsTranslation(['_sys_grid_search']); + + return $this->getJsCode() . parent::getCode($isDisplayHeader); + } + + public function getJsCode() + { + $aParams = array( + 'sObjName' => $this->sJsObject, + 'aHtmlIds' => array(), + 'oRequestParams' => array(), + 'sObjNameGrid' => 'sys_audit_administration' + ); + return BxDolTemplate::getInstance()->_wrapInTagJsCode("var " . $this->sJsObject . " = new BxDolAuditManageTools(" . json_encode($aParams) . ");"); + } + + protected function _getCellAdded($mixedValue, $sKey, $aField, $aRow) + { + return parent::_getCellDefault(bx_time_js($mixedValue), $sKey, $aField, $aRow); + } + + protected function _getCellAction ($mixedValue, $sKey, $aField, $aRow) + { + return parent::_getCellDefault(_t($aRow['action_lang_key'], $aRow['action_lang_key_params']), $sKey, $aField, $aRow); + } + + protected function _getCellContentId ($mixedValue, $sKey, $aField, $aRow) + { + $mixedValue = ''; + if ($aRow['content_id'] > 0){ + $sLink = BxDolRequest::serviceExists($aRow['content_module'], 'get_link') ? BxDolService::call($aRow['content_module'], 'get_link', array($aRow['content_id'])) : ''; + $sTitle = BxDolRequest::serviceExists($aRow['content_module'], 'get_title') ? BxDolService::call($aRow['content_module'], 'get_title', array($aRow['content_id'])) : $aRow['content_title']; + if ($sLink){ + $mixedValue = BxDolTemplate::getInstance()->parseLink($sLink, $sTitle); + } + else{ + $mixedValue = $sTitle; + } + } + $sLinkExtras = ''; + $aExtras = unserialize($aRow['extras']); + if (isset($aExtras['display_info'])){ + $sLinkExtras = $this->_oTemplate->parseLink('javascript:void(0)',' ' , array( + 'title' => '', + 'bx_grid_action_single' => 'show_stat', + 'bx_grid_action_data' => json_encode($aExtras) + )); + } + + return parent::_getCellDefault($mixedValue . $sLinkExtras, $sKey, $aField, $aRow); + } + + protected function _getCellContextProfileId ($mixedValue, $sKey, $aField, $aRow) + { + if ($aRow['context_profile_id'] > 0){ + $oProfile = BxDolProfile::getInstance($aRow['context_profile_id']); + if ($oProfile){ + $mixedValue = BxDolTemplate::getInstance()->parseLink($oProfile->getUrl(), $oProfile->getDisplayName()); + } + else{ + $mixedValue = $aRow['context_profile_title']; + } + } + else{ + $mixedValue = ''; + } + return parent::_getCellDefault($mixedValue, $sKey, $aField, $aRow); + } + + protected function _getCellContentModule ($mixedValue, $sKey, $aField, $aRow) + { + $oModule = bxDolModule::getInstance($aRow['content_module']); + if($oModule && $oModule instanceof iBxDolContentInfoService){ + $mixedValue = $oModule->_aModule['title']; + } + else{ + $mixedValue = $aRow['content_module']; + } + return parent::_getCellDefault($mixedValue, $sKey, $aField, $aRow); + } + + + protected function _getCellProfileId ($mixedValue, $sKey, $aField, $aRow) + { + if ($aRow['profile_id'] > 0){ + $oProfile = BxDolProfile::getInstance($aRow['profile_id']); + if ($oProfile){ + $mixedValue = BxDolTemplate::getInstance()->parseLink($oProfile->getUrl(), $oProfile->getDisplayName()); + } + else{ + $mixedValue = $aRow['profile_title']; + } + } + else{ + $mixedValue = ''; + } + return parent::_getCellDefault($mixedValue, $sKey, $aField, $aRow); + } + + protected function _getCellAuthorId ($mixedValue, $sKey, $aField, $aRow) + { + if ($aRow['profile_id'] > 0){ + $oProfile = BxDolProfile::getInstance($aRow['profile_id']); + if ($oProfile){ + $mixedValue = BxDolTemplate::getInstance()->parseLink($oProfile->getUrl(), $oProfile->getDisplayName()); + } + else{ + $mixedValue = $aRow['profile_title']; + } + } + else{ + $mixedValue = ''; + } + return parent::_getCellDefault($mixedValue, $sKey, $aField, $aRow); + } + + function _getFilterControls() + { + parent::_getFilterControls(); + return $this->_getFilterSelectOne($this->_sFilter1Name, $this->_sFilter1Value, $this->_aFilter1Values) . + $this->_getFilterSelectOne($this->_sFilterProfileName, $this->_sFilterProfileValue, $this->_aFilterProfileValues) . + $this->_getFilterSelectOne($this->_sFilterActionName, $this->_sFilterActionValue, $this->_aFilterActionValues) . + $this->_getFilterDatePicker($this->_sFilterFromDateName, $this->_sFilterFromDateValue) . + $this->_getFilterLabel('-') . + $this->_getFilterDatePicker($this->_sFilterToDateName, $this->_sFilterToDateValue) . + $this->_getFilterButton(); + } + + protected function _getFilterSelectOne($sFilterName, $sFilterValue, $aFilterValues) + { + if(empty($sFilterName) || empty($aFilterValues)) + return ''; + + foreach($aFilterValues as $sKey => $sValue) + $aFilterValues[$sKey] = _t($sValue); + + $aInputModules = array( + 'type' => 'select', + 'name' => $sFilterName, + 'attrs' => array( + 'id' => 'bx-grid-' . $sFilterName . '-' . $this->_sObject, + // 'onChange' => 'javascript:' . $this->sJsObject . '.onChangeFilter(this)' + ), + 'value' => $sFilterValue, + 'values' => $aFilterValues + ); + + $oForm = new BxTemplFormView(array()); + return $oForm->genRow($aInputModules); + } + + protected function _getFilterLabel($sFilterValue) + { + $aInputModules = array( + 'type' => 'value', + 'value' => $sFilterValue, + 'tr_attrs' => array('class' => 'bx-grid-controls-filter-label'), + ); + + $oForm = new BxTemplFormView(array()); + return $oForm->genRow($aInputModules, true); + } + + protected function _getFilterDatePicker($sFilterName, $sFilterValue) + { + if(empty($sFilterName)) + return ''; + + $aInputModules = array( + 'type' => 'datepicker', + 'name' => $sFilterName, + 'attrs' => array( + 'id' => 'bx-grid-' . $sFilterName . '-' . $this->_sObject, + ), + 'tr_attrs' => array('class' => 'bx-grid-controls-filter-datepicker'), + 'value' => $sFilterValue, + ); + + $oForm = new BxTemplFormView(array()); + return $oForm->genRow($aInputModules, true); + } + + protected function _getFilterButton() + { + $aInputModules = array( + 'type' => 'button', + 'name' => 'button', + 'attrs' => array( + 'id' => 'bx-grid-button-' . $this->_sObject, + 'onClick' => 'javascript:' . $this->sJsObject . '.onChangeFilter(this)', + ), + 'tr_attrs' => array('class' => 'bx-grid-controls-filter-button'), + 'value' => _t('_Search'), + ); + + $oForm = new BxTemplFormView(array()); + return $oForm->genRow($aInputModules, true); + } + + public function performActionShowStat() + { + $aTmp2 = bx_get('ids'); + $sData = $aTmp2[0]; + $aData = json_decode($sData, true); + $sContentInfo = ''; + if (isset($aData['display_info'])){ + foreach($aData['display_info'] as $sKey => $sValue) + $sContentInfo .= $sKey . ': ' . $sValue; + } + + $sContent = BxTemplStudioFunctions::getInstance()->popupBox('sys-audit-content-info', _t('_sys_audit_content_info_popup_title'), $sContentInfo); + + echoJson(array('popup' => $sContent)); + } + +} + +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseCmts.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseCmts.php new file mode 100644 index 0000000000..198ce4dc38 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseCmts.php @@ -0,0 +1,1779 @@ +_sTmplNameItem = 'comment.html'; + $this->_sTmplNameItemContent = 'comment_content.html'; + + $this->_sJsObjClass = 'BxDolCmts'; + $this->_sJsObjName = 'oCmts' . bx_gen_method_name($sSystem, array('_' , '-')) . '_' .str_replace('-', 'n', $iId); + $this->_sStylePrefix = isset($this->_aSystem['root_style_prefix']) ? $this->_aSystem['root_style_prefix'] : 'cmt'; + + $sHtmlId = str_replace(array('_' , ' '), array('-', '-'), $sSystem) . '-' . $iId; + + $this->_aHtmlIds = array( + 'main' => 'bx-cmt-' . $sHtmlId, + 'counter' => 'bx-cmt-counter-' . $sHtmlId + ); + + $this->_aElementDefaults = [ + 'show_do_comment_as_button' => false, + 'show_do_comment_as_button_small' => false, + 'show_do_comment_icon' => true, + 'show_do_comment_label' => false, + 'show_counter' => true, + 'show_counter_only' => true, + 'show_counter_empty' => false, + 'show_counter_reversed' => false, + 'recalculate_counter' => false + ]; + $this->_aElementDefaultsApi = array_merge($this->_aElementDefaults, [ + 'show_counter' => true, + ]); + $this->_aElementParamsApi = []; + + $this->_aAclId2Name = array(); + $aAclLevels = BxDolAcl::getInstance()->getMemberships(false, false, false); + foreach($aAclLevels as $iAclId => $sAclName) + $this->_aAclId2Name[$iAclId] = str_replace('_', '-', str_replace('_adm_prm_txt_level_', '', $sAclName)); + + if(empty(self::$_sTmplContentElementBlock)) + self::$_sTmplContentElementBlock = $this->_oTemplate->getHtml('comment_element_block.html'); + + if(empty(self::$_sTmplContentElementInline)) + self::$_sTmplContentElementInline = $this->_oTemplate->getHtml('comment_element_inline.html'); + + if(empty(self::$_sTmplContentDoCommentLabel)) + self::$_sTmplContentDoCommentLabel = $this->_oTemplate->getHtml('comment_do_comment_label.html'); + + if(empty(self::$_sTmplContentCounter)) + self::$_sTmplContentCounter = $this->_oTemplate->getHtml('comment_counter.html'); + + $this->_oTemplate->addJsTranslation('_sys_txt_cmt_loading'); + } + + /** + * Add comments CSS/JS + */ + public function addCssJs($aBp = [], $aDp = []) + { + $bDynamicMode = isset($aDp['dynamic_mode']) && $aDp['dynamic_mode'] === true; + + $oForm = BxDolForm::getObjectInstance($this->_sFormObject, $this->_sFormDisplayPost); + $oForm->addCssJs(); + + $sResult = $this->_oTemplate->addCss([ + BX_DIRECTORY_PATH_PLUGINS_PUBLIC . 'photo-swipe/|photoswipe.css', + BX_DIRECTORY_PATH_PLUGINS_PUBLIC . 'photo-swipe/default-skin/|default-skin.css', + ], $bDynamicMode); + + $sResult .= $this->_oTemplate->addJs([ + 'photo-swipe/photoswipe.min.js', + 'photo-swipe/photoswipe-ui-default.min.js', + ], $bDynamicMode); + + return $sResult; + } + + public function getJsObjectName() + { + return $this->_sJsObjName; + } + + /** + * Get initialization section of comments box + * + * @return string + */ + public function getJsScript($aBp = [], $aDp = []) + { + $bDynamicMode = isset($aDp['dynamic_mode']) && $aDp['dynamic_mode'] === true; + $bMinPostForm = isset($aDp['min_post_form']) ? $aDp['min_post_form'] : $this->_bMinPostForm; + + $aParams = [ + 'sObjName' => $this->_sJsObjName, + 'sRootUrl' => BX_DOL_URL_ROOT, + 'sSystem' => $this->getSystemName(), + 'iAuthorId' => $this->_getAuthorId(), + 'iObjId' => $this->getId(), + 'sBaseUrl' => $this->getBaseUrl(), + 'sSocket' => $this->getSocketName(), + 'sPostFormPosition' => $this->_aSystem['post_form_position'], + 'sBrowseType' => $this->_sBrowseType, + 'sDisplayType' => $this->_sDisplayType, + 'iDisplayStructure' => isset($aDp['structure']) && !empty($aDp['structure']) ? 1 : 0, + 'iMinPostForm' => $bMinPostForm ? 1 : 0, + 'sStylePrefix' => $this->_sStylePrefix, + 'aHtmlIds' => $this->_aHtmlIds, + ]; + + if($this->_aParams) + $aParams['aParams'] = $this->_aParams; + + $sIncludes = $this->addCssJs($aBp, $aDp); + return ($bDynamicMode ? $sIncludes : '') . $this->_oTemplate->_wrapInTagJsCode("if(window['" . $this->_sJsObjName . "'] == undefined) var " . $this->_sJsObjName . " = new " . $this->_sJsObjClass . "(" . json_encode($aParams) . "); " . $this->_sJsObjName . ".cmtInit();"); + } + + function getCommentsBlockAPI($aParams, $aBp = [], $aDp = ['in_designbox' => false, 'show_empty' => false]) + { + + $mixedResult = $this->isViewAllowed(); + if($mixedResult !== CHECK_ACTION_RESULT_ALLOWED) + return $mixedResult; // TODO: error checking + + $aBp['type'] = 'head'; + $this->_getParams($aBp, $aDp); + $this->_prepareParams($aBp, $aDp); + + $aBp['order']['way'] = 'desc'; + $aBp['order_way'] = 'desc'; + $aBp['start'] = 0 ; + $aPp = $aBp['per_view']; + $aBp['per_view'] = $aBp['per_view'] + 1; + + $aCmts = []; + + if (!isset($aParams['comment_id'])) + $aCmts = $this->getCommentsArray($aBp['vparent_id'], $aBp['filter'], $aBp['order'], $aBp['start'], $aBp[($aBp['init_view'] != -1 ? 'init' : 'per') . '_view']); + else + $aCmts = [['cmt_id' => $aParams['comment_id']]]; + + $aParams['start_from'] = 0; + if (count($aCmts) == $aBp['per_view']){ + $aBp['per_view'] = $aPp; + $aCmts = array_slice($aCmts, 0, $aBp['per_view']); + $aParams['start_from'] = $aBp['start'] + $aBp['per_view']; + } + + $aCmtsRv = []; + foreach ($aCmts as $aCmt) { + $aCmtsRv[] = $this->getCommentStructure($aCmt['cmt_id'], $aBp, $aDp); + } + return [ + 'unit' => 'comments', + 'start' => 0, + 'order' => 'a', + 'module' => $this->_sSystem, + 'object_id' => $this->_iId, + 'data' => $aCmtsRv, + ]; + + } + + /** + * get full comments block with initializations + */ + function getCommentsBlock($aBp = [], $aDp = []) + { + $mixedResult = $this->isViewAllowed(); + if($mixedResult !== CHECK_ACTION_RESULT_ALLOWED) + return $mixedResult; + + $this->_getParams($aBp, $aDp); + + $oSockets = BxDolSockets::getInstance(); + $bSockets = $oSockets->isEnabled(); + + if($this->_bLiveUpdates && !$bSockets) { + //add live update + $this->actionResumeLiveUpdate(); + + if(($oLiveUpdates = BxDolLiveUpdates::getInstance())!== false) { + $sServiceCall = BxDolService::getSerializedService('system', 'get_live_update', [$this->_sSystem, $this->_iId, $this->_getAuthorId(), '{count}'], 'TemplCmtsServices'); + $oLiveUpdates->add($this->_sSystem . '_live_updates_cmts_' . $this->_iId, 1, $sServiceCall); + } + //add live update + } + + $sComments = $this->getComments($aBp, $aDp); + $sCommentsPinned = $this->getCommentsPinned(array_merge($aBp, ['pinned' => 1]), $aDp); + $sContentBefore = $this->_getContentBefore($aBp, $aDp); + $sContentAfter = $this->_getContentAfter($aBp, $aDp); + if($this->_bLiveUpdates && $bSockets) + $sContentAfter .= $this->getLiveUpdateButton(); + $sPostFormTop = $this->getFormBoxPost($aBp, array_merge($aDp, ['type' => $this->_sDisplayType, 'position' => BX_CMT_PFP_TOP])); + $sPostFormBottom = $this->getFormBoxPost($aBp, array_merge($aDp, ['type' => $this->_sDisplayType, 'position' => BX_CMT_PFP_BOTTOM])); + $sJsContent = $this->getJsScript($aBp, $aDp); + + $sBlockTitle = _t($this->_aT['block_comments_title'], $this->getCommentsCountAll(0, true)); + $sBlockMenu = $this->_getControlsBox(); + + /** + * @hooks + * @hookdef hook-system-view_comments 'system', 'view_comments' - hook to override comments block + * - $unit_name - equals `system` + * - $action - equals `view_comments` + * - $object_id - not used + * - $sender_id - not used + * - $extra_params - array of additional params with the following array keys: + * - `object` - [object] an instance of comments, @see BxDolCmts + * - `system` - [string] comments object name + * - `id` - [int] commented content id + * - `params_browse` - [array] browse params array as key&value pairs + * - `params_display` - [array] display params array as key&value pairs + * - `post_form_top` - [string] by ref, post form code for top section, can be overridden in hook processing + * - `content_before` - [string] by ref, a code to be displayed before comments list, can be overridden in hook processing + * - `comments` - [string] by ref, a comments list code, can be overridden in hook processing + * - `comments_pinned` - [string] by ref, a pinned comments list code, can be overridden in hook processing + * - `content_after` - [string] by ref, a code to be displayed after comments list, can be overridden in hook processing + * - `post_form_bottom` - [string] by ref, post form code for bottom section, can be overridden in hook processing + * - `js_content` - [string] by ref, comments JavaScript code, can be overridden in hook processing + * - `block_title` - [string] by ref, block title, can be overridden in hook processing + * - `block_menu` - [string] by ref, block submenu, can be overridden in hook processing + * + * @hook @ref hook-system-view_comments + */ + bx_alert('system', 'view_comments', 0, 0, [ + 'object' => $this, + 'system' => $this->_sSystem, + 'id' => $this->getId(), + 'params_browse' => $aBp, + 'params_display' => $aDp, + 'post_form_top' => &$sPostFormTop, + 'content_before' => &$sContentBefore, + 'comments' => &$sComments, + 'comments_pinned' => &$sCommentsPinned, + 'content_after' => &$sContentAfter, + 'post_form_bottom' => &$sPostFormBottom, + 'js_content' => &$sJsContent, + 'block_title' => &$sBlockTitle, + 'block_menu' => &$sBlockMenu, + ]); + + $sContent = $this->_oTemplate->parseHtmlByName('comments_block.html', [ + 'style_prefix' => $this->_sStylePrefix, + 'js_object' => $this->_sJsObjName, + 'system' => $this->_sSystem, + 'list_anchor' => $this->getListAnchor(), + 'id' => $this->getId(), + 'content_before' => $sContentBefore, + 'comments' => $sComments, + 'comments_pinned' => $sCommentsPinned, + 'bx_if:show_divider_hidden' => [ + 'condition' => empty($sCommentsPinned), + 'content' => [] + ], + 'content_after' => $sContentAfter, + 'post_form_top' => $sPostFormTop, + 'post_form_bottom' => $sPostFormBottom, + 'image_preview' => $this->_oTemplate->parseHtmlByName('comments_photoswipe.html', []), + 'script' => $sJsContent + ]); + + return $aDp['in_designbox'] ? DesignBoxContent($sBlockTitle, $sContent, BX_DB_DEF, $sBlockMenu) : [ + 'title' => $sBlockTitle, + 'content' => $sContent, + 'menu' => $sBlockMenu, + ]; + } + + /** + * get comments list for specified parent comment + * + * @param array $aBp - browse params array + * @param array $aDp - display params array + * + */ + function getComments($aBp = [], $aDp = []) + { + $this->_prepareParams($aBp, $aDp); + + $aCmts = $this->getCommentsArray($aBp['vparent_id'], $aBp['filter'], $aBp['order'], $aBp['start'], $aBp[($aBp['init_view'] != -1 ? 'init' : 'per') . '_view']); + if(empty($aCmts) || !is_array($aCmts)) + return isset($aDp['show_empty']) && $aDp['show_empty'] === true ? $this->_getEmpty($aDp) : ''; + + $sCmts = ''; + foreach($aCmts as $k => $aCmt) + $sCmts .= $this->getComment($aCmt, $aBp, $aDp); + $sCmts = $this->_getMoreLink($sCmts, $aBp, $aDp); + + return $sCmts; + } + + function getCommentsPinned($aBp = [], $aDp = []) + { + $this->_prepareParams($aBp, $aDp); + + $aCmts = $this->getCommentsArray($aBp['vparent_id'], BX_CMT_FILTER_PINNED, $aBp['order'], 0, -1); + if(empty($aCmts) || !is_array($aCmts)) + return ''; + + $sCmts = ''; + foreach($aCmts as $k => $aCmt) + $sCmts .= $this->getComment($aCmt, $aBp, $aDp); + + return $sCmts; + } + + public function getCommentsByStructure($aBp = array(), $aDp = array()) + { + if(empty($aDp['structure'])) + return isset($aDp['show_empty']) && $aDp['show_empty'] === true ? $this->_getEmpty($aDp) : ''; + + $aBp['count'] = count($aDp['structure']); + $this->_prepareParams($aBp, $aDp); + $aDp['structure'] = array_slice($aDp['structure'], $aBp['start'], $aBp[($aBp['init_view'] != -1 ? 'init' : 'per') . '_view'], true); + + $sCmts = ''; + foreach($aDp['structure'] as $iCmtId => $aCmt) + $sCmts .= $this->getComment($iCmtId, $aBp, $aDp); + + $sCmts = $this->_getMoreLink($sCmts, $aBp, $aDp); + return $sCmts; + } + + /** + * get comment view block with initializations + */ + function getCommentBlock($iCmtId = 0, $aBp = array(), $aDp = array()) + { + $mixedResult = $this->isViewAllowed(); + if($mixedResult !== CHECK_ACTION_RESULT_ALLOWED) + return $mixedResult; + + $aBp = array_merge(array('type' => $this->_sBrowseType), $aBp); + $aDp = array_merge(array('type' => BX_CMT_DISPLAY_THREADED), $aDp); + + //--- Beg: Using pregenerated structure + $mixedStructure = $this->getCommentStructure((int)$iCmtId, $aBp, $aDp); + if($mixedStructure !== false) + $aDp['structure'] = $mixedStructure; + //--- End: Using pregenerated structure + + $sComment = $this->getComment($iCmtId, $aBp, $aDp); + if (!$sComment) + return ''; + + BxDolTemplate::getInstance()->addInjection ('injection_footer', 'text', $this->_oTemplate->parseHtmlByName('comments_photoswipe.html', [])); + + return $this->_oTemplate->parseHtmlByName('comment_block.html', array( + 'style_prefix' => $this->_sStylePrefix, + 'js_object' => $this->_sJsObjName, + 'system' => $this->_sSystem, + 'id' => $this->getId(), + 'comment' => $sComment, + 'script' => $this->getJsScript($aBp, $aDp) + )); + } + + /** + * get one just posted comment + * + * @param int $iCmtId - comment id + * @return string + */ + function getComment($mixedCmt, $aBp = array(), $aDp = array()) + { + $iUserId = $this->_getAuthorId(); + $aCmt = !is_array($mixedCmt) ? $this->getCommentRow((int)$mixedCmt) : $mixedCmt; + if (!$aCmt) + return ''; + + list($sAuthorName, $sAuthorLink, $sAuthorIcon) = $this->_getAuthorInfo($aCmt['cmt_author_id']); + + $sClass = $sClassCnt = ''; + if(isset($aCmt['vote_rate']) && (float)$aCmt['vote_rate'] < $this->_aSystem['viewing_threshold']) { + $this->_oTemplate->pareseHtmlByName('comment_hidden.html', array( + 'js_object' => $this->_sJsObjName, + 'id' => $aCmt['cmt_id'], + 'title' => bx_process_output(_t('_hidden_comment', $sAuthorName)), + 'bx_if:show_replies' => array( + 'condition' => $aCmt['cmt_replies'] > 0, + 'content' => array( + 'replies' => _t('_Show N replies', $aCmt['cmt_replies']) + ) + ) + )); + + $sClass = ' ' . $this->_sStylePrefix . '-hidden'; + } + + if($aCmt['cmt_author_id'] == $iUserId) + $sClass .= ' ' . $this->_sStylePrefix . '-mine'; + + $aAuthorAcl = BxDolAcl::getInstance()->getMemberMembershipInfo($aCmt['cmt_author_id']); + if(!empty($aAuthorAcl) && isset($this->_aAclId2Name[$aAuthorAcl['id']])) + $sClass .= ' ' . $this->_sStylePrefix . '-aml-' . $this->_aAclId2Name[$aAuthorAcl['id']]; + + if(!empty($aDp['blink']) && in_array($aCmt['cmt_id'], $aDp['blink'])) + $sClass .= ' ' . $this->_sStylePrefix . '-blink'; + + if(!empty($aDp['class_comment'])) + $sClass .= ' ' . $aDp['class_comment']; + + if(!empty($aDp['class_comment_content'])) + $sClassCnt .= ' ' . $aDp['class_comment_content']; + + $sActions = $this->_getActionsBox($aCmt, $aBp, $aDp); + + $aTmplReplyTo = array(); + if((int)$aCmt['cmt_parent_id'] != 0) { + $aParent = $this->getCommentRow($aCmt['cmt_parent_id']); + + if(!empty($aParent) && is_array($aParent)) { + $oProfile = $this->_getAuthorObject($aParent['cmt_author_id']); + $sParAuthorName = $oProfile->getDisplayName(); + $sParAuthorUnit = $oProfile->getUnit(0, array('template' => array('name' => 'unit_wo_info_links', 'size' => 'icon'))); + + $aTmplReplyTo = array( + 'style_prefix' => $this->_sStylePrefix, + 'par_cmt_link' => $this->getItemUrl($aCmt['cmt_parent_id']), + 'par_cmt_title' => bx_html_attribute(_t('_in_reply_to_x', $sParAuthorName)), + 'par_cmt_author' => $sParAuthorName, + 'par_cmt_author_unit' => $sParAuthorUnit + ); + } + } + + $sReplies = ''; + if(!(isset($aBp['pinned']) && (int)$aBp['pinned'] != 0 && (int)$aCmt['cmt_pinned'] != 0) && !empty($aDp)) { + $aDp['show_empty'] = false; + + if(!empty($aDp['structure'][$aCmt['cmt_id']]) && is_array($aDp['structure'][$aCmt['cmt_id']])) { + if(!empty($aDp['structure'][$aCmt['cmt_id']]['items'])) { + $aDp['structure'] = $aDp['structure'][$aCmt['cmt_id']]['items']; + $sReplies = $this->getCommentsByStructure(array('parent_id' => $aCmt['cmt_id'], 'type' => $aBp['type']), $aDp); + } + } + else if((int)$aCmt['cmt_replies'] > 0 && $aDp['type'] == BX_CMT_DISPLAY_THREADED) + $sReplies = $this->getComments(['parent_id' => $aCmt['cmt_id'], 'vparent_id' => $aCmt['cmt_id'], 'type' => $aBp['type'], 'order_way' => BX_CMT_ORDER_WAY_ASC], $aDp); + } + + $aTmplVarsMeta = array(); + if(!empty($this->_sMenuObjMeta)) { + $oMenuMeta = BxDolMenu::getObjectInstance($this->_sMenuObjMeta, $this->_oTemplate); + if($oMenuMeta) { + $oMenuMeta->setCmtsData($this, $aCmt['cmt_id']); + + $aTmplVarsMeta = array( + 'style_prefix' => $this->_sStylePrefix, + 'meta' => $oMenuMeta->getCode() + ); + } + } + + if($this->_isShowContent($aCmt)) { + $sContent = $this->_getContent($aCmt, $aBp, $aDp); + } + else { + $sClass .= ' cmt-author-not-active'; + $sContent = _t('_hidden_comment', BxDolProfileUndefined::getInstance()->getDisplayName()); + } + + $aVars = array_merge(array( + 'system' => $this->_sSystem, + 'style_prefix' => $this->_sStylePrefix, + 'js_object' => $this->_sJsObjName, + 'id' => $aCmt['cmt_id'], + 'anchor' => $this->getItemAnchor($aCmt['cmt_id']), + 'class' => $sClass, + 'class_cnt' => $sClassCnt, + 'bx_if:show_reply_to' => array( + 'condition' => !empty($aTmplReplyTo), + 'content' => $aTmplReplyTo + ), + 'bx_if:meta' => array( + 'condition' => !empty($aTmplVarsMeta), + 'content' => $aTmplVarsMeta + ), + 'bx_if:show_pinned' => array( + 'condition' => (int)$aCmt['cmt_pinned'] > 0, + 'content' => array( + 'style_prefix' => $this->_sStylePrefix, + ) + ), + 'content' => $sContent, + 'actions' => $sActions, + 'replies' => $sReplies, + ), $this->_getTmplVarsAuthor($aCmt), $this->_getTmplVarsNotes($aCmt)); + + $sResult = $this->_oTemplate->parseHtmlByName($this->_sTmplNameItem, $aVars); + + /** + * @hooks + * @hookdef hook-system-view_comment 'system', 'view_comment' - hook on get comment + * - $unit_name - equals `system` + * - $action - equals `view_comment` + * - $object_id - comment_id + * - $sender_id - not used + * - $extra_params - array of additional params with the following array keys: + * - `comment` - [array] comment's data + * - `system` - [string] comment's system name + * - `tmpl_name` - [string] template file path + * - `tmpl_vars` - [string] params for template file parsing + * - `override_result` - [string] by ref, if account confirmed = true, otherwise false, can be overridden in hook processing + * @hook @ref hook-system-view_comment + */ + bx_alert('system', 'view_comment', $aCmt['cmt_id'], 0, array('comment' => $aCmt, 'system' => $this->_sSystem, 'tmpl_name' => $this->_sTmplNameItem, 'tmpl_vars' => $aVars, 'override_result' => &$sResult)); + + return $sResult; + } + + public function getCommentStructure($iCmtId, $aBp = array(), $aDp = array()) + { + $aRoot = $this->getCommentRow((int)$iCmtId); + + $aBps = $aBp; + if(!empty($aRoot)) + $aBps['parent_id'] = $aRoot['cmt_id']; + $this->_prepareStructureBp($aDp['type'], $aBps); + + $iLevel = 0; + $aStructure = array(); + $this->{'_getStructure' . ($this->_bIsApi ? 'API' : '')}($aRoot, $aBps, $iLevel, $aStructure); + + return !empty($aStructure) && is_array($aStructure) ? $aStructure : false; + } + + function getCommentSearch($iCmtId, &$sAddon) + { + $aBp = array(); + $aDp = array( + 'type' => BX_CMT_DISPLAY_FLAT, + 'view_only' => true + ); + + if(empty($sAddon)) + $sAddon = $this->getJsScript($aBp, $aDp); + + BxDolTemplate::getInstance()->addInjection ('injection_footer', 'text', $this->_oTemplate->parseHtmlByName('comments_photoswipe.html', [])); + + return $this->_oTemplate->parseHtmlByName('comment_search.html', array( + 'comment' => $this->getComment($iCmtId, $aBp, $aDp), + )); + } + + /** + * get one comment for "Live Search" + * + * @param int $iCmtId - comment id + * @return string + */ + function getCommentLiveSearch($mixedCmt, $aParams = array()) + { + $aCmt = !is_array($mixedCmt) ? $this->getCommentRow((int)$mixedCmt) : $mixedCmt; + + list($sAuthorName, $sAuthorLink, $sAuthorIcon) = $this->_getAuthorInfo($aCmt['cmt_author_id']); + $bAuthorIcon = !empty($sAuthorIcon); + + $sViewLink = $this->getViewUrl($aCmt['cmt_id']); + if(empty($sViewLink)) + $sViewLink = '#'; + + return $this->_oTemplate->parseHtmlByName('comment_live_search.html', array( + 'bx_if:show_icon' => array( + 'condition' => $bAuthorIcon, + 'content' => array( + 'author_icon' => $sAuthorIcon, + 'view_link' => $sViewLink + ) + ), + 'bx_if:show_icon_empty' => array( + 'condition' => !$bAuthorIcon, + 'content' => array() + ), + 'view_link' => $sViewLink, + 'text' => BxTemplFunctions::getInstance()->getStringWithLimitedLength(strip_tags($aCmt['cmt_text']), $this->_sSnippetLenthLiveSearch), + 'sample' => isset($aParams['txt_sample_single']) ? _t($aParams['txt_sample_single']) : '' + )); + } + + function getFormBoxPost($aBp = array(), $aDp = array()) + { + return $this->_getFormBox(BX_CMT_ACTION_POST, $aBp, $aDp); + } + + function getFormBoxEdit($aBp = array(), $aDp = array()) + { + return $this->_getFormBox(BX_CMT_ACTION_EDIT, $aBp, $aDp); + } + + function getFormPost($iCmtParentId = 0, $aDp = array()) + { + return $this->_getFormPost($iCmtParentId, $aDp); + } + + function getFormEdit($iCmtId, $aDp = array()) + { + return $this->_getFormEdit($iCmtId, $aDp); + } + + function getControlsBox() + { + return $this->_getControlsBox(); + } + + function getLiveUpdate($iCountOld = 0, $iCountNew = 0) + { + $iCount = (int)$iCountNew - (int)$iCountOld; + if($iCount < 0) + return ''; + + $aComments = $this->_oQuery->getCommentsBy(array('type' => 'latest', 'object_id' => $this->_iId, 'author' => $this->_getAuthorId(), 'others' => 1, 'start' => '0', 'per_page' => $iCount)); + if(empty($aComments) || !is_array($aComments)) + return ''; + + $aComment = array_shift($aComments); + if(empty($aComment) || !is_array($aComment)) + return ''; + + return $this->getLiveUpdateButton($aComment['cmt_id']); + } + + function getLiveUpdateButton($iCommentId = 0) + { + $sJsObject = $this->getJsObjectName(); + + $bComment = is_numeric($iCommentId) && (int)$iCommentId != 0; + return $this->_oTemplate->parseHtmlByName('comments_lu_button.html', array( + 'style_prefix' => $this->_sStylePrefix, + 'class' => !$bComment ? 'hidden' : '', + 'onclick_show' => "javascript:" . $sJsObject . ".goToBtn(this, '" . ($bComment ? $this->getItemAnchor($iCommentId) : '{cmt_anchor}') . "', '" . ($bComment ? $iCommentId : '{cmt_id}') . "');", + )); + } + + function getLiveUpdates($iCountOld = 0, $iCountNew = 0) + { + $bShowAll = true; + $bShowActions = false; + + $iCount = (int)$iCountNew - (int)$iCountOld; + if($iCount < 0) + return ''; + + $aComments = $this->_oQuery->getCommentsBy(array('type' => 'latest', 'object_id' => $this->_iId, 'author' => $this->_getAuthorId(), 'others' => 1, 'start' => '0', 'per_page' => $iCount)); + if(empty($aComments) || !is_array($aComments)) + return ''; + + $sJsObject = $this->getJsObjectName(); + + $iUserId = $this->_getAuthorId(); + $bModerator = $this->isModerator(); + + $aComments = array_reverse($aComments); + $iComments = count($aComments); + + $aTmplVarsNotifs = array(); + foreach($aComments as $iIndex => $aComment) { + $iCommentId = $aComment['cmt_id']; + + $sShowOnClick = "javascript:" . $sJsObject . ".goTo(this, '" . $this->getItemAnchor($iCommentId) . "', '" . $iCommentId . "');"; + $sReplyOnClick = "javascript:" . $sJsObject . ".goToAndReply(this, '" . $this->getItemAnchor($iCommentId) . "', '" . $iCommentId . "');"; + + $iAuthorId = (int)$aComment['cmt_author_id']; + if($iAuthorId < 0) { + if(abs($iAuthorId) == $iUserId) + continue; + else if($bModerator) + $iAuthorId *= -1; + } + + $oAuthor = $this->_getAuthorObject($iAuthorId); + $sAuthorName = $oAuthor->getDisplayName(); + + $aTmplVarsNotifs[] = array( + 'bx_if:show_as_hidden' => array( + 'condition' => !$bShowAll && $iIndex < ($iComments - 1), + 'content' => array(), + ), + 'item' => $this->_oTemplate->parseHtmlByName('comments_lu_notifications.html', array( + 'style_prefix' => $this->_sStylePrefix, + 'onclick_show' => $sShowOnClick, + 'onclick_reply' => $sReplyOnClick, + 'author_link' => $oAuthor->getUrl(), + 'author_title' => bx_html_attribute($sAuthorName), + 'author_name' => $sAuthorName, + 'author_unit' => $oAuthor->getUnit(0, array('template' => 'unit_wo_info_links')), + 'text' => _t('_cmt_txt_added_sample') + )), + 'bx_if:show_previous' => array( + 'condition' => $bShowActions && $iIndex > 0, + 'content' => array( + 'onclick_previous' => $sJsObject . '.previousLiveUpdate(this)' + ) + ), + 'bx_if:show_close' => array( + 'condition' => $bShowActions, + 'content' => array( + 'onclick_close' => $sJsObject . '.hideLiveUpdate(this)' + ) + ) + ); + } + + return $this->_oTemplate->parseHtmlByName('popup_chain.html', array( + 'html_id' => $this->getNotificationId(), + 'bx_repeat:items' => $aTmplVarsNotifs + )); + } + + public function getElementBlock($aParams = array()) + { + $aParams['usage'] = BX_CMT_USAGE_BLOCK; + + return $this->getElement($aParams); + } + + public function getElementInline($aParams = array()) + { + $aParams['usage'] = BX_CMT_USAGE_INLINE; + + return $this->getElement($aParams); + } + + public function getElement($aParams = array()) + { + $aParams = array_merge($this->_aElementDefaults, $aParams); + + $bShowDoCommentAsButtonSmall = isset($aParams['show_do_comment_as_button_small']) && $aParams['show_do_comment_as_button_small'] == true; + $bShowDoCommentAsButton = !$bShowDoCommentAsButtonSmall && isset($aParams['show_do_comment_as_button']) && $aParams['show_do_comment_as_button'] == true; + $bShowCounterEmpty = isset($aParams['show_counter_empty']) && $aParams['show_counter_empty'] == true; + $bRecalculateCounter = isset($aParams['recalculate_counter']) && $aParams['recalculate_counter'] == true; + + $iObjectId = $this->getId(); + $iAuthorId = $this->_getAuthorId(); + $iAuthorIp = $this->_getAuthorIp(); + + $iCount = $this->getCommentsCountAll(0, $bRecalculateCounter); + $bCount = (int)$iCount != 0; + + $isAllowedComment = $this->isPostAllowed(); + + //--- Do Comment + $bTmplVarsDoComment = $this->_isShowDoComment($aParams, $isAllowedComment, $bCount); + $aTmplVarsDoComment = []; + if($bTmplVarsDoComment) + $aTmplVarsDoComment = [ + 'style_prefix' => $this->_sStylePrefix, + 'do_comment' => $this->_getDoComment($aParams, $isAllowedComment), + ]; + + //--- Counter + $bTmplVarsCounter = $this->_isShowCounter($aParams, $isAllowedComment, $bCount); + + $aTmplVarsCounter = array(); + if($bTmplVarsCounter) + $aTmplVarsCounter = array( + 'style_prefix' => $this->_sStylePrefix, + 'bx_if:show_hidden' => array( + 'condition' => !$bShowCounterEmpty && !$bCount, + 'content' => array() + ), + 'counter' => $this->getCounter(array_merge($aParams, [ + 'show_counter_only' => false + ])) + ); + + if(!$bTmplVarsDoComment && !$bTmplVarsCounter) + return ''; + + $sTmplName = $this->{'_getTmplElement' . bx_gen_method_name(!empty($aParams['usage']) ? $aParams['usage'] : BX_CMT_USAGE_DEFAULT)}(); + return $this->_oTemplate->parseHtmlByContent($sTmplName, array( + 'style_prefix' => $this->_sStylePrefix, + 'html_id' => $this->_aHtmlIds['main'], + 'class' => $this->_sStylePrefix . ($bShowDoCommentAsButton ? '-button' : '') . ($bShowDoCommentAsButtonSmall ? '-button-small' : ''), + 'count' => $iCount, + 'bx_if:show_do_comment' => array( + 'condition' => $bTmplVarsDoComment, + 'content' => $aTmplVarsDoComment + ), + 'bx_if:show_counter' => array( + 'condition' => $bTmplVarsCounter, + 'content' => $aTmplVarsCounter + ), + 'script' => '' + )); + } + + public function getElementAPI($aParams = []) + { + if(!$this->_bIsApi) + return; + + if(!$this->isEnabled()) + return bx_api_get_msg('_cmt_err_not_enabled'); + + $aParams = array_merge($this->_aElementDefaultsApi, $aParams); + + $bRecalculateCounter = isset($aParams['recalculate_counter']) && $aParams['recalculate_counter'] == true; + + $iObjectId = $this->getId(); + $iAuthorId = $this->_getAuthorId(); + + $iCount = $this->getCommentsCountAll(0, $bRecalculateCounter); + $bCount = (int)$iCount != 0; + + $isAllowedComment = $this->isPostAllowed(); + $aParams['count'] = $iCount; + + //--- Do Comment + $bDoComment = $this->_isShowDoComment($aParams, $isAllowedComment, $bCount); + $aDoComment = $bDoComment ? $this->_getDoComment($aParams, $isAllowedComment) : []; + + //--- Counter + $bCounter = $this->_isShowCounter($aParams, $isAllowedComment, $bCount); + $aCounter = $bCounter ? $this->getCounterAPI(array_merge($aParams, [ + 'show_counter_only' => false, + ])) : []; + + + if(!$bDoComment && !$bCounter) + return bx_api_get_msg(''); + + return [ + 'type' => $this->_sType, + 'system' => $this->_sSystem, + 'object_id' => $this->_iId, + 'params' => array_intersect_key($aParams, array_flip($this->_aElementParamsApi)), + 'action' => $aDoComment, + 'counter' => $aCounter + ]; + } + + public function getCounter($aParams = []) + { + $aParams = array_merge($this->_aElementDefaults, $aParams); + + $bShowDoCommentAsButtonSmall = isset($aParams['show_do_comment_as_button_small']) && $aParams['show_do_comment_as_button_small'] == true; + $bShowDoCommentAsButton = !$bShowDoCommentAsButtonSmall && isset($aParams['show_do_comment_as_button']) && $aParams['show_do_comment_as_button'] == true; + $bShowEmpty = isset($aParams['show_counter_empty']) && $aParams['show_counter_empty'] == true; + $bShowReversed = isset($aParams['show_counter_reversed']) && $aParams['show_counter_reversed'] == true; + $bShowScript = !isset($aParams['show_script']) || (bool)$aParams['show_script'] === true; + $bRecalculateCounter = isset($aParams['recalculate_counter']) && $aParams['recalculate_counter'] == true; + + $sClass = 'sys-action-counter'; + if(isset($aParams['show_counter_only']) && (bool)$aParams['show_counter_only'] === true) + $sClass .= ' sys-ac-only'; + + $iCount = (int)$this->getCommentsCountAll(0, $bRecalculateCounter); + if($iCount == 0 && !$bShowEmpty) + $sClass .= ' sys-ac-hidden'; + + $sClass .= ' ' . $this->_sStylePrefix . '-counter'; + if($bShowDoCommentAsButtonSmall) + $sClass .= ' bx-btn-small-height'; + if($bShowDoCommentAsButton) + $sClass .= ' bx-btn-height'; + + $iCmtsLimit = 5; + $aCmts = $this->_getCounterItems($iCmtsLimit); + if(!$bShowReversed) + $aCmts = array_reverse($aCmts); + + $aTmplVarsProfiles = []; + foreach($aCmts as $aCmt) { + $iAuthor = (int)$aCmt['cmt_author_id']; + if(array_key_exists($iAuthor, $aTmplVarsProfiles)) + continue; + + $oAuthor = BxDolProfile::getInstanceMagic($iAuthor); + if(!$oAuthor) + continue; + + $aTmplVarsProfiles[$iAuthor] = [ + 'icon' => $oAuthor->getUnit(0, ['template' => ['name' => 'unit_wo_info_links', 'size' => 'icon']]) + ]; + + if(count($aTmplVarsProfiles) >= $iCmtsLimit) + break; + } + $aTmplVarsProfiles = array_values($aTmplVarsProfiles); + + $sHref = !empty($aParams['overwrite_counter_link_href']) ? $aParams['overwrite_counter_link_href'] : $this->getListUrl(); + $sOnclick = ''; + if(!empty($aParams['overwrite_counter_link_onclick'])) + $sOnclick = $aParams['overwrite_counter_link_onclick']; + + return $this->_oTemplate->parseHtmlByContent($this->_getTmplCounter(), [ + 'style_prefix' => $this->_sStylePrefix, + 'id' => $this->_aHtmlIds['counter'], + 'class' => $sClass, + 'href' => $sHref, + 'bx_if:show_onclick' => [ + 'condition' => !empty($sOnclick), + 'content' => [ + 'onclick' => $sOnclick + ] + ], + 'content' => $this->_getCounterLabel($iCount, $aParams), + 'bx_repeat:profiles' => $aTmplVarsProfiles, + 'bx_if:show_icon' => [ + 'condition' => ($bShowEmpty || !empty($aTmplVarsProfiles)) && (!isset($aParams['show_icon']) || $aParams['show_icon']), + 'content' => [ + 'style_prefix' => $this->_sStylePrefix, + 'icon' => !empty($aParams['custom_icon']) ? $aParams['custom_icon'] : $this->_oTemplate->getImageAuto('comment|' . $this->_sStylePrefix . '-counter-icon') + ] + ], + 'script' => $this->getJsScript() + ]); + } + + public function getCounterApi($aParams = []) + { + $aParams = array_merge($this->_aElementDefaultsApi, $aParams); + + $bShowReversed = isset($aParams['show_counter_reversed']) && $aParams['show_counter_reversed'] == true; + $bRecalculateCounter = isset($aParams['recalculate_counter']) && $aParams['recalculate_counter'] == true; + + $iCount = (int)$this->getCommentsCountAll(0, $bRecalculateCounter); + + $iCmtsLimit = 5; + $aCmts = $this->_getCounterItems($iCmtsLimit); + if(!$bShowReversed) + $aCmts = array_reverse($aCmts); + + $aCmtsAuthors = []; + foreach($aCmts as $aCmt) { + $iAuthor = (int)$aCmt['cmt_author_id']; + if(array_key_exists($iAuthor, $aCmtsAuthors)) + continue; + + $aCmtsAuthors[$iAuthor] = BxDolProfile::getData($iAuthor); + + if(count($aCmtsAuthors) >= $iCmtsLimit) + break; + } + $aCmtsAuthors = array_values($aCmtsAuthors); + + return [ + 'count' => $iCount, + 'authors' => $aCmtsAuthors + ]; + } + + protected function _getCounterItems($iCmtsLimit, $iCmtsStart = 0) + { + return $this->_oQuery->getCommentsBy(array('type' => 'object_id', 'object_id' => $this->getId(), 'order_way' => 'desc', 'start' => $iCmtsStart, 'per_page' => $iCmtsLimit * 4)); + } + + protected function _getLabelDo($aParams = []) + { + return $this->_oTemplate->parseHtmlByContent($this->_getTmplLabelDo(), [ + 'style_prefix' => $this->_sStylePrefix, + 'bx_if:show_icon' => [ + 'condition' => isset($aParams['show_do_comment_icon']) && $aParams['show_do_comment_icon'] == true, + 'content' => [ + 'style_prefix' => $this->_sStylePrefix, + 'icon' => $this->_oTemplate->getImageAuto($this->_getIconDo()) + ] + ], + 'bx_if:show_text' => [ + 'condition' => isset($aParams['show_do_comment_label']) && $aParams['show_do_comment_label'] == true, + 'content' => [ + 'style_prefix' => $this->_sStylePrefix, + 'text' => _t($this->_getTitleDo()) + ] + ] + ]); + } + + protected function _getCounterLabel($iCount, $aParams = []) + { + $aParams = array_merge($this->_aElementDefaults, $aParams); + + $sResult = ''; + if((int)$iCount != 0) + $sResult = _t(isset($aParams['caption']) ? $aParams['caption'] : '_cmt_txt_counter', $iCount); + else + $sResult = _t(isset($aParams['caption_empty']) ? $aParams['caption_empty'] : '_cmt_txt_counter_empty'); + + return $sResult; + } + + protected function _getTmplElementBlock() + { + return self::$_sTmplContentElementBlock; + } + + protected function _getTmplElementInline() + { + return self::$_sTmplContentElementInline; + } + + protected function _getTmplLabelDo() + { + return self::$_sTmplContentDoCommentLabel; + } + + protected function _getTmplCounter() + { + return self::$_sTmplContentCounter; + } + + protected function _isShowContent($aCmt) + { + $oProfileAuthor = BxDolProfile::getInstance(abs($aCmt['cmt_author_id'])); + return (int)$aCmt['cmt_author_id'] == 0 || ($oProfileAuthor && $oProfileAuthor->isActive()) || isAdmin() || BxDolAcl::getInstance()->isMemberLevelInSet([MEMBERSHIP_ID_MODERATOR, MEMBERSHIP_ID_ADMINISTRATOR]); + } + + protected function _getContentBefore($aBp = array(), $aDp = array()) + { + return ''; + } + + protected function _getContentAfter($aBp = array(), $aDp = array()) + { + return ''; + } + + protected function _getControlsBox() + { + $sDisplay = ''; + $bDisplay = (int)$this->_aSystem['is_display_switch'] == 1; + if($bDisplay) { + $aDisplayLinks = array( + array('id' => $this->_sSystem . '-flat', 'name' => $this->_sSystem . '-flat', 'class' => '', 'title' => '_cmt_display_flat', 'target' => '_self', 'onclick' => 'javascript:' . $this->_sJsObjName . '.cmtChangeDisplay(this, \'flat\');'), + array('id' => $this->_sSystem . '-threaded', 'name' => $this->_sSystem . '-threaded', 'class' => '', 'title' => '_cmt_display_threaded', 'target' => '_self', 'onclick' => 'javascript:' . $this->_sJsObjName . '.cmtChangeDisplay(this, \'threaded\');') + ); + + $oMenu = new BxTemplMenuInteractive(array('template' => 'menu_interactive_vertical.html', 'menu_id'=> $this->_sSystem . '-display', 'menu_items' => $aDisplayLinks)); + $oMenu->setSelected('', $this->_sSystem . '-' . $this->_sDisplayType); + $sDisplay = $oMenu->getCode(); + } + + $sBrowseType = ''; + $bBrowseType = (int)$this->_aSystem['is_browse_switch'] == 1; + if($bBrowseType) { + $aBrowseLinks = array( + array('id' => $this->_sSystem . '-tail', 'name' => $this->_sSystem . '-tail', 'class' => '', 'title' => '_cmt_browse_tail', 'target' => '_self', 'onclick' => 'javascript:' . $this->_sJsObjName . '.cmtChangeBrowse(this, \'tail\');'), + array('id' => $this->_sSystem . '-head', 'name' => $this->_sSystem . '-head', 'class' => '', 'title' => '_cmt_browse_head', 'target' => '_self', 'onclick' => 'javascript:' . $this->_sJsObjName . '.cmtChangeBrowse(this, \'head\');'), + array('id' => $this->_sSystem . '-popular', 'name' => $this->_sSystem . '-popular', 'class' => '', 'title' => '_cmt_browse_popular', 'target' => '_self', 'onclick' => 'javascript:' . $this->_sJsObjName . '.cmtChangeBrowse(this, \'popular\');'), + ); + + $oMenu = new BxTemplMenuInteractive(array('template' => 'menu_interactive_vertical.html', 'menu_id'=> $this->_sSystem . '-browse', 'menu_items' => $aBrowseLinks)); + $oMenu->setSelected('', $this->_sSystem . '-' . $this->_sBrowseType); + $sBrowseType = $oMenu->getCode(); + } + + $sBrowseFilter = ''; + $bBrowseFilter = (int)$this->_aSystem['is_browse_filter'] == 1; + if($bBrowseFilter) { + $aFilterLinks = array( + array('id' => $this->_sSystem . '-all', 'name' => $this->_sSystem . '-all', 'class' => '', 'title' => '_cmt_browse_all', 'target' => '_self', 'onclick' => 'javascript:' . $this->_sJsObjName . '.cmtChangeFilter(this, \'all\');'), + array('id' => $this->_sSystem . '-friends', 'name' => $this->_sSystem . '-friends', 'class' => '', 'title' => '_cmt_browse_friends', 'target' => '_self', 'onclick' => 'javascript:' . $this->_sJsObjName . '.cmtChangeFilter(this, \'friends\');'), + array('id' => $this->_sSystem . '-subscriptions', 'name' => $this->_sSystem . '-subscriptions', 'class' => '', 'title' => '_cmt_browse_subscriptions', 'target' => '_self', 'onclick' => 'javascript:' . $this->_sJsObjName . '.cmtChangeFilter(this, \'subscriptions\');') + ); + + $oMenu = new BxTemplMenuInteractive(array('template' => 'menu_interactive_vertical.html', 'menu_id'=> $this->_sSystem . '-filter', 'menu_items' => $aFilterLinks)); + $oMenu->setSelected('', $this->_sSystem . '-' . $this->_sBrowseFilter); + $sBrowseFilter = $oMenu->getCode(); + } + + return $this->_oTemplate->parseHtmlByName('comments_controls.html', array( + 'display_switcher' => $bDisplay ? $sDisplay : '', + 'bx_if:is_divider_1' => array( + 'condition' => $bDisplay && $bBrowseType, + 'content' => array( + 'style_prefix' => $this->_sStylePrefix, + ) + ), + 'browse_switcher' => $bBrowseType ? $sBrowseType : '', + 'bx_if:is_divider_2' => array( + 'condition' => $bBrowseType && $bBrowseFilter, + 'content' => array( + 'style_prefix' => $this->_sStylePrefix, + ) + ), + 'filter_switcher' => $bBrowseFilter ? $sBrowseFilter : '', + )); + } + + protected function _getActionsBox(&$aCmt, $aBp = [], $aDp = []) + { + $bViewOnly = isset($aDp['view_only']) && $aDp['view_only'] === true; + $bDynamicMode = isset($aDp['dynamic_mode']) && $aDp['dynamic_mode'] === true; + + $sMenuActions = ''; + if(!$bViewOnly) { + $oMenuActions = BxDolMenu::getObjectInstance($this->_sMenuObjActions); + $oMenuActions->setCmtsData($this, $aCmt['cmt_id'], $aBp, $aDp); + $oMenuActions->setDynamicMode($bDynamicMode); + $sMenuActions = $oMenuActions->getCode(); + } + + return $this->_oTemplate->parseHtmlByName('comment_actions.html', array( + 'id' => $aCmt['cmt_id'], + 'js_object' => $this->_sJsObjName, + 'style_prefix' => $this->_sStylePrefix, + 'menu_actions' => $sMenuActions, + )); + } + + protected function _getCountersBox(&$aCmt, $aBp = [], $aDp = []) + { + $bDynamicMode = isset($aDp['dynamic_mode']) && $aDp['dynamic_mode'] === true; + + $oMenuCounters = BxDolMenu::getObjectInstance($this->_sMenuObjCounters); + if(!$oMenuCounters) + return ''; + + $oMenuCounters->setCmtsData($this, $aCmt['cmt_id'], $aBp, $aDp); + $oMenuCounters->setDynamicMode($bDynamicMode); + return $oMenuCounters->getCode(); + } + + protected function _getFormBox($sType, $aBp, $aDp) + { + $iCmtParentId = isset($aBp['parent_id']) ? (int)$aBp['parent_id'] : 0; + $sPosition = isset($aDp['position']) ? $aDp['position'] : ''; + $bQuote = isset($aDp['quote']) && (bool)$aDp['quote']; + $bFormMin = $iCmtParentId == 0 && isset($aDp['min_post_form']) && (bool)$aDp['min_post_form']; + + $sPositionSystem = $this->_aSystem['post_form_position']; + if(!empty($sPosition) && $sPositionSystem != $sPosition) + return ''; + + $sClass = ''; + if(!empty($sPosition)) + $sClass .= ' ' . $this->_sStylePrefix . '-reply-' . $sPosition; + if($bQuote) + $sClass .= ' ' . $this->_sStylePrefix . '-reply-quote'; + if($bFormMin) + $sClass .= ' ' . $this->_sStylePrefix . '-reply-min'; + if(!empty($aDp['class'])) + $sClass .= ' ' . $aDp['class']; + + $sClassBody = ''; + if(!empty($aDp['class_body'])) + $sClassBody .= ' ' . $aDp['class_body']; + + $aTmplVarsFormMin = array(); + if($bFormMin) { + list($sAuthorName, $sAuthorLink, $sAuthorIcon, $sAuthorUnit) = $this->_getAuthorInfo($this->_getAuthorId()); + + $oForm = new BxTemplFormView(array()); + $aInputPlaceholder = array( + 'type' => 'text', + 'name' => 'comment', + 'caption' => '', + 'attrs' => array( + 'onclick' => 'javascript:' . $this->_sJsObjName . '.cmtShowForm(this)', + 'placeholder' => _t($this->_aT['txt_min_form_placeholder'], $sAuthorName), + 'autocomplete' => 'off', + 'readonly' => 'readonly' + ), + 'value' => '', + ); + + $sClassBodyMin = ''; + if(!empty($aDp['class_body_min'])) + $sClassBodyMin .= ' ' . $aDp['class_body_min']; + + $aTmplVarsFormMin = array( + 'js_object' => $this->_sJsObjName, + 'class_body_min' => $sClassBodyMin, + 'style_prefix' => $this->_sStylePrefix, + 'author_unit' => $sAuthorUnit, + 'placeholder' => $oForm->genRow($aInputPlaceholder) + ); + } + + $aForm = $this->{'_getForm' . ucfirst($sType)}($iCmtParentId, $aDp); + if(empty($aForm['form'])) + return !empty($aForm['msg']) ? MsgBox($aForm['msg']) : ''; + + return $this->_oTemplate->parseHtmlByName('comment_reply_box.html', array( + 'js_object' => $this->_sJsObjName, + 'style_prefix' => $this->_sStylePrefix, + 'class' => $sClass, + 'class_body' => $sClassBody, + 'bx_if:show_form_min' => array( + 'condition' => $bFormMin, + 'content' => $aTmplVarsFormMin + ), + 'form' => $aForm['form'], + 'form_id' => $aForm['form_id'], + )); + } + + protected function _getFormAdd($aValues) + { + $iCmtAuthorId = isset($aValues['cmt_author_id']) ? (int)$aValues['cmt_author_id'] : $this->_getAuthorId(); + $iCmtParentId = isset($aValues['cmt_parent_id']) ? (int)$aValues['cmt_parent_id'] : 0; + + $oForm = $this->_getForm(BX_CMT_ACTION_POST, $iCmtParentId); + $oForm->aFormAttrs['method'] = BX_DOL_FORM_METHOD_SPECIFIC; + $oForm->aParams['csrf']['disable'] = true; + $oForm->aInputs['cmt_parent_id']['value'] = $iCmtParentId; + if(!empty($oForm->aParams['db']['submit_name'])) { + $sSubmitName = false; + if(is_array($oForm->aParams['db']['submit_name'])) + foreach($oForm->aParams['db']['submit_name'] as $sVal) { + if(isset($oForm->aInputs[$sVal])) { + $sSubmitName = $sVal; + break; + } + } + else + $sSubmitName = $oForm->aParams['db']['submit_name']; + + if($sSubmitName && isset($oForm->aInputs[$sSubmitName])) + $aValues[$sSubmitName] = $oForm->aInputs[$sSubmitName]['value']; + } + + $oForm->initChecker(array(), $aValues); + if(!$oForm->isSubmittedAndValid()) + return array('code' => 1, 'message' => '_sys_txt_error_occured'); + + $iLevel = 0; + $iCmtVisualParentId = 0; + if((int)$iCmtParentId > 0) { + $aParent = $this->getCommentRow($iCmtParentId); + + $iLevel = (int)$aParent['cmt_level'] + 1; + $iCmtVisualParentId = $iLevel > $this->getMaxLevel() ? $aParent['cmt_vparent_id'] : $iCmtParentId; + } + + $iCmtId = (int)$oForm->insert(array('cmt_vparent_id' => $iCmtVisualParentId, 'cmt_object_id' => $this->_iId, 'cmt_author_id' => $iCmtAuthorId, 'cmt_level' => $iLevel, 'cmt_time' => time())); + if(!$iCmtId) { + if(!$oForm->isValid()) + return array('code' => 1, 'message' => '_sys_txt_error_occured'); + else + return array('code' => 2, 'message' => '_cmt_err_cannot_perform_action'); + } + + $iCmtUniqId = $this->_oQuery->getUniqId($this->_aSystem['system_id'], $iCmtId, [ + 'author_id' => $iCmtAuthorId, + 'status_admin' => $this->getStatusAdmin() + ]); + + if($iCmtParentId) { + $this->_oQuery->updateRepliesCount($iCmtParentId, 1); + + if(!BxDolModuleQuery::getInstance()->isEnabledByName('bx_notifications')) + $this->_sendNotificationEmail($iCmtId, $iCmtParentId); + } + + $this->_triggerComment(); + + if($this->_sMetatagsObj && ($oMetatags = BxDolMetatags::getObjectInstance($this->_sMetatagsObj)) !== false) + $oMetatags->metaAdd($iCmtUniqId, $aValues['cmt_text']); + + $mixedResult = $this->onPostAfter($iCmtId); + if($mixedResult === false) + return array('code' => 2, 'message' => '_cmt_err_cannot_perform_action'); + + return $mixedResult; + } + + protected function _getFormPost($iCmtParentId = 0, $aDp = []) + { + $bCmtParentId = !empty($iCmtParentId); + + if(!$bCmtParentId && !$this->isPostAllowed()) { + $sMsg = ''; + if(!isLogged()) { + $oPermalink = BxDolPermalinks::getInstance(); + $sMsg = _t('_cmt_msg_login_required', $oPermalink->permalink('page.php?i=login'), $oPermalink->permalink('page.php?i=create-account')); + } + else + $sMsg = $this->msgErrPostAllowed(); + + return bx_is_api() ? bx_api_get_msg($sMsg) : ['msg' => $sMsg]; + } + + if($bCmtParentId && !$this->isReplyAllowed($iCmtParentId)) + return bx_is_api() ? bx_api_get_msg($sMsg) : ['msg' => $this->msgErrReplyAllowed()]; + + $bDynamic = isset($aDp['dynamic_mode']) && (bool)$aDp['dynamic_mode']; + $bQuote = isset($aDp['quote']) && (bool)$aDp['quote']; + + $oForm = $this->_getForm(BX_CMT_ACTION_POST, $iCmtParentId, $aDp); + $oForm->aInputs['cmt_parent_id']['value'] = $iCmtParentId; + + if($bQuote) { + $aCmtParent = $this->getCommentRow((int)$iCmtParentId); + if(!empty($aCmtParent['cmt_text'])) + $oForm->aInputs['cmt_text']['value'] = $this->_oTemplate->parseHtmlByName('comment_quote.html', [ + 'content' => $aCmtParent['cmt_text'] + ]); + } + + $oForm->initChecker(); + if($oForm->isSubmittedAndValid()) { + $iCmtAuthorId = $this->_getAuthorId(); + $iCmtParentId = (int)$oForm->getCleanValue('cmt_parent_id'); + + //--- Process Text ---// + $sCmtText = $oForm->getCleanValue('cmt_text'); + $bCmtText = !empty($sCmtText); + + //--- Process Media ---// + $aImageIds = $oForm->getCleanValue('cmt_image'); + $bImageIds = !empty($aImageIds) && is_array($aImageIds); + + if(!$bCmtText && !$bImageIds) { + $oForm->aInputs['cmt_text']['error'] = _t('_Please enter characters'); + $oForm->setValid(false); + return bx_is_api() ? ['form' => $oForm, 'res' => 0] : ['form' => $oForm->getCode($bDynamic), 'form_id' => $oForm->id]; + } + + $aParent = []; + if($iCmtParentId > 0) { + $aParent = $this->getCommentRow($iCmtParentId); + if(empty($aParent) || !is_array($aParent)) { + $iCmtParentId = 0; + $oForm->setSubmittedValue('cmt_parent_id', $iCmtParentId, $oForm->aFormAttrs['method']); + } + } + + $iLevel = 0; + $iCmtVisualParentId = 0; + if($iCmtParentId > 0) { + $iLevel = (int)$aParent['cmt_level'] + 1; + $iCmtVisualParentId = $iLevel > $this->getMaxLevel() ? $aParent['cmt_vparent_id'] : $iCmtParentId; + } + + $iCmtId = (int)$oForm->insert(['cmt_vparent_id' => $iCmtVisualParentId, 'cmt_object_id' => $this->_iId, 'cmt_author_id' => $iCmtAuthorId, 'cmt_level' => $iLevel, 'cmt_time' => time()]); + if($iCmtId != 0) { + $iCmtUniqId = $this->_oQuery->getUniqId($this->_aSystem['system_id'], $iCmtId, [ + 'author_id' => $iCmtAuthorId, + 'status_admin' => $this->getStatusAdmin() + ]); + + if($this->isAttachImageEnabled()) + $oForm->processImages($this, 'cmt_image', $iCmtUniqId, $iCmtId, $iCmtAuthorId, true); + + if($iCmtParentId > 0) { + $this->_oQuery->updateRepliesCount($iCmtParentId, 1); + + if(!BxDolModuleQuery::getInstance()->isEnabledByName('bx_notifications')) + $this->_sendNotificationEmail($iCmtId, $iCmtParentId); + } + + $this->_triggerComment(); + + if($iCmtParentId > 0) + $this->isReplyAllowed($iCmtParentId, true); + else + $this->isPostAllowed(true); + + if($this->_sMetatagsObj && ($oMetatags = BxDolMetatags::getObjectInstance($this->_sMetatagsObj)) !== false) + $oMetatags->metaAdd($iCmtUniqId, $sCmtText); + + if(($mixedResult = $this->onPostAfter($iCmtId, $aDp)) !== false){ + if (bx_is_api()){ + $this->_unsetFormObject(BX_CMT_ACTION_POST); + return ['form' => $this->_getForm(BX_CMT_ACTION_POST, $iCmtParentId), 'res' => $iCmtId]; + } + else{ + return $mixedResult; + } + } + } + return bx_is_api() ? bx_api_get_msg('_cmt_err_cannot_perform_action') : ['msg' => _t('_cmt_err_cannot_perform_action')]; + } + return bx_is_api() ? ['form' => $oForm, 'res' => 0] : ['form' => $oForm->getCode($bDynamic), 'form_id' => $oForm->id]; + } + + protected function _getFormEdit($iCmtId, $aDp = []) + { + $bDynamic = isset($aDp['dynamic_mode']) && (bool)$aDp['dynamic_mode']; + + $aCmt = $this->getCommentSimple($iCmtId); + if(!$aCmt) + return bx_is_api() ? bx_api_get_msg(_t('_No such comment')) : array('msg' => _t('_No such comment')); + + $iCmtAuthorId = $this->_getAuthorId(); + if(!$this->isEditAllowed($aCmt)){ + $sMsg = $aCmt['cmt_author_id'] == $iCmtAuthorId ? strip_tags($this->msgErrEditAllowed()) : _t('_Access denied'); + return bx_is_api() ? bx_api_get_msg($sMsg) : array('msg' => $sMsg); + } + + $oForm = $this->_getForm(BX_CMT_ACTION_EDIT, $aCmt['cmt_id'], $aDp); + + $oForm->initChecker($aCmt); + if($oForm->isSubmittedAndValid()) { + $sCmtText = $oForm->getCleanValue('cmt_text'); + + if($oForm->update($iCmtId) !== false) { + $iCmtUniqId = $this->_oQuery->getUniqId($this->_aSystem['system_id'], $iCmtId, [ + 'author_id' => (int)$aCmt['cmt_author_id'] + ]); + + $sStatusAdmin = $this->getStatusAdmin(); + if($sStatusAdmin !== BX_CMT_STATUS_ACTIVE) + $this->_oQuery->updateUniqId(['status_admin' => $sStatusAdmin], ['id' => $iCmtUniqId]); + + if($this->isAttachImageEnabled()) + $oForm->processImages($this, 'cmt_image', $iCmtUniqId, $iCmtId, $iCmtAuthorId, false); + + $this->isEditAllowed($aCmt, true); + + if($this->_sMetatagsObj && ($oMetatags = BxDolMetatags::getObjectInstance($this->_sMetatagsObj)) !== false) + $oMetatags->metaAdd($iCmtUniqId, $sCmtText); + + if(($mixedResult = $this->onEditAfter($iCmtId, $aDp)) !== false){ + if (bx_is_api()){ + $this->_unsetFormObject(BX_CMT_ACTION_POST); + return ['form' => $this->_getForm(BX_CMT_ACTION_POST, $iCmtParentId), 'res' => $iCmtId]; + } + else{ + return $mixedResult; + } + } + + } + return bx_is_api() ? bx_api_get_msg(_t('_cmt_err_cannot_perform_action')) : array('msg' => _t('_cmt_err_cannot_perform_action')); + } + + return bx_is_api() ? ['form' => $oForm, 'res' => 0] : array('form' => $oForm->getCode($bDynamic), 'form_id' => $oForm->id); + } + + protected function _getForm($sAction, $iId, $aDp = []) + { + $oForm = $this->_getFormObject($sAction); + $oForm->setId(sprintf($oForm->getAttributeMask('id'), $sAction, $this->_sSystem, $this->_iId, $iId)); + $oForm->setName(sprintf($oForm->getAttributeMask('name'), $sAction, $this->_sSystem, $this->_iId, $iId)); + $oForm->aParams['db']['table'] = $this->_aSystem['table']; + $oForm->aInputs['sys']['value'] = $this->_sSystem; + $oForm->aInputs['id']['value'] = $this->_iId; + $oForm->aInputs['action']['value'] = 'Submit' . ucfirst($sAction) . 'Form'; + + if($this->_aParams) + $oForm->aInputs = ['params' => [ + 'name' => 'params', + 'type' => 'hidden', + 'value' => json_encode($this->_aParams) + ]] + $oForm->aInputs; + + if(!$this->isAttachImageEnabled()) + unset($oForm->aInputs['cmt_image']); + + if(isset($oForm->aInputs['cmt_text'])) { + $oForm->aInputs['cmt_text']['html'] = $this->_aSystem['html']; + $oForm->aInputs['cmt_text']['db']['pass'] = $this->isHtml() ? 'XssHtml' : 'XssMultiline'; + + if(isset($oForm->aInputs['cmt_text']['checker']['func']) && strtolower($oForm->aInputs['cmt_text']['checker']['func']) == 'length') { + $iCmtTextMin = (int)$this->_aSystem['chars_post_min']; + $iCmtTextMax = (int)$this->_aSystem['chars_post_max']; + $oForm->aInputs['cmt_text']['checker']['params'] = array($iCmtTextMin, $iCmtTextMax); + $oForm->aInputs['cmt_text']['checker']['error'] = _t('_Please enter n1-n2 characters', $iCmtTextMin, $iCmtTextMax); + } + } + + if($sAction == BX_CMT_ACTION_EDIT && isset($oForm->aInputs['cmt_controls'])) + foreach($oForm->aInputs['cmt_controls'] as $mixedKey => $mixedValue) { + if(!is_numeric($mixedKey) || empty($mixedValue['name']) || $mixedValue['name'] != 'cmt_cancel') + continue; + + if(!isset($oForm->aInputs['cmt_controls'][$mixedKey]['attrs'])) + $oForm->aInputs['cmt_controls'][$mixedKey]['attrs'] = array(); + + $oForm->aInputs['cmt_controls'][$mixedKey]['attrs']['onclick'] = $this->_sJsObjName . '.cmtEdit(this, ' . $iId . ', false)'; + } + + return $oForm; + } + + protected function _getContent($aCmt, $aBp = [], $aDp = []) + { + $sAttachments = $this->_getAttachments($aCmt); + + return $this->_oTemplate->parseHtmlByName($this->_sTmplNameItemContent, array_merge(array( + 'style_prefix' => $this->_sStylePrefix, + 'js_object' => $this->_sJsObjName, + 'bx_if:show_attached' => array( + 'condition' => !empty($sAttachments), + 'content' => array( + 'style_prefix' => $this->_sStylePrefix, + 'attached' => $sAttachments + ) + ), + 'counters' => $this->_getCountersBox($aCmt, $aBp, $aDp), + ), $this->_getTmplVarsText($aCmt))); + } + + protected function _getMoreLink($sCmts, $aBp = array(), $aDp = array()) + { + $iStart = $iPerView = 0; + switch($aBp['type']) { + case BX_CMT_BROWSE_HEAD: + case BX_CMT_BROWSE_POPULAR: + case BX_CMT_BROWSE_CONNECTION: + $iPerView = $aBp['per_view']; + + $iStart = $aBp['start'] + $iPerView; + if($iStart >= $aBp['count']) + return $sCmts; + + break; + + case BX_CMT_BROWSE_TAIL: + $iPerView = $aBp['per_view']; + + $iStart = $aBp['start'] - $iPerView; + if($iStart < 0) { + $iPerView += $iStart; + $iStart = 0; + } + + if($iStart == 0 && $iPerView == 0) + return $sCmts; + + break; + } + + $sParentKey = isset($aBp['vparent_id']) ? 'vparent_id' : 'parent_id'; + $bRoot = (int)$aBp[$sParentKey] <= 0; + + $sMore = $this->_oTemplate->parseHtmlByName('comment_more.html', array( + 'js_object' => $this->_sJsObjName, + 'style_prefix' => $this->_sStylePrefix, + 'bx_if:is_root' => array( + 'condition' => $bRoot, + 'content' => array() + ), + 'parent_id' => $aBp[$sParentKey], + 'start' => $iStart, + 'per_view' => $iPerView, + 'title' => _t('_cmt_load_more_' . ($aBp[$sParentKey] == 0 ? 'comments' : 'replies') . '_' . $aBp['type']) + )); + + switch($aBp['type']) { + case BX_CMT_BROWSE_HEAD: + case BX_CMT_BROWSE_POPULAR: + case BX_CMT_BROWSE_CONNECTION: + $sCmts .= $sMore; + break; + + case BX_CMT_BROWSE_TAIL: + $sCmts = $sMore . $sCmts; + break; + } + + return $sCmts; + } + + protected function _getEmpty($aDp = array()) + { + $sClass = ''; + if(!empty($aDp['class'])) + $sClass .= ' ' . $aDp['class']; + + return $this->_oTemplate->parseHtmlByName('comment_empty.html', array( + 'style_prefix' => $this->_sStylePrefix, + 'class' => $sClass, + 'content' => MsgBox(_t('_Empty')) + )); + } + + protected function _getAttachments($aCmt) + { + $aTmplImages = array(); + if(!$this->isAttachImageEnabled()) + return ''; + + $aFiles = $this->_oQuery->getFiles($this->_aSystem['system_id'], $aCmt['cmt_id']); + if(!empty($aFiles) && is_array($aFiles)) { + $oStorage = BxDolStorage::getObjectInstance($this->getStorageObjectName()); + $oTranscoder = BxDolTranscoderImage::getObjectInstance($this->getTranscoderPreviewName()); + + foreach($aFiles as $aFile) { + $sFile = $oStorage->getFileUrlById($aFile['image_id']); + $bImage = $oTranscoder && $oTranscoder->isMimeTypeSupported($aFile['mime_type']); + + $sPreview = ''; + $iWidth = $iHeight = 0; + + if($bImage) { + if(!$this->_bIsApi && $oTranscoder) + $sPreview = $oTranscoder->getFileUrl($aFile['image_id']); + + if(empty($aFile['dimensions'])) { + $aFileInfo = $oStorage->getFile($aFile['image_id']); + if(!empty($aFileInfo['dimensions'])) + $aFile['dimensions'] = $aFileInfo['dimensions']; + } + + if(!empty($aFile['dimensions'])) + list($iWidth, $iHeight) = explode('x', $aFile['dimensions']); + } + + if(!$this->_bIsApi && !$sPreview) + $sPreview = $this->_oTemplate->getIconUrl($oStorage->getIconNameByFileName($aFile['file_name'])); + + $aTmplVarsFile = array( + 'js_object' => $this->_sJsObjName, + 'preview' => $sPreview, + 'file' => $sFile, + 'file_id' => $aFile['id'], + 'file_name' => $aFile['file_name'], + 'file_icon' => $oStorage->getFontIconNameByFileName($aFile['file_name']), + 'file_size' => _t_format_size($aFile['size']), + 'w' => $iWidth, + 'h' => $iHeight + ); + + if($this->_bIsApi){ + $aTmplImages[] = array( + 'is_image' => $bImage, + 'file' => $aTmplVarsFile['file'], + 'file_id' => $aTmplVarsFile['file_id'], + 'file_name' => $aTmplVarsFile['file_name'], + 'file_icon' => $aTmplVarsFile['file_icon'], + 'file_size' => $aTmplVarsFile['file_size'], + 'width' => $aTmplVarsFile['w'], + 'height' => $aTmplVarsFile['h'], + ); + } + else{ + $aTmplImages[] = array( + 'style_prefix' => $this->_sStylePrefix, + 'bx_if:show_image' => array( + 'condition' => $bImage, + 'content' => $aTmplVarsFile + ), + 'bx_if:show_file' => array( + 'condition' => !$bImage, + 'content' => $aTmplVarsFile + ), + ); + } + } + } + + if (bx_is_api()){ + return $aTmplImages; + } + + return $this->_oTemplate->parseHtmlByName('comment_attachments.html', array( + 'bx_repeat:attached' => $aTmplImages + )); + } + + protected function _getTmplVarsNotes($aCmt) + { + $aTmplVars = array(); + + //--- Pending status related notes. + if($aCmt['cmt_status_admin'] == BX_CMT_STATUS_PENDING) + $aTmplVars[] = [ + 'style_prefix' => $this->_sStylePrefix, + 'bx_if:show_note_color' => [ + 'condition' => true, + 'content' => [ + 'item_note_color' => 'red3' + ] + ], + 'item_note' => _t('_cmt_txt_note_approve_pending') + ]; + + return [ + 'bx_if:show_notes' => [ + 'condition' => !empty($aTmplVars), + 'content' => [ + 'style_prefix' => $this->_sStylePrefix, + 'bx_repeat:notes' => $aTmplVars + ] + ], + ]; + } + + protected function _getTmplVarsAuthor($aCmt) + { + list($sAuthorName, $sAuthorLink, $sAuthorIcon, $sAuthorUnit) = $this->_getAuthorInfo($aCmt['cmt_author_id']); + $bAuthorIcon = !empty($sAuthorIcon); + + return array( + 'author_unit' => $sAuthorUnit, + 'bx_if:show_icon' => array( + 'condition' => $bAuthorIcon, + 'content' => array( + 'author_icon' => $sAuthorIcon + ) + ), + 'bx_if:show_icon_empty' => array( + 'condition' => !$bAuthorIcon, + 'content' => array() + ), + 'bx_if:show_author_link' => array( + 'condition' => !empty($sAuthorLink), + 'content' => array( + 'author_link' => $sAuthorLink, + 'author_title' => bx_html_attribute($sAuthorName), + 'author_name' => $sAuthorName + ) + ), + 'bx_if:show_author_text' => array( + 'condition' => empty($sAuthorLink), + 'content' => array( + 'author_name' => $sAuthorName + ) + ), + ); + } + + protected function _getTmplVarsText($aCmt) + { + return [ + 'style_prefix' => $this->_sStylePrefix, + 'text' => $this->_prepareTextForOutput($aCmt['cmt_text'], $aCmt['cmt_id']) + ]; + } + + protected function _getDoComment($aParams = [], $isAllowedComment = true) + { + $bShowDoCommentAsButtonSmall = isset($aParams['show_do_comment_as_button_small']) && $aParams['show_do_comment_as_button_small'] == true; + $bShowDoCommentAsButton = !$bShowDoCommentAsButtonSmall && isset($aParams['show_do_comment_as_button']) && $aParams['show_do_comment_as_button'] == true; + + $iCount = isset($aParams['count']) ? (int)$aParams['count'] : 0; + $bDisabled = !$isAllowedComment; + + $sClass = ''; + if($bShowDoCommentAsButton) + $sClass = 'bx-btn'; + else if ($bShowDoCommentAsButtonSmall) + $sClass = 'bx-btn bx-btn-small'; + + if(!$isAllowedComment) + $sClass .= $bShowDoCommentAsButton || $bShowDoCommentAsButtonSmall ? ' bx-btn-disabled' : 'bx-cmts-disabled'; + + if($this->_bIsApi) + return [ + 'is_disabled' => $bDisabled, + 'count' => $iCount, + 'link' => bx_api_get_relative_url($this->getListUrl()), + 'title' => _t($this->_getTitleDo(), $iCount) + ]; + + return $this->_oTemplate->parseLink($this->getListUrl(), $this->_getLabelDo($aParams), [ + 'class' => $this->_sStylePrefix . '-do-comment ' . $this->_sStylePrefix . '-dc ' . $sClass, + 'title' => _t($this->_getTitleDo(), $iCount) + ]); + } +} + +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseCmtsMenuManage.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseCmtsMenuManage.php new file mode 100644 index 0000000000..0aac953a65 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseCmtsMenuManage.php @@ -0,0 +1,56 @@ +setCmtsData($oCmts, (int)bx_get('cmt_id')); + } + + $this->_bDynamicMode = true; + $this->_bShowTitles = true; + } + + public function initContentParams() + { + parent::initContentParams(); + + $this->_aContentParams = array_merge($this->_aContentParams, [ + 'cmt_system' => $this->_oCmts->getSystemName(), + 'cmt_object_id' => $this->_oCmts->getId(), + 'cmt_id' => (int)$this->_aCmt['cmt_id'] + ]); + } + + public function setContentParams($aParams) + { + if(!isset($aParams['cmt_system'], $aParams['cmt_object_id'], $aParams['cmt_id'])) + return false; + + $oCmts = BxTemplCmts::getObjectInstance($aParams['cmt_system'], (int)$aParams['cmt_object_id']); + if(!$oCmts) + return false; + + $this->setCmtsData($oCmts, (int)$aParams['cmt_id']); + + return parent::setContentParams($aParams); + } +} + +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseCmtsNotes.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseCmtsNotes.php new file mode 100644 index 0000000000..351ea1989f --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseCmtsNotes.php @@ -0,0 +1,31 @@ +aInputs['cmt_cf'])) + unset($oForm->aInputs['cmt_cf']); + + return $oForm; + } +} + +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseCmtsReviews.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseCmtsReviews.php new file mode 100644 index 0000000000..2663c063f0 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseCmtsReviews.php @@ -0,0 +1,164 @@ +_sTmplNameItemContent = 'review_content.html'; + + $this->_sJsObjClass = 'BxDolCmtsReviews'; + } + + public function getStylePrefix() + { + return $this->_sStylePrefix; + } + + public function getComment($mixedCmt, $aBp = array(), $aDp = array()) + { + $sResult = parent::getComment($mixedCmt, $aBp, $aDp); + if(empty($sResult)) + return $sResult; + + $sMood = $this->_getMood($mixedCmt, $aDp); + return $this->_oTemplate->parseHtmlByContent($sResult, array( + 'bx_if:show_mood' => array( + 'condition' => !empty($sMood), + 'content' => array( + 'style_prefix' => $this->_sStylePrefix, + 'mood' => $sMood + ) + ) + )); + } + + function getRatingBlock($aDp = array()) + { + $mixedResult = $this->isViewAllowed(); + if($mixedResult !== CHECK_ACTION_RESULT_ALLOWED) + return $mixedResult; + + $aBp = array(); + $this->_getParams($aBp, $aDp); + + $iId = $this->getId(); + $aStats = $this->_oQuery->getReviewsStats($iId); + + if(!empty($aStats) && is_array($aStats) && (int)$aStats['count'] > 0) + $sContent = $this->_oTemplate->parseHtmlByName('reviews_rating_block.html', array( + 'style_prefix' => $this->_sStylePrefix, + 'system' => $this->_sSystem, + 'id' => $iId, + 'content' => $this->_oTemplate->parseHtmlByName('review_mood_legend.html', array_merge(array( + 'style_prefix' => $this->_sStylePrefix, + 'html_id' => $this->getRatingLegendId(), + 'value' => (float)$aStats['avg'], + 'bx_if:show_init' => array( + 'condition' => false, + 'content' => array() + ) + ), $this->_getTmplVarsStars())), + 'script' => $this->getJsScript($aBp, $aDp) + )); + else + $sContent = MsgBox(_t('_cmt_rvw_txt_empty')); + + $sCaption = _t($this->_aT['block_rating_title']); + return $aDp['in_designbox'] ? DesignBoxContent($sCaption, $sContent) : array( + 'title' => $sCaption, + 'content' => $sContent + ); + } + + protected function _getForm($sAction, $iId, $aDp = []) + { + $oForm = parent::_getForm($sAction, $iId, $aDp); + + switch($sAction) { + case BX_CMT_ACTION_POST: + if(!empty($iId)) + unset($oForm->aInputs['cmt_mood']); + break; + + case BX_CMT_ACTION_EDIT: + $aCmt = $this->getCommentSimple($iId); + if(!empty($aCmt['cmt_parent_id'])) + unset($oForm->aInputs['cmt_mood']); + break; + } + + return $oForm; + } + + protected function _getContent($aCmt, $aBp = [], $aDp = []) + { + $sMood = $this->_getMood($aCmt, $aDp); + $sContent = parent::_getContent($aCmt, $aBp, $aDp); + return $this->_oTemplate->parseHtmlByContent($sContent, [ + 'bx_if:show_mood' => [ + 'condition' => !empty($sMood), + 'content' => [ + 'style_prefix' => $this->_sStylePrefix, + 'mood' => $sMood + ] + ] + ]); + } + + protected function _getMood(&$aCmt, $aDp = array()) + { + if(!is_array($aCmt)) + $aCmt = $this->getCommentSimple((int)$aCmt); + + if((int)$aCmt['cmt_parent_id'] > 0) + return ''; + + $sHtmlId = $this->getMoodLegendId($aCmt['cmt_id']); + return $this->_oTemplate->parseHtmlByName('review_mood_legend.html', array_merge(array( + 'style_prefix' => $this->_sStylePrefix, + 'html_id' => $sHtmlId, + 'value' => (int)$aCmt['cmt_mood'], + 'bx_if:show_init' => array( + 'condition' => isset($aDp['dynamic_mode']) && (bool)$aDp['dynamic_mode'], + 'content' => array( + 'style_prefix' => $this->_sStylePrefix, + 'js_object' => $this->_sJsObjName, + 'html_id' => $sHtmlId, + ) + ) + ), $this->_getTmplVarsStars())); + } + + protected function _getTmplVarsStars() { + $aTmplVarsStars = $aTmplVarsSlider = array(); + for($i = $this->_iMoodMinValue; $i <= $this->_iMoodMaxValue; $i++) { + $aTmplVarsStars[] = array( + 'style_prefix' => $this->_sStylePrefix, + 'value' => $i + ); + + $aTmplVarsSlider[] = array( + 'style_prefix' => $this->_sStylePrefix + ); + } + + return array( + 'bx_repeat:stars' => $aTmplVarsStars, + 'bx_repeat:slider' => $aTmplVarsSlider + ); + } +} + +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseCmtsReviewsForm.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseCmtsReviewsForm.php new file mode 100644 index 0000000000..c90a18e155 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseCmtsReviewsForm.php @@ -0,0 +1,86 @@ +_sSystem = ''; + $this->_iId = 0; + } + + protected function genCustomInputCmtMood ($aInput) + { + if(bx_is_api()) { + $aInput['type'] = 'mood'; + return $aInput; + } + + $oSystem = $this->_getSystemObject(); + + $sStylePrefix = $oSystem->getStylePrefix(); + $sJsObject = $oSystem->getJsObjectName(); + + $iMoodMinValue = $oSystem->getMoodMinValue(); + $iMoodMaxValue = $oSystem->getMoodMaxValue(); + + $aTmplVarsStars = $aTmplVarsSlider = $aTmplVarsButtons = array(); + for($i = $iMoodMinValue; $i <= $iMoodMaxValue; $i++) { + $aTmplVarsStars[] = array( + 'style_prefix' => $sStylePrefix, + 'value' => $i + ); + + $aTmplVarsSlider[] = array( + 'style_prefix' => $sStylePrefix + ); + + $aTmplVarsButtons[] = array( + 'style_prefix' => $sStylePrefix, + 'js_object' => $sJsObject, + 'value' => $i + ); + } + + return $this->oTemplate->parseHtmlByName('review_mood_form_field.html', array( + 'style_prefix' => $sStylePrefix, + 'name' => $aInput['name'], + 'value' => !empty($aInput['value']) ? $aInput['value'] : 0, + 'bx_repeat:stars' => $aTmplVarsStars, + 'bx_repeat:slider' => $aTmplVarsSlider, + 'bx_repeat:buttons' => $aTmplVarsButtons, + 'bx_if:show_init' => array( + 'condition' => $this->_bDynamicMode, + 'content' => array( + 'style_prefix' => $sStylePrefix, + 'js_object' => $sJsObject, + 'form_id' => $this->getId(), + ) + ) + )); + } + + protected function _getSystemObject() + { + if(empty($this->_sSystem)) + $this->_sSystem = $this->aInputs['sys']['value']; + + if(empty($this->_iId)) + $this->_iId = (int)$this->aInputs['id']['value']; + + return BxDolCmts::getObjectInstance($this->_sSystem, $this->_iId); + } +} + +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseCmtsServices.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseCmtsServices.php new file mode 100644 index 0000000000..38de662414 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseCmtsServices.php @@ -0,0 +1,709 @@ +serviceGetAuthor((int)$aCmt['cmt_id']); + } + + public function serviceGetBlockAuthor($sSystem = '', $iObjectId = 0, $iCommentId = 0) + { + if(empty($sSystem) && ($sSystem = bx_get('sys')) !== false) + $sSystem = bx_process_input($sSystem); + + if(empty($iObjectId) && ($iObjectId = bx_get('id')) !== false) + $iObjectId = bx_process_input($iObjectId, BX_DATA_INT); + + if(empty($iCommentId) && ($iCommentId = bx_get('cmt_id')) !== false) + $iCommentId = bx_process_input($iCommentId, BX_DATA_INT); + + if(bx_is_api()) { + $oCmts = BxDolCmts::getObjectInstance($sSystem, $iObjectId, true); + $aCmt = $oCmts->getCommentRow($iCommentId); + + return [bx_api_get_block('entity_author', [ + 'author_data' => BxDolProfile::getData($aCmt['cmt_author_id']), + 'entry_date' => $aCmt['cmt_time'], + 'menu_manage' => [], + 'text' => bx_process_output(strip_tags($oCmts->getObjectTitle($iObjectId))), + 'url' => bx_api_get_relative_url($oCmts->getBaseUrl()) + ])]; + } + + return ''; + } + + public function serviceGetInfo($iCmtUniqId, $bSearchableFieldsOnly = true) + { + $oCmts = BxDolCmts::getObjectInstanceByUniqId($iCmtUniqId); + if(!$oCmts) + return []; + + $aCmt = BxDolCmtsQuery::getCommentExtendedByUniqId($iCmtUniqId); + if(empty($aCmt) || !is_array($aCmt)) + return []; + + return $oCmts->serviceGetInfo((int)$aCmt['cmt_id'], $bSearchableFieldsOnly); + } + + public function serviceGetBlockView($sSystem = '', $iObjectId = 0, $iCommentId = 0, $iParentsDepthMax = false) + { + $bIsApi = bx_is_api(); + + if(empty($sSystem) && ($sSystem = bx_get('sys')) !== false) + $sSystem = bx_process_input($sSystem); + + if(empty($iObjectId) && ($iObjectId = bx_get('id')) !== false) + $iObjectId = bx_process_input($iObjectId, BX_DATA_INT); + + if(empty($iCommentId) && ($iCommentId = bx_get('cmt_id')) !== false) + $iCommentId = bx_process_input($iCommentId, BX_DATA_INT); + + $oCmts = BxDolCmts::getObjectInstance($sSystem, $iObjectId, true); + if(!$oCmts) + return $bIsApi ? [] : ''; + + $iCmtStartFrom = $iCommentId; + if($iParentsDepthMax !== false) { + $aCmtParents = $oCmts->getCommentParents($iCommentId, $iParentsDepthMax); + if(!empty($aCmtParents) && is_array($aCmtParents)) + $iCmtStartFrom = array_pop($aCmtParents); + } + + if($bIsApi) { + $aRv = $this->serviceGetDataApi([ + 'module' => $sSystem, + 'object_id' => $iObjectId, + 'comment_id' => $iCmtStartFrom + ]); + + if(isset($aRv['browse']) && is_array($aRv['browse'])) { + $aRv['browse']['data']['total_count'] = 0; + + if($iParentsDepthMax !== false) + $aRv['browse']['data']['highlighted'] = $iCommentId; + } + + return [$aRv]; + } + + return $oCmts->getCommentBlock($iCmtStartFrom); + } + + public function serviceAlertResponseSysCmtsImagesFileDeleted($oAlert) + { + $iUniqId = (int)$oAlert->aExtras['ghost']['content_id']; + + $aCmt = BxDolCmts::getGlobalInfo($iUniqId); + if(empty($aCmt) || !is_array($aCmt)) + return; + + $oCmts = BxDolCmts::getObjectInstance($aCmt['system_name'], 0, false); + if(!$oCmts) + return; + + $oCmts->getQueryObject()->deleteImages($aCmt['system_id'], false, $oAlert->iObject); + } + + public function serviceGetMenuItemAddonVote($sSystem, $iId, $iCmtId) + { + $oCmts = BxDolCmts::getObjectInstance($sSystem, $iId); + + $oVote = $oCmts->getVoteObject($oCmts->getCommentUniqId($iCmtId)); + if($oVote !== false) + return $oVote->getCounter(); + + return ''; + } + + public function serviceGetLiveUpdate($sSystem, $iContentId, $iProfileId, $iCount = 0) + { + $oCmts = BxDolCmts::getObjectInstance($sSystem, $iContentId); + if(!$oCmts || !$oCmts->isEnabled()) + return false; + + $sKey = $oCmts->getNotificationId(); + + bx_import('BxDolSession'); + if((int)BxDolSession::getInstance()->getValue($sKey) == 1) + return false; + + $iCountNew = $oCmts->getCommentsCount($iContentId, -1, BX_CMT_FILTER_OTHERS); + if($iCountNew == $iCount) + return false; + + return array( + 'count' => $iCountNew, // required + 'method' => $oCmts->getJsObjectName() . '.showLiveUpdate(oData)', // required + 'data' => array( + 'code' => $oCmts->getLiveUpdate($iCount, $iCountNew) + ), // optional, may have some additional data to be passed in JS method provided using 'method' param above. + ); + } + + public function serviceGetLiveUpdates($sSystem, $iContentId, $iProfileId, $iCount = 0) + { + $oCmts = BxDolCmts::getObjectInstance($sSystem, $iContentId); + if(!$oCmts || !$oCmts->isEnabled()) + return false; + + $sKey = $oCmts->getNotificationId(); + + bx_import('BxDolSession'); + if((int)BxDolSession::getInstance()->getValue($sKey) == 1) + return false; + + $iCountNew = $oCmts->getCommentsCount($iContentId, -1, BX_CMT_FILTER_OTHERS); + if($iCountNew == $iCount) + return false; + + return array( + 'count' => $iCountNew, // required + 'method' => $oCmts->getJsObjectName() . '.showLiveUpdates(oData)', // required + 'data' => array( + 'code' => $oCmts->getLiveUpdates($iCount, $iCountNew) + ), // optional, may have some additional data to be passed in JS method provided using 'method' param above. + ); + } + + public function serviceManageTools($sType = 'common') + { + $oGrid = BxDolGrid::getObjectInstance('sys_cmts_administration'); + if(!$oGrid) + return ''; + + $oTemplate = BxDolTemplate::getInstance(); + $oTemplate->addJs(array('BxDolCmtsManageTools.js')); + $oTemplate->addCss(array('cmts_manage_tools.css')); + $oTemplate->addJsTranslation(array('_sys_grid_search')); + return array( + 'content' => $oGrid->getCode() + ); + } + + public function serviceGetMenuAddonManageTools() + { + $iNumTotal = BxDolCmts::getGlobalNumByParams(); + + $iNum1 = BxDolCmts::getGlobalNumByParams([[ + 'key' => 'status_admin', + 'value' => 'pending', + 'operator' => '=' + ]]); + + $iNum2 = BxDolCmts::getGlobalNumByParams([[ + 'key' => 'reports', + 'value' => '0', + 'operator' => '>' + ]]); + + return [ + 'counter1_value' => $iNum1, + 'counter1_caption' => _t('_sys_menu_dashboard_manage_tools_addon_counter1_caption_profile_default'), + 'counter2_value' => $iNum2, + 'counter3_value' => $iNumTotal + ]; + } + + /** + * Comment Added for Timeline module + */ + public function serviceGetTimelinePost($aEvent, $aBrowseParams = array()) + { + $bCache = true; + + $iCmtUniqId = $aEvent['object_id']; + $oCmts = BxDolCmts::getObjectInstanceByUniqId($iCmtUniqId); + if(!$oCmts) + return false; + + $aCmt = BxDolCmtsQuery::getCommentExtendedByUniqId($iCmtUniqId); + if(empty($aCmt) || !is_array($aCmt)) + return false; + + $iCmtId = (int)$aCmt['cmt_id']; + + $iUserId = bx_get_logged_profile_id(); + $iAuthorId = (int)$aCmt['cmt_author_id']; + $iAuthorIdAbs = abs($iAuthorId); + if($iAuthorId < 0 && ((is_numeric($aEvent['owner_id']) && $iAuthorIdAbs == (int)$aEvent['owner_id']) || (is_array($aEvent['owner_id']) && in_array($iAuthorIdAbs, $aEvent['owner_id']))) && $iAuthorIdAbs != $iUserId) + return false; + + $sCmtUrl = $oCmts->getViewUrl($iCmtId); + + $sSample = '_cmt_txt_sample_comment_single_with_article'; + $sSampleWoArticle = '_cmt_txt_sample_comment_single'; + $sAction = ''; + $sActionCustom = '_cmt_txt_added_sample_custom'; + $aActionCustomMarkers = array( + 'sample' => $sSample, + 'sample_url' => $sCmtUrl, + 'psample' => strip_tags($oCmts->getObjectTitle()), + 'psample_url' => $oCmts->getBaseUrl(), + ); + + $iOwnerId = $iAuthorIdAbs; + if(isset($aEvent['object_privacy_view']) && (int)$aEvent['object_privacy_view'] < 0) + $iOwnerId = abs($aEvent['object_privacy_view']); + + //--- Votes + $aVotes = array(); + if(($oVotes = $oCmts->getVoteObject($iCmtUniqId)) !== false) + $aVotes = array( + 'system' => $oVotes->getSystemName(), + 'object_id' => $iCmtUniqId, + 'count' => $aCmt['votes'] + ); + + //--- Reactions + $aReactions = array(); + if(($oReactions = $oCmts->getReactionObject($iCmtUniqId)) !== false) + $aReactions = array( + 'system' => $oReactions->getSystemName(), + 'object_id' => $iCmtUniqId, + 'count' => $aCmt['rvotes'] + ); + + //--- Scores + $aScores = array(); + if(($oScores = $oCmts->getScoreObject($iCmtUniqId)) !== false) + $aScores = array( + 'system' => $oScores->getSystemName(), + 'object_id' => $iCmtUniqId, + 'score' => $aCmt['score'] + ); + + //--- Reports + $aReports = array(); + if(($oReports = $oCmts->getReportObject($iCmtUniqId)) !== false) + $aReports = array( + 'system' => $oReports->getSystemName(), + 'object_id' => $iCmtUniqId, + 'count' => $aCmt['reports'] + ); + + return array( + '_cache' => $bCache, + 'owner_id' => $iOwnerId, + 'object_owner_id' => $iAuthorId, + 'icon' => 'comments', + 'sample' => $sSample, + 'sample_wo_article' => $sSampleWoArticle, + 'sample_action' => $sAction, + 'sample_action_custom' => array( + 'content' => $sActionCustom, + 'markers' => $aActionCustomMarkers + ), + 'url' => $sCmtUrl, + 'content' => array( + 'sample' => $sSample, + 'sample_wo_article' => $sSampleWoArticle, + 'sample_action' => $sAction, + 'url' => $sCmtUrl, + 'title' => '', + 'text' => $oCmts->getViewText($aCmt), + 'images' => array(), + 'images_attach' => array(), + 'videos' => array(), + 'videos_attach' => array(), + 'files' => array(), + 'files_attach' => $oCmts->getAttachments($iCmtId) + ), //a string to display or array to parse default template before displaying. + 'date' => $aCmt['cmt_time'], + 'views' => array(), + 'votes' => $aVotes, + 'reactions' => $aReactions, + 'scores' => $aScores, + 'reports' => $aReports, + 'comments' => array(), + 'title' => !empty($aCmt['cmt_text']) ? $aCmt['cmt_text'] : '', //may be empty. + 'description' => '' //may be empty. + ); + } + + /** + * Comment added for Notifications module + */ + public function serviceGetNotificationsCommentAdded($aEvent) + { + $aCommentGi = BxDolCmts::getGlobalInfo($aEvent['subobject_id']); + if(empty($aCommentGi) || !is_array($aCommentGi)) + return []; + + $iContentId = (int)$aEvent['object_id']; + + $oComment = BxDolCmts::getObjectInstance($aCommentGi['system_name'], $iContentId); + if(!$oComment) + return []; + + $aCommentSystem = $oComment->getSystemInfo(); + + $oContentModule = BxDolModule::getInstance($aCommentSystem['module']); + if(!$oContentModule) + return []; + + $aContentInfo = $oContentModule->_oDb->getContentInfoById($iContentId); + if(empty($aContentInfo) || !is_array($aContentInfo)) + return []; + + $CNF = &$oContentModule->_oConfig->CNF; + if(empty($CNF['FIELD_ID']) || empty($CNF['FIELD_AUTHOR']) || !(isset($CNF['FIELD_TITLE']) || isset($CNF['FIELD_TEXT'])) || empty($CNF['URI_VIEW_ENTRY'])) + return []; + + $sEntryUrl = '{bx_url_root}' . BxDolPermalinks::getInstance()->permalink('page.php?i=' . $CNF['URI_VIEW_ENTRY'] . '&id=' . $aContentInfo[$CNF['FIELD_ID']]); + $sEntryCaption = isset($aContentInfo[$CNF['FIELD_TITLE']]) ? $aContentInfo[$CNF['FIELD_TITLE']] : strmaxtextlen($aContentInfo[$CNF['FIELD_TEXT']], 20, '...'); + + return array( + 'entry_sample' => $CNF['T']['txt_sample_single'], + 'entry_url' => $sEntryUrl, + 'entry_caption' => $sEntryCaption, + 'subentry_sample' => $CNF['T']['txt_sample_comment_single'], + 'subentry_url' => '{bx_url_root}' . $oComment->getViewUrl((int)$aCommentGi['cmt_id'], false), + 'lang_key' => '', //may be empty or not specified. In this case the default one from Notification module will be used. + ); + } + + /** + * Comment vote for Notifications module + */ + public function serviceGetNotificationsVote($aEvent) + { + $iCmtIdUnique = (int)$aEvent['object_id']; + + $aCmtInfo = BxDolCmts::getGlobalInfo($iCmtIdUnique); + if(empty($aCmtInfo) || !is_array($aCmtInfo)) + return array(); + + $oCmts = BxDolCmts::getObjectInstance($aCmtInfo['system_name'], 0, false); + if(!$oCmts || !$oCmts->isEnabled()) + return array(); + + $oVote = $oCmts->getVoteObject($iCmtIdUnique); + if(!$oVote) + return array(); + + $iCmtId = (int)$aCmtInfo['cmt_id']; + $sCmtUrl = str_replace(BX_DOL_URL_ROOT, '{bx_url_root}', $oCmts->serviceGetLink($iCmtId)); + $sCmtCaption = strmaxtextlen($oCmts->serviceGetText($iCmtId), 20, '...'); + + return array( + 'entry_sample' => $oCmts->getLanguageKey('txt_sample_single'), + 'entry_url' => $sCmtUrl, + 'entry_caption' => $sCmtCaption, + 'entry_author' => $aCmtInfo['author_id'], + 'subentry_sample' => $oCmts->getLanguageKey('txt_sample_vote_single'), + 'lang_key' => '', //may be empty or not specified. In this case the default one from Notification module will be used. + ); + } + + /** + * Comment reaction for Notifications module + */ + public function serviceGetNotificationsReaction($aEvent) + { + $iCmtIdUnique = (int)$aEvent['object_id']; + + $aCmtInfo = BxDolCmts::getGlobalInfo($iCmtIdUnique); + if(empty($aCmtInfo) || !is_array($aCmtInfo)) + return array(); + + $oCmts = BxDolCmts::getObjectInstance($aCmtInfo['system_name'], 0, false); + if(!$oCmts || !$oCmts->isEnabled()) + return array(); + + $oReaction = $oCmts->getReactionObject($iCmtIdUnique); + if(!$oReaction) + return array(); + + $aSubentry = $oReaction->getTrackBy(array('type' => 'id', 'id' => (int)$aEvent['subobject_id'])); + if(empty($aSubentry) || !is_array($aSubentry)) + return array(); + + $aSubentrySampleParams = array(); + $aReaction = $oReaction->getReaction($aSubentry['reaction']); + if(!empty($aReaction['title'])) + $aSubentrySampleParams[] = $aReaction['title']; + else + $aSubentrySampleParams[] = '_undefined'; + + $iCmtId = (int)$aCmtInfo['cmt_id']; + $sCmtUrl = str_replace(BX_DOL_URL_ROOT, '{bx_url_root}', $oCmts->serviceGetLink($iCmtId)); + $sCmtCaption = strmaxtextlen($oCmts->serviceGetText($iCmtId), 20, '...'); + + return array( + 'entry_sample' => $oCmts->getLanguageKey('txt_sample_single'), + 'entry_url' => $sCmtUrl, + 'entry_caption' => $sCmtCaption, + 'entry_author' => $aCmtInfo['author_id'], + 'subentry_sample' => $oCmts->getLanguageKey('txt_sample_reaction_single'), + 'subentry_sample_params' => $aSubentrySampleParams, + 'lang_key' => '', //may be empty or not specified. In this case the default one from Notification module will be used. + ); + } + + /** + * Comment score -> vote up for Notifications module + */ + public function serviceGetNotificationsScoreUp($aEvent) + { + return $this->_serviceGetNotificationsScore('up', $aEvent); + } + + /** + * Comment score -> vote down for Notifications module + */ + public function serviceGetNotificationsScoreDown($aEvent) + { + return $this->_serviceGetNotificationsScore('down', $aEvent); + } + + protected function _serviceGetNotificationsScore($sType, $aEvent) + { + $iCmtIdUnique = (int)$aEvent['object_id']; + + $aCmtInfo = BxDolCmts::getGlobalInfo($iCmtIdUnique); + if(empty($aCmtInfo) || !is_array($aCmtInfo)) + return array(); + + $oCmts = BxDolCmts::getObjectInstance($aCmtInfo['system_name'], 0, false); + if(!$oCmts || !$oCmts->isEnabled()) + return array(); + + $oScore = $oCmts->getScoreObject($iCmtIdUnique); + if(!$oScore) + return array(); + + $iCmtId = (int)$aCmtInfo['cmt_id']; + $sCmtUrl = str_replace(BX_DOL_URL_ROOT, '{bx_url_root}', $oCmts->serviceGetLink($iCmtId)); + $sCmtCaption = strmaxtextlen($oCmts->serviceGetText($iCmtId), 20, '...'); + + return array( + 'entry_sample' => $oCmts->getLanguageKey('txt_sample_single'), + 'entry_url' => $sCmtUrl, + 'entry_caption' => $sCmtCaption, + 'entry_author' => $aCmtInfo['author_id'], + 'subentry_sample' => $oCmts->getLanguageKey('txt_sample_score_' . $sType . '_single'), + 'lang_key' => '', //may be empty or not specified. In this case the default one from Notification module will be used. + ); + } + + /** + * @page service Service Calls + * @section bx_system_cmts System Services + * @subsection bx_system_cmts-general General + * @subsubsection bx_system_cmts-get_data_api get_data_api + * + * @code bx_srv('system', 'get_data_api', [], 'TemplCmtsServices'); @endcode + * + * Get comments data + * @param $aParams array with paramenters : + * "module":"bx_posts","object_id":3,"start_from":5,"order_way":"desc","is_form":false + * + * @see TemplCmtsServices::serviceGetDataApi + */ + /** + * @ref bx_system_cmts-get_data_api "get_data_api" + * @api @ref bx_system_cmts-get_data_api "get_data_api" + */ + + public function serviceGetDataApi($aParams) + { + if(is_string($aParams)) + $aParams = json_decode($aParams, true); + + if (isset($aParams['action']) && isset($aParams['id']) && $aParams['action'] == 'remove'){ + $iCmtId = $aParams['id']; + $oCmts = BxDolCmts::getObjectInstance($aParams['module'], $aParams['object_id']); + $oCmts->remove($iCmtId); + return 'Ok'; + } + + if (isset($aParams['action']) && isset($aParams['id']) && $aParams['action'] == 'edit'){ + $iCmtId = $aParams['id']; + $oCmts = BxDolCmts::getObjectInstance($aParams['module'], $aParams['object_id']); + $oForm = $oCmts->getFormEdit($iCmtId); + if($oForm['form']->isSubmittedAndValid()){ + $aParams['comment_id'] = $oForm['res']; + $aRv['browse'] = $this->serviceGetCommentsApi($oCmts, $aParams); + return $aRv; + } + $aForm = $oForm['form']->getCodeAPI(); + $aForm['inputs']['cmt_text']['numLines'] = 1; + $aForm['inputs']['cmt_text']['autoheight'] = true; + $aForm['inputs']['cmt_submit'] = $aForm['inputs']['cmt_controls'][0]; + unset($aForm['inputs']['cmt_controls']); + + $aForm['inputs']['cmt_submit']['icon'] = 'contact'; + $aForm['inputs']['cmt_submit']['variant'] = 'text'; + $aForm['inputs']['cmt_submit']['icon_only'] = true; + $aRv['form'] = ['id' => 'cmt_form', 'type' => 'form', 'name' => 'comment', 'data' => $aForm, 'request' => ['immutable' => true]]; + return $aRv; + } + + + $aParams['parent_id'] = !isset($aParams['parent_id']) ? 0 : $aParams['parent_id']; + $aParams['start_from'] = !isset($aParams['start_from']) ? 0 : $aParams['start_from']; + $aParams['order_way'] = !isset($aParams['order_way']) ? 'asc' : $aParams['order_way']; + $aParams['is_form'] = !isset($aParams['is_form']) ? true : $aParams['is_form']; + $aParams['insert'] = 'before'; + + $oCmts = BxDolCmts::getObjectInstance($aParams['module'], $aParams['object_id']); + + if (!$oCmts || !$oCmts->isEnabled()) + return false; + + $aRv = [ + 'id' => '1', + 'url' => '/api.php?r=system/get_data_api/TemplCmtsServices/¶ms[]=', + 'type' => 'comments' + ]; + + $oForm = $oCmts->getFormPost($aParams['parent_id']); + $bIsList = false; + if (isset($oForm['form']) && $aParams['is_form']){ + $aForm = $oForm['form']->getCodeAPI(); + $aForm['inputs']['cmt_text']['numLines'] = 1; + $aForm['inputs']['cmt_text']['autoheight'] = true; + $aForm['inputs']['cmt_submit']['icon'] = 'contact'; + $aForm['inputs']['cmt_submit']['variant'] = 'text'; + $aForm['inputs']['cmt_submit']['icon_only'] = true; + + // add view (form + new comment) + if($oForm['form']->isSubmittedAndValid()){ + $sInsert = $aParams['order_way'] == 'desc' ? 'after' : 'before'; + if (bx_get('cmt_parent_id') > 0) + $sInsert = 'after'; + $aParams['insert'] = $sInsert; + $aParams['comment_id'] = $oForm['res']; + $bIsList = true; + $aForm['inputs']['cmt_parent_id']['value'] = 0; + } + + $aRv['form'] = ['id' => 'cmt_form', 'type' => 'form', 'name' => 'comment', 'data' => $aForm, 'request' => ['immutable' => true]]; + + // default view (form + list) + if (!$oForm['form']->isSubmitted()){ + $bIsList = true; + } + } + else{ + // list only view + $bIsList = true; + $aParams['insert'] = 'before'; + } + if ($bIsList) + $aRv['browse'] = $this->serviceGetCommentsApi($oCmts, $aParams); + + return $aRv; + } + + public function serviceGetCommentsApi($oCmts, $aParams) + { + $mixedResult = $oCmts->isViewAllowed(); + if($mixedResult !== CHECK_ACTION_RESULT_ALLOWED) + return $mixedResult; // TODO: error checking + + if (isset($aParams['comment_id'])) + $aParams['comment_id'] = explode(',', $aParams['comment_id']); + + $aBp = !isset($aParams['aBp']) ? [] : $aParams['aBp']; + $aDp = ['in_designbox' => false, 'show_empty' => false]; + + $aDp['type'] = !getParam('sys_api_comments_flat') ? 'threaded' : 'flat'; + $aBp['type'] = 'head'; + $oCmts->getParams($aBp, $aDp); + $oCmts->prepareParams($aBp, $aDp); + + $aBp['order']['way'] = $aParams['order_way']; + $aBp['order_way'] = $aParams['order_way']; + $aBp['start'] = $aParams['start_from'] ; + $aPp = $aBp['per_view']; + $aBp['per_view'] = $aBp['per_view'] + 1; + if (isset($aParams['per_view'])){ + $aBp['per_view'] = $aParams['per_view']; + } + + $aCmts = isset($aParams['comment_id']) ? array_map(function($value) {return ['cmt_id' => $value];}, $aParams['comment_id']) : $oCmts->getCommentsArray($aBp['vparent_id'], $aBp['filter'], $aBp['order'], $aBp['start'], $aBp[($aBp['init_view'] != -1 ? 'init' : 'per') . '_view']); + + + $aParams['start_from'] = 0; + if (count($aCmts) == $aBp['per_view']){ + $aBp['per_view'] = $aPp; + $aCmts = array_slice($aCmts, 0, $aBp['per_view']); + $aParams['start_from'] = $aBp['start'] + $aBp['per_view']; + } + $aCmtsRv = []; + foreach ($aCmts as $aCmt) { + $aBp['order_way'] = 'asc'; + $oCmt = $oCmts->getCommentStructure($aCmt['cmt_id'], $aBp, $aDp); + if($oCmt === false) + continue; + + if(($sKey = array_shift(array_keys($oCmt))) && $oCmt[$sKey]['data']['cmt_parent_id'] > 0){ + $aParent = $oCmts->getCommentSimple((int)$oCmt[$sKey]['data']['cmt_parent_id']); + $oCmt[$sKey]['data']['cmt_parent'] = [ + 'data' => $aParent, + 'author_data' => BxDolProfile::getData($aParent['cmt_author_id']) + ]; + } + + $aCmtsRv[] = $oCmt; + } + + $aData = [ + 'unit' => 'comments', + 'start' => $aParams['start_from'], + 'count' => count($aCmts), + 'per_view' => $aBp['per_view'], + 'total_count' => $oCmts->getCommentsCount(), + 'order' => $aParams['order_way'], + 'view' => $aDp['type'], + 'module' => $oCmts->getSystemName(), + 'object_id' => $oCmts->getId(), + 'max_level' => $oCmts->getSystemInfo()['number_of_levels'], + 'highlighted' => 0, + 'data' => $aCmtsRv, + ]; + if (isset($aParams['mode']) && $aParams['mode'] == 'feed') + return $aData; + + $aRv = [ + 'id' => 'cmt_list', + 'type' => 'browse', + 'insert' => $aParams['insert'], + 'data' => $aData + ]; + + if (isset($aParams['comment_id'])){ + $aRv['new'] = $aParams['comment_id']; + } + + return $aRv; + } +} + +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseEditorQuill.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseEditorQuill.php new file mode 100644 index 0000000000..33c1fd342b --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseEditorQuill.php @@ -0,0 +1,223 @@ +_oTemplate = $oTemplate; + else + $this->_oTemplate = BxDolTemplate::getInstance(); + } + + /** + * Attach editor to HTML element, in most cases - textarea. + * @param $sSelector - jQuery selector to attach editor to. + * @param $iViewMode - editor view mode: BX_EDITOR_STANDARD, BX_EDITOR_MINI, BX_EDITOR_FULL + * @param $bDynamicMode - is AJAX mode or not, the HTML with editor area is loaded dynamically. + */ + public function attachEditor ($sSelector, $iViewMode = BX_EDITOR_STANDARD, $bDynamicMode = false, $aAttrs = []) + { + $sAllowedTags = ''; + $sToolbarItems = ''; + // set visual mode + switch ($iViewMode) { + case BX_EDITOR_MINI: + $sToolbarItems = getParam('sys_quill_toolbar_mini'); + $sAllowedTags = getParam('sys_quill_allowed_tags_mini'); + $sCustomInit = self::$CONF_MINI; + break; + + case BX_EDITOR_FULL: + $sToolbarItems = getParam('sys_quill_toolbar_full'); + $sAllowedTags = getParam('sys_quill_allowed_tags_full'); + $sCustomInit = self::$CONF_FULL; + break; + + case BX_EDITOR_STANDARD: + default: + $sToolbarItems = getParam('sys_quill_toolbar_standard'); + $sAllowedTags = getParam('sys_quill_allowed_tags_standard'); + $sCustomInit = self::$CONF_STANDARD; + } + + if ($this->_sButtonsCustom !== false) { + $sToolbarItems = $this->_sButtonsCustom; + } + + $sEditorName = 'quill_' . str_replace(['-', ' '], '_', $aAttrs['form_id'] . '_' . $aAttrs['element_name'] . '_' . $aAttrs['uniq']); + $this->_oTemplate->addJsTranslation([ + '_sys_txt_quill_tooltip_bold', + '_sys_txt_quill_tooltip_italic', + '_sys_txt_quill_tooltip_underline', + '_sys_txt_quill_tooltip_clean', + '_sys_txt_quill_tooltip_list_ordered', + '_sys_txt_quill_tooltip_list_bullet', + '_sys_txt_quill_tooltip_indent_1', + '_sys_txt_quill_tooltip_indent_2', + '_sys_txt_quill_tooltip_blockquote', + '_sys_txt_quill_tooltip_direction', + '_sys_txt_quill_tooltip_script_sub', + '_sys_txt_quill_tooltip_script_super', + '_sys_txt_quill_tooltip_link', + '_sys_txt_quill_tooltip_image', + '_sys_txt_quill_tooltip_code_block', + '_sys_txt_quill_tooltip_color', + '_sys_txt_quill_tooltip_background', + '_sys_txt_quill_tooltip_align', + '_sys_txt_quill_tooltip_header', + '_sys_txt_quill_tooltip_embed', + '_sys_txt_quill_tooltip_embed_popup_header', + '_sys_txt_quill_tooltip_link_popup_header', + ]); + // initialize editor + $sInitEditor = $this->_replaceMarkers(self::$CONF_COMMON, array( + 'bx_var_custom_init' => $sCustomInit, + 'bx_var_selector' => bx_js_string($sSelector. '.' . $aAttrs['uniq'], BX_ESCAPE_STR_APOS), + 'bx_var_query_params' => isset($aAttrs['query_params']) ? json_encode($aAttrs['query_params']) : "''", + 'bx_var_form_id' => $aAttrs['form_id'], + 'toolbar' => $sToolbarItems ? '[' . $sToolbarItems . ']' : 'false', + 'insert_as_plain_text' => getParam('sys_quill_insert_as_plain_text') == 'on' ? 'true' : 'false', + 'empty_tags' => getParam('sys_quill_allow_empty_tags') == 'on' ? 'true' : 'false', + 'allowed_tags' => $sAllowedTags == '' ? 'false' : $sAllowedTags, + 'bx_var_css_additional_class' => $sToolbarItems ? '' : 'bx-form-input-html-quill-empty', + 'bx_var_element_name' => str_replace(['-', ' '], '_', $aAttrs['element_name']), + 'bx_var_editor_name' => $sEditorName, + 'bx_var_skin' => bx_js_string($this->_aObject['skin'], BX_ESCAPE_STR_APOS), + 'bx_url_root' => bx_js_string(BX_DOL_URL_ROOT, BX_ESCAPE_STR_APOS) + )); + $sInitEditor = " + if(!Quill.imports['modules/imageUploader']) + Quill.register('modules/imageUploader', ImageUploader); + " . $sInitEditor; + + $sInitCallBack = " + bQuillEditorInited = true; + " . $sInitEditor; + + if ($bDynamicMode) { + list($aJs, $aCss) = $this->_getJsCss(true); + + $sScript = "var " . $sEditorName . ";"; + $sScript .= $this->_oTemplate->addJsPreloaded($aJs, $sInitCallBack, "typeof bQuillEditorInited === 'undefined'", $sInitEditor.';'); + + $sScript = $this->_oTemplate->_wrapInTagJsCode($sScript); + $sScript = $this->_oTemplate->addCss($aCss, true) . $sScript; + + } else { + $sScript = "var " . $sEditorName . "; " . $this->_oTemplate->addJsCodeOnLoad($sInitCallBack); + $sScript = $this->_oTemplate->_wrapInTagJsCode($sScript); + } + + return $this->_addJsCss($bDynamicMode) . $sScript; + } + + + /** + * Add css/js files which are needed for editor display and functionality. + */ + protected function _addJsCss($bDynamicMode = false, $sInitEditor = '') + { + if ($bDynamicMode) + return ''; + + if ($this->_bJsCssAdded) + return ''; + + list($aJs, $aCss) = $this->_getJsCss(); + + $this->_oTemplate->addJs($aJs); + $this->_oTemplate->addCss($aCss); + + $this->_bJsCssAdded = true; + + return ''; + } + + protected function _getJsCss($bUseUrlsForJs = false) + { + $sJsPrefix = $bUseUrlsForJs ? BX_DOL_URL_PLUGINS_PUBLIC : BX_DIRECTORY_PATH_PLUGINS_PUBLIC; + $sJsPrefixRoot = $bUseUrlsForJs ? BX_DOL_URL_ROOT .'inc/js/' : BX_DIRECTORY_PATH_INC . 'js/'; + $sJsSuffix = $bUseUrlsForJs ? '' : '|'; + + $aJs = array( + $sJsPrefix . 'highlight/' . $sJsSuffix . 'highlight.min.js', + $sJsPrefix . 'quill/' . $sJsSuffix . 'quill.min.js', + $sJsPrefix . 'quill/' . $sJsSuffix . 'quill.mention.js', + $sJsPrefix . 'quill/' . $sJsSuffix . 'quill.imageUploader.min.js', + $sJsPrefix . 'quill/' . $sJsSuffix . 'image-resize.min.js', + $sJsPrefix . 'quill/' . $sJsSuffix . 'quill-emoji.js', + $sJsPrefixRoot . $sJsSuffix . 'editor.quill.js', + + ); + + $sCss = 'editor.less'; + $aCss = BxDolTemplate::getInstance()->_lessCss(array( + 'path' => $this->_oTemplate->getCssPath($sCss), + 'url' => $this->_oTemplate->getCssUrl($sCss) + )); + + $aCss = array_merge($aCss, array( + BX_DIRECTORY_PATH_BASE . 'css/|editor_snow.quill.css', + BX_DIRECTORY_PATH_PLUGINS_PUBLIC . 'quill/|quill.mention.css', + BX_DIRECTORY_PATH_PLUGINS_PUBLIC . 'quill/|quill-emoji.css', + BX_DIRECTORY_PATH_PLUGINS_PUBLIC . 'highlight/|default.min.css', + BX_DIRECTORY_PATH_PLUGINS_PUBLIC . 'quill/quill.imageUploader.min.css', + BX_DIRECTORY_PATH_BASE . 'css/|editor.quill.css', + )); + + return array($aJs, $aCss); + } +} + +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseEmbedSystem.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseEmbedSystem.php new file mode 100644 index 0000000000..4569771be7 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseEmbedSystem.php @@ -0,0 +1,142 @@ +_sTableName = 'sys_embeded_data'; + parent::__construct ($aObject); + + if ($oTemplate) + $this->_oTemplate = $oTemplate; + else + $this->_oTemplate = BxDolTemplate::getInstance(); + } + + public function getLinkHTML ($sLink, $sTitle = '', $sMaxWidth = '') + { + $aData = $this->getData($sLink, ''); + + if(bx_is_api()) { + if(bx_get('mode') == 'alt') + return json_encode($aData); + + return $aData; + } + + $aAttrs = [ + 'title' => bx_html_attribute($sTitle), + ]; + + // check for external link + if(strncmp(BX_DOL_URL_ROOT, $sLink, strlen(BX_DOL_URL_ROOT)) !== 0) { + $aAttrs['target'] = '_blank'; + + if(getParam('sys_add_nofollow') == 'on') + $aAttrs['rel'] = 'nofollow'; + } + + return $this->_oTemplate->parseHtmlByName('embed_system_link.html', [ + 'link' => $aData['url'], + 'attrs' => bx_convert_array2attrs($aAttrs), + 'width' => $sMaxWidth, + 'image' => $aData['image'] ? $aData['image'] : $aData['logo'], + 'logo' => $aData['logo'], + 'title' => $aData['title'], + 'description' => $aData['description'], + 'domain' => $aData['domain'], + ]); + } + + public function getDataFromApi ($sUrl, $sTheme) + { + $a = bx_get_site_info($sUrl, [ + 'thumbnailUrl' => ['tag' => 'link', 'content_attr' => 'href'], + 'OGImage' => ['name_attr' => 'property', 'name' => 'og:image'], + 'icon' => ['tag' => 'link', 'name_attr' => 'rel', 'name' => 'shortcut icon', 'content_attr' => 'href'], + 'icon2' => ['tag' => 'link', 'name_attr' => 'rel', 'name' => 'icon', 'content_attr' => 'href'], + 'icon3' => ['tag' => 'link', 'name_attr' => 'rel', 'name' => 'apple-touch-icon', 'content_attr' => 'href'], + ]); + + + + + $a = array_merge($a, [ + 'image' => $a['OGImage'] ? $a['OGImage'] : $a['thumbnailUrl'], + 'logo' => $a['icon2'] ? $a['icon2'] : ($a['icon3'] ? $a['icon3'] : $a['icon']), + 'url' => $sUrl + ]); + + unset($a['OGImage'], $a['thumbnailUrl'], $a['icon'], $a['icon2'], $a['icon3']); + + + + if($a['image'] == '') { + $c = []; + if (getParam('sys_embed_microlink_key') != ''){ + $c = bx_file_get_contents("https://pro.microlink.io/?url=" . $sUrl, [], 'get', ['x-api-key: ' . getParam('sys_embed_microlink_key')]); + } + else{ + $c = bx_file_get_contents("https://api.microlink.io/?url=" . $sUrl); + } + + $b = json_decode($c, true); + $a = [ + 'title' => $b['data']['title'], + 'description' => $b['data']['description'], + 'image' => $b['data']['image']['url'], + 'logo' => $b['data']['logo']['url'], + 'url' => $sUrl, + ]; + } + + if($a['image'] && ($oStorage = BxDolStorage::getObjectInstance('sys_images')) !== false) { + $iMediaId = $oStorage->storeFileFromUrl($a['image'], false); + if($iMediaId) + $a['image'] = $oStorage->getFileUrlById($iMediaId); + } + + if($a['logo'] && ($oStorage = BxDolStorage::getObjectInstance('sys_images')) !== false) { + $iMediaId = $oStorage->storeFileFromUrl($a['logo'], false); + if($iMediaId) + $a['logo'] = $oStorage->getFileUrlById($iMediaId); + } + + + $aUrl = parse_url($sUrl); + $a['domain'] = $aUrl['host']; + + return json_encode($a); + } + + public function parseLinks(&$aLinks) + { + $aResult = []; + + if($aLinks && is_array($aLinks)) { + $oEmbera = $this->getEmberaInstance(); + + foreach ($aLinks as $sLink) { + $sHtml = $oEmbera->autoEmbed($sLink); + //if nothing to change/embed then return empty string to not replace anything on a frontend + $aResult[] = ['html' => $sHtml != $sLink ? $sHtml : '']; + } + } + + return $aResult; + } +} + +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseFunctions.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseFunctions.php new file mode 100644 index 0000000000..49f0640f15 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseFunctions.php @@ -0,0 +1,938 @@ +_oTemplate = $oTemplate ? $oTemplate : BxDolTemplate::getInstance(); + + $this->_sDesignBoxMenuTmplDefault = 'menu_block_submenu_ver.html'; + + $this->_sDesignBoxMenuIcon = 'ellipsis-v'; + $this->_sDesignBoxMenuIconType = 'icon'; + $this->_sDesignBoxMenuClick = "bx_menu_popup_inline('#{design_box_menu}', this, " . json_encode(array( + 'moveToDocRoot' => false + )) . ")"; + } + + /** + * Prevent cloning the instance + */ + public function __clone() + { + if (isset($GLOBALS['bxDolClasses'][get_class($this)])) + trigger_error('Clone is not allowed for the class: ' . get_class($this), E_USER_ERROR); + } + + public static function getInstanceWithTemplate($oTemplate) + { + $sClassName = 'BxTemplFunctions'; + if ($oTemplate){ + $sClassName .= get_class($oTemplate); + } + if(!isset($GLOBALS['bxDolClasses'][$sClassName])) + $GLOBALS['bxDolClasses'][$sClassName] = new BxTemplFunctions($oTemplate); + + return $GLOBALS['bxDolClasses'][$sClassName]; + } + + public static function getInstance() + { + return self::getInstanceWithTemplate(null); + } + + function TemplPageAddComponent($sKey) + { + $mixedResult = false; // if you have not such component, return false! + + switch($sKey) { + case 'sys_header_width': + $mixedResult = 'bx-def-page-width'; + break; + + case 'sys_toolbar_search': + $oSearch = new BxTemplSearch(); + $oSearch->setLiveSearch(true); + + $mixedResult = $this->_oTemplate->parseHtmlByName('_page_toolbar_search.html', [ + 'sys_site_search' => $oSearch->getForm(BX_DB_PADDING_DEF, false, true) . $oSearch->getResultsContainer() + ]); + break; + } + + return $mixedResult; + } + + function msgBox($sText, $iTimer = 0, $sOnClose = "") + { + $iId = time() . mt_rand(1, 1000); + + if($iTimer > 0) + BxDolTemplate::getInstance()->addJs(array('jquery.anim.js')); + + return $this->_oTemplate->parseHtmlByName('messageBox.html', array( + 'id' => $iId, + 'msgText' => $sText, + 'bx_if:timer' => array( + 'condition' => $iTimer > 0, + 'content' => array( + 'id' => $iId, + 'time' => 1000 * $iTimer, + 'on_close' => $sOnClose, + ) + ) + )); + } + + /** + * Get standard popup box with title. + * + * @param string $sName - unique name + * @param string $sTitle - translated title + * @param string $sContent - content of the box + * @return HTML string + */ + function popupBox($sName, $sTitle, $sContent, $isHiddenByDefault = false) + { + $iId = !empty($sName) ? $sName : time(); + + return $this->_oTemplate->parseHtmlByName('popup_box.html', array( + 'id' => $iId, + 'wrapper_style' => $isHiddenByDefault ? 'display:none;' : '', + 'title' => $sTitle, + 'content' => $sContent + )); + } + + /** + * Get popup box without title. + * + * @param string $sName - unique name + * @param string $sContent - content of the box + * @return HTML string + */ + function transBox($sName, $sContent, $isHiddenByDefault = false, $isPlaceInCenter = false) + { + return $this->simpleBox($sName, $sContent, $isHiddenByDefault, $isPlaceInCenter, 'popup_trans.html'); + } + + function slideBox($sName, $sContent, $isHiddenByDefault = false) + { + return $this->simpleBox($sName, $sContent, $isHiddenByDefault, false, 'popup_slide.html'); + } + + function inlineBox($sName, $sContent, $isHiddenByDefault = false) + { + return $this->simpleBox($sName, $sContent, $isHiddenByDefault, false, 'popup_inline.html'); + } + + protected function simpleBox($sName, $sContent, $isHiddenByDefault, $isPlaceInCenter, $sTemplate) + { + $iId = !empty($sName) ? $sName : time(); + + if(!is_array($sContent)) + $sContent = array('content' => $sContent); + + $sContent = $this->_oTemplate->parseHtmlByName($sTemplate, array_merge(array( + 'id' => $iId, + 'wrapper_class' => '', + 'wrapper_style' => $isHiddenByDefault ? 'display:none;' : '', + 'content' => '' + ), $sContent)); + + if($isPlaceInCenter) + $sContent = '' . $sContent . ''; + + return $sContent; + } + + function simpleBoxContent($sContent, $bWithIndent = true) + { + if(!$bWithIndent) + return $sContent; + + return $this->_oTemplate->parseHtmlByName('popup_content_indent.html', array( + 'content' => $sContent + )); + } + + function getIcon($sCode, $aAttrs = array()) + { + $sIconFont = false; + $sIconA = false; + $sIconUrl = false; + $sIconHtml = false; + $sIconFontWithHtml = false; + + $sClass = ''; + if(!empty($aAttrs['class'])) { + $sClass = ' ' . $aAttrs['class'] .' '; + unset($aAttrs['class']); + } + + $sAttrs = ''; + foreach($aAttrs as $sKey => $sValue) + $sAttrs .= ' ' . $sKey . '="' . bx_html_attribute($sValue) . '"'; + + if (!empty($sCode)) { + if (is_numeric($sCode) && (int)$sCode > 0) { + $oStorage = BxDolStorage::getObjectInstance(BX_DOL_STORAGE_OBJ_IMAGES); + $sIconUrl = $oStorage ? $oStorage->getFileUrlById((int)$sCode) : false; + } + else { + + if (strpos($sCode, '<img') !== false || strpos($sCode, ''); + if ($sClass != '' && strpos($sIconHtmlClear, 'class="') !== false) + $sIconHtml = str_replace('class="', 'class="' . $sClass, $sIconHtml); + else + $sIconHtml = str_replace('_oTemplate->parseHtmlByName('icon_emoji.html', array( + 'icon' => $sCode, + 'class' => $sClass, + 'attrs' => $sAttrs + )); + else { + if (strpos($sCode, '.') === false) { + //--- Process animated icon + if (strncmp($sCode, 'a:', 2) === 0) + $sIconA = substr($sCode, 2); + //--- Process font icons + else { + $sIconFont = $sCode; + $sIconFontWithHtml = $this->getFontIconAsHtml($sIconFont, $sClass, $sAttrs); + } + } + else { + //--- Process common image + if((!preg_match('/^https?:\/\//', $sCode))) + $sIconUrl = $this->_oTemplate->getIconUrl($sCode); + else + $sIconUrl = $sCode; + } + } + } + } + } + + return array ($sIconFont, $sIconUrl, $sIconA, $sIconHtml, $sIconFontWithHtml); + } + + function getFontIconAsHtml($sIconFont, $sClass = '', $sAttrs = '') + { + return ''; + } + + function getIconAsHtml($sCode, $aAttrs = array()) + { + $aIcons = $this->getIcon($sCode, $aAttrs); + return $aIcons[3] . $aIcons[4]; + } + + function getTemplateIcon($sName) + { + $sUrl = $this->_oTemplate->getIconUrl($sName); + return !empty($sUrl) ? $sUrl : $this->_oTemplate->getIconUrl('spacer.gif'); + } + + function getTemplateImage($sName) + { + $sUrl = $this->_oTemplate->getImageUrl($sName); + return !empty($sUrl) ? $sUrl : $this->_oTemplate->getImageUrl('spacer.gif'); + } + + function sysIcon ($sIcon, $sName, $sUrl = '', $iWidth = 0) + { + return '' . ($sUrl ? '' : '') . '' . ($sUrl ? '' : '') . ''; + } + + /** + * functions for limiting maximal string length + */ + function getStringWithLimitedLength($sString, $iWidth = 45, $isPopupOnOverflow = false, $bReturnString = true) + { + if (empty($sString) || mb_strlen($sString, 'UTF-8') <= $iWidth) + return $bReturnString ? $sString : array($sString); + + $sResult = ''; + $aWords = mb_split("[\s\r\n]", $sString); + $iPosition = 0; + $iWidthReal = $iWidth - 3; + $iWidthMin = $iWidth - 15; + foreach($aWords as $sWord) { + $sWord = trim($sWord); + $iWord = mb_strlen($sWord, 'UTF-8'); + if ($iPosition + $iWord > $iWidthReal) + break; + + // add word and continue + $sResult .= ' ' . $sWord; + $iPosition += 1 + $iWord; + } + + // last word is too long, cut it + if(!$iPosition || $iPosition < $iWidthMin) + $sResult .= ' ' . mb_substr($sWord, 0, $iWidthReal - $iPosition - $iWord, 'UTF-8'); + $sResult = trim($sResult); + + // add tripple dot + if(!$isPopupOnOverflow) { + $sResult .= '...'; + return $bReturnString ? $sResult : array($sResult); + } + + // add button width popup + $sId = 'bx-str-limit-' . rand(1, PHP_INT_MAX); + $sPopup = ''; + $sPopup .= '' . BxTemplFunctions::getInstance()->transBox('', ''.$sString.'') . ''; + + return $bReturnString ? $sResult . $sPopup : array($sResult, $sPopup); + } + + /** + * Display design box with specified title, template, content and menu. + * @param $sTitle - design box title, please note that some templates don't use title. + * @param $sContent - design box content. + * @param $iTemplateNum - number of design box template, use predefined contants only, default is BX_DB_DEF. + * @param $mixedMenu - design box menu, it can be: + * - object: instance of BxTemplMenu class + * - string: menu object identifier + * - array: array of menu links to create menu from + * @param $mixedButtons - design box menu representation, it can be: + * - false: design box menu will be used as horizontal menu (tabs) + * - array: array of menu links to create menu from. If empty array is used and 'design box menu' isn't empty, then 'design box menu' will be added as one of menu items automatically. If non-empty array is used and 'design box menu' isn't empty then it should be added as one of menu items. Use array('menu' => 1) to define menu item for 'design box menu'. + * @return string + * + * @see BX_DB_CONTENT_ONLY + * @see BX_DB_DEF + * @see BX_DB_EMPTY + * @see BX_DB_NO_CAPTION + * @see BX_DB_PADDING_CONTENT_ONLY + * @see BX_DB_PADDING_DEF + * @see BX_DB_PADDING_NO_CAPTION + */ + function designBoxContent ($sTitle, $sContent, $iTemplateNum = BX_DB_DEF, $mixedMenu = false, $mixedButtons = array()) + { + return $this->_oTemplate->parseHtmlByName('designbox_' . (int)$iTemplateNum . '.html', array( + 'title' => $sTitle, + 'designbox_content' => $sContent, + 'caption_item' => $this->designBoxMenu($mixedMenu, $mixedButtons), + )); + } + + function designBoxMenu ($mixedMenu, $mixedButtons = array()) + { + $bUseTabs = is_bool($mixedButtons) && $mixedButtons === true; + + $sClass = $sMenu = ''; + if(!empty($mixedMenu)) { + if(is_string($mixedMenu)) { + if(($oMenu = BxTemplMenu::getObjectInstance($mixedMenu)) !== false) { + $oMenu->setTemplateById($bUseTabs ? BX_DB_MENU_TEMPLATE_TABS : BX_DB_MENU_TEMPLATE_POPUP); + + $sMenu = $oMenu->getCode(); + } + else + $sMenu = $mixedMenu; + } + else if(is_array($mixedMenu)) { + if(isset($mixedMenu['template']) && isset($mixedMenu['menu_items'])) + $aMenu = $mixedMenu; + else + $aMenu = array('template' => $this->_sDesignBoxMenuTmplDefault, 'menu_items' => $mixedMenu); + + if(($oMenu = new BxTemplMenu($aMenu, $this->_oTemplate)) !== false) { + $oMenu->setTemplateById($bUseTabs ? BX_DB_MENU_TEMPLATE_TABS : BX_DB_MENU_TEMPLATE_POPUP); + + $sMenu = $oMenu->getCode(); + } + else + $sMenu = ''; + } + else if(is_object($mixedMenu) && is_a($mixedMenu, 'BxTemplMenu')) { + $mixedMenu->setTemplateById($bUseTabs ? BX_DB_MENU_TEMPLATE_TABS : BX_DB_MENU_TEMPLATE_POPUP); + if(($mixedMenu instanceof BxBaseMenuMoreAuto) && $mixedMenu->isMoreAuto()) + $sClass = ' bx-db-menu-tab-more-auto'; + + $sMenu = $mixedMenu->getCode(); + } + } + $bMenu = !empty($sMenu); + + $sResult = ''; + if($bUseTabs && $bMenu) + $sResult = $sMenu; + else if(is_array($mixedButtons)) { + $sPopup = ''; + + if($bMenu) { + $aButton = array(); + if(empty($mixedButtons)) + list($aButton, $sPopup) = $this->_designBoxMenuButton($sMenu); + //--- For backward compatibility + else if(!empty($mixedButtons['menu']) && is_array($mixedButtons['menu'])) { + list($aButton, $sPopup) = $this->_designBoxMenuButton($sMenu, $mixedButtons['menu']); + unset($mixedButtons['menu']); + } + + if(!empty($aButton)) + $mixedButtons[] = $aButton; + } + + foreach($mixedButtons as $aButton) { + if($bMenu && isset($aButton['menu'])) { + if(is_numeric($aButton['menu']) && (int)$aButton['menu'] == 1) + list($aButton, $sPopup) = $this->_designBoxMenuButton($sMenu); + else if(is_array($aButton['menu'])) + list($aButton, $sPopup) = $this->_designBoxMenuButton($sMenu, $aButton['menu']); + + if(isset($aButton['menu'])) + continue; + } + + $aAttrs = array(); + if(!empty($aButton['onclick'])) + $aAttrs['onclick'] = $aButton['onclick']; + + $aAttrs['class'] = 'bx-btn bx-btn-small'; + if(!empty($aButton['class'])) + $aAttrs['class'] .= ' ' . trim($aButton['class']); + + $bTmplVarsButtonIcon = !empty($aButton['icon']); + $aTmplVarsButtonIcon = !$bTmplVarsButtonIcon ? array() : array( + 'icon' => $aButton['icon'] + ); + + $bTmplVarsButtonIconA = !empty($aButton['icon-a']); + $aTmplVarsButtonIconA = !$bTmplVarsButtonIconA ? array() : array( + 'icon_a' => $aButton['icon-a'] + ); + + $bTmplVarsButtonTitle = !empty($aButton['title']); + $aTmplVarsButtonTitle = !$bTmplVarsButtonTitle ? array() : array( + 'title' => $aButton['title'] + ); + + $sResult .= $this->_oTemplate->parseHtmlByName('designbox_menu_button.html', array( + 'attrs' => bx_convert_array2attrs($aAttrs), + 'bx_if:show_icon' => array( + 'condition' => $bTmplVarsButtonIcon, + 'content' => $aTmplVarsButtonIcon + ), + 'bx_if:show_icon_a' => array( + 'condition' => $bTmplVarsButtonIconA, + 'content' => $aTmplVarsButtonIconA + ), + 'bx_if:show_title' => array( + 'condition' => $bTmplVarsButtonTitle, + 'content' => $aTmplVarsButtonTitle + ) + )); + } + + $sResult .= $sPopup; + } + + if(!empty($sResult)) + $sResult = $this->_oTemplate->parseHtmlByName('designbox_menu.html', array( + 'class' => $sClass, + 'content' => $sResult + )); + + return $sResult; + } + + protected function _designBoxMenuId () + { + return 'bx-menu-db-' . time() . rand(0, PHP_INT_MAX); + } + + protected function _designBoxMenuButton ($sMenu, $aParams = array()) + { + $sId = $this->_designBoxMenuId(); + $aButton = array($this->_sDesignBoxMenuIconType => $this->_sDesignBoxMenuIcon, 'onclick' => $this->_sDesignBoxMenuClick); + + if(!empty($aParams)) { + if(!empty($aParams['id'])) + $sId = $aParams['id']; + + $aButton = array_merge($aButton, $aParams); + } + + $aButton['onclick'] = bx_replace_markers($aButton['onclick'], array( + 'design_box_menu' => $sId + )); + + $sMenu = $this->_oTemplate->parseHtmlByName('designbox_menu_popup.html', array( + 'content' => $sMenu + )); + + return array($aButton, $this->transBox($sId, $sMenu, true)); + } + + /** + * Get logo URL. + * @return string + */ + function getMainLogoUrl() + { + return BxDolDesigns::getInstance()->getSiteLogoUrl(); + } + + /** + * Get mark URL. + * @return string + */ + function getMainMarkUrl() + { + return BxDolDesigns::getInstance()->getSiteMarkUrl(); + } + + /** + * Get logo HTML. + * @return string + */ + function getMainLogo($aParams = array()) + { + $oDesigns = BxDolDesigns::getInstance(); + + $sAlt = $oDesigns->getSiteLogoAlt(); + if(empty($sAlt)) + $sAlt = getParam('site_title'); + + $aLogoImages = []; + if(($mixedFileUrl = $this->getMainLogoUrl()) && !empty($mixedFileUrl)) { + if(!is_array($mixedFileUrl)) + $mixedFileUrl = ['light' => $mixedFileUrl]; + + foreach($mixedFileUrl as $sName => $sFileUrl) { + $iLogoWidth = (int)$oDesigns->getSiteLogoWidth(); + $sWidth = $iLogoWidth > 0 ? 'width:' . round($iLogoWidth/16, 3) . 'rem;' : ''; + + $iLogoHeight = (int)$oDesigns->getSiteLogoHeight(); + $sHeight = $iLogoHeight > 0 ? 'height:' . round($iLogoHeight/16, 3) . 'rem;' : ''; + + $aLogoImages[] = [ + 'id' => 'bx-logo', + 'src' => $sFileUrl, + 'alt' => bx_html_attribute($sAlt, BX_ESCAPE_STR_QUOTE), + 'style' => $sWidth . ' ' . $sHeight + ]; + } + } + $bLogoImages = !empty($aLogoImages) && is_array($aLogoImages); + + $aAttrs = array( + 'class' => 'bx-def-font-contrasted', + 'href' => BX_DOL_URL_ROOT, + 'title' => bx_html_attribute($sAlt, BX_ESCAPE_STR_QUOTE) + ); + if(!empty($aParams['attrs']) && is_array($aParams['attrs'])) + $aAttrs = array_merge($aAttrs, $aParams['attrs']); + + $sTmplName = 'logo_main.html'; + $aTmplVars = [ + 'attrs' => bx_convert_array2attrs($aAttrs), + 'bx_if:show_title' => [ + 'condition' => !$bLogoImages, + 'content' => [ + 'logo' => $sAlt, + ] + ], + 'bx_if:show_logo' => [ + 'condition' => $bLogoImages, + 'content' => [ + 'bx_repeat:images' => $aLogoImages, + ] + ], + ]; + + bx_alert('system', 'get_logo', 0, 0, [ + 'tmpl_name' => &$sTmplName, + 'tmpl_vars' => &$aTmplVars + ]); + + return $this->_oTemplate->parseHtmlByName($sTmplName, $aTmplVars); + } + + /** + * Get HTML code for manifests. + * @return HTML string to insert into HEAD section + */ + function getManifests() + { + return ''; + } + + /** + * Get HTML code for meta icons. + * @return HTML string to insert into HEAD section + */ + function getMetaIcons() + { + // favicon icon + $sImageUrlFav = ''; + if(($iId = (int)getParam('sys_site_icon')) != 0) + $sImageUrlFav = BxDolStorage::getObjectInstance(BX_DOL_STORAGE_OBJ_FILES)->getFileUrlById($iId); + + // svg icon + $sImageUrlSvg = ''; + if(($iId = (int)getParam('sys_site_icon_svg')) != 0) + $sImageUrlSvg = BxDolStorage::getObjectInstance(BX_DOL_STORAGE_OBJ_IMAGES)->getFileUrlById($iId); + + if(empty($sImageUrlFav) && empty($sImageUrlSvg)) + $sImageUrlFav = $sImageUrlSvg = $this->_oTemplate->getIconUrl('favicon.svg'); + + // apple device icon + $sImageUrlApl = ''; + if(($iId = (int)getParam('sys_site_icon_apple')) != 0) + $sImageUrlApl = BxDolTranscoderImage::getObjectInstance(BX_DOL_TRANSCODER_OBJ_ICON_APPLE)->getFileUrl($iId); + if(empty($sImageUrlApl)) + $sImageUrlApl = $this->_oTemplate->getIconUrl('apple-touch-icon.png'); + +/* + * TODO: + * 1. Remove commented code later if it won't be used. + * 2. Remove 'sys_icon_favicon' and 'sys_icon_facebook' transcoders and related transcoder filters. + * + // facebook icon + $sImageUrlFcb = ''; + $oTranscoder = BxDolTranscoderImage::getObjectInstance(BX_DOL_TRANSCODER_OBJ_ICON_FACEBOOK); + $sImageUrlFcb = $oTranscoder->getFileUrl($iId); + if(empty($sImageUrlFcb)) + $sImageUrlFcb = $this->_oTemplate->getIconUrl('facebook-icon.png'); +*/ + + $sRet = ''; + if($sImageUrlFav) + $sRet .= ''; + if($sImageUrlFav) + $sRet .= ''; + $sRet .= ''; + +/* + $sRet .= ''; +*/ + + return $sRet; + } + + function getInjectionHead() + { + return $this->getInjection('getInjHead'); + } + + function getInjectionHeader() + { + return $this->getInjection('getInjHeader'); + } + + function getInjectionFooter() + { + return $this->getInjection('getInjFooter'); + } + + public function getPopupAlert() + { + return $this->transBox('bx-popup-alert', $this->_oTemplate->parseHtmlByName('popup_trans_alert_cnt.html', array()), true); + } + + public function getPopupConfirm() + { + return $this->transBox('bx-popup-confirm', $this->_oTemplate->parseHtmlByName('popup_trans_confirm_cnt.html', array()), true); + } + + public function getPopupPrompt() + { + $sInputText = 'bx-popup-prompt-value'; + $aInputText = array( + 'type' => 'text', + 'name' => $sInputText, + 'attrs' => array( + 'id' => $sInputText, + ), + 'value' => '', + 'caption' => '' + ); + + $oForm = new BxTemplFormView(array(), $this->_oTemplate); + return $this->transBox('bx-popup-prompt', $this->_oTemplate->parseHtmlByName('popup_trans_prompt_cnt.html', array( + 'input' => $oForm->genRow($aInputText) + )), true); + } + + /** + * Output time wrapped in tag in HTML. + * Then time is autoformatted using JS upon page load, this is aumatically converted to user's timezone and + * updated in realtime in case of short periods of 'from now' time format. + * + * Short version of this function: + * @see bx_time_js + * + * @param $iUnixTimestamp time as unixtimestamp + * @param $sFormatIdentifier output format identifier + * @see BX_FORMAT_DATE + * @see BX_FORMAT_TIME + * @see BX_FORMAT_DATE_TIME + * @param $bForceFormat force provided format and don't use "from now" time autoformat. + */ + function timeForJs ($iUnixTimestamp, $sFormatIdentifier = BX_FORMAT_DATE, $bForceFormat = false) + { + $sDateUTC = bx_time_utc ($iUnixTimestamp); + return $this->timeForJsFullDate ($sDateUTC, $sFormatIdentifier, $bForceFormat); + } + + /** + * Same as @see timeForJs but instead of unxtimestamp full date format is used (ex: 2005-08-15T15:52:01) as passec date param + */ + function timeForJsFullDate ($sDateUTC, $sFormatIdentifier = BX_FORMAT_DATE, $bForceFormat = false, $bUTC = false) + { + return '' . $sDateUTC . ''; + } + + function statusOnOff ($mixed, $isMsg = false) + { + if ((is_bool($mixed) && !$mixed) || (is_string($mixed) && 'fail' == $mixed)) + return ' ' . ($isMsg ? _t('_sys_off') : ''); + elseif (is_string($mixed) && 'warn' == $mixed) + return ' ' . ($isMsg ? _t('_sys_warn') : ''); + elseif (is_string($mixed) && 'undef' == $mixed) + return ' ' . ($isMsg ? _t('_undefined') : ''); + else + return ' ' . ($isMsg ? _t('_sys_on') : ''); + } + + /** + * Ouputs HTML5 video player. + * @param $sUrlPoster video poster image + * @param $sUrlMP4 .mp4 video + * @param $sUrlMP4Hd .mp4 video in better quality + * @param $aAttrs custom attributes, defaults are: controls="" preload="none" autobuffer="" + * @param $sStyles custom styles, defaults are: width:100%; height:auto; + */ + function videoPlayer ($sUrlPoster, $sUrlMP4, $sUrlMP4Hd = '', $aAttrs = false, $sStyles = false, $bDynamicMode = false) + { + $oPlayer = BxDolPlayer::getObjectInstance(); + if(!$oPlayer) + return ''; + + if($sStyles === false) + $sStyles = 'width:100%; height:auto;'; + + return $oPlayer->getCodeVideo (BX_PLAYER_STANDARD, array( + 'poster' => $sUrlPoster, + 'mp4' => array('sd' => $sUrlMP4, 'hd' => $sUrlMP4Hd), + 'attrs' => $aAttrs, + 'styles' => $sStyles, + ), $bDynamicMode); + } + + protected function getInjection($sPrefix) + { + $sContent = ''; + + $aMethods = get_class_methods($this); + foreach($aMethods as $sMethod) + if(preg_match("/^(" . $sPrefix . ")[A-Z].+$/", $sMethod)) + $sContent .= $this->$sMethod(); + + return $sContent; + } + + protected function getInjHeadLiveUpdates() + { + $sContent = ''; + + if(($oLiveUpdates = BxDolLiveUpdates::getInstance()) !== false) + $sContent .= $oLiveUpdates->init(); + + return $sContent; + } + + protected function getInjHeaderPushNotifications() + { + $iProfileId = bx_get_logged_profile_id(); + if(empty($iProfileId)) + return ''; + + $sAppId = getParam('sys_push_app_id'); + if(empty($sAppId)) + return ''; + + $aTags = BxDolPush::getTags($iProfileId); + if (!$aTags) + return ''; + + $sShortName = getParam('sys_push_short_name'); + $sSafariWebId = getParam('sys_push_safari_id'); + + $sSubfolder = '/plugins_public/onesignal/'; + $aUrl = parse_url(BX_DOL_URL_ROOT); + if(!empty($aUrl['path'])) { + $sPath = trim($aUrl['path'], '/'); + if(!empty($sPath)) + $sSubfolder = '/' . $sPath . $sSubfolder; + } + + $this->_oTemplate->addJs(array( + 'https://cdn.onesignal.com/sdks/OneSignalSDK.js', + 'BxDolPush.js', + )); + + $sJsClass = 'BxDolPush'; + $sJsObject = 'oBxDolPush'; + + $sContent = "var " . $sJsObject . " = new " . $sJsClass . "(" . json_encode(array( + 'sObjName' => $sJsObject, + 'sSiteName' => getParam('site_title'), + 'aTags' => $aTags, + 'sAppId' => $sAppId, + 'sShortName' => $sShortName, + 'sSafariWebId' => $sSafariWebId, + 'sSubfolder' => $sSubfolder, + 'sNotificationUrl' => BX_DOL_URL_ROOT, + 'sTxtNotificationRequest' => _t('_sys_push_notification_request', getParam('site_title')), + 'sTxtNotificationRequestYes' => _t('_sys_push_notification_request_yes'), + 'sTxtNotificationRequestNo' => _t('_sys_push_notification_request_no'), + )) . ");"; + + return $this->_oTemplate->_wrapInTagJsCode($sContent); + } + + protected function getInjHeaderPopupLoading() + { + return $this->transBox('bx-popup-loading', $this->_oTemplate->parsePageByName('popup_loading.html', array()), true); + } + + protected function getInjFooterMenuLoading() + { + return $this->_oTemplate->parsePageByName('menu_loading.html', array()); + } + + protected function getInjFooterPopupMenus() + { + $sContent = ''; + + $oSearch = new BxTemplSearch(); + $oSearch->setLiveSearch(true); + $sContent .= $this->_oTemplate->parsePageByName('search.html', array( + 'search_form' => $oSearch->getForm(BX_DB_CONTENT_ONLY), + 'results' => $oSearch->getResultsContainer(), + )); + + $sContent .= $this->_oTemplate->getMenu ('sys_site'); + if(isLogged()) { + $sContent .= $this->_oTemplate->getMenu ('sys_add_content'); + $sContent .= $this->_oTemplate->getMenu ('sys_account_popup'); + } + + return $sContent; + } + + protected function getInjFooterPopupApps() + { + if($this->_oTemplate->getPageType() != BX_PAGE_TYPE_APPLICATION) + return ''; + + $oMenu = BxDolMenu::getObjectInstance('sys_homepage'); + if(!$oMenu) + return ''; + + $this->_oTemplate->addJs(['popper.js']); + return $this->_oTemplate->parsePageByName('menu_apps.html', [ + 'name' => 'sys-menu-apps', + 'title' => _t('_apps'), + 'bx_repeat:menu_items' => $oMenu->getMenuItems(), + ]); + } + + protected function getInjFooterPopups() + { + $sContent = ''; + + $sContent .= $this->getPopupAlert(); + $sContent .= $this->getPopupConfirm(); + $sContent .= $this->getPopupPrompt(); + + return $sContent; + } + + protected function getInjFooterEmbed() + { + // Load embed files + $oEmbed = BxDolEmbed::getObjectInstance(false); + if ($oEmbed) + return $oEmbed->addJsCss() . $oEmbed->addProcessLinkMethod(); + + return ''; + } +} + +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseMenu.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseMenu.php new file mode 100644 index 0000000000..02650656f4 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseMenu.php @@ -0,0 +1,464 @@ + '', 'onclick' => ''); + protected $_bDisplayAddons = false; + + protected $_aSelected; // Selected menu item. + + public function __construct ($aObject, $oTemplate) + { + parent::__construct ($aObject); + + if ($oTemplate) + $this->_oTemplate = $oTemplate; + else + $this->_oTemplate = BxDolTemplate::getInstance(); + + $this->_iPageType = false; + $this->_aSelected = []; + } + + public function getDisplayAddons() + { + return $this->_bDisplayAddons; + } + + public function setDisplayAddons($b) + { + $bRet = $this->_bDisplayAddons; + $this->_bDisplayAddons = $b; + return $bRet; + } + + /** + * Get menu code. + * @return string + */ + public function getCode () + { + $sMenuTitle = isset($this->_aObject['title']) ? _t($this->_aObject['title']) : 'Menu-' . rand(0, PHP_INT_MAX); + if (isset($GLOBALS['bx_profiler'])) $GLOBALS['bx_profiler']->beginMenu($sMenuTitle); + + if(!$this->_iPageType) + $this->_iPageType = BxDolTemplate::getInstance()->getPageType(); + + $s = ''; + $aVars = $this->_getTemplateVars (); + if (!empty($aVars['bx_repeat:menu_items'])) { + $this->_addJsCss(); + $s = $this->_getCode($this->_aObject['template'], $aVars); + } + + if (isset($GLOBALS['bx_profiler'])) $GLOBALS['bx_profiler']->endMenu($sMenuTitle); + + return $s; + } + + /** + * Get menu code API. + * @return array + */ + public function getCodeAPI () + { + $aItems = []; + + $aVars = $this->_getTemplateVars(); + if(!empty($aVars['bx_repeat:menu_items'])) + $aItems = $aVars['bx_repeat:menu_items']; + + return [ + 'object' => $this->_sObject, + 'persistent' => $this->_aObject['persistent'], + 'params' => $this->getContentParams(), + 'items' => $aItems + ]; + } + + /** + * Get menu short code API. + * @return array + */ + public function getShortCodeAPI () + { + return [ + 'object' => $this->_sObject, + 'params' => $this->getContentParams() + ]; + } + + protected function _getCode($sTmplName, $aTmplVars) + { + return $this->_oTemplate->parseHtmlByName($this->getTemplateName($sTmplName), $aTmplVars); + } + + public function getCodeItem ($sName) + { + if(empty($sName)) + return ''; + + $sCode = $this->_oTemplate->getHtml(str_replace('.html', '_item.html', $this->_aObject['template'])); + if(empty($sCode)) + return ''; + + $mixedTmplVars = $this->getMenuItem($sName); + if($mixedTmplVars === false) + return ''; + + return $this->_oTemplate->parseHtmlByContent($sCode, $mixedTmplVars); + } + + /** + * Get template variables array + * @return array + */ + protected function _getTemplateVars () + { + $aMenuItems = $this->getMenuItems(); + $sMenuItemSelected = _t($aMenuItems && $this->_aSelected && !empty($this->_aSelected['title']) ? $this->_aSelected['title'] : '_Contents'); + + return [ + 'object' => $this->_sObject, + 'menu_item_selected' => $sMenuItemSelected, + 'bx_repeat:menu_items' => $aMenuItems, + ]; + } + + /** + * Get menu items array, which is ready to pass to menu template. + * @return array or false + */ + public function getMenuItems () + { + if (!isset($this->_aObject['menu_items'])) + $this->_aObject['menu_items'] = $this->getMenuItemsRaw (); + + $aItems = array(); + foreach ($this->_aObject['menu_items'] as $aItem) { + $aItem = $this->_getMenuItem ($aItem); + if($aItem !== false) + $aItems[] = $aItem; + } + + return $aItems; + } + + /** + * Get menu item array, which is ready to pass to whole menu or + * single menu item template. May return false if single menu item + * is requested but cannot be shown by circumstances. + * @return array or false + */ + public function getMenuItem ($sName) + { + if (!isset($this->_aObject['menu_items'])) + $this->_aObject['menu_items'] = $this->getMenuItemsRaw (); + + if(!empty($sName)) + return $this->_getMenuItem($this->_aObject['menu_items'][$sName]); + } + + /** + * Get menu items array, this is just a wrapper for DB function for make it easier to override. + * It is used in @see BxBaseMenu::getMenuItems + * @return array + */ + protected function getMenuItemsRaw () + { + if($this->_bMultilevel) + return $this->_oQuery->getMenuItemsHierarchy(); + else + return $this->_oQuery->getMenuItems(); + } + + protected function _getMenuItem ($a) + { + if (!$this->_isActive($a) || !$this->_isVisible($a)) + return false; + + if ($this->_bIsApi) { + list ($sIcon, $sIconUrl) = $this->_getMenuIcon($a); + + $aResult = [ + 'id' => $a['id'], + 'name' => $a['name'], + 'title' => _t($a['title']), + 'link' => isset($a['link']) ? $a['link'] : '', + 'icon' => $sIcon ? $sIcon : '', + 'image' => $sIconUrl ? $sIconUrl : '', + 'submenu' => !empty($a['submenu_object']) ? $a['submenu_object'] : '', + 'addon' => $this->_bDisplayAddons ? $this->_getMenuAddon($a) : '', + 'primary' => $a['primary'], + ]; + + if(($aMarkers = $this->_getMenuMarkers($a)) && is_array($aMarkers)) + $this->addMarkers($aMarkers); + $aResult = $this->_replaceMarkers($aResult); + + if(!empty($aResult['link'])) + $aResult['link'] = $this->_oPermalinks->permalink($aResult['link']); + + return $aResult; + } + + $bIsSelected = $this->_isSelected($a); + if($bIsSelected) + $this->_aSelected = $a; + + $a['object'] = $this->_sObject; + + $a['title'] = _t($a['title']); + $a['bx_if:title'] = array( + 'condition' => !empty($a['title']), + 'content' => array( + 'title' => $a['title'] + ) + ); + + $this->removeMarker('addon'); + + $a = $this->_replaceMarkers($a); + + if ($this->_bDisplayAddons) { + $mixedAddon = $this->_getMenuAddon($a); + if (!is_array($mixedAddon)) { + $this->addMarkers(array('addon' => $mixedAddon)); + $a = $this->_replaceMarkers($a); + } + } + + $aMarkers = $this->_getMenuMarkers($a); + if ($aMarkers && is_array($aMarkers)) { + $this->addMarkers($aMarkers); + $a = $this->_replaceMarkers($a); + } + + list ($sIcon, $sIconUrl, $sIconA, $sIconHtml) = $this->_getMenuIcon($a); + + $a['class_add'] = $bIsSelected ? 'bx-menu-tab-active' : ''; + $a['class_add'] .= $this->_getVisibilityClass($a); + $a['class_link'] = ''; + + $a['link'] = isset($a['link']) ? $this->_oPermalinks->permalink($a['link']) : 'javascript:void(0);'; + $a['title_attr'] = bx_html_attribute(strip_tags($a['title'])); + + $a['attrs'] = $this->_getMenuAttrs($a); + $a['attrs_wrp'] = ''; + + if($this->_bHx && !empty($a['link']) && strpos($a['link'], 'javascript:') === false) { + $this->_aHx['get'] = $a['link']; + $a['attrs'] .= bx_get_htmx_attrs($this->_aHx, $this->_mHxPreload); + + if(!bx_is_htmx_request() && !$bIsSelected) + $a['attrs_wrp'] .= bx_get_htmx_attrs([ + 'get' => $a['link'], + 'trigger' => 'load', + 'target' => '#bx-content-preload', + 'swap' => 'beforeend', + ]); + } + + $a['bx_if:image'] = array ( + 'condition' => (bool)$sIconUrl, + 'content' => array('icon_url' => $sIconUrl), + ); + $a['bx_if:image_inline'] = array ( + 'condition' => false, + 'content' => array('image' => ''), + ); + $a['bx_if:icon'] = array ( + 'condition' => (bool)$sIcon, + 'content' => array('icon' => $sIcon), + ); + $a['bx_if:icon-html'] = array ( + 'condition' => (bool)$sIconHtml, + 'content' => array('icon' => $sIconHtml), + ); + $a['bx_if:icon-a'] = array ( + 'condition' => (bool)$sIconA, + 'content' => array('icon-a' => $sIconA), + ); + $a['bx_if:title'] = array ( + 'condition' => (bool)$a['title'], + 'content' => array( + 'title' => $a['title'], + 'title_attr' => $a['title_attr'] + ), + ); + + $bOnClick = !empty($a['onclick']); + $aOnClick = $bOnClick ? [ + 'onclick' => $a['onclick'], + ] : []; + + $a['bx_if:onclick'] = [ + 'condition' => $bOnClick, + 'content' => $aOnClick + ]; + + $aTmplVarsAddon = $this->_bDisplayAddons ? $this->_getTmplVarsAddon($mixedAddon, $a) : array('addon' => '', 'addonf' => ''); + $a['bx_if:addon'] = array ( + 'condition' => $this->_bDisplayAddons && !empty($aTmplVarsAddon['addon']), + 'content' => $aTmplVarsAddon + ); + + $aTmplVarsSubitems = array('subitems' => ''); + $bTmplVarsSubitems = $this->_bMultilevel && !empty($a['subitems']); + if($bTmplVarsSubitems) { + $sClassCollpsed = 'bx-mi-collapsed'; + if(($iCollapsed = $this->getUserChoiceCollapsedSubmenu($a)) !== false) + $a['class_add'] .= $iCollapsed ? ' ' . $sClassCollpsed : ''; + else if(isset($a['collapsed']) && $a['collapsed']) + $a['class_add'] .= ' ' . $sClassCollpsed; + + $aSubitems = array(); + foreach($a['subitems'] as $aSubitem) { + $aSubitem = $this->_getMenuItem($aSubitem); + if($aSubitem !== false) + $aSubitems[] = $aSubitem; + } + + if(!$bOnClick) + $a['bx_if:onclick'] = [ + 'condition' => true, + 'content' => [ + 'onclick' => "javascript:return bx_menu_toggle(this, '" . $this->_sObject . "', '" . $a['name'] . "')" + ] + ]; + + $aTmplVarsSubitems['subitems'] = $this->_oTemplate->parseHtmlByName(str_replace('.html', '_subitems.html', $this->getTemplateName()), array( + 'bx_repeat:menu_items' => $aSubitems, + )); + } + + $a['bx_if:show_toggler'] = [ + 'condition' => $bTmplVarsSubitems, + 'content' => [] + ]; + $a['bx_if:show_subitems'] = array ( + 'condition' => $bTmplVarsSubitems, + 'content' => $aTmplVarsSubitems + ); + + unset($a['subitems']); + + foreach ($this->_aOptionalParams as $sName => $sDefaultValue) + if (!isset($a[$sName])) + $a[$sName] = $sDefaultValue; + + return $a; + } + + protected function _getMenuIcon ($a) + { + return BxTemplFunctions::getInstanceWithTemplate($this->_oTemplate)->getIcon(!empty($a['icon']) ? $a['icon'] : ''); + } + + public function getMenuIconHtml($sIcon) + { + list ($sIcon, $sIconUrl, $sIconA, $sIconHtml) = BxTemplFunctions::getInstanceWithTemplate($this->_oTemplate)->getIcon($sIcon); + + $a['bx_if:image'] = array ( + 'condition' => (bool)$sIconUrl, + 'content' => array('icon_url' => $sIconUrl), + ); + $a['bx_if:icon'] = array ( + 'condition' => (bool)$sIcon, + 'content' => array('icon' => $sIcon), + ); + $a['bx_if:icon-a'] = array ( + 'condition' => (bool)$sIconA, + 'content' => array('icon-a' => $sIconA), + ); + $a['bx_if:icon-html'] = array ( + 'condition' => (bool)$sIconHtml, + 'content' => array('icon' => $sIconHtml), + ); + + return $this->_oTemplate->parseHtmlByName('menu_icon.html', $a); + } + + protected function _getMenuAddon ($aMenuItem) + { + if (empty($aMenuItem['addon'])) + return ''; + + if (isset($aMenuItem['addon_cache']) && $aMenuItem['addon_cache']) { + $oCache = BxDolDb::getInstance()->getDbCacheObject(); + $sKey = 'menu_' . $this->_sObject . '_' . $aMenuItem['name'] . '_' . bx_get_logged_profile_id() . '_' . bx_site_hash() . '.php'; + $s = $oCache->getData($sKey); + if ($s !== null) { + return $s; + } + else { + $s = BxDolService::callSerialized($aMenuItem['addon'], $this->_aMarkers); + $oCache->setData($sKey, $s); + } + + return $s; + } + else { + return BxDolService::callSerialized($aMenuItem['addon'], $this->_aMarkers); + } + } + + protected function _getMenuMarkers ($aMenuItem) + { + if (empty($aMenuItem['markers'])) + return ''; + + return BxDolService::callSerialized($aMenuItem['markers'], $this->_aMarkers); + } + + protected function _getMenuAttrs ($aMenuItem) + { + $sAttrs = ''; + if(!empty($aMenuItem['target'])) + $sAttrs .= ' target="' . $aMenuItem['target'] . '"'; + + if($this->_bAddNoFollow && !empty($aMenuItem['link']) && preg_match('@^https?://@', $aMenuItem['link']) && strncmp($aMenuItem['link'], BX_DOL_URL_ROOT, strlen(BX_DOL_URL_ROOT)) !== 0) + $sAttrs .= ' rel="noreferrer"'; + + return $sAttrs; + } + + /** + * Add css/js files which are needed for menu display and functionality. + */ + protected function _addJsCss() + { + $this->_oTemplate->addCss('menu.css'); + } + + protected function _getTmplVarsAddon($mixedAddon, $aMenuItem) + { + $sAddon = ''; + if(!is_array($mixedAddon)) + $sAddon = $mixedAddon; + else if(!empty($mixedAddon['addon'])) + $sAddon = $mixedAddon['addon']; + + return array( + 'addon' => $sAddon, + 'addonf' => '' + ); + } +} + +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBasePage.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBasePage.php new file mode 100644 index 0000000000..dcb9f39838 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBasePage.php @@ -0,0 +1,1387 @@ +_oTemplate = $oTemplate; + else + $this->_oTemplate = BxDolTemplate::getInstance(); + + $this->_sStorage = 'sys_images'; + + $this->_sJsClassName = 'BxDolPage'; + $this->_sJsObjectName = 'oBxDolPage'; + + $this->_bStickyColumns = isset($this->_aObject['sticky_columns']) && $this->_aObject['sticky_columns'] == 1; + + $sHtmlId = str_replace(array('_' , ' '), array('-', '-'), $this->_sObject); + $this->_aHtmlIds = array( + 'help_popup' => $sHtmlId . '-help-popup-', + ); + $this->addMarkers(array('site_title' => getParam('site_title'))); + } + + public function performActionGetHelp () + { + $iBlockId = (int)bx_get('block_id'); + if(empty($iBlockId)) + return; + + $aBlock = $this->_oQuery->getPageBlock($iBlockId); + if(empty($aBlock) || !is_array($aBlock) || empty($aBlock['help'])) + return; + + echo $this->_oTemplate->parseHtmlByName('designbox_help_popup.html', array( + 'content' => _t($aBlock['help']) + )); + } + + public function performActionGetShare () + { + $aEmbedData = BxDolPage::getEmbedData(bx_get('url')); + if(!isset($aEmbedData['url'])) + return; + + $sMenu = ''; + if(getParam('sys_a2a_enable') != 'on') { + if(($oMenu = BxDolMenu::getObjectInstance('sys_social_sharing')) !== false) { + $oMenu->addMarkers([ + 'url' => $aEmbedData['url'], + 'img_url_encoded' => '', + 'title_encoded' => '' + ]); + $sMenu = $oMenu->getCode(); + } + } + else + $sMenu = getParam('sys_a2a_code'); + + echo PopupBox('sys_share_popup', _t('_sys_txt_share_popup_header'), $this->_oTemplate->parseHtmlByName('designbox_share_popup.html', [ + 'url' => bx_process_output($aEmbedData['url']), + 'menu' => $sMenu, + 'code' => htmlspecialchars($aEmbedData['html']), + ]), true); + } + + public function performActionEmbed () + { + $aCover = $this->getPageCoverImage(); + $sTitle = $this->_getPageTitle(); + $this->_oTemplate->getEmbed($this->_oTemplate->parseHtmlByName('embed_card.html', [ + 'title' => $sTitle, + 'url' => BxDolPermalinks::getInstance()->permalink($this->_aObject['url']), + 'bx_if:thumb' => [ + 'condition' => $this->isPageCover() && count($aCover) > 0, + 'content' => [ + 'title' => $sTitle, + 'url' => BxDolPermalinks::getInstance()->permalink($this->_aObject['url']), + 'background' => BxDolCover::getInstance(BxDolTemplate::getInstance())->getCoverImageUrl($aCover) + ], + ], + 'bx_if:no_thumb' => [ + 'condition' => count($aCover) == 0 || !$this->isPageCover(), + 'content' => [ + 'title' => $sTitle, + 'url' => BxDolPermalinks::getInstance()->permalink($this->_aObject['url']), + ] + ] + ] + )); + } + + public function performActionCreativeSave() + { + if(!$this->isAllowedCreativeManage()) + return echoJson(['code' => 1]); + + $iId = 0; + $sContent = ''; + if(($iId = bx_get('b')) === false || ($sContent = bx_get('c')) === false) + return echoJson(['code' => 2]); + + $iId = bx_process_input($iId, BX_DATA_INT); + $sContent = bx_process_input($sContent, BX_DATA_HTML); + if(!$this->_oQuery->setPageBlockContent($iId, $sContent)) + return echoJson(['code' => 3]); + + return echoJson(['code' => 0]); + } + + public function isAllowedCreativeManage() + { + return isAdmin(); + } + + /** + * Very similar to BxBasePage::getCode + * but adds css and js files which are needed for the corect page display + */ + public function getCodeDynamic () + { + // TODO: remake to use use collect* template methods + + $oTemplate = BxDolTemplate::getInstance(); + + // get js&css before the page code is generated + $aCssBefore = $oTemplate->getCss(); + $aJsBefore = $oTemplate->getJs(); + + // generate page code + $sContent = $this->getCode(); + + // get js&css after the page code is generated + $aCssAfter = $oTemplate->getCss(); + $aJsAfter = $oTemplate->getJs(); + + // compare files which were added before and after page code is generated + $f = function ($a1, $a2) { + return strcasecmp($a1['url'], $a2['url']); + }; + $aCssNew = array_udiff($aCssAfter, $aCssBefore, $f); + $aJsNew = array_udiff($aJsAfter, $aJsBefore, $f); + + // add newly added js&css files in static mode + $sCss = $sJs = ''; + foreach ($aCssNew as $a) + $sCss .= $oTemplate->addCss($a['url'], true); + foreach ($aJsNew as $a) + $sJs .= $oTemplate->addJs($a['url'], true); + + return $sJs . $sCss . $sContent; + } + + public function getIncludes () + { + $oTemplate = BxDolTemplate::getInstance(); + + // generate page code + $this->getCode(); + + // get js&css after the page code is generated + $aCss = $oTemplate->getCss(); + $aJs = $oTemplate->getJs(); + + // add js&css files in static mode + $sResult = ''; + foreach ($aCss as $a) + $sResult .= $oTemplate->addCss($a['url'], true); + foreach ($aJs as $a) + $sResult .= $oTemplate->addJs($a['url'], true); + + // add js translations + $sResult .= $oTemplate->getJsTranslation(true); + + return $sResult; + } + + /** + * Get page code with automatic caching, adding necessary css/js files and system template vars. + * @return string. + */ + public function getCode () + { + if (bx_get('dynamic') && ($iBlockId = (int)bx_get('pageBlock'))) { + + if (self::isLockedFromUnauthenticated($this->_aObject['uri']) || !$this->_isVisiblePage($this->_aObject)) { + header('HTTP/1.0 403 Forbidden'); + exit; + } + + /** + * @hooks + * @hookdef hook-system-page_output_block 'system', 'page_output_block' - hook with page block data to be output + * - $unit_name - equals `system` + * - $action - equals `page_output_block` + * - $object_id - not used + * - $sender_id - not used + * - $extra_params - array of additional params with the following array keys: + * - `page_name` - [string] page object name + * - `page_object` - [object] an instance of page class, @see BxDolPage + * - `page_query` - [object] an instance of page related query class + * - `block_id` - [int] block id + * @hook @ref hook-system-page_output_block + */ + bx_alert('system', 'page_output_block', 0, false, [ + 'page_name' => $this->_sObject, + 'page_object' => $this, + 'page_query' => $this->_oQuery, + 'block_id' => (int)$iBlockId, + ]); + + header( 'Content-type:text/html;charset=utf-8' ); + + BxDolTemplate::getInstance()->collectingStart(); + + $s = $this->_getBlockOnlyCode($iBlockId); + + $sCss = bx_get('includedCss'); + $sJs = bx_get('includedJs'); + echo BxDolTemplate::getInstance()->collectingEndGetCode($sCss ? @json_decode($sCss) : [], $sJs ? @json_decode($sJs) : []); + + echo $s; + exit; + } + + if (($mixedAvailable = $this->_isAvailablePage($this->_aObject)) !== true) + return $this->_getPageNotFoundMsg($mixedAvailable); + + if (($mixedVisible = $this->_isVisiblePage($this->_aObject)) !== true) + return $this->_getPageAccessDeniedMsg($mixedVisible); + + $this->_addJsCss(); + + if (!$this->_bSubPage) { + $this->_addSysTemplateVars(); + + $this->_selectMenu(); + + $this->_setSubmenu(array()); + } + + if (bx_is_dbg() || !getParam('sys_page_cache_enable') || !$this->_aObject['cache_lifetime'] || (isset($_SERVER['REQUEST_METHOD']) && $_SERVER['REQUEST_METHOD'] === 'POST')) { + $sPageCode = $this->_getPageCode(); + } + else { + $oCache = $this->_getPageCacheObject(); + $sKey = $this->_getPageCacheKey(); + $sKeyCssJs = 'cssjs_' . $sKey; + + $mixedRet = $oCache->getData($sKey, $this->_aObject['cache_lifetime']); + $aRetCssJs = $oCache->getData($sKeyCssJs, $this->_aObject['cache_lifetime']); + + if ($mixedRet !== null && $aRetCssJs !== null) { + BxDolTemplate::getInstance()->collectingStart(); + BxDolTemplate::getInstance()->collectingInject($aRetCssJs['css'], $aRetCssJs['js']); + $sPageCode = BxDolTemplate::getInstance()->collectingEndGetCode(); + $sPageCode .= $mixedRet; + } else { + + BxDolTemplate::getInstance()->collectingStart(); + + $sPageCode = $this->_getPageCode(); + + $aPageCssJs = BxDolTemplate::getInstance()->collectingEndGetCode(array(), array(), 'array'); + + $oCache->setData($sKey, $sPageCode, $this->_aObject['cache_lifetime']); + $oCache->setData($sKeyCssJs, $aPageCssJs, $this->_aObject['cache_lifetime']); + } + } + + /** + * @hooks + * @hookdef hook-system-page_output 'system', 'page_output' - hook with page data to be output + * - $unit_name - equals `system` + * - $action - equals `page_output` + * - $object_id - not used + * - $sender_id - not used + * - $extra_params - array of additional params with the following array keys: + * - `page_name` - [string] page object name + * - `page_object` - [object] an instance of page class, @see BxDolPage + * - `page_query` - [object] an instance of page related query class + * - `page_code` - [string] by ref, final page code to be output, can be overridden in hook processing + * - `sub_page` - [boolean] if the page is used as subpage of some parent page + * @hook @ref hook-system-page_output + */ + bx_alert('system', 'page_output', 0, false, [ + 'page_name' => $this->_sObject, + 'page_object' => $this, + 'page_query' => $this->_oQuery, + 'page_code' => &$sPageCode, + 'sub_page' => $this->_bSubPage, + ]); + + if (!$this->_bSubPage) + $sPageCode .= $this->getJsScript(); + + return $sPageCode; + } + + public function getJsClassName() + { + return $this->_sJsClassName; + } + + public function getJsObjectName() + { + return $this->_sJsObjectName; + } + + function _wrapInTagJsCode($sCode) + { + return ""; + } + + public function getJsScript() + { + $sJsObjName = $this->getJsObjectName(); + $sJsObjClass = $this->getJsClassName(); + $sCode = "if(window['" . $sJsObjName . "'] == undefined) var " . $sJsObjName . " = new " . $sJsObjClass . "(" . json_encode(array( + 'sObjName' => $sJsObjName, + 'sObject' => $this->_sObject, + 'sRootUrl' => BX_DOL_URL_ROOT, + 'aHtmlIds' => $this->_aHtmlIds, + 'isStickyColumns' => $this->_bStickyColumns + )) . ");"; + + return $this->_wrapInTagJsCode($sCode); + } + + /** + * Is page cover enabled. + * @return string + */ + public function isPageCover() + { + $bResult = false; + switch((int)$this->_aObject['cover']) { + case 1: //--- Enabled for all + $bResult = true; + break; + + case 2: //--- Enabled for visitors only + $bResult = !isLogged(); + break; + + case 3: //--- Enabled for members only + $bResult = isLogged(); + break; + } + + return $bResult; + } + + public function setSubPage($b = true) + { + $this->_bSubPage = $b; + } + + public function setPageCover($bCover = true) + { + $this->_aObject['cover'] = (bool)$bCover; + } + + public function getPageCoverImage($bTranscoder = true) + { + $iId = (int)$this->_aObject['cover_image']; + if(empty($iId)) { + $iId = (int)getParam('sys_site_cover_common'); + if(empty($iId)) + return array(); + } + + $aResult = array( + 'id' => $iId + ); + if($bTranscoder) + $aResult['transcoder'] = BX_DOL_TRANSCODER_OBJ_COVER; + else + $aResult['object'] = $this->_sStorage; + + return $aResult; + } + + public function getPageCoverParams() + { + $aParams = [ + 'title' => $this->_getPageTitle(), + 'actions' => '', + 'bx_if:image' => [ + 'condition' => false, + 'content' => [] + ], + 'bx_if:icon' => [ + 'condition' => false, + 'content' => [] + ], + ]; + + if(($oMenuSubmenu = BxDolMenu::getObjectInstance('sys_site_submenu')) !== false) { + $aCoverParams = $oMenuSubmenu->getPageCoverParams(); + if(!empty($aCoverParams) && is_array($aCoverParams)) + $aParams = $aCoverParams; + } + + if(!empty($this->_aObject['cover_title'])) { + $sCoverTitle = _t($this->_aObject['cover_title']); + if($sCoverTitle && strcmp($sCoverTitle, $this->_aObject['cover_title']) != 0) + $aParams['title'] = $sCoverTitle; + } + + return $aParams; + } + + /** + * Get block title. + * @return string + */ + public function getBlockTitle ($aBlock) + { + return $this->_replaceMarkers(_t($aBlock['title']), array('block_id' => $aBlock['id'])); + } + + /** + * Get help control if help is available for the block. + * @return string + */ + public function getBlockHelp ($aBlock) + { + if(empty($aBlock['help']) || empty(strip_tags(_t($aBlock['help'])))) + return ''; + + return $this->_oTemplate->parseHtmlByName('designbox_help.html', array( + 'js_object' => $this->_sJsObjectName, + 'block_id' => $aBlock['id'] + )); + } + + /** + * Get code to load block asyncroniously + * @param $aBlock block code + * @param $iAsync if greater than 0 the it defines loading indicator for the block + * @return HTML code string + */ + public function getBlockAsyncCode($aBlock, $iAsync) + { + $aContentPlaceholder = $this->_oQuery->getPageBlockContentPlaceholder($iAsync); + if (!$aContentPlaceholder) + return _t('_sys_txt_error_occured'); + $oTemplate = $this->_oTemplate; + if ('system' != $aContentPlaceholder['module']) { + $oModule = BxDolModule::getInstance($aContentPlaceholder['module']); + if (!$oModule) + return _t('_sys_txt_error_occured'); + $oTemplate = $oModule->_oTemplate; + } + return $oTemplate->parseHtmlByName($aContentPlaceholder['template'], $aBlock); + } + + /** + * Get page array with all cells and blocks + */ + public function getPageAPI ($aBlocks = []) + { + define('BX_API_PAGE', true); + $query_string = ''; + + if (isset(bx_get('params')[2]) && bx_get('params')[2] != ''){ + $array = json_decode(bx_get('params')[2], true); + $query_string = http_build_query($array); + parse_str($query_string, $a); + $_GET = array_merge($_GET, $a); + } + + $bIsAvailable = $this->_isAvailablePage($this->_aObject); + $bIsVisible = $this->_isVisiblePage($this->_aObject); + //TODO: If page isn't Available or isn't Visible then we should exit with related Error Codes immediately. + + $sMetaTitle = $this->_getPageMetaTitle(); + $sName = $this->_getPageTitle(); + $a = [ + 'id' => $this->_aObject['id'], + 'title' => $sMetaTitle ? $sMetaTitle : $sName, + 'name' => $sName, + 'uri' => $this->_aObject['uri'], + 'url' => ((bx_get('params')[0] ? bx_get('params')[0] : $this->_aObject['uri'] ) . ($query_string != '' ? '?' . $query_string : '')), + 'author' => $this->_aObject['author'], + 'added' => $this->_aObject['added'], + 'module' => $this->getModule(), + 'type' => $this->getType (), + 'layout' => str_replace('.html', '', $this->_aObject['template']), + 'cover_block' => '', + 'menu_top' => '', + 'menu' => '', + 'menu_bottom' => '', + 'menu_add' => '', + 'elements' => $this->getPageBlocksAPI($aBlocks), + ]; + + $sMenuTop = getParam('sys_api_menu_top'); + if (!empty($sMenuTop) && ($oMenuTop = BxDolMenu::getObjectInstance($sMenuTop)) !== false) + $a['menu_top'] = $oMenuTop->getCodeAPI(); + + if (($oMenuSubmenu = BxDolMenu::getObjectInstance('sys_site_submenu')) !== false) { + if(($sSubmenu = $this->getSubMenu()) !== '') + $oMenuSubmenu->setObjectSubmenu($sSubmenu, []); + + $a['menu'] = $oMenuSubmenu->getCodeAPI(); + } + + /** + * Profile/Context view page. + */ + if(isset($this->_aProfileInfo)) { + $oProfileModule = BxDolModule::getInstance($this->_aProfileInfo['type']); + if($oProfileModule !== null) + $aProfileContentInfo = $oProfileModule->_oDb->getContentInfoById($this->_aProfileInfo['content_id']); + + if(!empty($aProfileContentInfo) && is_array($aProfileContentInfo)) { + $CNF = &$oProfileModule->_oConfig->CNF; + + /** + * Process page cover with related menus and lists. + */ + if(BxDolCover::getInstance($this)->isCover()) { + $a['cover_block'] = [ + 'profile' => BxDolProfile::getData($this->_aProfileInfo['id'], [ + 'get_avatar' => 'getAvatarBig', + 'with_info' => true + ]), + 'actions_menu' => '', + 'meta_menu' => '', + 'badges' => BxDolProfile::getInstance($this->_aProfileInfo['id'])->getBadges(), + 'cover' => $oProfileModule->serviceGetCover($this->_aProfileInfo['content_id']), + 'allow_edit' => $oProfileModule->checkAllowedChangeCover($aProfileContentInfo) === CHECK_ACTION_RESULT_ALLOWED + ]; + + if(!empty($CNF['OBJECT_MENU_VIEW_ENTRY_META']) && ($oMetaMenu = BxTemplMenu::getObjectInstance($CNF['OBJECT_MENU_VIEW_ENTRY_META'])) !== false) + $a['cover_block']['meta_menu'] = $oMetaMenu->getCodeAPI(); + + if(!empty($CNF['OBJECT_CONNECTIONS']) && ($oConnection = BxDolConnection::getObjectInstance($CNF['OBJECT_CONNECTIONS'])) !== false) + $a['cover_block']['members_list'] = $oConnection->getConnectedListAPI($this->_aProfileInfo['id'], false, BX_CONNECTIONS_CONTENT_TYPE_INITIATORS, 10); + + if(!empty($CNF['OBJECT_MENU_ACTIONS_VIEW_ENTRY_ALL']) && ($oActionMenu = BxTemplMenu::getObjectInstance($CNF['OBJECT_MENU_ACTIONS_VIEW_ENTRY_ALL'])) !== false) + $a['cover_block']['actions_menu'] = $oActionMenu->getCodeAPI(); + } + + /** + * Process page mange menu. + */ + if(($oMenuManage = BxDolMenu::getObjectInstance('sys_site_manage')) !== false) { + if(!empty($CNF['FIELD_ID'])) + $oMenuManage->setContentId($aProfileContentInfo[$CNF['FIELD_ID']]); + + $aObjectManage = []; + if(!empty($CNF['OBJECT_MENU_MANAGE_VIEW_ENTRY'])) + $aObjectManage = [$CNF['OBJECT_MENU_MANAGE_VIEW_ENTRY']]; + else if(!empty($CNF['OBJECT_MENU_ACTIONS_VIEW_ENTRY_MORE'])) + $aObjectManage = [$CNF['OBJECT_MENU_ACTIONS_VIEW_ENTRY_MORE'], true]; + + call_user_func_array([$oMenuManage, 'setObjectManage'], $aObjectManage); + + $aMenuManage = $oMenuManage->getCodeAPI(); + if(!empty($aMenuManage) && is_array($aMenuManage)) { + if(isset($a['cover_block'], $a['cover_block']['actions_menu']) && is_array($a['cover_block']['actions_menu'])) + $a['cover_block']['actions_menu']['items'] = array_merge($a['cover_block']['actions_menu']['items'], $aMenuManage['items']); + else + $a['cover_block']['actions_menu'] = $aMenuManage; + } + } + } + } + + if (isLogged()) { + $o = BxDolProfile::getInstance(); + $a['user'] = BxDolProfile::getDataForPage($o); + } + + $aExtras = [ + 'page' => $this, + 'blocks' => $aBlocks, + 'data' => &$a, + ]; + + if(!$bIsAvailable) + $a['page_status'] = 404; + else if(!$bIsVisible) + $a['page_status'] = 403; + + /** + * @hooks + * @hookdef hook-system-get_page_api 'system', 'get_page_api' - hook to override page peremeters, is used in API calls + * - $unit_name - equals `system` + * - $action - equals `get_page_api` + * - $object_id - not used + * - $sender_id - not used + * - $extra_params - array of additional params with the following array keys: + * - `page` - [object] an instance of page class, @see BxDolPage + * - `blocks` - [array] array with page blocks + * - `data` - [array] by ref, page peremeters array as key&value pairs, can be overridden in hook processing + * @hook @ref hook-system-get_page_api + */ + bx_alert('system', 'get_page_api', 0, 0, $aExtras); + + return $a; + } + + public function getPageBlocksAPI($aBlocks = []) + { + $bBlocks = !empty($aBlocks) && is_array($aBlocks); + $aFieldsUnset = ['object', 'cell_id', 'title_system', 'class', 'submenu', 'tabs', 'async', 'visible_for_levels', 'hidden_on', 'type', 'text', 'text_updated', 'help', 'cache_lifetime', 'active', 'active_api', 'copyable', 'deletable', 'order']; + + $aCells = $this->_oQuery->getPageBlocks(true); + foreach($aCells as $sKey => &$aCell) { + foreach($aCell as $i => $aBlock) { + if(!$this->_isVisibleBlock($aBlock)) { + unset($aCells[$sKey][$i]); + continue; + } + + $this->processPageBlock($aCells[$sKey][$i], true); + $aBlock = $aCells[$sKey][$i]; + + $sSource = ''; + if($aBlock['type'] == 'service') { + $aContent = @unserialize($aBlock['content']); + if(isset($aContent['module'], $aContent['method'])) + $sSource = $aContent['module'] . ':' . $aContent['method']; + } + else{ + $sSource = 'system:block_' . $aBlock['id']; + } + + if($bBlocks && !in_array($sSource, $aBlocks)) { + unset($aCells[$sKey][$i]); + continue; + } + + $sFunc = '_getBlock' . bx_gen_method_name($aBlock['type']); + $mBlock = method_exists($this, $sFunc) ? $this->$sFunc($aBlock) : $aBlock['content']; + + $aCells[$sKey][$i] = array_merge($aCells[$sKey][$i], [ + 'title' => isset($mBlock['title']) ? $mBlock['title'] : $this->getBlockTitle($aBlock), + 'content' => isset($mBlock['content']) ? $mBlock['content'] : $mBlock, + 'menu' => isset($mBlock['menu']) ? $mBlock['menu'] : '', + 'source' => $sSource + ]); + $aCells[$sKey][$i] = array_diff_key($aCells[$sKey][$i], array_flip($aFieldsUnset)); + } + } + + return array_map('array_values', $aCells); + } + + /** + * Get page code vars + * @return string + */ + protected function _getPageCodeVars () + { + $aHiddenOn = array( + pow(2, BX_DB_HIDDEN_PHONE - 1) => 'bx-def-media-phone-hide', + pow(2, BX_DB_HIDDEN_TABLET - 1) => 'bx-def-media-tablet-hide', + pow(2, BX_DB_HIDDEN_DESKTOP - 1) => 'bx-def-media-desktop-hide', + pow(2, BX_DB_HIDDEN_MOBILE - 1) => 'bx-def-mobile-app-hide' + ); + + $aVars = array ( + 'page_id' => 'bx-page-' . $this->_aObject['uri'], + 'bx_if:show_layout_row_dump' => array( + 'condition' => false, + 'content' => array() + ) + ); + $aBlocks = $this->_oQuery->getPageBlocks(); + foreach ($aBlocks as $sKey => $aCell) { + $sCell = ''; + foreach ($aCell as $aBlock) { + $this->processPageBlock($aBlock, false); + + $sContentWithBox = $this->_getBlockCodeWithCache($aBlock, $aBlock['async']); + + $sClassAdd = ''; + if(!empty($aBlock['class'])) + $sClassAdd .= ' ' . $aBlock['class']; + + if(!empty($aBlock['hidden_on'])) + foreach($aHiddenOn as $iHiddenOn => $sHiddenOnClass) + if((int)$aBlock['hidden_on'] & $iHiddenOn) + $sClassAdd .= ' ' . $sHiddenOnClass; + + if ($sContentWithBox) + $sCell .= $this->_oTemplate->parseHtmlByName('designbox_container.html', array( + 'class_add' => $sClassAdd, + 'bx_if:show_html_id' => array( + 'condition' => true, + 'content' => array( + 'html_id' => 'bx-page-block-' . $aBlock['id'] + ), + ), + 'content' => $sContentWithBox + )); + } + $aVars[$sKey] = $sCell; + } + + return $aVars; + } + + /** + * Process block values, especially if someting need to be overrided + */ + protected function processPageBlock(&$aBlock, $bApi = false) + { + + } + + /** + * Get page code only. + * @return string + */ + protected function _getPageCode () + { + $aVars = $this->_getPageCodeVars (); + return $this->_oTemplate->parseHtmlByName($this->_aObject['template'], $aVars); + } + + /** + * Get one block code only. + * @return string + */ + protected function _getBlockOnlyCode ($iBlockId) + { + if (!($aBlock = $this->_oQuery->getPageBlock((int)$iBlockId))) + return ''; + return $this->_getBlockCodeWithCache($aBlock, 0); + } + + + protected function _getBlockCodeWithCache(&$aBlock, $iAsync = 0) + { + if (bx_is_dbg() || !getParam('sys_pb_cache_enable') || !$aBlock['cache_lifetime'] || $iAsync || (isset($_SERVER['REQUEST_METHOD']) && $_SERVER['REQUEST_METHOD'] === 'POST')) { + $sBlockCode = $this->_getBlockCode($aBlock, $iAsync); + } + else { + $oCache = $this->_getBlockCacheObject(); + $sKey = $this->_getBlockCacheKey(false, $aBlock); + $sKeyCssJs = 'cssjs_' . $sKey; + + $mixedRet = $oCache->getData($sKey, $aBlock['cache_lifetime']); + $aRetCssJs = $oCache->getData($sKeyCssJs, $aBlock['cache_lifetime']); + + if ($mixedRet !== null && $aRetCssJs !== null) { + BxDolTemplate::getInstance()->collectingStart(); + BxDolTemplate::getInstance()->collectingInject($aRetCssJs['css'], $aRetCssJs['js']); + $sBlockCode = BxDolTemplate::getInstance()->collectingEndGetCode(); + $sBlockCode .= $mixedRet; + } else { + BxDolTemplate::getInstance()->collectingStart(); + + $sBlockCode = $this->_getBlockCode($aBlock, $iAsync); + + $aBlockCssJs = BxDolTemplate::getInstance()->collectingEndGetCode(array(), array(), 'array'); + + $oCache->setData($sKey, $sBlockCode, $aBlock['cache_lifetime']); + $oCache->setData($sKeyCssJs, $aBlockCssJs, $aBlock['cache_lifetime']); + } + } + + return $sBlockCode; + } + + /** + * Get block code. + * @return string + */ + protected function _getBlockCode(&$aBlock, $iAsync = 0) + { + $sContentWithBox = ''; + $oFunctions = $this->_oTemplate->getTemplateFunctions(); + + if (isset($GLOBALS['bx_profiler'])) $GLOBALS['bx_profiler']->beginPageBlock(_t($aBlock['title']), $aBlock['id']); + + $aDbNoTitle = [BX_DB_CONTENT_ONLY, BX_DB_PADDING_CONTENT_ONLY, BX_DB_NO_CAPTION, BX_DB_PADDING_NO_CAPTION]; + + $sTitle = $this->getBlockTitle($aBlock); + $sHelp = $this->getBlockHelp($aBlock); + + $sFunc = '_getBlock' . ucfirst($aBlock['type']); + $bBlockVisible = $this->_isVisibleBlock($aBlock); + if ($iAsync && $bBlockVisible) { + $iDesignboxId = $aBlock['designbox_id']; + + $sHelpTitle = $sHelpContent = ''; + if(!in_array($iDesignboxId, $aDbNoTitle)) + $sHelpTitle = $sHelp; + else + $sHelpContent = $sHelp; + + $sContent = $this->getBlockAsyncCode($aBlock, $iAsync); + $aParams = array( + $sTitle . $sHelpTitle, + $sContent . $sHelpContent, + $iDesignboxId + ); + $sContentWithBox = call_user_func_array(array($oFunctions, 'designBoxContent'), $aParams); + } + elseif ($bBlockVisible && method_exists($this, $sFunc)) { + $mixedContent = $this->$sFunc($aBlock); + + if(!empty($aBlock['content_empty'])) { + $sEmpty = _t($aBlock['content_empty']); + $sRegExp = '/(<[A-Za-z0-9]+\b.[^<]*[\pPi\pPf]bx\-msg\-box\b.*[\pPi\pPf][^>]*>)(' . _t('_Empty') . ')(<\/[A-Za-z0-9]+>)/su'; + if(is_string($mixedContent)) + $mixedContent = preg_replace($sRegExp, "\${1}" . $sEmpty . "\${3}", $mixedContent); + else if(is_array($mixedContent) && !empty($mixedContent['content'])) + $mixedContent['content'] = preg_replace($sRegExp, "\${1}" . $sEmpty . "\${3}", $mixedContent['content']); + } + + $this->_oQuery->setReadOnlyMode(true); + + if(is_array($mixedContent) && !empty($mixedContent['content'])) { + $iDesignboxId = isset($mixedContent['designbox_id']) ? $mixedContent['designbox_id'] : $aBlock['designbox_id']; + + if(!empty($mixedContent['markers']) && is_array($mixedContent['markers'])) { + $this->addMarkers($mixedContent['markers']); + + $sTitle = $this->getBlockTitle($aBlock); + } + + $sHelpTitle = $sHelpContent = ''; + if(!in_array($iDesignboxId, $aDbNoTitle)) + $sHelpTitle = $sHelp; + else + $sHelpContent = $sHelp; + + $aParams = array( + (isset($mixedContent['title']) ? $mixedContent['title'] : $sTitle) . $sHelpTitle, + $mixedContent['content'] . $sHelpContent, + $iDesignboxId + ); + + $mixedMenu = false; + if(isset($mixedContent['menu'])) + $mixedMenu = $mixedContent['menu']; + else if(!empty($aBlock['submenu'])) + $mixedMenu = $aBlock['submenu']; + $aParams[] = $mixedMenu; + + if(isset($mixedContent['buttons'])) + $aParams[] = $mixedContent['buttons']; + else if($mixedMenu) + $aParams[] = (int)$aBlock['tabs'] == 1 ? true : array(); + + if(isset($mixedContent['class'])) + $aBlock['class'] = $mixedContent['class']; + } + else if(is_string($mixedContent) && !empty($mixedContent)) { + $iDesignboxId = $aBlock['designbox_id']; + + $sHelpTitle = $sHelpContent = ''; + if(!in_array($iDesignboxId, $aDbNoTitle)) + $sHelpTitle = $sHelp; + else + $sHelpContent = $sHelp; + + $aParams = array( + $sTitle . $sHelpTitle, + $mixedContent . $sHelpContent, + $iDesignboxId + ); + + $mixedMenu = !empty($aBlock['submenu']) ? $aBlock['submenu'] : false; + $aParams[] = $mixedMenu; + + if($mixedMenu) + $aParams[] = (int)$aBlock['tabs'] == 1 ? true : array(); + } + + if(!empty($aParams)) + $sContentWithBox = call_user_func_array(array($oFunctions, 'designBoxContent'), $aParams); + } + + if (isset($GLOBALS['bx_profiler'])) $GLOBALS['bx_profiler']->endPageBlock($aBlock['id'], $sContentWithBox ? false : true, false ); + + return $sContentWithBox; + } + + /** + * Add necessary js and css files. + */ + protected function _addJsCss() + { + $this->_oTemplate->addJs(array('BxDolPage.js', 'theia-sticky-sidebar/theia-sticky-sidebar.min.js', 'theia-sticky-sidebar/ResizeSensor.min.js')); + $this->_oTemplate->addCss('page_layouts.css'); + } + + /** + * Set system template variables, like page title, meta description, meta keywords and meta robots. + */ + protected function _addSysTemplateVars () + { + $oTemplate = BxDolTemplate::getInstance(); + + $sPageTitle = $this->_getPageTitle(); + if ($sPageTitle) + $oTemplate->setPageHeader ($sPageTitle); + + $sMetaTitle = $this->_getPageMetaTitle(); + if ($sMetaTitle) + $oTemplate->setPageMetaTitle ($sMetaTitle); + + $sMetaDesc = $this->_getPageMetaDesc(); + if ($sMetaDesc) + $oTemplate->setPageDescription ($sMetaDesc); + + $sMetaRobots = $this->_getPageMetaRobots(); + if ($sMetaRobots) + $oTemplate->setPageMetaRobots ($sMetaRobots); + + $sMetaImage = $this->_getPageMetaImage(); + if ($sMetaImage) + $oTemplate->addPageMetaImage($sMetaImage); + + $sMetaKeywords = $this->_getPageMetaKeywords(); + if ($sMetaKeywords) + $oTemplate->addPageKeywords ($sMetaKeywords); + } + + /** + * Select menu from page properties. + */ + protected function _selectMenu () + { + BxDolMenu::setSelectedGlobal ($this->_aObject['module'], $this->_aObject['uri']); + } + + /** + * Set page submenu if it's specified + */ + protected function _setSubmenu ($aParams) + { + if(empty($this->_aObject['submenu']) || $this->_aObject['submenu'] == 'disabled') + return; + + $oMenuSubmenu = BxDolMenu::getObjectInstance('sys_site_submenu'); + if(!$oMenuSubmenu) + return; + + $oMenuSubmenu->setObjectSubmenu($this->_aObject['submenu'], $aParams); + } + + /** + * Get content for 'raw' block type. + * @return string + */ + protected function _getBlockRaw ($aBlock) + { + if (bx_is_api()){ + return [bx_api_get_block('raw', ['title' => _t($aBlock['title']), 'content' => BxDolTemplate::getInstance()->parseHtmlByContent($aBlock['content'], array())])]; + } + + $s = '' . BxDolTemplate::getInstance()->parseHtmlByContent($aBlock['content'], array()) . ''; + $s = $this->_replaceMarkers($s, array('block_id' => $aBlock['id'])); + $s = bx_process_macros($s); + return $s; + } + + /** + * Get content for 'custom' block type. + * @return string + */ + protected function _getBlockCustom ($aBlock) + { + if (bx_is_api()){ + return [bx_api_get_block('custom', ['title' => _t($aBlock['title']), 'content' => BxDolTemplate::getInstance()->parseHtmlByContent($aBlock['content'], array())])]; + } + + $s = '' . BxDolTemplate::getInstance()->parseHtmlByContent($aBlock['content'], array()) . ''; + $s = $this->_replaceMarkers($s, array('block_id' => $aBlock['id'])); + $s = bx_process_macros($s); + return $s; + } + + /** + * Get content for 'html' block type. + * @return string + */ + protected function _getBlockHtml ($aBlock) + { + if (bx_is_api()){ + return [bx_api_get_block('html', ['title' => _t($aBlock['title']), 'content' => $aBlock['content']])]; + } + + $s = '' . $aBlock['content'] . ''; + $s = $this->_replaceMarkers($s, array('block_id' => $aBlock['id'])); + $s = bx_process_macros($s); + return $s; + } + + /** + * Get content for 'creative' block type. + * @return string + */ + protected function _getBlockCreative ($aBlock) + { + if(bx_is_api()) + return [bx_api_get_block('creative', ['title' => _t($aBlock['title']), 'content' => $aBlock['content']])]; + + $s = $this->_replaceMarkers($aBlock['content'], ['block_id' => $aBlock['id']]); + $s = bx_process_macros($s); + + $bCanManage = $this->isAllowedCreativeManage(); + + if($bCanManage) { + $this->_oTemplate->addCss([ + BX_DIRECTORY_PATH_PLUGINS_PUBLIC . 'grapesjs/|grapes.min.css', + ]); + + $this->_oTemplate->addJs([ + 'grapesjs/grapes.min.js', + 'grapesjs/grapesjs-blocks-basic.js', + 'grapesjs/grapesjs-style-bg.js', + 'grapesjs/grapesjs-preset-webpage.min.js', + ]); + } + + return $this->_oTemplate->parseHtmlByName('block_creative.html', [ + 'block_id' => $aBlock['id'], + 'content' => $s, + 'bx_if:show_controls' => [ + 'condition' => $bCanManage, + 'content' => [ + 'onclick_edit' => $this->_sJsObjectName . '.creativeEdit(this, ' . $aBlock['id'] . ')', + 'onclick_save' => $this->_sJsObjectName . '.creativeSave(this, ' . $aBlock['id'] . ')' + ] + ] + ]); + } + + /** + * Get content for 'bento_grid' block type. + * @return string + */ + protected function _getBlockBentoGrid ($aBlock) + { + if(bx_is_api()) { + $iBlockId = (int)$aBlock['id']; + + $iContentId = 0; + if(($mContentId = bx_get('id')) !== false) + $iContentId = (int)$mContentId; + + $sContentModule = ''; + if(!empty($this->_aObject['module']) && !in_array($this->_aObject['module'], ['system', 'custom'])) + $sContentModule = $this->_aObject['module']; + + $bIsAllowedEdit = false; + if(!empty($sContentModule) && bx_is_srv($sContentModule, 'check_allowed_with_content')) + $bIsAllowedEdit = bx_srv($sContentModule, 'check_allowed_with_content', ['edit', $iContentId]) === CHECK_ACTION_RESULT_ALLOWED; + else + $bIsAllowedEdit = isAdmin(); + + return [bx_api_get_block('bento_grid', [ + 'title' => _t($aBlock['title']), + 'content' => self::getPageBlockData($iBlockId, $iContentId, $sContentModule) + ], ['ext' => [ + 'block_id' => $iBlockId, + 'content_id' => $iContentId, + 'content_module' => $sContentModule, + 'is_allowed_edit' => $bIsAllowedEdit + ]])]; + } + + /** + * Isn't supported for now. + */ + return ''; + } + + /** + * Get content for 'wiki' block type. + * @return string + */ + protected function _getBlockWiki ($aBlock) + { + $oWiki = BxDolWiki::getObjectInstance($this->_aObject['module']); + if (!$oWiki) { + $sContent = _t('_sys_wiki_error_missing_wiki_object', $this->_aObject['module']); + } + else { + $sContent = $oWiki->getBlockContent($aBlock['id'], false, (int)bx_get($aBlock['id'].'rev') ? (int)bx_get($aBlock['id'].'rev') : false); + } + + $s = '' . $sContent . ''; + $s = $this->_replaceMarkers($s, array('block_id' => $aBlock['id'])); + $s = bx_process_macros($s); + return $s; + } + + /** + * Get content for 'lang' block type. + * @return string + */ + protected function _getBlockLang ($aBlock) + { + if (bx_is_api()){ + return [bx_api_get_block('lang', ['title' => _t($aBlock['title']), 'content' => bx_process_macros(_t(trim($aBlock['content'])))])]; + } + + $s = '' . _t(trim($aBlock['content'])) . ''; + $s = $this->_replaceMarkers($s, array('block_id' => $aBlock['id'])); + $s = bx_process_macros($s); + return $s; + } + + /** + * Get content for 'image' block type. + * @return string + */ + protected function _getBlockImage ($aBlock) + { + if (empty($aBlock['content'])) + return false; + + list($iFileId, $sAlign ) = explode('#', $aBlock['content']); + $iFileId = (int)$iFileId; + if (!$iFileId) + return false; + + $oStorage = BxDolStorage::getObjectInstance(BX_DOL_STORAGE_OBJ_IMAGES); + if (!$oStorage) + return false; + + $sUrl = $oStorage->getFileUrlById($iFileId); + if (!$sUrl) + return false; + + $sStyleAdd = ''; + $sClassAdd = 'bx-page-image-container'; + $aAlign = ['left' => 'start', 'center' => 'center', 'right' => 'end']; + if(array_key_exists($sAlign, $aAlign)) { + $sClassAdd .= ' flex justify-' . $aAlign[$sAlign]; + + $sStyleAdd = 'style="text-align:' . $sAlign . '"'; + } + + return ''; + } + + /** + * Get content for 'rss' block type. + * @return string + */ + protected function _getBlockRss ($aBlock) + { + if (empty($aBlock['content'])) + return false; + + list( $sUrl, $iNum ) = explode('#', $aBlock['content']); + $iNum = (int)$iNum; + + return BxDolRss::getObjectInstance('sys_page_block')->getHolder($aBlock['id'], $iNum); + } + + /** + * Get content for 'menu' block type. + * @return string + */ + protected function _getBlockMenu ($aBlock) + { + $oMenu = BxTemplMenu::getObjectInstance($aBlock['content']); + return $oMenu ? $oMenu->getCode () : ''; + } + + /** + * Get content for 'service' block type. + * @return string + */ + protected function _getBlockService ($aBlock) + { + $aMarkers = array_merge($this->_aMarkers, [ + 'block_id' => $aBlock['id'] + ]); + + return BxDolService::callSerialized($aBlock['content'], $aMarkers); + } + + /** + * Get page title. + * @return string + */ + protected function _getPageTitle() + { + return $this->_replaceMarkers(_t($this->_aObject['title'])); + } + + /** + * Get page meta description. + * @return string + */ + protected function _getPageMetaDesc() + { + return $this->_replaceMarkers(_t($this->_aObject['meta_description'])); + } + + /** + * Get page meta title. + * @return string + */ + protected function _getPageMetaTitle() + { + return $this->_replaceMarkers(_t($this->_aObject['meta_title'])); + } + + /** + * Get page meta image. + * @return string + */ + protected function _getPageMetaImage() + { + return ''; + } + + /** + * Get page meta keywords. + * @return string + */ + protected function _getPageMetaKeywords() + { + return $this->_replaceMarkers(_t($this->_aObject['meta_keywords'])); + } + + /** + * Get page meta robots. + * @return string + */ + protected function _getPageMetaRobots() + { + return _t($this->_aObject['meta_robots']); + } + + /** + * Get page not found message. + * @return string + */ + protected function _getPageNotFoundMsg ($mixedMsg = false) + { + $this->_oTemplate->displayPageNotFound(); + exit; + } + + /** + * Get access denied message. + * @return string + */ + protected function _getPageAccessDeniedMsg ($mixedMsg = false) + { + return MsgBox($mixedMsg !== false ? $mixedMsg : _t('_Access denied')); + } + + /** + * Get page cache object. + * @return cache object instance + */ + protected function _getPageCacheObject () + { + return $this->_getCacheObject (); + } + + /** + * Get block cache object. + * @return cache object instance + */ + protected function _getBlockCacheObject () + { + return $this->_getCacheObject ('Block', 'pb'); + } + + protected function _getCacheObject ($sSuffixObj = 'Page', $sSuffixParam = 'page') + { + $sObj = '_o' . $sSuffixObj . 'CacheObject'; + $sParam = 'sys_' . $sSuffixParam . '_cache_engine'; + + if ($this->{$sObj} != null) { + return $this->{$sObj}; + } else { + $sEngine = getParam($sParam); + $this->{$sObj} = bx_instance ('BxDolCache' . $sEngine); + if (!$this->{$sObj}->isAvailable()) + $this->{$sObj} = bx_instance ('BxDolCacheFile'); + return $this->{$sObj}; + } + } + + /** + * Get page cache key. + * @param $isPrefixOnly return key prefix only. + * @return string + */ + protected function _getPageCacheKey ($isPrefixOnly = false) + { + $s = 'page_' . $this->_aObject['object'] . '_'; + if ($isPrefixOnly) + return $s; + $s .= $this->_getPageCacheParams (); + $s .= bx_site_hash() . '.php'; + return $s; + } + + /** + * Get block cache key. + * @param $isPrefixOnly return key prefix only. + * @return string + */ + protected function _getBlockCacheKey ($isPrefixOnly = false, $aBlock = array()) + { + $s = $this->_getPageCacheKey(true) . 'block_'; + if ($isPrefixOnly) + return $s; + $s .= ($aBlock ? $aBlock['id'] : 0) . '_' . $this->_getPageCacheParams (); + $s .= bx_site_hash() . '.php'; + return $s; + } + + /** + * Additional cache key. In the case of dynamic page. + * For example - profile page, where each profile has own page. + * @return string + */ + protected function _getPageCacheParams () + { + return md5(serialize($_GET) . bx_lang_name()); + } + + /** + * Clean page cache. + * @param $isDelAllWithPagePrefix delete cache by prefix, it can be used for dynamic pages, like profile view, where for each profile separate cache is generated. + * @return string + */ + protected function cleanCache ($isDelAllWithPagePrefix = false) + { + $a = ['Page', 'Block']; + $bRet = false; + foreach ($a as $s) { + $oCache = $this->{'_get' . $s . 'CacheObject'} (); + $sKey = $this->{'_get'. $s . 'CacheKey'} ($isDelAllWithPagePrefix); + + if ($isDelAllWithPagePrefix) + $bRet = $bRet && $oCache->removeAllByPrefix($sKey); + else + $bRet = $bRet && $oCache->delData($sKey); + } + return $bRet; + } +} + +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseScore.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseScore.php new file mode 100644 index 0000000000..46469cd32c --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseScore.php @@ -0,0 +1,561 @@ +_bCssJsAdded = false; + + $this->_sJsObjName = 'oScore' . bx_gen_method_name($sSystem, array('_' , '-')) . $iId; + $this->_sStylePrefix = 'bx-score'; + + $sHtmlId = str_replace(array('_' , ' '), array('-', '-'), $sSystem) . '-' . $iId; + $this->_aHtmlIds = array( + 'main' => 'bx-score-' . $sHtmlId, + 'counter' => 'bx-score-counter-' . $sHtmlId, + 'by_popup' => 'bx-score-by-popup-' . $sHtmlId, + 'legend' => 'bx-score-legend-' . $sHtmlId, + ); + + $this->_aElementDefaults = [ + 'show_do_vote_as_button' => false, + 'show_do_vote_as_button_small' => false, + 'show_do_vote_icon' => true, + 'show_do_vote_label' => false, + 'show_counter' => true, + 'show_counter_only' => true, + 'show_counter_empty' => true, + 'show_counter_style' => self::$_sCounterStyleSimple, //--- Alloved styles are 'simple', 'divided' + 'show_counter_label_icon' => false, + 'show_counter_label_text' => true, + 'show_legend' => false, + 'show_script' => true + ]; + $this->_aElementDefaultsApi = array_merge($this->_aElementDefaults, [ + 'show_counter' => true, + ]); + $this->_aElementParamsApi = ['is_voted']; + + $this->_sTmplNameLegend = 'score_legend.html'; + $this->_sTmplNameByList = 'score_by_list.html'; + + $this->_sTmplContentElementBlock = $this->_oTemplate->getHtml('score_element_block.html'); + $this->_sTmplContentElementInline = $this->_oTemplate->getHtml('score_element_inline.html'); + $this->_sTmplContentDoActionLabel = $this->_oTemplate->getHtml('score_do_vote_label.html'); + $this->_sTmplContentCounterLabel = $this->_oTemplate->getHtml('score_counter_label.html'); + } + + public function getJsObjectName() + { + return $this->_sJsObjName; + } + + public function getJsScript($aParams = []) + { + $sJsObjName = $this->getJsObjectName(); + + $bDynamicMode = isset($aParams['dynamic_mode']) && (bool)$aParams['dynamic_mode'] === true; + + $aParamsJs = array( + 'sObjName' => $sJsObjName, + 'sSystem' => $this->getSystemName(), + 'iAuthorId' => $this->_getAuthorId(), + 'iObjId' => $this->getId(), + 'sRootUrl' => BX_DOL_URL_ROOT, + 'sSocket' => $this->getSocketName(), + 'sStylePrefix' => $this->_sStylePrefix, + 'aHtmlIds' => $this->_aHtmlIds, + 'aRequestParams' => $this->_prepareRequestParamsData($aParams) + ); + $sCode = "if(window['" . $sJsObjName . "'] == undefined) var " . $sJsObjName . " = new BxDolScore(" . json_encode($aParamsJs) . ");"; + + return $this->_oTemplate->_wrapInTagJsCode($sCode); + } + + public function getJsClick($sType) + { + return $this->getJsObjectName() . '.vote' . ucfirst($sType) . '(this)'; + } + + public function getJsClickCounter($aParams = []) + { + $sJsObject = $this->getJsObjectName(); + $sJsMethod = 'toggleByPopup'; + + if(!isset($aParams['type'], $aParams['show_counter_style']) || $aParams['show_counter_style'] == self::$_sCounterStyleSimple) + return $sJsObject . '.' . $sJsMethod . '(this)'; + + return $sJsObject . '.' . $sJsMethod . '(this, \'' . $aParams['type'] . '\')'; + } + + public function getCounter($aParams = []) + { + $aParams = array_merge($this->_aElementDefaults, $aParams); + + $sDefault = $this->_aElementDefaults['show_counter_style']; + $sCounterStyle = !empty($aParams['show_counter_style']) ? $aParams['show_counter_style'] : $sDefault; + + $sMethodPrefix = '_getCounter'; + $sMethod = $sMethodPrefix . bx_gen_method_name($sCounterStyle); + if(!method_exists($this, $sMethod)) + $sMethod = $sMethodPrefix . bx_gen_method_name($sDefault); + + return $this->$sMethod($aParams); + } + + public function _getCounterSimple($aParams = []) + { + $aScore = $this->_oQuery->getScore($this->getId()); + + $iCup = (int)$aScore['count_up']; + $iCdown = (int)$aScore['count_down']; + + return $this->_getCounterItem(array_merge($aParams, [ + 'allowed_view_voters' => $this->isAllowedVoteViewVoters(), + 'value' => $iCup - $iCdown, + 'value_empty' => $iCup == 0 && $iCdown == 0, + ])); + } + + public function _getCounterDivided($aParams = []) + { + $bShowCounterEmpty = isset($aParams['show_counter_empty']) && (bool)$aParams['show_counter_empty'] === true; + $bShowCounterOnly = isset($aParams['show_counter_only']) && (bool)$aParams['show_counter_only'] === true; + $bShowScript = !isset($aParams['show_script']) || (bool)$aParams['show_script'] === true; + + $bAllowedViewVoters = $this->isAllowedVoteViewVoters(); + + $bScore = $this->_isVote(); + $aScore = $this->_getVote(); + + $aCounters = [ + BX_DOL_SCORE_DO_UP => (int)$aScore['count_up'], + BX_DOL_SCORE_DO_DOWN => (int)$aScore['count_down'] + ]; + + $sCounters = ''; + foreach($aCounters as $sType => $iValue) + $sCounters .= $this->_getCounterItem(array_merge($aParams, [ + 'show_counter_label_icon' => $bShowCounterOnly, + 'show_script' => false, + 'allowed_view_voters' => $bAllowedViewVoters, + 'type' => $sType, + 'value_html_id' => $this->_aHtmlIds['counter'] . '-' . $sType, + 'value' => $iValue, + 'value_empty' => !$bScore, + ])); + + return $this->_oTemplate->parseHtmlByName('score_counter_wrapper.html', [ + 'html_id' => $this->_aHtmlIds['counter'], + 'style_prefix' => $this->_sStylePrefix, + 'class' => $this->_aHtmlIds['counter'] . (!$bScore && !$bShowCounterEmpty ? ' bx-sc-hidden' : ''), + 'style' => self::$_sCounterStyleDivided, + 'counter' => $sCounters, + 'script' => $bShowScript ? $this->getJsScript($aParams) : '' + ]); + } + + public function _getCounterItem($aParams = []) + { + $aParams = array_merge($this->_aElementDefaults, $aParams); + + $bDynamicMode = isset($aParams['dynamic_mode']) && (bool)$aParams['dynamic_mode'] === true; + $bShowEmpty = isset($aParams['show_counter_empty']) && (bool)$aParams['show_counter_empty'] === true; + $bShowDoVoteAsButtonSmall = isset($aParams['show_do_vote_as_button_small']) && (bool)$aParams['show_do_vote_as_button_small'] === true; + $bShowDoVoteAsButton = !$bShowDoVoteAsButtonSmall && isset($aParams['show_do_vote_as_button']) && (bool)$aParams['show_do_vote_as_button'] === true; + $bShowScript = !isset($aParams['show_script']) || (bool)$aParams['show_script'] === true; + + $sClass = 'sys-action-counter'; + if(isset($aParams['show_counter_only']) && (bool)$aParams['show_counter_only'] === true) + $sClass .= ' sys-ac-only'; + + $sClass .= ' ' . $this->_sStylePrefix . '-counter'; + if($bShowDoVoteAsButtonSmall) + $sClass .= ' bx-btn-small-height'; + if($bShowDoVoteAsButton) + $sClass .= ' bx-btn-height'; + + $bLink = $aParams['allowed_view_voters'] && !$aParams['value_empty']; + $sCounter = !$aParams['value_empty'] || $bShowEmpty ? $this->_getCounterLabel($aParams['value'], $aParams) : ''; + + $aTmplVarsText = [ + 'id' => isset($aParams['value_html_id']) ? $aParams['value_html_id'] : $this->_aHtmlIds['counter'], + 'class' => $sClass, + 'content' => $sCounter, + 'title' => _t($this->_getTitleDoBy()), + ]; + + $aTmplVarsLink = array_merge($aTmplVarsText, [ + 'onclick' => $bLink ? 'javascript:' . $this->getJsClickCounter($aParams) : '' + ]); + + return $this->_oTemplate->parseHtmlByName('score_counter.html', array( + 'bx_if:show_link' => array( + 'condition' => $bLink, + 'content' => $aTmplVarsLink + ), + 'bx_if:show_text' => array( + 'condition' => !$bLink, + 'content' => $aTmplVarsText + ), + 'script' => $bShowScript ? $this->getJsScript($aParams) : '' + )); + } + + public function getCounterAPI($aParams = []) + { + $aParams = array_merge($this->_aElementDefaultsApi, $aParams); + + return $this->_getVote(); + } + + public function getLegend($aParams = array()) + { + $aLegend = $this->_oQuery->getLegend($this->_iId); + $aTypes = array( + BX_DOL_SCORE_DO_UP, + BX_DOL_SCORE_DO_DOWN + ); + + $aTmplVarsItems = array(); + foreach($aTypes as $sType) + $aTmplVarsItems[] = array( + 'style_prefix' => $this->_sStylePrefix, + 'value' => $this->_getLabelDo($sType, $aParams), + 'label' => isset($aLegend[$sType]['count']) ? (int)$aLegend[$sType]['count'] : 0 + ); + + return $this->_oTemplate->parseHtmlByName($this->_sTmplNameLegend, array( + 'style_prefix' => $this->_sStylePrefix, + 'html_id' => $this->_aHtmlIds['legend'], + 'bx_repeat:items' => $aTmplVarsItems + )); + } + + public function getElementBlock($aParams = array()) + { + $aParams['usage'] = BX_DOL_SCORE_USAGE_BLOCK; + + return $this->getElement($aParams); + } + + public function getElementInline($aParams = array()) + { + $aParams['usage'] = BX_DOL_SCORE_USAGE_INLINE; + + return $this->getElement($aParams); + } + + public function getElement($aParams = array()) + { + $aParams = array_merge($this->_aElementDefaults, $aParams); + + $bShowDoVoteAsButtonSmall = isset($aParams['show_do_vote_as_button_small']) && (bool)$aParams['show_do_vote_as_button_small'] === true; + $bShowDoVoteAsButton = !$bShowDoVoteAsButtonSmall && isset($aParams['show_do_vote_as_button']) && (bool)$aParams['show_do_vote_as_button'] === true; + $bShowCounterEmpty = isset($aParams['show_counter_empty']) && (bool)$aParams['show_counter_empty'] === true; + $bShowCounterSimple = $bShowCounterDivided = false; + if(isset($aParams['show_counter_style'])) { + if($aParams['show_counter_style'] == self::$_sCounterStyleSimple) + $bShowCounterSimple = true; + if($aParams['show_counter_style'] == self::$_sCounterStyleDivided) + $bShowCounterDivided = true; + } + + $iObjectId = $this->getId(); + $iAuthorId = $this->_getAuthorId(); + $iAuthorIp = $this->_getAuthorIp(); + $isAllowedVote = $this->isAllowedVote(); + $isAllowedVoteView = $this->isAllowedVoteView(); + $isAllowedVoteViewVoters = $this->isAllowedVoteViewVoters(); + + $aScore = $this->_oQuery->getScore($iObjectId); + $bCount = $this->_isCount($aScore); + $bCounter = $this->_isShowCounter($aParams, $isAllowedVote, $isAllowedVoteView, $bCount); + + $aParams['is_voted'] = $this->isPerformed($iObjectId, $iAuthorId, $iAuthorIp) ? true : false; + + //--- Do Vote + $bTmplVarsDoVote = $this->_isShowDoVote($aParams, $isAllowedVote, $bCount); + $aTmplVarsDoVoteUp = $aTmplVarsDoVoteDown = []; + if($bTmplVarsDoVote) + foreach([BX_DOL_SCORE_DO_UP, BX_DOL_SCORE_DO_DOWN] as $sType) + ${'aTmplVarsDoVote' . ucfirst($sType)} = [ + 'style_prefix' => $this->_sStylePrefix, + 'style' => $aParams['show_counter_style'], + 'do_vote' => $this->_getDoVote($sType, $aParams, $isAllowedVote), + 'bx_if:show_counter_' . $sType => [ + 'condition' => $bShowCounterDivided && $bCounter, + 'content' => [ + 'style_prefix' => $this->_sStylePrefix, + 'style' => $aParams['show_counter_style'], + 'bx_if:show_c' . $sType . '_hidden' => [ + 'condition' => !$bShowCounterEmpty && !$bCount, + 'content' => [] + ], + 'counter' => $this->_getCounterItem(array_merge($aParams, [ + 'show_do_vote_as_button' => false, + 'show_do_vote_as_button_small' => false, + 'show_counter_only' => false, + 'show_counter_label_icon' => false, + 'show_script' => false, + 'allowed_view_voters' => $isAllowedVoteViewVoters, + 'type' => $sType, + 'value_html_id' => $this->_aHtmlIds['counter'] . '-' . $sType, + 'value' => isset($aScore['count_' . $sType]) ? (int)$aScore['count_' . $sType] : 0, + 'value_empty' => !$bCount, + ])) + ] + ] + ]; + + //--- Counter (Simple) + $bTmplVarsCounter = $bShowCounterSimple && $bCounter; + $aTmplVarsCounter = array(); + if($bTmplVarsCounter) + $aTmplVarsCounter = array( + 'style_prefix' => $this->_sStylePrefix, + 'bx_if:show_hidden' => array( + 'condition' => !$bShowCounterEmpty && !$bCount, + 'content' => array() + ), + 'counter' => $this->getCounter(array_merge($aParams, [ + 'show_counter_only' => false, + 'show_script' => false + ])) + ); + + //--- Legend + $bTmplVarsLegend = $this->_isShowLegend($aParams, $isAllowedVote, $isAllowedVoteView, $bCount); + $aTmplVarsLegend = array(); + if($bTmplVarsLegend) + $aTmplVarsLegend = array( + 'legend' => $this->getLegend($aParams) + ); + + if(!$bTmplVarsDoVote && !$bTmplVarsCounter && !$bTmplVarsLegend) + return ''; + + $sTmplName = $this->{'_getTmplContentElement' . bx_gen_method_name(!empty($aParams['usage']) ? $aParams['usage'] : BX_DOL_SCORE_USAGE_DEFAULT)}(); + return $this->_oTemplate->parseHtmlByContent($sTmplName, array( + 'style_prefix' => $this->_sStylePrefix, + 'html_id' => $this->_aHtmlIds['main'], + 'class' => $this->_sStylePrefix . ($bShowDoVoteAsButton ? '-button' : '') . ($bShowDoVoteAsButtonSmall ? '-button-small' : ''), + 'score' => $aScore['score'], + 'cup' => $aScore['count_up'], + 'cdown' => $aScore['count_down'], + 'bx_if:show_do_vote_up' => array( + 'condition' => $bTmplVarsDoVote, + 'content' => $aTmplVarsDoVoteUp + ), + 'bx_if:show_counter' => array( + 'condition' => $bTmplVarsCounter, + 'content' => $aTmplVarsCounter + ), + 'bx_if:show_do_vote_down' => array( + 'condition' => $bTmplVarsDoVote, + 'content' => $aTmplVarsDoVoteDown + ), + 'bx_if:show_legend' => array( + 'condition' => $bTmplVarsLegend, + 'content' => $aTmplVarsLegend + ), + 'script' => $this->getJsScript($aParams) + )); + } + + public function getElementAPI($aParams = []) + { + if(!($this->_bApi = bx_is_api())) + return; + + if(!$this->isEnabled()) + return bx_api_get_msg('_sys_score_err_not_enabled'); + + $aParams = array_merge($this->_aElementDefaultsApi, $aParams); + + $iObjectId = $this->getId(); + $iAuthorId = $this->_getAuthorId(); + + $bCount = $this->_isCount(); + $isAllowedVote = $this->isAllowedVote(); + $isAllowedVoteView = $this->isAllowedVoteView(); + $aParams['is_voted'] = $this->isPerformed($iObjectId, $iAuthorId); + $aParams['track'] = $aParams['is_voted'] ? $this->_getTrack($iObjectId, $iAuthorId) : []; + + //--- Do Vote + $bDoVote = $this->_isShowDoVote($aParams, $isAllowedVote, $bCount); + $aDoVoteUp = $bDoVote ? $this->_getDoVote(BX_DOL_SCORE_DO_UP, $aParams, $isAllowedVote) : []; + $aDoVoteDown = $bDoVote ? $this->_getDoVote(BX_DOL_SCORE_DO_DOWN, $aParams, $isAllowedVote) : []; + + //--- Counter + $bCounter = $this->_isShowCounter($aParams, $isAllowedVote, $isAllowedVoteView, $bCount); + $aCounter = $bCounter ? $this->getCounterAPI(array_merge($aParams, [ + 'show_counter_only' => false, + 'show_script' => false + ])) : []; + + if(!$bDoVote && !$bCounter) + return bx_api_get_msg(''); + + return [ + 'type' => 'scores', + 'system' => $this->_sSystem, + 'object_id' => $this->_iId, + 'params' => array_intersect_key($aParams, array_flip($this->_aElementParamsApi)), + 'action' => [ + BX_DOL_SCORE_DO_UP => $aDoVoteUp, + BX_DOL_SCORE_DO_DOWN => $aDoVoteDown + ], + 'counter' => $aCounter, + ]; + } + + protected function _getDoVote($sType, $aParams = [], $isAllowedVote = true) + { + $bUndo = $this->isUndo(); + $bVoted = isset($aParams['is_voted']) && (bool)$aParams['is_voted'] === true; + $bShowDoVoteAsButtonSmall = isset($aParams['show_do_vote_as_button_small']) && (bool)$aParams['show_do_vote_as_button_small'] === true; + $bShowDoVoteAsButton = !$bShowDoVoteAsButtonSmall && isset($aParams['show_do_vote_as_button']) && (bool)$aParams['show_do_vote_as_button'] === true; + $bDisabled = !$isAllowedVote || ($bVoted && !$bUndo); + + $sClass = ''; + if($bShowDoVoteAsButton) + $sClass = 'bx-btn'; + else if ($bShowDoVoteAsButtonSmall) + $sClass = 'bx-btn bx-btn-small'; + + if($bDisabled) + $sClass .= $bShowDoVoteAsButton || $bShowDoVoteAsButtonSmall ? ' bx-btn-disabled' : 'bx-score-disabled'; + + if($this->_bApi) + return [ + 'is_undo' => $bUndo, + 'is_voted' => $bVoted, + 'is_disabled' => $bDisabled, + 'title' => _t($this->_getTitleDo($sType)), + ]; + + return $this->_oTemplate->parseLink('javascript:void(0)', $this->_getLabelDo($sType, $aParams), array( + 'class' => $this->_sStylePrefix . '-do-vote ' . $this->_sStylePrefix . '-dv-' . $sType . ' ' . $sClass, + 'title' => _t($this->_getTitleDo($sType)), + 'onclick' => !$bDisabled ? $this->getJsClick($sType) : '' + )); + } + + protected function _getCounterLabel($iCount, $aParams = []) + { + return $this->_oTemplate->parseHtmlByContent($this->_getTmplContentCounterLabel(), array( + 'style_prefix' => $this->_sStylePrefix, + 'bx_if:show_icon' => array( + 'condition' => !isset($aParams['show_counter_label_icon']) || (bool)$aParams['show_counter_label_icon'] === true, + 'content' => array( + 'style_prefix' => $this->_sStylePrefix, + 'icon' => $this->_oTemplate->getImageAuto($this->_getIconDo(isset($aParams['type']) ? $aParams['type'] : '')) + ) + ), + 'bx_if:show_text' => array( + 'condition' => !isset($aParams['show_counter_label_text']) || (bool)$aParams['show_counter_label_text'] === true, + 'content' => array( + 'style_prefix' => $this->_sStylePrefix, + 'text' => _t('_sys_score_counter', $iCount) + ) + ) + )); + } + + protected function _getLabelDo($sType, $aParams = array()) + { + return $this->_oTemplate->parseHtmlByContent($this->_getTmplContentDoActionLabel(), array( + 'style_prefix' => $this->_sStylePrefix, + 'bx_if:show_icon' => array( + 'condition' => isset($aParams['show_do_vote_icon']) && (bool)$aParams['show_do_vote_icon'] === true, + 'content' => array( + 'style_prefix' => $this->_sStylePrefix, + 'icon' => $this->_oTemplate->getImageAuto($this->_getIconDo($sType)) + ) + ), + 'bx_if:show_text' => array( + 'condition' => isset($aParams['show_do_vote_label']) && (bool)$aParams['show_do_vote_label'] === true, + 'content' => array( + 'style_prefix' => $this->_sStylePrefix, + 'text' => _t($this->_getTitleDo($sType)) + ) + ) + )); + } + + protected function _getVotedBy($aParams) + { + $aParams = array_merge($this->_aElementDefaults, $aParams, [ + 'show_do_vote_icon' => true, + 'show_do_vote_label' => false + ]); + + $aParamsDb = []; + if(!empty($aParams['type'])) + $aParamsDb['type'] = $aParams['type']; + $aUsers = $this->_oQuery->getPerformedBy($this->getId(), $aParamsDb); + + $aTmplUsers = []; + foreach($aUsers as $aUser) { + list($sUserName, $sUserLink, $sUserIcon, $sUserUnit, $sUserUnitWoInfo) = $this->_getAuthorInfo($aUser['id']); + $aTmplUsers[] = [ + 'style_prefix' => $this->_sStylePrefix, + 'user_name' => $sUserName, + 'user_link' => $sUserLink, + 'user_unit' => $sUserUnitWoInfo, + 'vote' => $this->_getLabelDo($aUser['vote_type'], $aParams), + 'date' => bx_time_js($aUser['vote_date']), + ]; + } + + if(empty($aTmplUsers)) + $aTmplUsers = MsgBox(_t('_Empty')); + + return $this->_oTemplate->parseHtmlByName($this->_sTmplNameByList, [ + 'style_prefix' => $this->_sStylePrefix, + 'bx_repeat:list' => $aTmplUsers + ]); + } + + protected function _isShowDoVote($aParams, $isAllowedVote, $bCount) + { + $bShowDoVote = !isset($aParams['show_do_vote']) || (bool)$aParams['show_do_vote'] === true; + + return $bShowDoVote && ($isAllowedVote || $bCount); + } + + protected function _isShowCounter($aParams, $isAllowedVote, $isAllowedVoteView, $bCount) + { + return isset($aParams['show_counter']) && (bool)$aParams['show_counter'] === true && $isAllowedVoteView && ($isAllowedVote || $bCount); + } + + protected function _isShowLegend($aParams, $isAllowedVote, $isAllowedVoteView, $bCount) + { + return isset($aParams['show_legend']) && (bool)$aParams['show_legend'] === true && $isAllowedVoteView; + } +} + +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseSearch.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseSearch.php new file mode 100644 index 0000000000..7d62213d47 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseSearch.php @@ -0,0 +1,175 @@ +_oTemplate = $oTemplate ? $oTemplate : BxDolTemplate::getInstance(); + + $this->_sIdLoading = $this->_sIdForm; + + $this->_iSearchLenth = (int)getParam('sys_live_search_limit'); + $this->_sSearchFunctionParams = "%d, '%s', '%s', '%s', %d, %d"; + } + + public function setLiveSearch($bLiveSearch) + { + parent::setLiveSearch($bLiveSearch); + + if($this->_bLiveSearch) { + $this->_sIdForm .= $this->_sSuffixLiveSearch; + $this->_sIdResults .= $this->_sSuffixLiveSearch; + $this->_sIdLoading = $this->_sIdResults; + } + } + + public function getForm($iDesignBoxTemplate = BX_DB_PADDING_DEF, $sTitle = false, $bOnlyForm = false) + { + if ($this->_sMetaType || $this->_sCategoryObject) + return ''; + + if (false === $sTitle) + $sTitle = _t( "_Search"); + + $aSection = ''; + if (bx_get('type')) + $aSection = bx_process_input(bx_get('type')); + else if (bx_get('section')) + $aSection = bx_process_input(bx_get('section')); + + $aForm = $this->_getForm([ + 'section' => $aSection, + 'keyword' => bx_get('keyword') ? bx_process_input(bx_get('keyword')) : '' + ]); + + $oForm = new BxTemplFormView($aForm); + $sForm = $oForm->getCode(); + + if (!$this->_bLiveSearch) { + $o = new BxTemplPaginate(array()); + $o->addCssJs(); + } + if ($bOnlyForm) + return $sForm; + + return $this->_oTemplate->parseHtmlByName('designbox_container.html', array( + 'class_add' => '', + 'bx_if:show_html_id' => array( + 'condition' => false, + 'content' => array(), + ), + 'content' => DesignBoxContent($sTitle, $sForm, $iDesignBoxTemplate) + )); + } + + public function getResultsContainer($sCode = '') + { + return $this->_oTemplate->parseHtmlByName('search_result.html', [ + 'html_id' => $this->_sIdResults, + 'class' => str_replace('_', '-', $this->_sIdResults), + 'content' => $sCode + ]); + } + + protected function _getForm($aValues = array()) + { + $aForm = array( + 'form_attrs' => array( + 'id' => $this->_sIdForm, + 'action' => BX_DOL_URL_ROOT . 'searchKeyword.php', + 'method' => 'post', + ), + 'params' => array( + 'csrf' => array( + 'disable' => true, + ), + ), + 'inputs' => array( + 'live_search' => array( + 'type' => 'hidden', + 'name' => 'live_search', + 'value' => $this->_bLiveSearch ? 1 : 0, + ), + 'section' => array( + 'type' => 'select', + 'name' => 'section', + 'caption' => _t('_Section'), + 'values' => array_merge(array('' => _t('_search_in_all_section')), $this->getKeyTitlesPairs()), + 'value' => $aValues['section'], + ), + 'keyword' => array( + 'type' => 'text', + 'name' => 'keyword', + 'caption' => _t('_Keyword'), + 'value' => $aValues['keyword'], + ), + 'search' => array( + 'type' => 'submit', + 'name' => 'search', + 'value' => _t('_Search'), + ) + ) + ); + + if ($this->_bLiveSearch) { + $sJsParams = sprintf($this->_sSearchFunctionParams, $this->_iSearchLenth, '#' . $this->_sIdForm, '#' . $this->_sIdResults, '#' . $this->_sIdLoading, $this->_bLiveSearch, (int)getParam('sys_search_keyword_min_len')); + + unset($aForm['inputs']['section']); + unset($aForm['inputs']['search']); + unset($aForm['inputs']['keyword']['caption']); + $aForm['inputs']['keyword']['attrs']['placeholder'] = _t('_sys_search' . (BxDolAI::getAssistantForLiveSearch() ? '_or_ask' : '') . '_placeholder'); + $aForm['inputs']['keyword']['attrs']['onkeydown'] = "return bx_search_on_type(event, $sJsParams);"; + $aForm['inputs']['keyword']['attrs']['onpaste'] = $aForm['inputs']['keyword']['attrs']['onkeydown']; + } + + /** + * @hooks + * @hookdef hook-search-get_form 'search', 'get_form' - hook in create search form + * - $unit_name - equals `search` + * - $action - equals `get_form` + * - $object_id - not used + * - $sender_id - not used + * - $extra_params - array of additional params with the following array keys: + * - `object` - [object] current search object + * - `override_result` - [array] by ref, form arrray defenition, can be overridden in hook processing + * @hook @ref hook-search-get_form + */ + bx_alert('search', 'get_form', 0, 0, array('object' => $this, 'override_result' => &$aForm)); + + return $aForm; + } + + protected function getKeyTitlesPairs () + { + $a = array(); + foreach ($this->aClasses as $sKey => $r) + if ($this->_sMetaType || $r['GlobalSearch']) + $a[$sKey] = _t($r['title']); + return $a; + } +} + +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseSearchExtended.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseSearchExtended.php new file mode 100644 index 0000000000..256b78e711 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseSearchExtended.php @@ -0,0 +1,435 @@ +_oTemplate = $oTemplate; + else if(!empty($this->_aObject['module'])) + $this->_oTemplate = BxDolModule::getInstance($this->_aObject['module'])->_oTemplate; + else + $this->_oTemplate = BxDolTemplate::getInstance(); + + $this->_sFormClassName = ''; + $this->_sFormClassPath = ''; + + $this->_oForm = null; + + $this->_bJsMode = false; + + $this->_iAgeMin = 1; + $this->_iAgeMax = 75; + } + + public function getForm($aParams = array()) + { + if(!$this->isEnabled()) + return ''; + + $oForm = $this->prepareForm($aParams); + + return bx_is_api() ? bx_api_get_block('form', $oForm->getCodeAPI(), ['id' => 2, 'ext' => ['name' => $this->_aObject['module'] . '_serach', 'request' => ['url' => '/api.php?r=system/get_form/TemplSearchExtendedServices¶ms[]=' . $this->_aObject['module'], 'immutable' => true]]]) : $oForm->getCode(); + } + + public function getResultsAPI($aData, $iPerPage, $iStart, $aParamsSearch = '') + { + return bx_api_get_block('browse', [ + 'nocache' => true, + 'module' => $this->_aObject['module'], + 'unit' => 'general-content-list', + 'request_url' => '/api.php?r=system/get_results/TemplSearchExtendedServices¶ms[]=', + 'data' => defined('BX_API_PAGE') ? [] : $aData, + 'params' => ['per_page' => $iPerPage, 'start' => $iStart, 'object' => $this->_aObject['module'], 'search_params' => $aParamsSearch], + ]); + } + + /** + * Get search results from search form or from custom condition + * + * @param $aParams['cond'] custom condition to pass instead of form submission, + * conditions are key&value pair, where 'key' is form input name and + * 'value' is the term to search for + * @param $aParams['start'] position of first record to display + * @param $aParams['per_page'] number of items per page + * @param $aParams['template'] custom unit templates to use + * @return HTML string with search results + */ + public function getResults($aParams = array()) + { + if(!$this->isEnabled()) + return ''; + + $bJsMode = isset($aParams['js_mode']) ? (bool)$aParams['js_mode'] : $this->_bJsMode; + $bCondition = !empty($aParams['cond']) && is_array($aParams['cond']); + + $iStart = !empty($aParams['start']) ? $aParams['start'] : 0; + $iPerPage = !empty($aParams['per_page']) ? $aParams['per_page'] : 0; + unset($aParams['start'], $aParams['per_page']); + + $sUnitTemplate = !empty($aParams['template']) ? $aParams['template'] : ''; + + $oForm = $this->prepareForm($aParams); + if($bCondition) { + $mixedSubmitName = $oForm->aParams['db']['submit_name']; + if(is_array($mixedSubmitName)) + $mixedSubmitName = array_pop($mixedSubmitName); + $aParams['cond'][$mixedSubmitName] = 1; + + $oForm->aFormAttrs['method'] = BX_DOL_FORM_METHOD_SPECIFIC; + $oForm->aParams['csrf']['disable'] = true; + + $oForm->initChecker(array(), $aParams['cond']); + } + + if(!$oForm->isSubmittedAndValid() && !$this->_bFilterMode && (!$this->_bIsApi || !isset($aParams['search_params']))) + return ''; + + $oContentInfo = BxDolContentInfo::getObjectInstance($this->_aObject['object_content_info']); + + if(!$oContentInfo) + return ''; + + $aParamsSearch = []; + if(empty($aParams['search_params'])) { + foreach($this->_aObject['fields'] as $aField) { + $mixedValue = $oForm->getCleanValue($aField['name']); + if(empty($mixedValue) || (is_array($mixedValue) && bx_is_empty_array($mixedValue))) + continue; + + $aParamsSearch[$aField['name']] = array( + 'type' => $aField['search_type'], + 'value' => $mixedValue, + 'operator' => $aField['search_operator'] + ); + + if(!$bCondition) { + if(!isset($aParams['cond'])) + $aParams['cond'] = array(); + + switch($oForm->aInputs[$aField['name']]['type']) { + case 'location': + case 'location_radius': + $aParams['cond'][$aField['name']] = $mixedValue['string']; + + $aLocationComponents = BxDolMetatags::locationsParseComponents($mixedValue['array'], $aField['name']); + if($oForm->aInputs[$aField['name']]['type'] == 'location_radius' && count($mixedValue['array']) > count($aLocationComponents)) + $aLocationComponents[$aField['name'] . '_rad'] = array_pop($mixedValue['array']); + + $aParams['cond'] = array_merge($aParams['cond'], $aLocationComponents); + break; + + default: + $aParams['cond'][$aField['name']] = $mixedValue; + } + } + } + } + else + $aParamsSearch = $aParams['search_params']; + + if((empty($aParamsSearch) || !is_array($aParamsSearch)) && !$this->_bFilterMode) + return $this->_bIsApi ? bx_api_get_msg(_t('Not Found'), ['ext' => ['msg_type' => 'result']]) : ''; + + if (!$iPerPage) { + bx_import('BxDolSearch'); + $iPerPage = BX_DOL_SEARCH_RESULTS_PER_PAGE_DEFAULT; + } + + $aResults = false; + + if (bx_get('sort')){ + $aTmp = explode(':', bx_get('sort')); + $aParamsSearch['order'] = [['field' => $aTmp[0], 'direction' => $aTmp[1]]]; + } + + /** + * @hooks + * @hookdef hook-search-get_data 'search', 'get_data' - hook in get data for serach + * - $unit_name - equals `search` + * - $action - equals `get_data` + * - $object_id - not used + * - $sender_id - not used + * - $extra_params - array of additional params with the following array keys: + * - `object` - [array] by ref, object info for current search, can be overridden in hook processing + * - `search_params` - [string] by ref, search params, can be overridden in hook processing + * - `search_results` - [string] by ref, html for block, can be overridden in hook processing + * @hook @ref hook-search-get_data + */ + bx_alert('search', 'get_data', 0, false, array('object' => $this->_aObject, 'search_params' => &$aParamsSearch, 'search_results' => &$aResults)); + + if($aResults === false) + $aResults = $oContentInfo->getSearchResultExtended($aParamsSearch, $iStart, $iPerPage + 1, $this->_bFilterMode); + + if(empty($aResults) || !is_array($aResults)) + return $this->_bIsApi ? [bx_api_get_msg(_t('Nothing found'), ['ext' => ['msg_type' => 'result']])] : _t('Nothing found'); + + if(!empty($aParams['cond']) && is_array($aParams['cond'])) + $aParams['cond'] = self::encodeConditions($aParams['cond']); + + $aPaginate = ['start' => $iStart, 'per_page' => $iPerPage]; + if(!empty($aParams['total'])) { + if(is_numeric($aParams['total'])) + $aPaginate['total'] = (int)$aParams['total']; + else + $aPaginate['total'] = count($oContentInfo->getSearchResultExtended($aParamsSearch, 0, 0, $this->_bFilterMode)); + } + + if(!$bJsMode) { + $aParams['start'] = '{start}'; + $aParams['per_page'] = '{per_page}'; + + list($sPageLink, $aPageParams) = bx_get_base_url_inline($aParams); + if(!$this->_bIsApi) + $aPaginate['page_url'] = BxDolPermalinks::getInstance()->permalink(bx_append_url_params($sPageLink, $aPageParams, true, ['{start}', '{per_page}'])); + } + else + $aPaginate['on_change_page'] = "return !loadDynamicBlockAutoPaginate(this, '{start}', '{per_page}', " . bx_js_string(json_encode($aParams)) . ");"; + + $oPaginate = new BxTemplPaginate($aPaginate); + $oPaginate->setNumFromDataArray($aResults); + + $bTmplVarsPaginate = $iStart || $oPaginate->getNum() > $iPerPage; + $aTmplVarsPaginate = $bTmplVarsPaginate ? array('paginate' => $oPaginate->getSimplePaginate()) : array(); + + $mixedResults = $this->_bIsApi ? [] : ''; + foreach($aResults as $iId) { + $mixedResult = $oContentInfo->getContentSearchResultUnit($iId, $sUnitTemplate); + + if($this->_bIsApi) + $mixedResults[] = $mixedResult; + else + $mixedResults .= $mixedResult; + } + + if($this->_bIsApi) { + if(isset($aParams['search_params'])) + return [$this->getResultsAPI($mixedResults, $iPerPage, $iStart, $aParamsSearch)]; + else + return [$this->getResultsAPI($mixedResults, $iPerPage, $iStart, $aParamsSearch)]; + } + + $aTxtDirection = [ + 'asc' => _t('_order_asc'), + 'desc' => _t('_order_desc') + ]; + + $sSort = ''; + if($mixedResults != '') { + $aData = $this->_aObject['sortable_fields']; + + $aValues = []; + foreach($aData as $aField) { + if ($aField['active'] == 0) + continue; + + $sLangKey = $aField['caption'] . '_' . $aField['direction']; + $sLangVal = _t($sLangKey); + + $aValues[$aField['name'] . ':' . $aField['direction']] = strcmp($sLangKey, $sLangVal) != 0 ? $sLangVal : _t($aField['caption']) . ' ' . $aTxtDirection[$aField['direction']]; + } + + if (!empty($aValues)){ + $aValues = array_merge(['' => _t('_sys_txt_search_sort_by_default')], $aValues); + } + $oForm = new BxTemplFormView(array()); + + $sOnChange = ''; + if(!$bJsMode) { + unset($aParams['start']); + unset($aParams['per_page']); + list($sPageLink, $aPageParams) = bx_get_base_url_inline($aParams); + $sOnChange = "bx_search_extnded_sort(this,'" . BxDolPermalinks::getInstance()->permalink(bx_append_url_params($sPageLink, $aPageParams)) . "')"; + } + else{ + $sOnChange = "return !loadDynamicBlockAutoSort(this, $(this).val()," . bx_js_string(json_encode($aParams)) . ");"; + } + + $sSort = ''; + if (!empty($aValues)){ + $aInputSort = array( + 'type' => 'select', + 'name' => 'sort', + 'value' => bx_get('sort') ? bx_get('sort') : '', + 'values' => $aValues, + 'caption' => _t('_sys_txt_search_sort_by'), + 'attrs' => array( + 'onChange' => $sOnChange, + ), + 'tr_attrs' => array( + 'class' => 'sort' + ) + ); + $sSort = $oForm->genRow($aInputSort); + } + } + + return $this->_oTemplate->parseHtmlByName('search_extended_results.html', [ + 'class' => str_replace('_', '-', $this->_sObject), + 'sort' => $sSort, + 'code' => $mixedResults, + 'bx_if:show_paginate' => [ + 'condition' => $bTmplVarsPaginate, + 'content' => $aTmplVarsPaginate + ] + ]); + } + + protected function &prepareForm($aParams = array()) + { + if(!empty($this->_oForm) && $this->_oForm instanceof BxDolForm) + return $this->_oForm; + + $sForm = 'sys_search_extended_' . $this->_sObject; + $sFormSubmit = 'search' . $this->_sObject; + + list($sPageLink, $aPageParams) = bx_get_base_url_inline(); + + $mDefValues = bx_get('filters'); + + if ($mDefValues){ + $mDefValues = json_decode($mDefValues, true); + } + + $aForm = array( + 'form_attrs' => array( + 'id' => $sForm, + 'name' => $sForm, + 'action' => BxDolPermalinks::getInstance()->permalink(bx_append_url_params($sPageLink, array('i' => $aPageParams['i']))), + 'method' => 'post' + ), + 'params' => array( + 'db' => array( + 'table' => '', + 'key' => '', + 'uri' => '', + 'uri_title' => '', + 'submit_name' => $sFormSubmit + ), + 'checker_helper' => 'BxBaseSearchExtendedFormCheckerHelper', + ), + 'inputs' => array() + ); + + foreach ($this->_aObject['fields'] as $aField) { + if((int)$aField['active'] == 0) + continue; + + if(in_array($aField['search_type'], array('checkbox_set', 'select_multiple'))) { + if(isset($aField['values'][''])) + unset($aField['values']['']); + + if(isset($aField['values'][0]) && !is_array($aField['values'][0])) + unset($aField['values'][0]); + } + + $aAttrs = array(); + + if(in_array($aField['search_type'], array('datepicker_range_age')) && !empty($aField['search_value'])) { + $aFieldParams = BxDolService::callSerialized($aField['search_value']); + $iMin = isset($aFieldParams['min']) && is_numeric($aFieldParams['min']) ? $aFieldParams['min'] : $this->_iAgeMin; + $iMax = isset($aFieldParams['max']) && is_numeric($aFieldParams['max']) ? $aFieldParams['max'] : $this->_iAgeMax; + + $aField['search_value'] = $iMin . '-' . $iMax; + $aAttrs = array('min' => $iMin, 'max' => $iMax, 'step' => 1); + } + + if(in_array($aField['search_type'], array('datepicker_range')) && !empty($aField['search_value'])) { + $aField['search_value'] = ''; + } + + $aForm['inputs'][$aField['name']] = array( + 'type' => $aField['search_type'], + 'name' => $aField['name'], + 'caption' => _t($aField['caption']), + 'info' => _t($aField['info']), + 'values' => $aField['values'], + 'value' => $aField['search_value'] == '' && isset($mDefValues) && isset($mDefValues[$aField['name']]) ? $mDefValues[$aField['name']] : $aField['search_value'], + 'attrs' => $aAttrs, + 'db' => array( + 'pass' => 'datepicker_range_age' === $aField['search_type'] ? 'AgeRange' : (!empty($aField['pass']) ? $aField['pass'] : 'Xss') + ) + ); + + if(in_array($aField['search_type'], array('location', 'location_radius'))) + $aForm['inputs'][$aField['name']]['manual_input'] = true; + } + + $aForm['inputs']['search'] = array( + 'type' => 'submit', + 'name' => $sFormSubmit, + 'value' => _t($this->_bFilterMode ? '_Apply' : '_Search') + ); + + $sClass = 'BxTemplSearchExtendedForm'; + if(!empty($this->_sFormClassName)) { + $sClass = $this->_sFormClassName; + if(!empty($this->_sFormClassPath)) + require_once(BX_DIRECTORY_PATH_ROOT . $this->_sFormClassPath); + } + + $bJsMode = isset($aParams['js_mode']) ? (bool)$aParams['js_mode'] : $this->_bJsMode; + $bCondition = !empty($aParams['cond']) && is_array($aParams['cond']); + $aValues = !$bJsMode && $bCondition ? $aParams['cond'] : array(); + + $this->_oForm = new $sClass($aForm, $this->_oTemplate); + $this->_oForm->initChecker($aValues, $aValues); + + return $this->_oForm; + } +} + +class BxBaseSearchExtendedFormCheckerHelper extends BxDolFormCheckerHelper +{ + static public function passAgeRange ($s) + { + if (is_array($s)) { + $a = array (); + foreach ($s as $k => $v) + $a[$k] = self::_passAgeRange ($v); + return $a; + } + return self::_passAgeRange ($s); + } + + static public function _passAgeRange ($s) + { + $a = explode ('-', $s); + if (!$a || count($a) != 2) + return $s; + $i0 = new \DateInterval("P".(int)$a[0]."Y"); + $i1 = new \DateInterval("P".(int)$a[1]."Y"); + + return [ + (new DateTime("now", new DateTimeZone('UTC')))->sub($i1)->format("Y-m-d"), + (new DateTime("now", new DateTimeZone('UTC')))->sub($i0)->format("Y-m-d"), + ]; + } +} + +/** @} */ \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseSearchExtendedServices.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseSearchExtendedServices.php new file mode 100644 index 0000000000..b525dd19f5 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseSearchExtendedServices.php @@ -0,0 +1,117 @@ +prepareParams($aParams); + + if(empty($aParams['object'])) + return ''; + + $oSearch = BxDolSearchExtended::getObjectInstance($aParams['object']); + if(!$oSearch || !$oSearch->isEnabled()) + return ''; + + $mForm = $oSearch->getForm($aParams); + if(bx_is_api()) + $mForm = [$mForm]; + + return $mForm; + } + + public function serviceGetResults($mParams) + { + $aParams = []; + $fProcessDefValues = function($aValues) { + if(empty($aValues) || !is_array($aValues)) + return; + + foreach($aValues as $sKey => $sValue) { + if(empty($sValue)) + continue; + + $_POST[$sKey] = $sValue; + } + }; + + if(($mDefValues = bx_get('filters')) !== false) + $fProcessDefValues(json_decode($mDefValues, true)); + + if(is_string($mParams)) { + $mParams = json_decode($mParams, true); + if(!empty($mParams['params']) && is_array($mParams['params'])) + $aParams = $mParams['params']; + + if(isset($aParams['filters'])) + $fProcessDefValues($aParams['filters']); + } + else + $aParams = $mParams; + + $this->prepareParams($aParams); + + if(empty($aParams['object'])) + return ''; + + $oSearch = BxDolSearchExtended::getObjectInstance($aParams['object']); + if(!$oSearch || !$oSearch->isEnabled()) + return ''; + + $sResults = $oSearch->getResults($aParams); + + if (bx_is_api()){ + return $sResults; + } + + return !empty($sResults) ? $sResults : (isset($aParams['show_empty']) && (bool)$aParams['show_empty'] ? MsgBox(_t('_Empty')) : ''); + } + + public function prepareParams(&$aParams) + { + if(empty($aParams['object']) && bx_get('object') !== false) + $aParams['object'] = bx_process_input(bx_get('object'), BX_DATA_TEXT); + + if(!isset($aParams['show_empty']) && bx_get('show_empty') !== false) + $aParams['show_empty'] = (bool)bx_get('show_empty'); + + if(empty($aParams['template']) && bx_get('template') !== false) + $aParams['template'] = bx_process_input(bx_get('template'), BX_DATA_TEXT); + + if(empty($aParams['cond']) && bx_get('cond') !== false) + $aParams['cond'] = BxDolSearchExtended::decodeConditions(bx_process_input(bx_get('cond'), BX_DATA_TEXT)); + + if(!isset($aParams['start']) && bx_get('start') !== false) + $aParams['start'] = (int)bx_get('start'); + + if(!isset($aParams['per_page']) && bx_get('per_page') !== false) + $aParams['per_page'] = (int)bx_get('per_page'); + + if(!isset($aParams['total']) && ($mixedTotal = bx_get('total')) !== false) + $aParams['total'] = is_numeric($mixedTotal) ? (int)$mixedTotal : $mixedTotal == 'true'; + } +} + +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseServiceAccount.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseServiceAccount.php new file mode 100644 index 0000000000..10e57df32c --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseServiceAccount.php @@ -0,0 +1,895 @@ +_oAccountForms = new BxTemplAccountForms(); + $this->_oAccountQuery = BxDolAccountQuery::getInstance(); + } + + /** + * @page service Service Calls + * @section bx_system_general System Services + * @subsection bx_system_general-account Account + * @subsubsection bx_system_general-create_account_form create_account_form + * + * @code bx_srv('system', 'create_account_form', [], 'TemplServiceAccount'); @endcode + * @code {{~system:create_account_form:TemplServiceAccount[{"no_login_text":true, "no_auth_buttons":true}]~}} @endcode + * + * Join form. + * @param $aParams array of additional params, such as: + * - no_login_text + * - no_auth_buttons + * + * @see BxBaseServiceAccount::serviceGetCreatePostForm + */ + /** + * @ref bx_system_general-create_account_form "create_account_form" + */ + public function serviceCreateAccountForm ($aParams = array()) + { + $bApi = bx_is_api(); + + if (isLogged() && 'create-account' == bx_get('i')) { + if (!$bApi) { + header('Location: ' . BX_DOL_URL_ROOT); + exit; + } + else + return [ + ['id' => 2, 'type' => 'redirect', 'data' => ['uri' => '/']], + ]; + } + + if($bApi) { + $mixedResult = $this->_oAccountForms->createAccountForm($aParams); + if(is_array($mixedResult)) + return [bx_api_get_block('form', $mixedResult, [ + 'ext' => [ + 'request' => ['url' => '/api.php?r=system/create_account_form/TemplServiceAccount', 'immutable' => true] + ] + ])]; + else if($mixedResult === true){ + $sRedirectUrl = BxDolForm::getSubmittedValue('relocate','post'); + if(empty($sRedirectUrl)){ + $sRedirectUrl = '/'; + } + else{ + $parts = parse_url($sRedirectUrl); + parse_str($parts['query'], $query); + unset($query['_q']); + $parts['query'] = http_build_query($query); + $sRedirectUrl = $parts['path'] . (!empty($parts['query']) ? '?' . $parts['query'] : ''); + } + return [ + bx_api_get_block('redirect', ['uri' => $sRedirectUrl]), + //bx_api_get_block('login', ['session' => BxDolSession::getInstance()->getId()], ['id' => 2]), + ]; + } + else + return [bx_api_get_msg($mixedResult)]; + } + + $oPemalink = BxDolPermalinks::getInstance(); + + if (isset($_SERVER['HTTP_REFERER']) && 0 === mb_stripos($_SERVER['HTTP_REFERER'], BX_DOL_URL_ROOT)) { // remember referrer + $sJoinReferrer = $_SERVER['HTTP_REFERER']; + $aNoRelocatePages = array('forgot-password', 'login', 'create-account', 'logout'); + foreach ($aNoRelocatePages as $s) { + if (false !== mb_stripos($sJoinReferrer, $s)) { + $sJoinReferrer = ''; + break; + } + } + if ($sJoinReferrer) + BxDolSession::getInstance()->setValue('join-referrer', $sJoinReferrer); + } + + $aTmplVarsAuth = []; + if(!isset($aParams['no_auth_buttons']) || false === (bool)$aParams['no_auth_buttons']) + $aTmplVarsAuth['content'] = BxDolService::call('system', 'member_auth_code', array(), 'TemplServiceLogin'); + + $aTmplVarsForm = []; + if(!(bool)getParam('sys_account_disable_join_form')) + $aTmplVarsForm['content'] = $this->_oAccountForms->createAccountForm($aParams); + + $aTmplVarsLogin = []; + if(!isset($aParams['no_login_text']) || false === (bool)$aParams['no_login_text']) + $aTmplVarsLogin['url'] = bx_absolute_url($oPemalink->permalink('page.php?i=login')); + + return BxDolTemplate::getInstance()->parseHtmlByName('block_join.html', [ + 'bx_if:show_auth' => [ + 'condition' => !empty($aTmplVarsAuth), + 'content' => $aTmplVarsAuth + ], + 'bx_if:show_form' => [ + 'condition' => !empty($aTmplVarsForm), + 'content' => $aTmplVarsForm, + ], + 'bx_if:show_login' => [ + 'condition' => !empty($aTmplVarsLogin), + 'content' => $aTmplVarsLogin + ], + 'agreement' => _t('_sys_form_account_input_agreement_value', bx_absolute_url($oPemalink->permalink('page.php?i=terms')), bx_absolute_url($oPemalink->permalink('page.php?i=privacy'))), + ]); + } + + public function serviceAccountSettingsEmail ($iAccountId = false) + { + if (false === $iAccountId) + $iAccountId = getLoggedId(); + + $bApi = bx_is_api(); + + $mixedResult =$this->_oAccountForms->editAccountEmailSettingsForm($iAccountId); + + if($bApi) { + if(is_array($mixedResult)){ + if (isset($mixedResult['form'] )){ + return [ + bx_api_get_msg($mixedResult['msg']), + bx_api_get_block('form', $mixedResult['form'], [ + 'ext' => [ + 'request' => ['url' => '/api.php?r=system/account_settings_email/TemplServiceAccount', 'immutable' => true] + ] + ])]; + } + else{ + return [bx_api_get_block('form', $mixedResult, [ + 'ext' => [ + 'request' => ['url' => '/api.php?r=system/account_settings_email/TemplServiceAccount', 'immutable' => true] + ] + ])]; + } + } + else + return [bx_api_get_msg($mixedResult)]; + } + + return $mixedResult; + } + + public function serviceAccountSettingsPassword ($iAccountId = false) + { + if (false === $iAccountId) + $iAccountId = getLoggedId(); + + $bApi = bx_is_api(); + + $mixedResult =$this->_oAccountForms->editAccountPasswordSettingsForm($iAccountId); + if($bApi) { + if(is_array($mixedResult)){ + if (isset($mixedResult['form'] )){ + return [ + bx_api_get_msg($mixedResult['msg']), + bx_api_get_block('form', $mixedResult['form'], [ + 'ext' => [ + 'request' => ['url' => '/api.php?r=system/account_settings_password/TemplServiceAccount', 'immutable' => true] + ] + ])]; + } + else{ + return [bx_api_get_block('form', $mixedResult, [ + 'ext' => [ + 'request' => ['url' => '/api.php?r=system/account_settings_password/TemplServiceAccount', 'immutable' => true] + ] + ])]; + } + } + else + return [bx_api_get_msg($mixedResult)]; + } + + return $mixedResult; + } + + public function serviceAccountSettingsInfo ($iAccountId = false) + { + if (false === $iAccountId) + $iAccountId = getLoggedId(); + + $bApi = bx_is_api(); + + $mixedResult =$this->_oAccountForms->editAccountInfoForm($iAccountId); + + if($bApi) { + if(is_array($mixedResult)){ + if (isset($mixedResult['form'] )){ + return [ + bx_api_get_msg($mixedResult['msg']), + bx_api_get_block('form', $mixedResult['form'], [ + 'ext' => [ + 'request' => ['url' => '/api.php?r=system/account_settings_info/TemplServiceAccount', 'immutable' => true] + ] + ])]; + } + else{ + return [bx_api_get_block('form', $mixedResult, [ + 'ext' => [ + 'request' => ['url' => '/api.php?r=system/account_settings_info/TemplServiceAccount', 'immutable' => true] + ] + ])]; + } + } + else + return [bx_api_get_msg($mixedResult)]; + } + return $mixedResult; + } + + public function serviceAccountSettingsDelAccount ($iAccountId = false) + { + if (!$iAccountId) + $iAccountId = bx_process_input(bx_get('id'), BX_DATA_INT); + if (!$iAccountId) + $iAccountId = getLoggedId(); + + $bApi = bx_is_api(); + + $mixedResult = $this->_oAccountForms->deleteAccountForm($iAccountId); + + if($bApi) { + if(is_array($mixedResult)){ + if (isset($mixedResult['form'] )){ + return [ + bx_api_get_msg($mixedResult['msg']), + bx_api_get_block('form', $mixedResult['form'], [ + 'ext' => [ + 'request' => ['url' => '/api.php?r=system/account_settings_del_account/TemplServiceAccount', 'immutable' => true] + ] + ])]; + } + else{ + return [bx_api_get_block('form', $mixedResult, [ + 'ext' => [ + 'request' => ['url' => '/api.php?r=system/account_settings_del_account/TemplServiceAccount', 'immutable' => true] + ] + ])]; + } + } + else if(is_string($mixedResult)) + return [ + bx_api_get_msg($mixedResult) + ]; + else + return []; + } + + return $mixedResult; + } + + /** + * Display unsubscribe from newsletters form + */ + public function serviceUnsubscribeNews() + { + return $this->_unsubscribeForm('sys_unsubscribe_news'); + } + + /** + * Display unsubscribe from notifications form + */ + public function serviceUnsubscribeNotifications() + { + return $this->_unsubscribeForm('sys_unsubscribe_updates'); + } + + /** + * Display confirmation statuses list + */ + public function serviceGetConfirmationTypes() + { + $aResult = array(); + $aChoices = array(BX_ACCOUNT_CONFIRMATION_NONE, BX_ACCOUNT_CONFIRMATION_EMAIL, BX_ACCOUNT_CONFIRMATION_PHONE, BX_ACCOUNT_CONFIRMATION_EMAIL_PHONE, BX_ACCOUNT_CONFIRMATION_EMAIL_OR_PHONE); + foreach($aChoices as $sChoice) + $aResult[$sChoice] = _t('_sys_acc_confirmation_type_' . $sChoice); + + return $aResult; + } + + protected function _unsubscribeForm($sDisplay) + { + $iAccountId = bx_process_input(bx_get('id')); + $sCode = bx_process_input(bx_get('code')); + + // validate input params + + $oAccount = BxDolAccount::getInstance($iAccountId); + if (!$oAccount) + return MsgBox(_t('_sys_txt_unsubscribe_wrong_link')); + + if ($sCode != $oAccount->getEmailHash()) + return MsgBox(_t('_sys_txt_unsubscribe_wrong_link')); + + $oForm = BxDolForm::getObjectInstance('sys_unsubscribe', $sDisplay); + if (!$oForm) + return MsgBox(_t('_sys_txt_unsubscribe_error_occured')); + + // show form + + $aAccountInfo = $oAccount->getInfo(); + $aAccountInfo['code'] = $sCode; + $oForm->initChecker($aAccountInfo); + + if ($oForm->isSubmittedAndValid()) { + + if (!$oForm->update($oAccount->id())) + return MsgBox(_t('_sys_txt_unsubscribe_error_occured')); + + return MsgBox(_t('_sys_txt_unsubscribe_email_settings_update_success')); + } + + return '' . _t("_sys_txt_unsubscribe_info", $aAccountInfo['email']) . '' . $oForm->getCode(); + } + + /** + * Display email confirmation form, if confirmation code is provided then try to confirm profile + */ + public function serviceEmailConfirmation($sMsg = false) + { + $bApi = bx_is_api(); + // if user is logged in and email is confirmed then just display a message + if (isLogged() && !bx_get('code')) { + $oAccount = BxDolAccount::getInstance(); + if ($oAccount->isConfirmedEmail()) + return $bApi ? [bx_api_get_msg(_t("_sys_txt_confirm_email_already_confirmed"))] : MsgBox(_t("_sys_txt_confirm_email_already_confirmed")); + } + + // if confirmation code is provided in the URL - perform email confirmation right away + if (bx_get('code') !== false) + return $this->confirmEmail(bx_process_input(bx_get('code'))); + + // if user requested to resend verification letter then send letter and display message + if (bx_process_input(bx_get('resend')) && isLogged()) { + $oAccount = BxDolAccount::getInstance(); + if ($oAccount->sendConfirmationEmail()) + $sMsg = _t('_sys_txt_confirm_email_sent'); + else + $sMsg = _t('_sys_txt_confirm_email_sent_failed'); + return $bApi ? [bx_api_get_msg($sMsg)] : MsgBox($sMsg); + } + + // show and process code verification form + + $oForm = BxDolForm::getObjectInstance('sys_confirm_email', 'sys_confirm_email'); + if (!$oForm) + return $bApi ? [bx_api_get_msg(_t("_sys_txt_confirm_email_error_occured"))] : MsgBox(_t("_sys_txt_confirm_email_error_occured")); + + $oForm->initChecker(); + + if ($oForm->isSubmittedAndValid()) { + + $oKey = BxDolKey::getInstance(); + if (!$oKey){ + return $bApi ? [bx_api_get_msg(_t("_sys_txt_confirm_email_error_occured"))] : MsgBox(_t("_sys_txt_confirm_email_error_occured")); + } + else{ + $oRv = $this->confirmEmail(trim($oForm->getCleanValue('code'))); + if (!$bApi) + return $oRv; + + return $oRv; + } + + } + + if ($bApi){ + return [bx_api_get_block('form', $oForm->getCodeAPI(), [ + 'ext' => [ + 'request' => ['url' => '/api.php?r=system/email_confirmation/TemplServiceAccount', 'immutable' => true] + ] + ])]; + } + + return '' . _t("_sys_txt_confirm_email_desc") . '' . $oForm->getCode(); + } + + /** + * Display phone confirmation forms, if confirmation code is provided then try to confirm profile + */ + public function servicePhoneConfirmation($sMsg = false) + { + // if user is logged in and phone is confirmed then just display a message + if (isLogged()) { + $oAccount = BxDolAccount::getInstance(); + if ($oAccount->isConfirmedPhone()) + return MsgBox(_t("_sys_txt_confirm_phone_already_confirmed")); + + $iStep = 1; + $a = $oAccount->getInfo(); + $sPhoneNumber = $a['phone']; + + $oSession = BxDolSession::getInstance(); + if ($sPhoneNumber != "" && $oSession->isValue(BX_ACCOUNT_SESSION_KEY_FOR_PHONE_ACTIVATEION_CODE)) + $iStep = 2; + + if (bx_get('step')) + $iStep = (int)bx_get('step'); + + // show and process phone set form + if ($iStep == 1){ + $oForm = BxDolForm::getObjectInstance('sys_confirm_phone', 'sys_confirm_phone_set_phone'); + if (!$oForm) + return MsgBox(_t("_sys_txt_confirm_phone_set_phone_error_occured")); + + $oForm->initChecker(['phone' => $sPhoneNumber]); + if ($oForm->isSubmittedAndValid()) { + $sPhoneNumber = trim($oForm->getCleanValue('phone')); + $oAccount->updatePhone($sPhoneNumber); + + $sActivationCode = rand(1000, 9999); + $sActivationText =_t('_sys_txt_confirm_phone_sms_text', $sActivationCode); + $mixedResult = null; + /** + * @hooks + * @hookdef hook-account-before_confirm_phone_send_sms 'account', 'before_confirm_phone_send_sms' - hook in confirm phone + * - $unit_name - equals `account` + * - $action - equals `before_confirm_phone_send_sms` + * - $object_id - account id + * - $sender_id - logged profile_id + * - $extra_params - array of additional params with the following array keys: + * - `phone_number` - [string] by ref, phone number to send sms, can be overridden in hook processing + * - `sms_text` - [string] by ref, text for sms, can be overridden in hook processing + * - `override_result` - [mixed] by ref, can be object, can be overridden in hook processing + * @hook @ref hook-account-before_confirm_phone_send_sms + */ + bx_alert('account', 'before_confirm_phone_send_sms', $oAccount->id(), bx_get_logged_profile_id(), [ + 'phone_number' => $sPhoneNumber, + 'sms_text' => $sActivationText, + 'override_result' => &$mixedResult + ]); + + if ($mixedResult === null && !BxDolTwilio::getInstance()->sendSms($sPhoneNumber, $sActivationText)) + return MsgBox(_t("_sys_txt_confirm_phone_send_sms_error_occured")); + + $oSession->setValue(BX_ACCOUNT_SESSION_KEY_FOR_PHONE_ACTIVATEION_CODE, $sActivationCode); + header('Location: ' . bx_absolute_url(BxDolPermalinks::getInstance()->permalink('page.php?i=confirm-phone'))); + } + return '' . _t("_sys_txt_confirm_phone_set_phone_desc_set_phone") . '' .$oForm->getCode(); + } + + if ($iStep == 2){ + $oForm = BxDolForm::getObjectInstance('sys_confirm_phone', 'sys_confirm_phone_confirmation'); + if (!$oForm) + return MsgBox(_t("_sys_txt_confirm_phone_set_phone_confirmation_occured")); + + $oForm->initChecker(); + + if ($oForm->isSubmittedAndValid()) { + $oAccount->updatePhoneConfirmed(true); + $oSession->unsetValue(BX_ACCOUNT_SESSION_KEY_FOR_PHONE_ACTIVATEION_CODE); + return MsgBox(_t("_sys_txt_confirm_phone_confirm_success")); + } + return '' . _t("_sys_txt_confirm_phone_set_phone_desc_phone_confirmation") . '' .$oForm->getCode(); + } + } + } + + /** + * Perform email confirmation + */ + public function confirmEmail($sKey) + { + $bApi = bx_is_api(); + + $mixedAccountId = $this->_confirmEmail($sKey); + if(is_string($mixedAccountId) && !is_numeric($mixedAccountId)) + return $bApi ? [bx_api_get_msg($mixedAccountId)] : MsgBox($mixedAccountId); + + if(($oSockets = BxDolSockets::getInstance()) && $oSockets->isEnabled()) + $oSockets->sendEvent('sys_account', $mixedAccountId, 'confirmed', ''); + + // redirect with success message + $sUrl = getParam('sys_redirect_after_email_confirmation'); + /** + * @hooks + * @hookdef hook-account-after_email_confirmation 'account', 'after_email_confirmation' - hook after email confirmed + * - $unit_name - equals `account` + * - $action - equals `after_email_confirmation` + * - $object_id - account id + * - $sender_id - not used + * - $extra_params - array of additional params with the following array keys: + * - `override_result` - [string] by ref, url for redirect after email confirmed, can be overridden in hook processing + * @hook @ref hook-account-after_email_confirmation + */ + bx_alert('account', 'after_email_confirmation', $mixedAccountId, false, ['override_result' => &$sUrl]); + if ($bApi){ + return [bx_api_get_block('redirect', ['uri' => bx_api_get_relative_url(BxDolPermalinks::getInstance()->permalink($sUrl)), 'timeout' => 1000])]; + } + + $oTemplate = BxDolTemplate::getInstance(); + $oTemplate->setPageNameIndex (BX_PAGE_TRANSITION); + $oTemplate->setPageHeader (_t('_sys_txt_confirm_email_success')); + $oTemplate->setPageContent ('page_main_code', MsgBox(_t('_sys_txt_confirm_email_success'))); + $oTemplate->setPageContent ('url_relocate', bx_absolute_url(BxDolPermalinks::getInstance()->permalink($sUrl))); + + BxDolTemplate::getInstance()->getPageCode(); + exit; + } + + public function serviceConfirmEmail($sKey) + { + $mixedAccountId = $this->_confirmEmail($sKey); + return is_int($mixedAccountId) || is_numeric($mixedAccountId); + } + + public function serviceGetOptionsResetPasswordRedirect() + { + $aResult = array(); + + $aChoices = array('home', 'profile', 'profile_edit', 'custom'); + foreach($aChoices as $sChoice) + $aResult[] = array('key' => $sChoice, 'value' => _t('_adm_stg_cpt_option_value_sys_account_reset_password_redirect_' . $sChoice)); + + return $aResult; + } + + public function serviceGetOptionsSwitchToProfileRedirect() + { + $aResult = array(); + + $aChoices = array('back', 'home', 'profile', 'custom'); + foreach($aChoices as $sChoice) + $aResult[] = array('key' => $sChoice, 'value' => _t('_adm_stg_cpt_option_value_sys_account_switch_to_profile_redirect_' . $sChoice)); + + return $aResult; + } + + public function serviceGetOptionsPruningInterval() + { + $aResult = array(); + + $aChoices = array('no_login_delete', 'no_login_suspend', 'no_confirm_delete', 'no_profile_delete'); + foreach($aChoices as $sChoice) + $aResult[] = array('key' => $sChoice, 'value' => _t('_adm_stg_cpt_option_value_sys_account_pruning_' . $sChoice)); + + return $aResult; + } + + /** + * @page service Service Calls + * @section bx_system_general System Services + * @subsection bx_system_general-account Account + * @subsubsection bx_system_general-forgot_password forgot_password + * + * @code bx_srv('system', 'forgot_password', [], 'TemplServiceAccount'); @endcode + * @code {{~system:forgot_password:TemplServiceAccount~}} @endcode + * + * Display forgot password form, + * if reset password key is provided then reset password + * + * @see BxBaseServiceAccount::serviceForgotPassword + */ + /** + * @ref bx_system_general-forgot_password "forgot_password" + */ + public function serviceForgotPassword() + { + if(isLogged()){ + header('Location: ' . BX_DOL_URL_ROOT); + exit; + } + + $bApi = bx_is_api(); + + if (bx_get('key') !== false) + return $this->resetPassword(); + + $oForm = BxDolForm::getObjectInstance('sys_forgot_password', 'sys_forgot_password'); + if (!$oForm) + return ''; + + $bNeedCheckEmailAndPhone = true; + $sCaptionKey = "_sys_txt_forgot_pasword_by_both_desc"; + if (BxDolAccount::isNeedConfirmPhone()){ + if (!BxDolAccount::isNeedConfirmEmail()){ + unset($oForm->aInputs['email']); + $sCaptionKey = "_sys_txt_forgot_pasword_by_phone_desc"; + $oForm->aInputs['phone']['checker']['func'] = 'PhoneExist'; + $bNeedCheckEmailAndPhone = false; + } + } + else{ + unset($oForm->aInputs['phone']); + $sCaptionKey = "_sys_txt_forgot_pasword_desc"; + $oForm->aInputs['email']['checker']['func'] = 'EmailExist'; + $bNeedCheckEmailAndPhone = false; + } + + if ((BxDolAccount::isNeedConfirmPhone() && BxDolAccount::isNeedConfirmEmail())){ + if (isset($oForm->aInputs['phone'])) + $oForm->aInputs['phone']['required'] = false; + if (isset($oForm->aInputs['email'])) + $oForm->aInputs['email']['required'] = false; + } + + $oForm->initChecker(); + + $bShowErrorEmptyBoth = false; + if ($oForm->isSubmitted() && $bNeedCheckEmailAndPhone && $oForm->getCleanValue('phone') == '' && $oForm->getCleanValue('email') == ''){ + $bShowErrorEmptyBoth = true; + $oForm->setValid(false); + } + + if ($oForm->isSubmittedAndValid()) { + $sEmail = $oForm->getCleanValue('email'); + $sPhone = $oForm->getCleanValue('phone'); + + if (isset($oForm->aInputs['email']) && $sEmail != '') { + $oAccount = BxDolAccount::getInstance($this->_oAccountQuery->getIdByEmail($sEmail)); + + if($oAccount && $oAccount->sendResetPasswordEmail()) + $sResultMsg = MsgBox(_t("_sys_txt_forgot_pasword_check_email")); + else + $sResultMsg = MsgBox(_t("_sys_txt_forgot_pasword_email_send_failed")); + + $sForm = ''; + } + + if (isset($oForm->aInputs['phone']) && $sPhone != '') { + $iAccountId = $this->_oAccountQuery->getIdByPhone($sPhone); + $aAccountInfo = $this->_oAccountQuery->getInfoById($iAccountId); + + $sKey = bx_get_reset_password_key($aAccountInfo['email']); + $sForgotPasswordUrl = bx_get_reset_password_link_by_key($sKey); + + $sSmsText = _t('_sys_txt_forgot_pasword_sms_text', $sForgotPasswordUrl); + + $mixedOverrideResult = null; + /** + * @hooks + * @hookdef hook-account-before_forgot_password_send_sms 'account', 'before_forgot_password_send_sms' - hook in $oAccount->isConfirmed check + * - $unit_name - equals `account` + * - $action - equals `before_forgot_password_send_sms` + * - $object_id - account id + * - $sender_id - not used + * - $extra_params - array of additional params with the following array keys: + * - `phone_number` - [string] by ref, phone number to send sms, can be overridden in hook processing + * - `sms_text` - [string] by ref, text for sms, can be overridden in hook processing + * - `override_result` - [mixed] by ref, can be object, can be overridden in hook processing + * @hook @ref hook-account-before_forgot_password_send_sms + */ + bx_alert('account', 'before_forgot_password_send_sms', $aAccountInfo['id'], false, array('phone_number' => &$sPhone, 'sms_text' => &$sSmsText, 'override_result' => &$mixedOverrideResult)); + if ($mixedOverrideResult === null) { + $oTwilio = BxDolTwilio::getInstance(); + if($oTwilio->sendSms($sPhone, $sSmsText)) + $sResultMsg = MsgBox(_t("_sys_txt_forgot_pasword_check_phone")); + else + $sResultMsg = MsgBox(_t("_sys_txt_forgot_pasword_error_occured")); + } + + $sForm = ''; + } + + if($bApi) { + return [ + bx_api_get_msg(strip_tags($sResultMsg)), + ]; + } + } + else { + $sResultMsg = _t($sCaptionKey); + $sForm = $oForm->getCode(); + + if($bApi) { + return [ + bx_api_get_msg($sResultMsg, ['ext' => ['msg_type' => 'caption']]), + bx_api_get_block('form', $oForm->getCodeAPI(), [ + 'ext' => [ + 'request' => ['url' => '/api.php?r=system/forgot_password/TemplServiceAccount', 'immutable' => true] + ] + ])]; + } + } + + return '' . $sResultMsg . '' . $sForm . ($bShowErrorEmptyBoth ? '' . _t("_sys_form_forgot_password_phone_and_email_empty_error") . '' : ''); + } + + /** + * @page service Service Calls + * @section bx_system_general System Services + * @subsection bx_system_general-account Account + * @subsubsection bx_system_general-switch_profile switch_profile + * + * @code bx_srv('system', 'switch_profile', [123], 'TemplServiceAccount'); @endcode + * @code {{~system:switch_profile:TemplServiceAccount:[123]~}} @endcode + * + * Switch current user profile. + * User can switch between profiles if multiple profiles are created. + * Also it's possible to switch to Organization profile if user is admin of Organization, + * or other module which can `actAsProfile`. + * Admin can switch to any prifile by default + * + * @param $iSwitchToProfileId profile ID to switch to + * @return true on success or error message otherwise, so make sue to make strict (===) comparision + * + * @see BxBaseServiceAccount::serviceSwitchProfile + */ + /** + * @ref bx_system_general-switch_profile "switch_profile" + */ + public function serviceSwitchProfile($iSwitchToProfileId) + { + $oProfile = BxDolProfile::getInstance($iSwitchToProfileId); + if (!$oProfile) { + return _t('_sys_txt_error_occured'); + } + + $iViewerAccountId = getLoggedId(); + $iSwitchToAccountId = $oProfile->getAccountId(); + + $iViewerProfileId = bx_get_logged_profile_id(); + $aCheck = checkActionModule($iViewerProfileId, 'switch to any profile', 'system', false); + $bAllowSwitchToAnyProfile = $aCheck[CHECK_ACTION_RESULT] === CHECK_ACTION_RESULT_ALLOWED; + + $bCanSwitch = ($iSwitchToAccountId == $iViewerAccountId || $bAllowSwitchToAnyProfile); + /** + * @hooks + * @hookdef hook-account-check_switch_context 'account', 'check_switch_context' - hook on switch profile_id + * - $unit_name - equals `account` + * - $action - equals `check_switch_context` + * - $object_id - account id + * - $sender_id - viewer profile_id + * - $extra_params - array of additional params with the following array keys: + * - `switch_to_profile` - [int] profile_id to switch + * - `viewer_account` - [int] viewer's profile_id, can be overridden in hook processing + * - `override_result` - [bool] by ref, true if allow switch profile, otherwise false, can be overridden in hook processing + * @hook @ref hook-account-check_switch_context + */ + bx_alert('account', 'check_switch_context', $iSwitchToAccountId, $iViewerProfileId, array('switch_to_profile' => $iSwitchToProfileId, 'viewer_account' => $iViewerAccountId, 'override_result' => &$bCanSwitch)); + + if (!$bCanSwitch) { + return isset($aCheck[CHECK_ACTION_MESSAGE]) ? $aCheck[CHECK_ACTION_MESSAGE] : _t('_sys_txt_error_occured'); + } + + $oAccount = BxDolAccount::getInstance(); + if (!$oAccount->updateProfileContext($iSwitchToProfileId)) { + return _t('_sys_txt_error_occured'); + } + + checkActionModule($iViewerProfileId, 'switch to any profile', 'system', true); + if (bx_is_api()){ + return BxDolProfile::getDataForPage($iSwitchToProfileId); + } + return true; + } + + /** + * Reset password procedure + */ + public function resetPassword() + { + $bApi = bx_is_api(); + $sKey = bx_process_input(bx_get('key')); + + $oForm = BxDolForm::getObjectInstance('sys_forgot_password', 'sys_forgot_password_reset'); + if(!empty($sKey) && isset($oForm->aInputs['key'])) + $oForm->aInputs['key']['value'] = $sKey; + + $oForm->initChecker(); + if($oForm->isSubmittedAndValid()) { + $sErrorUrl = bx_absolute_url(BxDolPermalinks::getInstance()->permalink('page.php?i=forgot-password')); + + // check if key exists + $oKey = BxDolKey::getInstance(); + $sKey = $oForm->getCleanValue('key'); + if(!$oKey || !$oKey->isKeyExists($sKey)) + return $bApi ? bx_api_get_msg(_t('_sys_txt_reset_pasword_error_invalid_key', $sErrorUrl)) : MsgBox(_t('_sys_txt_reset_pasword_error_invalid_key', $sErrorUrl)); + + // check if key data exists + $aKeyData = $oKey->getKeyData($sKey); + if(empty($aKeyData['email'])) + return $bApi ? [bx_api_get_msg(_t('_sys_txt_reset_pasword_error_invalid_key', $sErrorUrl))] : MsgBox(_t('_sys_txt_reset_pasword_error_invalid_key', $sErrorUrl)); + + // check if account with such email exists + $iAccountId = $this->_oAccountQuery->getIdByEmail($aKeyData['email']); + if(empty($iAccountId)) + return $bApi ? [bx_api_get_msg(_t('_sys_txt_reset_pasword_error_not_found', $sErrorUrl))] : MsgBox(_t('_sys_txt_reset_pasword_error_not_found', $sErrorUrl));; + + $sPassword = $oForm->getCleanValue('password'); + $oAccount = BxDolAccount::getInstance($iAccountId); + if (!$oAccount || !$oAccount->updatePassword($sPassword)) + return $bApi ?[ bx_api_get_msg(_t('_sys_txt_reset_pasword_error_occured', $sErrorUrl))] : MsgBox(_t('_sys_txt_reset_pasword_error_occured', $sErrorUrl)); + + $this->_oAccountQuery->unlockAccount($iAccountId); + $oKey->removeKey($sKey); + + return $bApi ? [bx_api_get_msg(_t('_sys_txt_reset_pasword_success', $sErrorUrl))] : MsgBox(_t('_sys_txt_reset_pasword_success'), 3) . bx_srv('system', 'login_form_only', array('', bx_get_reset_password_redirect($iAccountId)), 'TemplServiceLogin'); + } + + $sTitleReset = _t('_sys_page_title_forgot_password_reset'); + BxDolTemplate::getInstance()->setPageHeader($sTitleReset); + if(($oPage = BxDolPage::getObjectInstanceByURI()) !== false) + $oPage->setTitle($sTitleReset); + + if($bApi) { + return [ + bx_api_get_block('form', $oForm->getCodeAPI(), [ + 'ext' => [ + 'request' => ['url' => '/api.php?r=system/forgot_password/TemplServiceAccount', 'immutable' => true] + ] + ])]; + } + + return $oForm->getCode(); + } + + /** + * Generate new password. + */ + public function generateUserNewPwd($iAccountId) + { + $sPwd = genRndPwd(8, false); + $sSalt = genRndSalt(); + $sPasswordHash = encryptUserPwd($sPwd, $sSalt); + + $oAccount = BxDolAccount::getInstance($iAccountId); + $iPasswordExpired = $oAccount->getPasswordExpiredDateByAccount($iAccountId); + + $this->_oAccountQuery->updatePassword($sPasswordHash, $sSalt, $iAccountId, $iPasswordExpired); + + /** + * @hooks + * @hookdef hook-account-edited 'account', 'edited' - hook on account edited + * - $unit_name - equals `account` + * - $action - equals `edited` + * - $object_id - account id + * - $sender_id - account id + * - $extra_params - array of additional params with the following array keys: + * - `action` - [string] can be forgot_password/change_password or $sDisplayName (display name for current form) + * @hook @ref hook-account-edited + */ + bx_alert('account', 'edited', $iAccountId, $iAccountId, array('action' => 'forgot_password')); + + return $sPwd; + } + + protected function _confirmEmail($sKey) + { + // check if key exists + $oKey = BxDolKey::getInstance(); + if (!$oKey || !$oKey->isKeyExists($sKey)) + return _t("_sys_txt_confirm_email_error_occured"); + + // check if key data exists + $aData = $oKey->getKeyData($sKey); + if (!isset($aData['account_id'])) + return _t("_sys_txt_confirm_email_error_occured"); + + // check if account exists + $oAccount = BxDolAccount::getInstance($aData['account_id']); + if (!$oAccount) + return _t("_sys_txt_confirm_email_error_occured"); + + // remove key + $oKey->removeKey($sKey); + + // confirm email + if (!$oAccount->updateEmailConfirmed(true)) + return _t("_sys_txt_confirm_email_error_occured"); + + // login to user's account automatically + bx_login($aData['account_id']); + + return (int)$aData['account_id']; + } +} + +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseServiceMetatags.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseServiceMetatags.php new file mode 100644 index 0000000000..1ec3349702 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseServiceMetatags.php @@ -0,0 +1,141 @@ + $bMenuView]; + if ($aContextInfo !== false) + $aParams['context_id'] = $aContextInfo['context_profile_id']; + + $sResult = BxDolMetatags::getObjectInstance($sObject)->getKeywordsCloud($mixedSection, $iMaxCount, false, $aParams); + + if(empty($sResult)) + return $bShowEmpty ? MsgBox(_t('_Empty')) : ''; + + return $sResult; + } + + public function serviceBrowseLabels($aParams = array()) + { + return BxDolLabel::getInstance()->getLabelsBrowse($aParams); + } + + /** + * Get location map. + * @param $sObject metatgs object to get keywords cloud for + * @param $iId content id + * @return map HTML string + */ + public function serviceLocationsMap($sObject, $iId, $aParams = array()) + { + $oMetatags = BxDolMetatags::getObjectInstance($sObject); + if($oMetatags === false) + return false; + + $sModule = $oMetatags->getModule(); + + $aContentInfo = bx_srv($sModule, 'get_info', [$iId, false]); + if(empty($aContentInfo) || !is_array($aContentInfo)) + return false; + + $oFormsHelper = bx_srv($sModule, 'forms_helper'); + $oFormView = $oFormsHelper->getObjectFormView(); + if(!$oFormView) + return false; + + $CNF = &BxDolModule::getInstance($sModule)->_oConfig->CNF; + + $oFormView->initChecker($aContentInfo); + if(empty($CNF['FIELD_LOCATION']) || !$oFormView->isInputVisible($CNF['FIELD_LOCATION'])) + return false; + + return $oMetatags->getLocationsMap($iId, $aParams); + } + + /** + * Get notification data for Notifications module - action Mention. + */ + public function serviceGetNotificationsPostMention($aEvent) + { + $iProfile = (int)$aEvent['object_owner_id']; + $oProfile = BxDolProfile::getInstance($iProfile); + if(!$oProfile) + return []; + + $sEntryUrl = ''; + if (isset($aEvent['content']['module']) && isset($aEvent['content']['content_id'])) { + if ('sys_cmts' == $aEvent['content']['module']) { + $oCmts = BxDolCmts::getObjectInstanceByUniqId($aEvent['content']['content_id']); + $aCmt = BxDolCmtsQuery::getCommentExtendedByUniqId($aEvent['content']['content_id']); + if ($oCmts && $aCmt) + $sEntryUrl = $oCmts->getViewUrl($aCmt['cmt_id']); + } elseif (BxDolRequest::serviceExists($aEvent['content']['module'], 'get_link')) { + $sEntryUrl = str_replace(BX_DOL_URL_ROOT, '{bx_url_root}', bx_srv($aEvent['content']['module'], 'get_link', [$aEvent['content']['content_id']])); + } + } + + if(!$sEntryUrl) + $sEntryUrl = '{bx_url_root}' . bx_append_url_params('searchKeyword.php', ['type' => 'mention', 'keyword' => $iProfile]); + + return [ + 'entry_sample' => '_sys_profile_sample_single', + 'entry_url' => $sEntryUrl, + 'entry_caption' => $oProfile->getDisplayName(), + 'entry_author' => $iProfile, + 'lang_key' => '_sys_metatags_mention_added', + ]; + } +} + +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseServices.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseServices.php new file mode 100644 index 0000000000..2275496760 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseServices.php @@ -0,0 +1,1489 @@ +serviceGetPublicServices(); + return isset($aServices[$sService]); + } + + public function serviceGetPublicServices() + { + return array ( + 'GetProductsNames' => 'BxBaseServices', + 'GetPageByRequest' => 'BxBaseServicePages', + ); + } + + public function serviceIsSafeService($s) + { + $sService = bx_gen_method_name($s); + $aSafeServices = $this->serviceGetSafeServices(); + return isset($aSafeServices[$sService]); + } + + public function serviceGetSafeServices() + { + return array( + 'GetMenu' => 'BxBaseServices', + 'GetCreatePostForm' => 'BxBaseServices', + 'GetProductsNames' => 'BxBaseServices', + 'KeywordSearch' => 'BxBaseServices', + 'GetDataSearchApi' => 'BxBaseServices', + 'Cmts' => 'BxBaseServices', + 'GetFooter' => 'BxBaseServices', + + 'GetPageBlockData' => 'BxBaseServicePages', + 'SetPageBlockData' => 'BxBaseServicePages', + 'GetUrlInfo' => 'BxBaseServicePages', + + 'CreateAccountForm' => 'BxBaseServiceAccount', + 'AccountSettingsEmail' => 'BxBaseServiceAccount', + 'AccountSettingsPassword' => 'BxBaseServiceAccount', + 'AccountSettingsDelAccount' => 'BxBaseServiceAccount', + 'AccountSettingsInfo' => 'BxBaseServiceAccount', + 'ForgotPassword' => 'BxBaseServiceAccount', + 'SwitchProfile' => 'BxBaseServiceAccount', + 'AccountProfileSwitcher' => 'BxBaseServiceAccount', + 'EmailConfirmation' => 'BxBaseServiceAccount', + 'ConfirmEmail' => 'BxBaseServiceAccount', + + 'CategoriesList' => 'BxBaseServiceCategory', + + 'Test' => 'BxBaseServiceLogin', + 'MemberAuthCode' => 'BxBaseServiceLogin', + 'LoginForm' => 'BxBaseServiceLogin', + 'LoginFormOnly' => 'BxBaseServiceLogin', + 'Logout' => 'BxBaseServiceLogin', + + 'KeywordsCloud' => 'BxBaseServiceMetatags', + + 'AccountProfileSwitcher' => 'BxBaseServiceProfiles', + 'ProfileMembership' => 'BxBaseServiceProfiles', + 'ProfileNotifications' => 'BxBaseServiceProfiles', + 'GetCountOnlineProfiles' => 'BxBaseServiceProfiles', + 'BrowseRecommendationsFriends' => 'BxBaseServiceProfiles', + 'BrowseRecommendationsSubscriptions' => 'BxBaseServiceProfiles', + 'BrowseFriends' => 'BxBaseServiceProfiles', + 'SetMembership' => 'BxBaseServiceProfiles', + 'BrowseFriendRequests' => 'BxBaseServiceProfiles', + 'BrowseFriendRequested' => 'BxBaseServiceProfiles', + 'BrowseSubscribedMe' => 'BxBaseServiceProfiles', + 'BrowseSubscriptions' => 'BxBaseServiceProfiles', + 'BrowseMembers' => 'BxBaseServiceProfiles', + 'UpdateSettings' => 'BxBaseServiceProfiles', + 'Befriend' => 'BxBaseServiceProfiles', + + 'GetChartGrowth' => 'BxBaseChartServices', + 'GetChartStats' => 'BxBaseChartServices', + 'GetDataByInterval' => 'BxBaseChartServices', + + 'GetCartItemsCount' => 'BxBasePaymentsServices', + 'GetOrdersCount' => 'BxBasePaymentsServices', + + 'Do' => 'BxBaseReportServices', + 'GetPerformedBy' => 'BxBaseReportServices', + + 'Do' => 'BxBaseVoteServices', + 'GetPerformedBy' => 'BxBaseVoteServices', + + 'Perform' => 'BxBaseFeatureServices', + + 'Perform' => 'BxBaseServiceConnections', + 'Perform' => 'BxBaseServiceRecommendations', + 'GetDataApi' => 'BxBaseCmtsServices', + + 'GetDataApi' => 'BxBaseUploaderServices', + + 'GetStatBlock' => 'BxBaseDashboardServices', + + 'PerfomActionApi' => 'BxBaseServiceGrid', + + 'GetLabels' => 'BxBaseLabelsServices', + 'GetForm' => 'BxBaseSearchExtendedServices', + 'GetResults' => 'BxBaseSearchExtendedServices' + ); + } + + public function serviceGetPreloaderContent($sName) { + $sResult = ''; + + switch($sName) { + case 'icons': + $sResult = getParam('sys_css_icons_default'); + break; + + case 'tailwind': + $sFile = getParam('sys_css_tailwind_default'); + if(empty($sFile)) + $sFile = 'tailwind.min.css'; + + $sResult = '{dir_plugins_public}tailwind/css/|' . $sFile; + break; + } + + return $sResult; + } + + /** + * @page service Service Calls + * @section bx_system_general System Services + * @subsection bx_system_general-general General + * @subsubsection bx_system_general-module_check_for_update module_check_for_update + * + * @code bx_srv('system', 'module_check_for_update', ["bx_posts"]); @endcode + * @code bx_srv('system', 'module_check_for_update', ["bx_posts"], 'TemplServices'); @endcode + * @code {{~system:module_check_for_update:TemplServices["bx_posts"]~}} @endcode + * + * Checks whether an update is available for requested module or not. + * @param $mixedModule - module ID/name to check the updates for. + * @return array with information about the update, false if nothing was found + * + * @see BxBaseServices::serviceModuleCheckForUpdate + */ + /** + * @ref bx_system_general-module_check_for_update "module_check_for_update" + */ + public function serviceModuleCheckForUpdate($mixedModule) + { + $aModule = BxDolModuleQuery::getInstance()->{'getModuleBy' . (is_numeric($mixedModule) ? 'Id' : 'Name')}($mixedModule, false); + if(empty($aModule) || !is_array($aModule)) + return false; + + $aUpdates = BxDolStudioInstallerUtils::getInstance()->checkUpdatesByModule($aModule['name']); + if(empty($aUpdates) || !is_array($aUpdates)) + return false; + + $aUpdate = array_shift($aUpdates); + return array( + 'version_from' => $aUpdate['file_version'], + 'version_to' => $aUpdate['file_version_to'], + 'file_id' => $aUpdate['file_id'] + ); + } + + /** + * @page service Service Calls + * @section bx_system_general System Services + * @subsection bx_system_general-general General + * @subsubsection bx_system_general-module_update module_update + * + * @code bx_srv('system', 'module_update', ["bx_posts"]); @endcode + * @code bx_srv('system', 'module_update', ["bx_posts"], 'TemplServices'); @endcode + * @code {{~system:module_update:TemplServices["bx_posts"]~}} @endcode + * + * Download and install an update for requested module. The operation may be performed + * immediately or by Transient Cron task. The second way is more common. + * @param $mixedModule - module ID/name to check the updates for. + * @return integer value determining the result of the operation. It can be one of the following values: + * BX_DOL_STUDIO_IU_RC_SUCCESS, BX_DOL_STUDIO_IU_RC_FAILED or BX_DOL_STUDIO_IU_RC_SCHEDULED. + * + * @see BxBaseServices::serviceModuleUpdate + */ + /** + * @ref bx_system_general-module_update "module_update" + */ + public function serviceModuleUpdate($mixedModule) + { + $aModule = BxDolModuleQuery::getInstance()->{'getModuleBy' . (is_numeric($mixedModule) ? 'Id' : 'Name')}($mixedModule, false); + if(empty($aModule) || !is_array($aModule)) + return BX_DOL_STUDIO_IU_RC_FAILED; + + $aResult = BxDolStudioInstallerUtils::getInstance()->downloadUpdatePublic($aModule['name'], true); + return $aResult['code']; + } + + /** + * @page service Service Calls + * @section bx_system_general System Services + * @subsection bx_system_general-general General + * @subsubsection bx_system_general-module_delete module_delete + * + * @code bx_srv('system', 'module_delete', ["bx_posts"]); @endcode + * @code bx_srv('system', 'module_delete', ["bx_posts", true], 'TemplServices'); @endcode + * @code {{~system:module_delete:TemplServices["bx_posts"]~}} @endcode + * + * Delete the requested module. By default only uninstalled module can be deleted. + * The operation may be performed immediately or by Transient Cron task. The second way is more common. + * @param $sModule - module name to delete. + * @param $bForceUninstall - if 'true' is passed the module will be uninstalled before deletion. + * @return integer value determining the result of the operation. It can be one of the following values: + * BX_DOL_STUDIO_IU_RC_SUCCESS, BX_DOL_STUDIO_IU_RC_FAILED or BX_DOL_STUDIO_IU_RC_SCHEDULED. + * + * @see BxBaseServices::serviceModuleDelete + */ + /** + * @ref bx_system_general-module_delete "module_delete" + */ + public function serviceModuleDelete($sModule, $bForceUninstall = false) + { + $sModulePath = ''; + $oInstallerUtils = BxDolStudioInstallerUtils::getInstance(); + + $aModule = BxDolModuleQuery::getInstance()->getModuleByName($sModule, false); + if(!empty($aModule) && is_array($aModule)) { + if(!$bForceUninstall) + return BX_DOL_STUDIO_IU_RC_FAILED; + + $sModulePath = $aModule['path']; + + $aResult = $oInstallerUtils->perform($sModulePath, 'uninstall', array('auto_disable' => $bForceUninstall)); + if($aResult['code'] != BX_DOL_STUDIO_IU_RC_SUCCESS) + return BX_DOL_STUDIO_IU_RC_FAILED; + } + else { + $aModules = $oInstallerUtils->getModules(false); + if(!isset($aModules[$sModule])) + return BX_DOL_STUDIO_IU_RC_FAILED; + + $sModulePath = $aModules[$sModule]['dir']; + } + + $aResult = $oInstallerUtils->perform($sModulePath, 'delete'); + return $aResult['code']; + } + + /** + * @page service Service Calls + * @section bx_system_general System Services + * @subsection bx_system_general-general General + * @subsubsection bx_system_general-module_install module_install + * + * @code bx_srv('system', 'module_install', ["bx_posts"]); @endcode + * @code bx_srv('system', 'module_install', ["bx_posts", true], 'TemplServices'); @endcode + * @code {{~system:module_install:TemplServices["bx_posts"]~}} @endcode + * + * Install the requested module. By default the module will be installed only. + * @param $sModule - module name to install. + * @param $bForceEnable - if 'true' is passed the module will be automatically enabled after installation. + * @return boolean value determining the result of the operation. + * + * @see BxBaseServices::serviceModuleInstall + */ + /** + * @ref bx_system_general-module_install "module_install" + */ + public function serviceModuleInstall($sModule, $bForceEnable = false) + { + $oInstallerUtils = BxDolStudioInstallerUtils::getInstance(); + + $aModules = $oInstallerUtils->getModules(false); + if(!isset($aModules[$sModule])) + return false; + + $aResult = $oInstallerUtils->perform($aModules[$sModule]['dir'], 'install', array('auto_enable' => $bForceEnable)); + if($aResult['code'] != BX_DOL_STUDIO_IU_RC_SUCCESS) + return false; + + return true; + } + + /** + * @page service Service Calls + * @section bx_system_general System Services + * @subsection bx_system_general-general General + * @subsubsection bx_system_general-module_uninstall module_uninstall + * + * @code bx_srv('system', 'module_uninstall', ["bx_posts"]); @endcode + * @code bx_srv('system', 'module_uninstall', ["bx_posts", true], 'TemplServices'); @endcode + * @code {{~system:module_uninstall:TemplServices["bx_posts"]~}} @endcode + * + * Uninstall the requested module. By default only disabled module can be uninstalled. + * @param $mixedModule - module ID/name to uninstall. + * @param $bForceDisable - if 'true' is passed the module will be automatically disabled before uninstallation. + * @return boolean value determining the result of the operation. + * + * @see BxBaseServices::serviceModuleUninstall + */ + /** + * @ref bx_system_general-module_uninstall "module_uninstall" + */ + public function serviceModuleUninstall($mixedModule, $bForceDisable = false) + { + $aModule = BxDolModuleQuery::getInstance()->{'getModuleBy' . (is_numeric($mixedModule) ? 'Id' : 'Name')}($mixedModule, false); + if(empty($aModule) || !is_array($aModule)) + return false; + + if((int)$aModule['enabled'] != 0 && !$bForceDisable) + return false; + + $aResult = BxDolStudioInstallerUtils::getInstance()->perform($aModule['path'], 'uninstall', array('auto_disable' => $bForceDisable)); + if($aResult['code'] != BX_DOL_STUDIO_IU_RC_SUCCESS) + return false; + + return true; + } + + /** + * @page service Service Calls + * @section bx_system_general System Services + * @subsection bx_system_general-general General + * @subsubsection bx_system_general-module_enable module_enable + * + * @code bx_srv('system', 'module_enable', ["bx_posts"]); @endcode + * @code bx_srv('system', 'module_enable', ["bx_posts"], 'TemplServices'); @endcode + * @code {{~system:module_enable:TemplServices["bx_posts"]~}} @endcode + * + * Enable the requested module. + * @param $mixedModule - module ID/name to enable. + * @return boolean value determining the result of the operation. + * + * @see BxBaseServices::serviceModuleEnable + */ + /** + * @ref bx_system_general-module_enable "module_enable" + */ + public function serviceModuleEnable($mixedModule) + { + $aModule = BxDolModuleQuery::getInstance()->{'getModuleBy' . (is_numeric($mixedModule) ? 'Id' : 'Name')}($mixedModule, false); + if(empty($aModule) || !is_array($aModule)) + return false; + + if((int)$aModule['enabled'] != 0) + return false; + + $aResult = BxDolStudioInstallerUtils::getInstance()->perform($aModule['path'], 'enable'); + if($aResult['code'] != BX_DOL_STUDIO_IU_RC_SUCCESS) + return false; + + return true; + } + + /** + * @page service Service Calls + * @section bx_system_general System Services + * @subsection bx_system_general-general General + * @subsubsection bx_system_general-module_disable module_disable + * + * @code bx_srv('system', 'module_disable', ["bx_posts"]); @endcode + * @code bx_srv('system', 'module_disable', ["bx_posts"], 'TemplServices'); @endcode + * @code {{~system:module_disable:TemplServices["bx_posts"]~}} @endcode + * + * Disable the requested module. + * @param $mixedModule - module ID/name to disable. + * @return boolean value determining the result of the operation. + * + * @see BxBaseServices::serviceModuleDisable + */ + /** + * @ref bx_system_general-module_disable "module_disable" + */ + public function serviceModuleDisable($mixedModule) + { + $aModule = BxDolModuleQuery::getInstance()->{'getModuleBy' . (is_numeric($mixedModule) ? 'Id' : 'Name')}($mixedModule, false); + if(empty($aModule) || !is_array($aModule)) + return false; + + if((int)$aModule['enabled'] == 0) + return false; + + $aResult = BxDolStudioInstallerUtils::getInstance()->perform($aModule['path'], 'disable'); + if($aResult['code'] != BX_DOL_STUDIO_IU_RC_SUCCESS) + return false; + + return true; + } + + /** + * @page service Service Calls + * @section bx_system_general System Services + * @subsection bx_system_general-general General + * @subsubsection bx_system_general-is_module_installed is_module_installed + * + * @code bx_srv('system', 'is_module_installed', ["bx_posts"]); @endcode + * @code bx_srv('system', 'is_module_installed', ["bx_posts"], 'TemplServices'); @endcode + * @code {{~system:is_module_installed:TemplServices["bx_posts"]~}} @endcode + * + * Checks whether the requested module is installed or not. + * @param $mixedModule - module ID/name to check. + * @return boolean value determining the result of the operation. + * + * @see BxBaseServices::serviceIsModuleInstalled + */ + /** + * @ref bx_system_general-is_module_installed "is_module_installed" + */ + public function serviceIsModuleInstalled($mixedModule) + { + $aModule = BxDolModuleQuery::getInstance()->{'getModuleBy' . (is_numeric($mixedModule) ? 'Id' : 'Name')}($mixedModule, false); + return !empty($aModule) && is_array($aModule); + } + + /** + * @page service Service Calls + * @section bx_system_general System Services + * @subsection bx_system_general-general General + * @subsubsection bx_system_general-is_module_enabled is_module_enabled + * + * @code bx_srv('system', 'is_module_enabled', ["bx_posts"]); @endcode + * @code bx_srv('system', 'is_module_enabled', ["bx_posts"], 'TemplServices'); @endcode + * @code {{~system:is_module_enabled:TemplServices["bx_posts"]~}} @endcode + * + * Checks whether the requested module is enabled or not. + * @param $mixedModule - module ID/name to check. + * @return boolean value determining the result of the operation. + * + * @see BxBaseServices::serviceIsModuleEnabled + */ + /** + * @ref bx_system_general-is_module_enabled "is_module_enabled" + */ + public function serviceIsModuleEnabled($mixedModule) + { + $aModule = BxDolModuleQuery::getInstance()->{'getModuleBy' . (is_numeric($mixedModule) ? 'Id' : 'Name')}($mixedModule, false); + return !empty($aModule) && is_array($aModule) && (int)$aModule['enabled'] != 0; + } + + /** + * Checks whether a module is a 'Content' module or not. + * + * @param string $mixedModule - module name or an instance of Module class. + * @return boolean result of operation. + */ + public function serviceIsModuleContent($mixedModule) + { + if($mixedModule instanceof BxDolModule) + $mixedModule = $mixedModule->getName(); + + return BxDolModuleQuery::getInstance()->isModuleContent($mixedModule); + } + + /** + * Checks whether a module is a 'Context' module or not. + * + * @param string $mixedModule - module name or an instance of Module class. + * @return boolean result of operation. + */ + public function serviceIsModuleContext($mixedModule) + { + if($mixedModule instanceof BxDolModule) + $mixedModule = $mixedModule->getName(); + + return BxDolModuleQuery::getInstance()->isModuleContext($mixedModule); + } + + /** + * Checks whether a module is a 'Profile' module or not. + * + * @param string $mixedModule - module name or an instance of Module class. + * @return boolean result of operation. + */ + public function serviceIsModuleProfile($mixedModule) + { + if($mixedModule instanceof BxDolModule) + $mixedModule = $mixedModule->getName(); + + return BxDolModuleQuery::getInstance()->isModuleProfile($mixedModule); + } + + /** + * Get modules by type. Available types are 'content', 'context', 'profile'. + * + * @param type $sType - string with type. + * @return array of modules. + */ + public function serviceGetModulesByType($sType, $aParams = []) + { + $oModuleQuery = BxDolModuleQuery::getInstance(); + + if(!$oModuleQuery->checkModulesSubtypes()) { + $oInstallerUtils = new BxDolInstallerUtils(); + $aModules = $oModuleQuery->getModulesBy(['type' => 'modules']); + foreach($aModules as $aModule) + if(($iModuleSubtypes = $oInstallerUtils->getSubtypes($aModule['name'])) != 0) + $oModuleQuery->updateModule(['subtypes' => $iModuleSubtypes], ['id' => $aModule['id']]); + } + + $iSubtypes = 0; + switch($sType) { + case 'content'; + $iSubtypes = BX_DOL_MODULE_SUBTYPE_TEXT; + break; + + case 'context'; + $iSubtypes = BX_DOL_MODULE_SUBTYPE_CONTEXT; + break; + + case 'profile'; + $iSubtypes = BX_DOL_MODULE_SUBTYPE_PROFILE; + break; + } + + $aResults = $oModuleQuery->getModulesBy(array_merge([ + 'type' => 'modules_subtypes', + 'value' => $iSubtypes, + 'active' => 1 + ], array_intersect_key($aParams, array_flip(['id_as_key', 'name_as_key'])))); + + return $aResults; + } + + public function serviceProfileUnit ($iContentId, $aParams = array()) + { + return $this->_serviceProfileFunc('getUnit', $iContentId, $aParams); + } + + public function serviceHasImage ($iContentId) + { + return false; + } + + public function serviceProfilePicture ($iContentId) + { + return BxDolTemplate::getInstance()->getImageUrl('account.svg'); + } + + public function serviceProfileAvatar ($iContentId) + { + return BxDolTemplate::getInstance()->getImageUrl('account.svg'); + } + + public function serviceProfileCover ($iContentId) + { + return ''; + } + + public function serviceProfileEditUrl ($iContentId) + { + return bx_absolute_url(BxDolPermalinks::getInstance()->permalink('page.php?i=account-settings-info')); + } + + public function serviceProfileThumb ($iContentId) + { + return $this->_serviceProfileFunc('getThumb', $iContentId); + } + + public function serviceProfileIcon ($iContentId) + { + return $this->_serviceProfileFunc('getIcon', $iContentId); + } + + public function serviceProfileName ($iContentId) + { + return $this->_serviceProfileFunc('getDisplayName', $iContentId); + } + + public function serviceProfileUrl ($iContentId) + { + return $this->_serviceProfileFunc('getUrl', $iContentId); + } + + /** + * @see iBxDolProfileService::serviceCheckAllowedProfileView + */ + public function serviceCheckAllowedProfileView($iContentId) + { + return _t('_Access denied'); + } + + /** + * @see iBxDolProfileService::serviceCheckAllowedProfileContact + */ + public function serviceCheckAllowedProfileContact($iContentId) + { + return _t('_Access denied'); + } + + /** + * @see iBxDolProfileService::serviceCheckAllowedPostInProfile + */ + public function serviceCheckAllowedPostInProfile($iContentId, $sPostModule = '') + { + return _t('_Access denied'); + } + + /** + * @see iBxDolProfileService::serviceCheckAllowedModuleActionInProfile + */ + public function serviceCheckAllowedModuleActionInProfile($iContentId, $sPostModule, $sActionName) + { + return _t('_Access denied'); + } + + /** + * @see iBxDolProfileService::serviceGetSpaceTitle + */ + public function serviceGetSpaceTitle() + { + return ''; + } + + /** + * @see iBxDolProfileService::serviceGetParticipatingProfiles + */ + public function serviceGetParticipatingProfiles($iProfileId, $aConnectionObject = false) + { + return array(); + } + + /** + * @page service Service Calls + * @section bx_system_general System Services + * @subsection bx_system_general-general General + * @subsubsection bx_system_general-get_create_post_form get_create_post_form + * + * @code bx_srv('system', 'get_create_post_form', [false, "bx_posts"], 'TemplServices'); @endcode + * @code {{~system:get_create_post_form:TemplServices[false,"bx_posts"]~}} @endcode + * + * Get United Create Post form. + * @param $mixedContextId - context which the post will be created in: + * - false = 'Public' post form; + * - 0 = 'Profile' post form, which allows to post in your own profile and connections; + * - n = 'Context' post form, which allows to post in context (3d party profile, group, event, etc). + * @param $sDefault - tab selected by default. + * @param $aCustom - an array with custom paramaters. + * @return string with form content + * + * @see BxBaseServices::serviceGetCreatePostForm + */ + /** + * @ref bx_system_general-get_create_post_form "get_create_post_form" + */ + public function serviceGetCreatePostForm($mixedContextId = false, $sDefault = '', $aCustom = array()) + { + if(!isLogged() || ($mixedContextId !== false && !is_numeric($mixedContextId))) + return ''; + + $oProfile = BxDolProfile::getInstance(); + if(!$oProfile) + return ''; + + if($mixedContextId !== false) + $mixedContextId = (int)(!empty($mixedContextId) ? -$mixedContextId : $oProfile->id()); + + $oMenu = BxDolMenu::getObjectInstance('sys_create_post'); + if(!$oMenu) + return ''; + + $oMenu->setContextId($mixedContextId); + $aMenuItems = $oMenu->getMenuItems(); + if(empty($aMenuItems) || !is_array($aMenuItems)) + return ''; + + if(empty($sDefault)) { + $aDefault = array_shift($aMenuItems); + $sDefault = !empty($aDefault['module']) ? $aDefault['module'] : $aDefault['name']; + } + $oMenu->setSelected($sDefault, $sDefault); + + $bContext = $mixedContextId !== false; + if($bContext && ($aContextInfo = BxDolProfileQuery::getInstance()->getInfoById(abs($mixedContextId)))) + if(bx_srv($aContextInfo['type'], 'check_allowed_post_in_profile', [$aContextInfo['content_id'], $sDefault]) !== CHECK_ACTION_RESULT_ALLOWED) + return ''; + + $sTitle = _t('_sys_page_block_title_create_post' . (!$bContext ? '_public' : ($mixedContextId < 0 ? '_context' : ''))); + $sPlaceholder = _t('_sys_txt_create_post_placeholder', $oProfile->getDisplayName()); + + $oDbModules = BxDolModuleQuery::getInstance(); + $oTemplate = BxDolTemplate::getInstance(); + $oTemplate->addJs(['BxDolCreatePost.js']); + + $aPreloadingList = []; + $aModules = explode(',', getParam('sys_create_post_form_preloading_list')); + if(!empty($aModules)) + foreach($aModules as $sModule) { + $aModule = $oDbModules->getModuleByName($sModule); + if(empty($aModule) || !is_array($aModule)) + continue; + + $aPreloadingList[$sModule] = $aModule['uri']; + } + + if(bx_is_api()) { + return [ + 'title' => $sTitle, + 'content' => '', + 'menu' => $oMenu->getCodeAPI() + ]; + } + + $sJsObject = 'oBxDolCreatePost'; + $sJsContent = $oTemplate->_wrapInTagJsCode("var " . $sJsObject . " = new BxDolCreatePost(" . json_encode([ + 'sObjName' => $sJsObject, + 'sRootUrl' => BX_DOL_URL_ROOT, + 'sDefault' => $sDefault, + 'iContextId' => $bContext ? $mixedContextId : 0, + 'oPreloadingList' => $aPreloadingList, + 'oCustom' => $aCustom + ]) . ");"); + + return [ + 'title' => $sTitle, + 'content' => $oTemplate->parseHtmlByName('create_post_form.html', [ + 'default' => $sDefault, + 'placeholder' => $sPlaceholder, + 'user_thumb' => $oProfile->getUnit(0, ['template' => 'unit_wo_info_links']), + 'form' => bx_srv($sDefault, 'get_create_post_form', [[ + 'context_id' => $mixedContextId, + 'ajax_mode' => true, + 'absolute_action_url' => true, + 'custom' => $aCustom + ]]), + 'js_object' => $sJsObject, + 'js_content' => $sJsContent + ]), + 'menu' => $oMenu + ]; + } + + public function serviceGetOptionsCreatePostFormPreloadingList() + { + $oMenu = BxDolMenu::getObjectInstance('sys_create_post'); + if(!$oMenu) + return []; + + $aMenuItems = $oMenu->getMenuItems(); + + $aResult = []; + foreach($aMenuItems as $aMenuItem) { + $sModule = !empty($aMenuItem['module']) ? $aMenuItem['module'] : $aMenuItem['name']; + if(!bx_srv('system', 'is_module_enabled', [$sModule])) + continue; + + $aResult[] = [ + 'key' => $sModule, + 'value' => _t('_' . $sModule) + ]; + } + + return $aResult; + } + + public function serviceGetBlockAuthor($sModule, $iContentId = 0) + { + if(!$iContentId && bx_get('id') !== false) + $iContentId = (int)bx_get('id'); + + $sMethodGetAuthor = 'get_author'; + if(!$sModule || !$iContentId || !BxDolRequest::serviceExists($sModule, $sMethodGetAuthor)) + return ''; + + $iAuthor = bx_srv($sModule, $sMethodGetAuthor, [$iContentId]); + if(!$iAuthor) + return ''; + + $oAuthor = BxDolProfile::getInstance($iAuthor); + if(!$oAuthor) + return ''; + + $sModuleAuthor = $oAuthor->getModule(); + $sMethodGetCover = 'entity_cover'; + if(!BxDolRequest::serviceExists($sModuleAuthor, $sMethodGetCover)) + return ''; + + return bx_srv($sModuleAuthor, $sMethodGetCover, [$oAuthor->getContentId(), [ + 'use_as_author' => true, + 'show_text' => false + ]]); + } + + public function serviceGetBlockAskAssistant($aParams = []) + { + $iAssistant = BxDolAI::getAssistantForAskBlock(); + if(!$iAssistant) + return ''; + + return BxDolAIAssistant::getObjectInstance($iAssistant)->getAskBlock($aParams); + } + + public function serviceGetMenu($aParams) + { + $bIsApi = bx_is_api(); + $mixedResulEmpty = $bIsApi ? [] : ''; + + if($bIsApi && is_string($aParams)) + $aParams = bx_api_get_browse_params($aParams); + + if(!isset($aParams['object'])) + return $mixedResulEmpty; + + $oMenu = BxDolMenu::getObjectInstance($aParams['object']); + if(!$oMenu) + return $mixedResulEmpty; + + if(!empty($aParams['params']) && is_array($aParams['params'])) + $oMenu->setContentParams($aParams['params']); + + return $bIsApi ? $oMenu->getCodeAPI() : $oMenu->getCode(); + } + + /** + * @page service Service Calls + * @section bx_system_general System Services + * @subsection bx_system_general-general General + * @subsubsection bx_system_general-get_site_submenu get_site_submenu + * + * @code bx_srv('system', 'get_site_submenu', [], 'TemplServices'); @endcode + * @code {{~system:get_site_submenu:TemplServices[]~}} @endcode + * + * Get Site Submenu code. + * @see BxBaseServices::serviceGetSiteSubmenu + */ + /** + * @ref bx_system_general-get_site_submenu "get_site_submenu" + */ + public function serviceGetSiteSubmenu() + { + $oMenu = BxDolMenu::getObjectInstance('sys_site_submenu'); + return $oMenu ? $oMenu->getCode() : ''; + } + + /** + * @page service Service Calls + * @section bx_system_general System Services + * @subsection bx_system_general-general General + * @subsubsection bx_system_general-get_products_names get_products_names + * + * @code bx_srv('system', 'get_products_names', [], 'TemplServices'); + * + * @code http://example.com/m/oauth2/com/get_products_names?module=system&class=BaseServices @endcode + * @code http://hihi.una.io/modules/?r=oauth2/com/get_products_names&module=system&class=BaseServices @endcode + * + * Get an array of products names from all modules with payments functionality. + * @param $iVendorId filter products by vendor ID. + * @param $iLimit limit number of records from one module. + * @return array of products where key id product name and value is module name + * + * @see BxBaseServices::serviceGetProductsNames + */ + /** + * @ref bx_system_general-get_products_names "get_products_names" + */ + public function serviceGetProductsNames($iVendorId = 0, $iLimit = 1000) + { + $o = BxDolPayments::getInstance(); + if (!$o) + return array(); + return $o->getProductsNames($iVendorId, $iLimit); + } + + /** + * @see iBxDolProfileService::serviceCheckSpacePrivacy + */ + public function serviceCheckSpacePrivacy($iContentId) + { + return _t('_Access denied'); + } + + public function serviceFormsHelper () + { + return new BxTemplAccountForms(); + } + + public function serviceActAsProfile () + { + return false; + } + + public function servicePrepareFields ($aFieldsProfile) + { + return $aFieldsProfile; + } + + public function serviceProfilesSearch ($sTerm, $iLimit) + { + $oDb = BxDolAccountQuery::getInstance(); + $aRet = array(); + $a = $oDb->searchByTerm($sTerm, $iLimit); + foreach ($a as $r) + $aRet[] = array ('label' => $this->serviceProfileName($r['content_id']), 'value' => $r['profile_id']); + return $aRet; + } + + /** + * @page service Service Calls + * @section bx_system_general System Services + * @subsection bx_system_general-general General + * @subsubsection bx_system_general-keyword_search keyword_search + * + * @code bx_srv('system', 'keyword_search', ["bx_posts", ["keyword" => "test"}], 'TemplServices'); @endcode + * + * @code {{~system:keyword_search:TemplServices["bx_posts", {"keyword":"test"}]~}} @endcode + * @code {{~system:keyword_search:TemplServices["bx_albums", {"meta_type": "location_country", "keyword": "AU"}, "unit.html"]~}} @endcode + * @code {{~system:keyword_search:TemplServices["bx_albums", {"meta_type": "location_country_state", "state":"NSW", "keyword": "AU"}, "unit.html"]~}} @endcode + * @code {{~system:keyword_search:TemplServices["bx_albums", {"meta_type": "location_country_city", "state":"NSW", "city":"Manly", "keyword": "AU"}, "unit.html"]~}} @endcode + * @code {{~system:keyword_search:TemplServices["bx_posts", {"meta_type": "mention", "keyword": 2}, "unit_gallery.html"]~}} @endcode + * @code {{~system:keyword_search:TemplServices["bx_posts", {"cat": "bx_posts_cats", "keyword": 3}, "unit_gallery.html"]~}} @endcode + * + * Search by keyword + * @param $sSection - search object to search in, usually module name, for example: bx_posts + * @param $aCondition - condition for search, supported conditions: + * - search by keyword: ["keyword" => "test"] + * - search by country: ["meta_type" => "location_country", "keyword" => "AU"] + * - search by country and state: ["meta_type": "location_country_state", "state":"NSW", "keyword": "AU"] + * - search by country, state and city: ["meta_type": "location_country_city", "state":"NSW", "city":"Manly", "keyword": "AU"] + * - search for mentions: ["meta_type" => "mention", "keyword" => 2] + * - search in category: ["cat": "bx_posts_cats", "keyword": 3] + * @param $sTemplate - template for displaying search results, for example: unit.html + * @param $iStart - paginate, display records starting from this number + * @param $iPerPage - paginate, display this number of records per page + * @param $bLiveSearch - search results like in live search + * + * @see BxBaseServices::serviceKeywordSearch + */ + /** + * @ref bx_system_general-keyword_search "keyword_search" + */ + public function serviceKeywordSearch ($sSection, $aCondition, $sTemplate = '', $iStart = 0, $iPerPage = 0, $bLiveSearch = 0, $bPaginate = false) + { + if (!$sSection || !isset($aCondition['keyword'])) + return ''; + + $sClass = 'BxTemplSearch'; + + $sElsName = 'bx_elasticsearch'; + $sElsMethod = 'is_configured'; + if(BxDolRequest::serviceExists($sElsName, $sElsMethod) && BxDolService::call($sElsName, $sElsMethod)) { + $oModule = BxDolModule::getInstance($sElsName); + + bx_import('Search', $oModule->_aModule); + $sClass = 'BxElsSearch'; + } + + $oSearch = new $sClass(array($sSection)); + $oSearch->setLiveSearch($bLiveSearch); + $oSearch->setMetaType(isset($aCondition['meta_type']) ? $aCondition['meta_type'] : ''); + $oSearch->setCategoryObject(isset($aCondition['cat']) ? $aCondition['cat'] : ''); + $oSearch->setCustomSearchCondition($aCondition); + if (!$bPaginate) + $oSearch->setRawProcessing(true); + $oSearch->setCustomCurrentCondition(array( + 'paginate' => array ( + 'start' => $iStart, + 'perPage' => $iPerPage ? $iPerPage : BX_DOL_SEARCH_RESULTS_PER_PAGE_DEFAULT, + ))); + if ($sTemplate) + $oSearch->setUnitTemplate($sTemplate); + + return $oSearch->response(); + } + + /** + * @page service Service Calls + * @section bx_system_general System Services + * @subsection bx_system_general-general General + * @subsubsection bx_system_general-keyword_search keyword_search + * + * @code bx_srv('system', 'search_keyword_form', 'TemplServices'); @endcode + * + * Block with Search by Keywords Form + * + * @see BxBaseServices::serviceSearchKeywordForm + */ + /** + * @ref bx_system_general-keyword_search "keyword_search" + */ + public function serviceSearchKeywordForm () + { + return $this->_getSearchObject()->getForm(BX_DB_PADDING_DEF, false, true); + } + + /** + * @page service Service Calls + * @section bx_system_general System Services + * @subsection bx_system_general-general General + * @subsubsection bx_system_general-keyword_search keyword_search + * + * @code bx_srv('system', 'search_keyword_result', 'TemplServices'); @endcode + * + * Block with Search by Keywords Results + * + * @see BxBaseServices::serviceSearchKeywordResult + */ + /** + * @ref bx_system_general-keyword_search "keyword_search" + */ + public function serviceSearchKeywordResult () + { + $sKeyword = bx_process_input(bx_get('keyword')); + $bKeyword = $sKeyword !== false; + + if(bx_is_api()) + return $this->serviceGetDataSearchApi(['params' => + [ + 'keyword' => $sKeyword, + 'section' => bx_process_input(bx_get('section')), + 'cat' => bx_process_input(bx_get('cat')) + ] + ]); + + $sCode = ''; + if($bKeyword) { + $oSearch = $this->_getSearchObject(); + + $sCode = $oSearch->response(); + if(!$sCode) + $sCode = $oSearch->getEmptyResult(); + } + + return $sCode; + } + + /** + * @ref bx_system_general-get_date_search_api "get_date_search_api" + * @api @ref bx_system_general-get_date_search_api "get_date_search_api" + */ + public function serviceGetDataSearchApi ($aParams) + { + if(!bx_is_api()) + return false; + + if(is_string($aParams)) + $aParams = json_decode($aParams, true); + + $aSections = []; + $aSectionsAll = BxDolDb::getInstance()->fromCache( + 'sys_global_search_pairs', + 'getPairs', + 'SELECT `ObjectName` AS `name`, `Title` AS `title` FROM `sys_objects_search` WHERE `GlobalSearch`=\'1\' ORDER BY `Order` ASC', + 'name', 'title' + ); + + $aSectionNames = explode(',', getParam('sys_api_search_sections')); + foreach($aSectionNames as $sSectionName) { + if(!isset($aSectionsAll[$sSectionName])) + continue; + + $aSections[$sSectionName] = [ + 'name' => $sSectionName, + 'title' => _t($aSectionsAll[$sSectionName]) + ]; + } + + $aParamsBrowse = array_merge([ + 'keyword' => '', + 'section' => '', + 'sections' => array_values($aSections), + 'start' => 0, + 'per_page' => 12 + ], !empty($aParams['params']) && is_array($aParams['params']) ? $aParams['params'] : []); + + if(empty($aParamsBrowse['section'])) + $aParamsBrowse['section'] = array_keys($aSections); + else if(is_string($aParamsBrowse['section'])) + $aParamsBrowse['section'] = explode(',', $aParamsBrowse['section']); + + $sClass = 'BxTemplSearch'; + $oSearch = new $sClass($aParamsBrowse['section']); + $oSearch->setLiveSearch(true); + $oSearch->setDataProcessing(true); + $oSearch->setCustomSearchCondition(['keyword' => $aParamsBrowse['keyword']]); + $oSearch->setCustomCurrentCondition([ + 'paginate' => [ + 'forceStart' => $aParamsBrowse['start'], + 'perPage' => $aParamsBrowse['per_page'], + ] + ]); + + $aData = $oSearch->response(); + if(count($aData) > $aParamsBrowse['per_page']) + $aData = array_slice($aData, $aParamsBrowse['start'], $aParamsBrowse['per_page']); + + return [ + bx_api_get_block('browse', [ + 'unit' => 'search-results', + 'request_url' => '/api.php?r=system/get_data_search_api/TemplServices¶ms[]=', + 'params' => $aParamsBrowse, + 'data' => $aData + ]) + ]; + } + + /** + * @page service Service Calls + * @section bx_system_general System Services + * @subsection bx_system_general-general General + * @subsubsection bx_system_general-cmts cmts + * + * @code bx_srv('system', 'cmts', ["sys_blocks", 1], 'TemplServices'); @endcode + * + * @code {{~system:cmts:TemplServices["sys_blocks", 1]~}} @endcode + * + * Comments block + * @param $sObject - comments object name + * @param $sId - content id assiciated tith the comments + * + * @see BxBaseServices::serviceCmts + */ + /** + * @ref bx_system_general-cmts "cmts" + */ + public function serviceCmts ($sObject, $sId) + { + $o = BxDolCmts::getObjectInstance($sObject, $sId); + if (!$o || !$o->isEnabled()) + return ''; + return $o->getCommentsBlock(array(), array('in_designbox' => false, 'show_empty' => true)); + } + + public function _serviceProfileFunc ($sFunc, $iContentId, $aParams = array()) + { + if (!$iContentId) + return false; + if (!($oAccount = BxDolAccount::getInstance($iContentId))) + return false; + + return $oAccount->$sFunc(false, $aParams); + } + + public function serviceAlertResponseProcessInstalled() + { + BxDolTranscoderImage::registerHandlersSystem(); + } + + public function serviceAlertResponseProcessStorageChange ($oAlert) + { + if ('sys_storage_default' != $oAlert->aExtras['option']) + return; + + $aStorages = BxDolStorageQuery::getStorageObjects(); + foreach ($aStorages as $r) { + if (0 == $r['current_size'] && 0 == $r['current_number'] && ($oStorage = BxDolStorage::getObjectInstance($r['object']))) + $oStorage->changeStorageEngine($oAlert->aExtras['value']); + } + + } + + public function serviceGetOptionsProfileBot() + { + $aResult = array( + array('key' => '', 'value' => _t('_Select_one')) + ); + + $aAccountsIds = BxDolAccountQuery::getInstance()->getOperators(); + foreach($aAccountsIds as $iAccountId) { + $aProfilesIds = BxDolAccount::getInstance($iAccountId)->getProfilesIds(true, false); + foreach($aProfilesIds as $iProfileId) { + $oProfile = BxDolProfile::getInstance($iProfileId); + $aResult[] = array( + 'key' => $iProfileId, + 'value' => _t('_sys_profile_with_type', $oProfile->getDisplayName(), $oProfile->getModule()), + ); + } + } + + return $aResult; + } + + public function serviceGetOptionsModuleListForPrivacySelector() + { + $aResult = array(); + $BxDolModuleQuery = BxDolModuleQuery::getInstance(); + $aModules = $BxDolModuleQuery->getModulesBy(array('type' => 'modules', 'active' => 1)); + foreach($aModules as $aModule){ + $oModule = BxDolModule::getInstance($aModule['name']); + if($oModule instanceof iBxDolContentInfoService){ + if (!BxDolRequest::serviceExists($aModule['name'], 'act_as_profile')) + continue; + $aResult[$aModule['name']] = $aModule['title']; + } + } + return $aResult; + } + + + public function serviceGetOptionsCaptchaDefault() + { + $aResults = []; + $aObjects = BxDolCaptchaQuery::getObjects(); + foreach($aObjects as $aObject) + $aResults[$aObject['object']] = $aObject['title']; + + return $aResults; + } + + public function serviceGetOptionsEmbedDefault() + { + $aResults = array( + '' => _t('_None') + ); + + $aObjects = BxDolEmbedQuery::getObjects(); + foreach($aObjects as $aObject) + $aResults[$aObject['object']] = $aObject['title']; + + return $aResults; + } + + public function serviceGetOptionsLocationFieldDefault() + { + $aResults = array(); + + $aObjects = BxDolLocationFieldQuery::getObjects(); + foreach($aObjects as $aObject) + $aResults[$aObject['object']] = _t($aObject['title']); + + return $aResults; + } + + public function serviceGetOptionsLocationMapDefault() + { + $aResults = array(); + + $aObjects = BxDolLocationMapQuery::getObjects(); + foreach($aObjects as $aObject) + $aResults[$aObject['object']] = _t($aObject['title']); + + return $aResults; + } + + public function serviceGetOptionsSocketsFieldDefault() + { + $aResults = []; + $aObjects = ['sys_sockets_disabled', 'sys_sockets_soketi']; + foreach($aObjects as $sObject) + $aResults[$sObject] = _t('_adm_stg_cpt_option_sys_sockets_type_' . $sObject); + return $aResults; + } + + public function serviceGetOptionsLocationLeafletGetProviders() + { + return BxDolLocationMapLeaflet::getProviders(); + } + + public function serviceGetOptionsRelations() + { + $aModules = BxDolModuleQuery::getInstance()->getModulesBy(array('type' => 'modules', 'active' => 1)); + + $aProfiles = array(); + foreach($aModules as $aModule) { + $sMethod = 'act_as_profile'; + if(!BxDolRequest::serviceExists($aModule['name'], $sMethod) || !BxDolService::call($aModule['name'], $sMethod)) + continue; + + $aProfiles[$aModule['name']] = _t('_' . $aModule['name']); + } + + $aResults = array(); + foreach($aProfiles as $sName1 => $sTitle1) + foreach($aProfiles as $sName2 => $sTitle2) + $aResults[$sName1 . '_' . $sName2] = $sTitle1 . ' - ' . $sTitle2; + + return $aResults; + } + + public function serviceGetOptionsCfProhibited() + { + return BxDolFormQuery::getDataItems('sys_content_filter'); + } + + public function serviceGetOptionsCfUnauthenticated() + { + return BxDolFormQuery::getDataItems('sys_content_filter'); + } + + public function serviceGetOptionsTaiwindDefault() + { + $sPath = BX_DIRECTORY_PATH_PLUGINS_PUBLIC . 'tailwind/css'; + $aExcludes = ['.', '..', 'tailwind.css']; + + $aResults = []; + if(($oHandle = opendir($sPath)) !== false) { + while(($sFile = readdir($oHandle)) !== false) { + if(in_array($sFile, $aExcludes)) + continue; + + if(($oHandlerFile = fopen($sPath . '/' . $sFile, 'r')) === false) + continue; + + if(($sContent = fread($oHandlerFile, 1024)) !== false && strpos($sContent, '@tailwind base') === false) + $aResults[$sFile] = $sFile; + + fclose($oHandlerFile); + } + + closedir($oHandle); + } + + return $aResults; + } + + public function serviceGetOptionsApiMenuTop() + { + $aMenus = BxDolMenuQuery::getMenuObjects(); + + $aResults = ['' => _t('_sys_please_select')]; + foreach($aMenus as $aMenu) + if($aMenu['module'] == 'system') + $aResults[$aMenu['object']] = _t($aMenu['title']); + + return $aResults; + } + + public function serviceGetOptionsAgentsModel() + { + return ['' => _t('_Select_one')] + BxDolAI::getInstance()->getModels(['active' => true, 'hidden' => false]); + } + + public function serviceGetOptionsAgentsProfile($bSelectOne = true) + { + $aResult = []; + if($bSelectOne) + $aResult[] = ['key' => '', 'value' => _t('_Select_one')]; + + $aAccountsIds = BxDolAccountQuery::getInstance()->getOperators(); + foreach($aAccountsIds as $iAccountId) { + $aProfilesIds = BxDolAccount::getInstance($iAccountId)->getProfilesIds(true, false); + foreach($aProfilesIds as $iProfileId) + if(($oProfile = BxDolProfile::getInstance($iProfileId)) !== false && ($sProfileModule = $oProfile->getModule()) != 'system') + $aResult[] = [ + 'key' => $iProfileId, + 'value' => _t('_sys_profile_with_type', $oProfile->getDisplayName(), _t('_' . $sProfileModule)) + ]; + } + + return $aResult; + } + + public function serviceGetOptionsStudioAssistant() + { + return ['' => _t('_Select_one')] + BxDolAI::getInstance()->getAssistants(['active' => true, 'hidden' => false]); + } + + public function serviceGetOptionsLiveSearchAssistant() + { + return ['' => _t('_Select_one')] + BxDolAI::getInstance()->getAssistants(['active' => true, 'hidden' => false]); + } + + public function serviceGetOptionsAskBlockAssistant() + { + return ['' => _t('_Select_one')] + BxDolAI::getInstance()->getAssistants(['active' => true, 'hidden' => false]); + } + + public function serviceRedirect($sUrl = false) + { + if (!getParam('sys_confirmation_before_redirect')) { + BxDolTemplate::getInstance()->displayPageNotFound(); + exit; + } + + if (false === $sUrl) + $sUrl = bx_get('url'); + + if (!$sUrl || !preg_match('@^https?://@', $sUrl)) { + http_response_code(500); + return MsgBox(_t('_error occured')); + } + else { + + $bSpam = null; + /** + * @hooks + * @hookdef hook-system-check_spam_url 'system', 'check_spam_url' - hook to override sClass for search + * - $unit_name - equals `system` + * - $action - equals `check_spam_url` + * - $object_id - not used + * - $sender_id - logged account id + * - $extra_params - array of additional params with the following array keys: + * - `is_spam` - [bool] by ref, spam url or not, can be overridden in hook processing + * - `content` - [string] by ref, url of link, can be overridden in hook processing + * - `where` - [string] equal redirect + * @hook @ref hook-system-check_spam_url + */ + bx_alert('system', 'check_spam_url', 0, getLoggedId(), array('is_spam' => &$bSpam, 'content' => &$sUrl, 'where' => 'redirect')); + + $sLangKey = $bSpam ? '_sys_redirect_confirmation_harmful' : '_sys_redirect_confirmation'; + return BxDolTemplate::getInstance()->parseHtmlByName('redirect.html', [ + 'text' => _t($sLangKey, bx_process_output($sUrl), getParam('site_title')), + 'url' => bx_js_string($sUrl, BX_ESCAPE_STR_APOS), + ]); + } + } + + public function serviceGetBadge($aBadge, $bIsCompact = false) + { + $sClass = ''; + $sStyleFont = ''; + $sStyleBg = ''; + if ($aBadge['color'] == '') + $aBadge['color'] = 'purple-600'; + + if ($bIsCompact && $aBadge['icon'] != ''){ + $aBadge['is_icon_only'] = 1; + } + if ($aBadge['is_icon_only'] == 1){ + $sClass .= ' bx-badge-compact'; + if (substr_count($aBadge['color'], 'rgb(')) + $sStyleFont = 'color: ' . $aBadge['color']; + else + $sClass .= ' text-' . $aBadge['color']; + } + else{ + if (substr_count($aBadge['color'], 'rgb(')) + $sStyleBg = 'background-color: ' . $aBadge['color']; + else + $sClass .= ' bg-' . $aBadge['color']; + } + + return BxDolTemplate::getInstance()->parseHtmlByName('badge.html', array( + 'bx_if:content' => array( + 'condition' => $aBadge['is_icon_only'] != '1', + 'content' => array('content' => _t($aBadge['text'])), + ), + 'bx_if:icon' => array( + 'condition' => $aBadge['icon'] != '', + 'content' => array('content' => BxDolTemplate::getInstance()->getIcon($aBadge['icon'], array('class' => 'bx-badge-icon sys-colored', 'style' => $sStyleFont))), + ), + 'title' => $aBadge['text'], + 'style_font' => $sStyleFont, + 'style_bg' => $sStyleBg, + 'class' => $sClass, + ) + ); + } + + public function serviceGetFooter() + { + return BxDolTemplate::getInstance()->parseHtmlByName('footer.html', []); + } + + private function _getSearchObject() + { + $sClass = 'BxTemplSearch'; + $sElsName = 'bx_elasticsearch'; + $sElsMethod = 'is_configured'; + if(BxDolRequest::serviceExists($sElsName, $sElsMethod) && BxDolService::call($sElsName, $sElsMethod) && !bx_get('cat') && !bx_get('type')) { + $oModule = BxDolModule::getInstance($sElsName); + bx_import('Search', $oModule->_aModule); + $sClass = 'BxElsSearch'; + } + /** + * @hooks + * @hookdef hook-system-search_keyword 'system', 'search_keyword' - hook to override sClass for search + * - $unit_name - equals `system` + * - $action - equals `search_keyword` + * - $object_id - not used + * - $sender_id - not used + * - $extra_params - array of additional params with the following array keys: + * - `override_result` - [string] by ref, class name for search, can be overridden in hook processing + * @hook @ref hook-system-search_keyword + */ + bx_alert('system', 'search_keyword', 0, 0, array('class' => &$sClass)); + + $oSearch = new $sClass(bx_get('section')); + $oSearch->setLiveSearch(bx_get('live_search') ? 1 : 0); + $oSearch->setMetaType(bx_process_input(bx_get('type'))); + $oSearch->setCategoryObject(bx_process_input(bx_get('cat'))); + + return $oSearch; + } +} + +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/search_extended_results.html b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/search_extended_results.html new file mode 100644 index 0000000000..b22cb85e12 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/search_extended_results.html @@ -0,0 +1,7 @@ + + __sort__ + __code__ + + __paginate__ + + \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/uploader_button_html5_js.html b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/uploader_button_html5_js.html new file mode 100644 index 0000000000..60fd4b0a8e --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/uploader_button_html5_js.html @@ -0,0 +1,23 @@ +__uploader_instance_name__ = new BxDolUploaderHTML5('__engine__', '__storage_object__', '__uniq_id__', { + 'multiple': __multiple__, + 'latest': __latest__, + 'content_id': '__content_id__', + 'images_transcoder' : '__images_transcoder__', + 'storage_private' : '__storage_private__', + 'template_error_msg': '{error}', + 'template_ghost': __template_ghost__, + 'reordering': __is_init_reordering__, + 'maxFilesize': __max_file_size__/1024.0/1024.0, + 'acceptedFiles': __accepted_files__, + 'resizeWidth': __resize_width__, + 'resizeHeight': __resize_height__, + 'resizeMethod': __resize_method__, + 'dictDefaultMessage': '', + 'dictFileTooBig': '', + 'dictMaxFilesExceeded': '', + 'dictInvalidFileType': '', + 'on_upload_before': __on_upload_before__, + 'on_upload': __on_upload__, + 'on_restore_ghosts': __on_restore_ghosts__ +}); +__uploader_instance_name__.restoreGhosts(__is_init_reordering__); \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/vote_counter_label_likes.html b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/vote_counter_label_likes.html new file mode 100644 index 0000000000..7353b21035 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/vote_counter_label_likes.html @@ -0,0 +1,8 @@ + + + __icon__ + + + __text__ + + \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/vote_counter_label_reactions.html b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/vote_counter_label_reactions.html new file mode 100644 index 0000000000..c54f718d4f --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/vote_counter_label_reactions.html @@ -0,0 +1,16 @@ + + + + + + + + __emoji__ + + __image__ + + + + __text__ + + \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/vote_counter_wrapper_reactions.html b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/vote_counter_wrapper_reactions.html new file mode 100644 index 0000000000..86d25031fb --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/vote_counter_wrapper_reactions.html @@ -0,0 +1,9 @@ + + + __counter__ + + __counter__ + + __script__ + + \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/script.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/script.php index 5987147399..20b8665a97 100644 --- a/upgrade/files/14.0.0.B2-14.0.0.RC1/script.php +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/script.php @@ -3,6 +3,9 @@ if (!$this->oDb->isFieldExists('sys_options', 'info')) $this->oDb->query("ALTER TABLE `sys_options` ADD `info` varchar(255) NOT NULL default '' AFTER `caption`"); + $aPathInfo = pathinfo(__FILE__); + $this->oDb->executeSQL($aPathInfo['dirname'] . '/sql_update_info.sql'); + if (!$this->oDb->isFieldExists('sys_agents_models', 'for_asst')) $this->oDb->query("ALTER TABLE `sys_agents_models` ADD `for_asst` tinyint(4) NOT NULL DEFAULT '0' AFTER `params`"); diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/sql.sql b/upgrade/files/14.0.0.B2-14.0.0.RC1/sql.sql index 732b57f7bc..adbc12e50b 100644 --- a/upgrade/files/14.0.0.B2-14.0.0.RC1/sql.sql +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/sql.sql @@ -10,27 +10,6 @@ INSERT INTO `sys_objects_cmts` (`Name`, `Module`, `Table`, `CharsPostMin`, `Char -- Options -SET @iCategoryId = (SELECT `id` FROM `sys_options_categories` WHERE `name` = 'hidden'); - -INSERT IGNORE INTO `sys_options`(`category_id`, `name`, `caption`, `value`, `type`, `extra`, `check`, `check_params`, `check_error`, `order`) VALUES -(@iCategoryId, 'sys_embed_microlink_key', '_adm_stg_cpt_option_sys_embed_microlink_key', '', 'digit', '', '', '', '', 300); - -UPDATE `sys_options` SET `info` = '_adm_stg_inf_option_site_title' WHERE `name` = 'site_title'; -UPDATE `sys_options` SET `info` = '_adm_stg_inf_option_site_email' WHERE `name` = 'site_email'; -UPDATE `sys_options` SET `info` = '_adm_stg_inf_option_site_email_notify' WHERE `name` = 'site_email_notify'; -UPDATE `sys_options` SET `info` = '_adm_stg_inf_option_site_tour_home' WHERE `name` = 'site_tour_home'; -UPDATE `sys_options` SET `info` = '_adm_stg_inf_option_site_tour_studio' WHERE `name` = 'site_tour_studio'; -UPDATE `sys_options` SET `info` = '_adm_stg_inf_option_sys_autoupdate' WHERE `name` = 'sys_autoupdate'; -UPDATE `sys_options` SET `info` = '_adm_stg_inf_option_sys_autoupdate_force_modified_files' WHERE `name` = 'sys_autoupdate_force_modified_files'; -UPDATE `sys_options` SET `info` = '_adm_stg_inf_option_smart_app_banner' WHERE `name` = 'smart_app_banner'; -UPDATE `sys_options` SET `info` = '_adm_stg_inf_option_smart_app_banner_ios_app_id' WHERE `name` = 'smart_app_banner_ios_app_id'; -UPDATE `sys_options` SET `info` = '_adm_stg_inf_option_sys_per_page_search_keyword_single' WHERE `name` = 'sys_per_page_search_keyword_single'; -UPDATE `sys_options` SET `info` = '_adm_stg_inf_option_sys_per_page_search_keyword_plural' WHERE `name` = 'sys_per_page_search_keyword_plural'; -UPDATE `sys_options` SET `info` = '_adm_stg_inf_option_sys_live_search_limit' WHERE `name` = 'sys_live_search_limit'; -UPDATE `sys_options` SET `info` = '_adm_stg_inf_option_sys_profiles_search_limit' WHERE `name` = 'sys_profiles_search_limit'; -UPDATE `sys_options` SET `info` = '_adm_stg_inf_option_sys_profile_bot' WHERE `name` = 'sys_profile_bot'; -UPDATE `sys_options` SET `info` = '_adm_stg_inf_option_sys_create_post_form_preloading_list' WHERE `name` = 'sys_create_post_form_preloading_list'; - SET @iCategoryId = (SELECT `id` FROM `sys_options_categories` WHERE `name` = 'storage'); INSERT IGNORE INTO `sys_options`(`category_id`, `name`, `caption`, `value`, `type`, `extra`, `check`, `check_error`, `order`) VALUES diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/sql_update_info.sql b/upgrade/files/14.0.0.B2-14.0.0.RC1/sql_update_info.sql new file mode 100644 index 0000000000..ba5f5b118a --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/sql_update_info.sql @@ -0,0 +1,22 @@ + +SET @iCategoryId = (SELECT `id` FROM `sys_options_categories` WHERE `name` = 'hidden'); + +INSERT IGNORE INTO `sys_options`(`category_id`, `name`, `caption`, `value`, `type`, `extra`, `check`, `check_params`, `check_error`, `order`) VALUES +(@iCategoryId, 'sys_embed_microlink_key', '_adm_stg_cpt_option_sys_embed_microlink_key', '', 'digit', '', '', '', '', 300); + +UPDATE `sys_options` SET `info` = '_adm_stg_inf_option_site_title' WHERE `name` = 'site_title'; +UPDATE `sys_options` SET `info` = '_adm_stg_inf_option_site_email' WHERE `name` = 'site_email'; +UPDATE `sys_options` SET `info` = '_adm_stg_inf_option_site_email_notify' WHERE `name` = 'site_email_notify'; +UPDATE `sys_options` SET `info` = '_adm_stg_inf_option_site_tour_home' WHERE `name` = 'site_tour_home'; +UPDATE `sys_options` SET `info` = '_adm_stg_inf_option_site_tour_studio' WHERE `name` = 'site_tour_studio'; +UPDATE `sys_options` SET `info` = '_adm_stg_inf_option_sys_autoupdate' WHERE `name` = 'sys_autoupdate'; +UPDATE `sys_options` SET `info` = '_adm_stg_inf_option_sys_autoupdate_force_modified_files' WHERE `name` = 'sys_autoupdate_force_modified_files'; +UPDATE `sys_options` SET `info` = '_adm_stg_inf_option_smart_app_banner' WHERE `name` = 'smart_app_banner'; +UPDATE `sys_options` SET `info` = '_adm_stg_inf_option_smart_app_banner_ios_app_id' WHERE `name` = 'smart_app_banner_ios_app_id'; +UPDATE `sys_options` SET `info` = '_adm_stg_inf_option_sys_per_page_search_keyword_single' WHERE `name` = 'sys_per_page_search_keyword_single'; +UPDATE `sys_options` SET `info` = '_adm_stg_inf_option_sys_per_page_search_keyword_plural' WHERE `name` = 'sys_per_page_search_keyword_plural'; +UPDATE `sys_options` SET `info` = '_adm_stg_inf_option_sys_live_search_limit' WHERE `name` = 'sys_live_search_limit'; +UPDATE `sys_options` SET `info` = '_adm_stg_inf_option_sys_profiles_search_limit' WHERE `name` = 'sys_profiles_search_limit'; +UPDATE `sys_options` SET `info` = '_adm_stg_inf_option_sys_profile_bot' WHERE `name` = 'sys_profile_bot'; +UPDATE `sys_options` SET `info` = '_adm_stg_inf_option_sys_create_post_form_preloading_list' WHERE `name` = 'sys_create_post_form_preloading_list'; +
)___(.*?)___(<\/code>)/s", + function ($aMatches) use (&$aCode) { + $sCode = isset($aCode[$aMatches[2]]) ? $aCode[$aMatches[2]] : 'n/a'; + return $aMatches[1] . $sCode . $aMatches[3]; + }, + $s); + + return $s; +} + +/* + * This function apply bx_process_input and then bx_process_output. + * Use this function to output data immediately after receiving, without saving to database. + * Patams are the same as bx_process_input function - @see bx_process_input + */ +function bx_process_pass ($mixedData, $iDataType = BX_DATA_TEXT, $mixedParams = false, $isCheckMagicQuotes = true) +{ + return bx_process_output(bx_process_input ($mixedData, $iDataType, $mixedParams, $isCheckMagicQuotes), $iDataType, $mixedParams); +} + +/** + * DEPRECATED + * use bx_process_input + bx_process_output instead + * -------- + * function for processing pass data + * + * This function cleans the GET/POST/COOKIE data if magic_quotes_gpc() is on + * for data which should be outputed immediately after submit + */ +/* +function process_pass_data( $text, $strip_tags = 0 ) +{ + if ( $strip_tags ) + $text = strip_tags($text); + if ( !get_magic_quotes_gpc() ) + return $text; + else + return stripslashes($text); +} +*/ + +/* + * function for output data from database into html + */ +function htmlspecialchars_adv( $string ) +{ + return htmlspecialchars($string, ENT_COMPAT, 'UTF-8', false); +} + +/** + * Send mail to user by parsing email template + */ +function sendMailTemplate($sTemplateName, $iAccountId = 0, $iProfileId = 0, $aReplaceVars = array(), $iEmailType = BX_EMAIL_NOTIFY, $bAddToQueue = false) +{ + $oProfile = $iProfileId ? BxDolProfile::getInstance($iProfileId) : null; + + $oAccount = $iAccountId ? BxDolAccount::getInstance($iAccountId) : ($oProfile ? $oProfile->getAccountObject() : null); + + $oEmailTemplates = BxDolEmailTemplates::getInstance(); + + if (!($oAccount || $oProfile) || !$oEmailTemplates) + return false; + + $aTemplate = $oEmailTemplates->parseTemplate($sTemplateName, $aReplaceVars, $oAccount ? $oAccount->id() : 0, (int)$iProfileId); + if (!$aTemplate) + return false; + + return sendMail($oAccount->getEmail(), $aTemplate['Subject'], $aTemplate['Body'], 0, array(), $iEmailType, 'html', false, array(), $bAddToQueue); +} + +/** + * Send system email + */ +function sendMailTemplateSystem($sTemplateName, $aReplaceVars = array(), $iEmailType = BX_EMAIL_SYSTEM, $bAddToQueue = false) +{ + $oEmailTemplates = BxDolEmailTemplates::getInstance(); + + if (!$oEmailTemplates) + return false; + + $aTemplate = $oEmailTemplates->parseTemplate($sTemplateName, $aReplaceVars); + if (!$aTemplate) + return false; + + return sendMail(getParam('site_email'), $aTemplate['Subject'], $aTemplate['Body'], 0, array(), $iEmailType, 'html', false, array(), $bAddToQueue); +} +/** + * Send email function + * + * @param $mRecipientEmails - Email where email should be send, can be array, string with one email or comma separated + * @param $sMailSubject - subject of the message + * @param $sMailBody - Body of the message + * @param $iRecipientID - ID of recipient profile + * @param $aPlus - Array of additional information + * @param $iEmailType - email message type: BX_EMAIL_SYSTEM, BX_EMAIL_NOTIFY or BX_EMAIL_MASS + * @param $sEmailFlag - use 'html' for HTML email message + * @param $isDisableAlert - disable alert + * @param $aCustomHeaders - custom email headers + * @param $bAddToQueue - add message to email queue + * @return true if message was send or false otherwise + */ +function sendMail($mRecipientEmails, $sMailSubject, $sMailBody, $iRecipientID = 0, $aPlus = array(), $iEmailType = BX_EMAIL_NOTIFY, $sEmailFlag = 'html', $isDisableAlert = false, $aCustomHeaders = array(), $bAddToQueue = false) +{ + if (is_string($mRecipientEmails)){ + if(strpos($mRecipientEmails, ',') !== false){ + $mRecipientEmails = explode(',', $mRecipientEmails); + } + else{ + return _sendMail($mRecipientEmails, $sMailSubject, $sMailBody, $iRecipientID, $aPlus, $iEmailType, $sEmailFlag, $isDisableAlert, $aCustomHeaders, $bAddToQueue); + } + } + + if (is_array($mRecipientEmails)) { + $bReturn = false; + foreach($mRecipientEmails as $sRecipientEmail) { + $sRecipientEmail = trim($sRecipientEmail); + if (_sendMail($sRecipientEmail, $sMailSubject, $sMailBody, $iRecipientID, $aPlus, $iEmailType, $sEmailFlag, $isDisableAlert, $aCustomHeaders, $bAddToQueue)) + $bReturn = true; + } + return $bReturn; + } +} + +function _sendMail($sRecipientEmail, $sMailSubject, $sMailBody, $iRecipientID = 0, $aPlus = array(), $iEmailType = BX_EMAIL_NOTIFY, $sEmailFlag = 'html', $isDisableAlert = false, $aCustomHeaders = array(), $bAddToQueue = false) +{ + // make sure that recipient's email is valid and message isn't empty + if (!$sMailBody || !$sRecipientEmail || preg_match('/\(2\)$/', $sRecipientEmail)) + return false; + + // get recipient account + $oAccount = !$isDisableAlert ? BxDolAccount::getInstance($sRecipientEmail) : null; + $aAccountInfo = $oAccount ? $oAccount->getInfo() : false; + + // don't send bulk emails if user didn't subscribed to site news or email is unconfirmed + if ($aAccountInfo && BX_EMAIL_MASS == $iEmailType && (!$aAccountInfo['email_confirmed'] || !$aAccountInfo['receive_news'])) + return false; + + // don't send email notifications if user didn't subscribed to notifications or email is unconfirmed + if ($aAccountInfo && BX_EMAIL_NOTIFY == $iEmailType && (!$aAccountInfo['email_confirmed'] || !$aAccountInfo['receive_updates'])) + return false; + + // decode HTML entities in the subj + $sMailSubject = html_entity_decode($sMailSubject, ENT_QUOTES | ENT_SUBSTITUTE | ENT_HTML401, 'UTF-8'); + + if($bAddToQueue && BxDolQueueEmail::getInstance()->add($sRecipientEmail, $sMailSubject, $sMailBody, $iRecipientID, $aPlus, $iEmailType, $sEmailFlag, $isDisableAlert, $aCustomHeaders)) + return true; + + // if profile id is provided - get profile's info + $aRecipientInfo = false; + if ($iRecipientID) { + $oProfile = BxDolProfile::getInstance($iRecipientID); + if ($oProfile) + $aRecipientInfo = $oProfile->getInfo(); + } + + // get site vars + $sEmailNotify = !$isDisableAlert ? getParam('site_email_notify') : $sRecipientEmail; + $sSiteTitle = !$isDisableAlert ? getParam('site_title') : 'UNA ' . BX_DOL_VERSION; + + // add unsubscribe link + if (!$isDisableAlert && empty($aPlus['unsubscribe'])) { + $aPlus['unsubscribe'] = ''; + if ($oAccount && (BX_EMAIL_MASS == $iEmailType || BX_EMAIL_NOTIFY == $iEmailType)) + $aPlus['unsubscribe'] = ($sLink = $oAccount->getUnsubscribeLink($iEmailType)) ? '' . _t('_sys_et_txt_unsubscribe') . '' : ''; + } + + // parse template + if ($aPlus || $iRecipientID || $oAccount) { + if(!is_array($aPlus)) + $aPlus = []; + + $oEmailTemplates = BxDolEmailTemplates::getInstance(); + $sMailSubject = $oEmailTemplates->parseContent($sMailSubject, $aPlus, !$iRecipientID && $oAccount ? $oAccount->id() : 0, $iRecipientID); + $sMailBody = $oEmailTemplates->parseContent($sMailBody, $aPlus, !$iRecipientID && $oAccount ? $oAccount->id() : 0, $iRecipientID); + } + + if(($sRootUrl = getParam('sys_api_url_root_email')) !== '') { + if(substr(BX_DOL_URL_ROOT, -1) == '/' && substr($sRootUrl, -1) != '/') + $sRootUrl .= '/'; + + $sMailBody = str_replace(BX_DOL_URL_ROOT, $sRootUrl, $sMailBody); + + // restore URLs in images + $sMailBody = str_replace([ + 'src="' . $sRootUrl, + "src='" . $sRootUrl + ], [ + 'src="' . BX_DOL_URL_ROOT, + "src='" . BX_DOL_URL_ROOT + ], $sMailBody); + } + + // email message headers + $sMailHeader = ''; + foreach ($aCustomHeaders as $sHeaderName => $sHeaderValue) + $sMailHeader = "$sHeaderName: $sHeaderValue\r\n" . $sMailHeader; + + if (!isset($aCustomHeaders['From'])) + $sMailHeader = "From: =?UTF-8?B?" . base64_encode( $sSiteTitle ) . "?= <{$sEmailNotify}>"; + + if (!isset($aCustomHeaders['MIME-Version'])) + $sMailHeader = "MIME-Version: 1.0\r\n" . $sMailHeader; + + $sMailParameters = isset($aCustomHeaders['Sender']) ? "-f{$aCustomHeaders['Sender']}" : "-f{$sEmailNotify}"; + + if (isset($aCustomHeaders['Subject'])) + $sMailSubject = $aCustomHeaders['Subject']; + + // build data for alert handler + $bResult = null; + $aAlert = array( + 'email' => $sRecipientEmail, + 'subject' => $sMailSubject, + 'body' => $sMailBody, + 'header' => $sMailHeader, + 'params' => $sMailParameters, + 'recipient' => $aRecipientInfo, + 'email_type' => $iEmailType, + 'html' => 'html' == $sEmailFlag ? true : false, + 'custom_headers' => $aCustomHeaders, + 'override_result' => &$bResult, + ); + + /** + * @hooks + * @hookdef hook-system-check_send_mail 'system', 'check_send_mail' - hook for disabling mail sending + * - $unit_name - equals `system` + * - $action - equals `check_send_mail` + * - $object_id - recipient profile id + * - $sender_id - not used + * - $extra_params - array of additional params with the following array keys: + * - `email` - [string] recipient email + * - `subject` - [string] email subject + * - `body` - [string] email body + * - `header` - [string] email headers, headers are separated with double new line character + * - `params` - [string] parameters for php mail function + * - `recipient` - [array] recipient info array + * - `email_type` - [int] email type, one of the following BX_EMAIL_SYSTEM, BX_EMAIL_NOTIFY, BX_EMAIL_MASS + * - `html` - [boolean] `true` if email content is HTML, if `false` then email content is text + * - `custom_headers` - [array] custom email headers array as key&value pairs + * - `override_result` - [boolean] override result of `sendMail` function, if `true` then mail sending should continue as usual, if `false` then mail sending should stop + * @hook @ref hook-system-check_send_mail + */ + bx_alert('system', 'check_send_mail', (isset($aRecipientInfo['ID']) ? $aRecipientInfo['ID'] : 0), '', $aAlert); + + if ($bResult !== null) + return $bResult; + + // system alert + if (!$isDisableAlert) { + /** + * @hooks + * @hookdef hook-system-before_send_mail 'system', 'before_send_mail' - hook before mail sending + * It's equivalent to @ref hook-system-check_send_mail + * @hook @ref hook-system-before_send_mail + */ + bx_alert('system', 'before_send_mail', (isset($aRecipientInfo['ID']) ? $aRecipientInfo['ID'] : 0), '', $aAlert); + if ($bResult !== null) + return $bResult; + unset($aAlert['override_result']); + } + + // prepare HTML/Plain message + if($sEmailFlag == 'html') + $sMailHeader = "Content-type: text/html; charset=UTF-8\r\n" . $sMailHeader; + else { + $sMailHeader = "Content-type: text/plain; charset=UTF-8\r\n" . $sMailHeader; + $sMailBody = html2txt($sMailBody); + } + + // encode subject + if (0 !== strncasecmp($sMailSubject, '=?UTF-8?B?', 10)) + $sMailSubject = '=?UTF-8?B?' . base64_encode($sMailSubject) . '?='; + + // send mail or put it into queue + $bResult = mail($sRecipientEmail, $sMailSubject, $sMailBody, $sMailHeader, $sMailParameters); + + // system alert + if (!$isDisableAlert) { + /** + * @hooks + * @hookdef hook-system-send_mail 'system', 'send_mail' - hook when mail was sent + * It's equivalent to @ref hook-system-check_send_mail + * except `override_result` parameter in $extra_params is missing + * @hook @ref hook-system-send_mail + */ + bx_alert('system', 'send_mail', (isset($aRecipientInfo['ID']) ? $aRecipientInfo['ID'] : 0), '', $aAlert); + } + + return $bResult; +} + +/* + * Getting an array with Templates' Names + */ +function get_templates_array($bEnabledOnly = true, $bShortInfo = true) +{ + $oDb = BxDolDb::getInstance(); + + $sWhereAddon = $bEnabledOnly ? " AND `enabled`='1'" : ""; + + if($bShortInfo) + return $oDb->getPairs("SELECT `uri`, `title` FROM `sys_modules` WHERE 1 AND `type`='" . BX_DOL_MODULE_TYPE_TEMPLATE . "'" . $sWhereAddon, "uri", "title"); + else + return $oDb->getAllWithKey("SELECT * FROM `sys_modules` WHERE 1 AND `type`='" . BX_DOL_MODULE_TYPE_TEMPLATE . "'" . $sWhereAddon, "uri"); +} + +function bx_get_image_exif_and_size($oStorage, $oTranscoder, $iContentId){ + $sData = ''; + $sExif = ''; + $aExif = false; + $aPhoto = $oStorage->getFile($iContentId); + if ($oTranscoder->isMimeTypeSupported($aPhoto['mime_type'])) { + $oImageReize = BxDolImageResize::getInstance(); + + $a = $oImageReize->getImageSize($oTranscoder->getFileUrl($iContentId)); + $sData = isset($a['w']) && isset($a['h']) ? $a['w'] . 'x' . $a['h'] : ''; + + if ($aExif = $oImageReize->getExifInfo($oStorage->getFileUrlById($iContentId))) { + $a = array('Make', 'Model', 'FocalLength', 'ShutterSpeedValue', 'ExposureTime', 'ISOSpeedRatings', 'Orientation', 'Artist', 'Copyright', 'Flash', 'WhiteBalance', 'DateTimeOriginal', 'DateTimeDigitized', 'ExifVersion', 'COMPUTED', 'GPSLatitudeRef', 'GPSLatitude', 'GPSLongitudeRef', 'GPSLongitude', 'GPSAltitudeRef', 'GPSAltitude', 'GPSTimeStamp', 'GPSImgDirectionRef', 'GPSImgDirection', 'GPSDateStamp'); + $aExifFiltered = array(); + foreach ($a as $sIndex) + if (isset($aExif[$sIndex])) + $aExifFiltered[$sIndex] = $aExif[$sIndex]; + $sExif = serialize($aExifFiltered); + } + } + return array('exif' => $sExif, 'size' => $sData); +} + +function bx_get_svg_image_size($sUrl) +{ + $iWidth = $iHeight = 0; + + $sContent = bx_file_get_contents($sUrl); + if(empty($sContent)) + return [$iWidth, $iHeight]; + + $aAttributes = BxDolXmlParser::getInstance()->getAttributes($sContent, 'SVG', 0); + if(isset($aAttributes['VIEWBOX'])) { + $aViewBox = explode(' ', $aAttributes['VIEWBOX']); + if(!empty($aViewBox) && is_array($aViewBox) && count($aViewBox) == 4) { + $iWidth = (float)$aViewBox[2]; + $iHeight = (float)$aViewBox[3]; + } + } + + if(!$iWidth && isset($aAttributes['WIDTH'])) + $iWidth = $this->_str2px($aAttributes['WIDTH']); + + if(!$iHeight && isset($aAttributes['HEIGHT'])) + $iHeight = $this->_str2px($aAttributes['HEIGHT']); + + return [$iWidth, $iHeight]; +} + +function extFileExists( $sFileSrc ) +{ + return (file_exists( $sFileSrc ) && is_file( $sFileSrc )) ? true : false; +} + +function getVisitorIP() +{ + $ip = "0.0.0.0"; + if (isset($_SERVER['HTTP_X_FORWARDED_FOR']) && !empty($_SERVER['HTTP_X_FORWARDED_FOR'])) { + $ip = $_SERVER['HTTP_X_FORWARDED_FOR']; + } elseif (isset( $_SERVER['HTTP_CLIENT_IP']) && !empty($_SERVER['HTTP_CLIENT_IP'])) { + $ip = explode(".",$_SERVER['HTTP_CLIENT_IP']); + $ip = $ip[3].".".$ip[2].".".$ip[1].".".$ip[0]; + } elseif (!isset( $_SERVER['HTTP_X_FORWARDED_FOR']) || empty($_SERVER['HTTP_X_FORWARDED_FOR'])) { + if (!isset( $_SERVER['HTTP_CLIENT_IP']) && empty($_SERVER['HTTP_CLIENT_IP']) && isset($_SERVER['REMOTE_ADDR'])) + $ip = $_SERVER['REMOTE_ADDR']; + } + return $ip; +} + +function genFlag($sLang = '', $oTemplate = null) +{ + if (!$oTemplate) + $oTemplate = BxDolTemplate::getInstance(); + $oTemplate->addCss(BX_DIRECTORY_PATH_PLUGINS_PUBLIC . 'flag-icon-css/css/|flag-icon.min.css'); + $sFlag = BxDolLanguages::getInstance()->getLangFlag($sLang); + return ''; +} + +// print debug information ( e.g. arrays ) +function echoDbg( $what, $desc = '' ) +{ + if ( $desc ) + echo "$desc: "; + echo ""; + print_r( $what ); + echo "\n"; +} + +function echoDbgLog($mWhat, $sDesc = 'unused', $sFileName = 'unused') +{ + bx_log('sys_debug', $mWhat); +} + +function bx_is_dbg() +{ + return (defined('BX_DBG_COOKIE') && !empty($_COOKIE[BX_DBG_COOKIE])) || (defined('BX_DBG_PROFILES') && in_array(bx_get_logged_profile_id(), BX_DBG_PROFILES)); +} + +function dbgTiming($sStartMicrotime) +{ + $i1 = explode(' ', microtime ()); + $i2 = explode(' ', $sStartMicrotime); + $iTime = ($i1[0]+$i1[1]) - ($i2[0]+$i2[1]); + return round($iTime, 6) . ' sec'; +} + +function echoJson($a) +{ + header('Content-Type: application/json; charset=utf-8'); + + echo json_encode($a); +} + +function clear_xss($val) +{ + // HTML Purifier plugin + global $oHtmlPurifier; + if (!isset($oHtmlPurifier) && !$GLOBALS['logged']['admin']) { + HTMLPurifier_Bootstrap::registerAutoload(); + + $oConfig = HTMLPurifier_Config::createDefault(); + + $oConfig->set('Cache.SerializerPath', rtrim(BX_DIRECTORY_PATH_CACHE, '/')); + $oConfig->set('Cache.SerializerPermissions', BX_DOL_DIR_RIGHTS); + + $oConfig->set('HTML.SafeObject', 'true'); + $oConfig->set('Output.FlashCompat', 'true'); + $oConfig->set('HTML.FlashAllowFullScreen', 'true'); + $oConfig->set('Attr.AllowedFrameTargets', array('_blank', '_self', '_parent', '_top')); + + if (getParam('sys_add_nofollow')) { + $sHost = parse_url(BX_DOL_URL_ROOT, PHP_URL_HOST); + $oConfig->set('URI.Host', $sHost); + $oConfig->set('HTML.Nofollow', 'true'); + } + + $oConfig->set('Filter.Custom', array ( + new BxDolHTMLPurifierFilterYouTube(), + new BxDolHTMLPurifierFilterYoutubeIframe(), + new BxDolHTMLPurifierFilterAddBxLinksClass(), + new BxDolHTMLPurifierFilterLocalIframe(), + new BxDolHTMLPurifierFilterEmbed(), + )); + + $oConfig->set('HTML.DefinitionID', 'html5-definitions'); + $oConfig->set('HTML.DefinitionRev', 1); + + if ($def = $oConfig->maybeGetRawHTMLDefinition()) { + $def->addElement('section', 'Block', 'Flow', 'Common'); + $def->addElement('nav', 'Block', 'Flow', 'Common'); + $def->addElement('article', 'Block', 'Flow', 'Common'); + $def->addElement('aside', 'Block', 'Flow', 'Common'); + $def->addElement('header', 'Block', 'Flow', 'Common'); + $def->addElement('footer', 'Block', 'Flow', 'Common'); + $def->addElement('video', 'Block', 'Optional: (source, Flow) | (Flow, source) | Flow', 'Common', array( + 'src' => 'URI', + 'type' => 'Text', + 'width' => 'Length', + 'height' => 'Length', + 'poster' => 'URI', + 'preload' => 'Enum#auto,metadata,none', + 'controls' => 'Bool', + )); + $def->addElement('source', 'Block', 'Flow', 'Common', array( + 'src' => 'URI', + 'type' => 'Text', + )); + $def->addAttribute('a', 'data-profile-id', 'Text'); + $def->addAttribute('a', 'dchar', 'Text'); + $def->addAttribute('div', 'source', 'Text'); + } + + $oHtmlPurifier = new HTMLPurifier($oConfig); + } + + if (!$GLOBALS['logged']['admin']) + $val = $oHtmlPurifier->purify($val); + + $sNewVal = $val; + if (!$GLOBALS['logged']['admin']) + $sNewVal = $oHtmlPurifier->purify($val); + + /** + * @hooks + * @hookdef hook-account-clear_xss 'account', 'clear_xss' - hook after string is checked for xss + * - $unit_name - equals `system` + * - $action - equals `clear_xss` + * - $object_id - not used + * - $sender_id - not used + * - $extra_params - array of additional params with the following array keys: + * - `oHtmlPurifier` - [object] HtmlPurifier object + * - `input_data` - [string] string before check xss + * - `return_data` - [string] by ref, string before check xss, can be overridden in hook processing + * @hook @ref hook-system-clear_xss + */ + bx_alert('system', 'clear_xss', 0, 0, array('oHtmlPurifier' => $oHtmlPurifier, 'input_data' => $val, 'return_data' => &$sNewVal)); + + return $val; +} + +//--------------------------------------- friendly permalinks --------------------------------------// +//------------------------------------------- main functions ---------------------------------------// +function uriGenerate ($sValue, $sTable, $sField, $aParams = []) +{ + $sDivider = isset($aParams['divider']) ? $aParams['divider'] : '-'; + $aCond = isset($aParams['cond']) && is_array($aParams['cond']) ? $aParams['cond'] : []; + + $sValue = uriFilter($sValue, $aParams); + if(uriCheckUniq($sValue, $sTable, $sField, $aCond)) + return $sValue; + + // cut off redundant part + if(get_mb_len($sValue) > 240) + $sValue = get_mb_substr($sValue, 0, 240); + + // try to add number + for($i = 0 ; $i < 999 ; ++$i) { + $iRnd = mt_rand(1000, 9999); + if(uriCheckUniq($sValue . $sDivider . $iRnd, $sTable, $sField, $aCond)) + return ($sValue . $sDivider . $iRnd); + } + + return rand(0, PHP_INT_MAX); +} + +function uriFilter ($s, $aParams = []) +{ + $sEmpty = isset($aParams['empty']) ? $aParams['empty'] : '-'; + $sDivider = isset($aParams['divider']) ? $aParams['divider'] : '-'; + + if(BxTemplConfig::getInstance()->bAllowUnicodeInPreg) + $s = get_mb_replace ('/[^\pL^\pN^_]+/u', $sDivider, $s); // unicode characters + else + $s = get_mb_replace ('/([^\d^\w]+)/u', $sDivider, $s); // latin characters only + + $s = get_mb_replace ('/([' . $sDivider . '^]+)/', $sDivider, $s); + $s = get_mb_replace ('/([' . $sDivider . ']+)$/', '', $s); // remove trailing dash + if(!$s) + $s = $sEmpty; + + return !isset($aParams['lowercase']) || $aParams['lowercase'] === true ? mb_strtolower($s) : $s; +} + +function uriCheckUniq ($sValue, $sTable, $sField, $aCond = []) +{ + $oDb = BxDolDb::getInstance(); + + $sWhere = $aCond ? $oDb->arrayToSQL($aCond, ' AND ') : '1'; + $sSql = $oDb->prepare("SELECT 1 FROM `$sTable` WHERE $sWhere AND `$sField`=? LIMIT 1", $sValue); + return !$oDb->query($sSql); +} + +function get_mb_replace ($sPattern, $sReplace, $s) +{ + return preg_replace ($sPattern, $sReplace, $s); +} + +function get_mb_len ($s) +{ + return (function_exists('mb_strlen')) ? mb_strlen($s) : strlen($s); +} + +function get_mb_substr ($s, $iStart, $iLen) +{ + return (function_exists('mb_substr')) ? mb_substr ($s, $iStart, $iLen) : substr ($s, $iStart, $iLen); +} + +function bx_mb_substr_replace($s, $sReplace, $iPosStart, $iLength) +{ + return mb_substr($s, 0, $iPosStart) . $sReplace . mb_substr($s, $iPosStart + $iLength); +} + +function bx_mb_strpos ($s, $sReplacement, $iStart = 0) +{ + return mb_strpos($s, $sReplacement, $iStart); +} + +/** + * Import class file, it automatically detects class path by its prefix or module array/name + * + * @param $sClassName - full class name or class postfix(withoit prefix) in the case of module class + * @param $mixedModule - module array or module name in the case of module class + */ +function bx_import($sClassName, $mixedModule = array()) +{ + if (class_exists($sClassName, false)) + return; + + $aModule = false; + if ($mixedModule) { + if (is_array($mixedModule)) { + $aModule = $mixedModule; + } elseif (is_string($mixedModule)) { + $o = BxDolModule::getInstance($mixedModule); + $aModule = $o->_aModule; + } elseif (is_bool($mixedModule) && true === $mixedModule) { + $aModule = $GLOBALS['aModule']; + } + } + + if ($aModule) { + if (class_exists($aModule['class_prefix'] . $sClassName, false)) + return; + require_once (BX_DIRECTORY_PATH_MODULES . $aModule['path'] . 'classes/' . $aModule['class_prefix'] . $sClassName . '.php'); + return; + } + + if (0 === strncmp($sClassName, 'BxDol', 5)) { + if (0 === strncmp($sClassName, 'BxDolStudio', 11)) + require_once(BX_DOL_DIR_STUDIO_CLASSES . $sClassName . '.php'); + else + require_once(BX_DIRECTORY_PATH_CLASSES . $sClassName . '.php'); + return; + } + + if (0 === strncmp($sClassName, 'BxBase', 6)) { + if (0 === strncmp($sClassName, 'BxBaseMod', 9)) { + $aMatches = array(); + if (preg_match('/BxBaseMod([A-Z][a-z]+)/', $sClassName, $aMatches)) { + require_once(BX_DIRECTORY_PATH_MODULES . 'base/' . strtolower($aMatches[1]) . '/classes/' . $sClassName . '.php'); + return; + } + } if (0 === strncmp($sClassName, 'BxBaseStudio', 12)) { + require_once(BX_DOL_DIR_STUDIO_BASE . 'scripts/' . $sClassName . '.php'); + return; + } else { + require_once(BX_DIRECTORY_PATH_BASE . 'scripts/' . $sClassName . '.php'); + return; + } + } + + if (0 === strncmp($sClassName, 'BxTempl', 7)) { + if(0 === strncmp($sClassName, 'BxTemplStudio', 13)) { + $sPath = BX_DIRECTORY_PATH_MODULES . BxDolStudioTemplate::getInstance()->getPath() . 'data/template/studio/scripts/' . $sClassName . '.php'; + if (!file_exists($sPath)) + $sPath = BX_DOL_DIR_STUDIO_BASE . 'scripts_templ/' . $sClassName . '.php'; + } else { + $sPath = BX_DIRECTORY_PATH_MODULES . BxDolTemplate::getInstance()->getPath() . 'data/template/system/scripts/' . $sClassName . '.php'; + } + + if (file_exists($sPath)) { + require_once($sPath); + return; + } + else{ + require_once(BX_DIRECTORY_PATH_BASE . 'scripts_templ/' . $sClassName . '.php'); + return; + } + + trigger_error ("bx_import fatal error: class (" . $sClassName . ") wasn't found", E_USER_ERROR); + } +} + +/** + * used in spl_autoload_register() function, so no need to call bx_import for system classes + */ +function bx_autoload($sClassName) +{ + if (0 === strncmp($sClassName, 'BxDol', 5) || 0 === strncmp($sClassName, 'BxBase', 6) || 0 === strncmp($sClassName, 'BxTempl', 7)) + bx_import($sClassName); +} + +/** + * Gets an instance of class pathing necessary parameters if it's necessary. + * + * @param string $sClassName class name. + * @param array $aParams an array of parameters to be pathed to the constructor of the class. + * @param array $mixedModule an array with module description. Is used when the requested class is located in some module. + * @return unknown + */ +function bx_instance($sClassName, $aParams = array(), $mixedModule = array()) +{ + if(isset($GLOBALS['bxDolClasses'][$sClassName])) + return $GLOBALS['bxDolClasses'][$sClassName]; + + if ($mixedModule) { + if (!is_array($mixedModule)) { + $o = BxDolModule::getInstance($mixedModule); + $mixedModule = $o->_aModule; + } + $sClassName = bx_ltrim_str($sClassName, $mixedModule['class_prefix']); + bx_import($sClassName, $mixedModule); + $sClassName = $mixedModule['class_prefix'] . $sClassName; + } + + $oClass = new ReflectionClass($sClassName); + + $GLOBALS['bxDolClasses'][$sClassName] = empty($aParams) ? $oClass->newInstance() : $oClass->newInstanceArgs($aParams); + + return $GLOBALS['bxDolClasses'][$sClassName]; +} + + +/** + * Escapes string/array ready to pass to js script with filtered symbols like ', " etc + * + * @param $mixedInput - string/array which should be filtered + * @param $iQuoteType - string escaping method: BX_ESCAPE_STR_AUTO(default), BX_ESCAPE_STR_APOS or BX_ESCAPE_STR_QUOTE + * @return converted string / array + */ +function bx_js_string ($mixedInput, $iQuoteType = BX_ESCAPE_STR_AUTO) +{ + $aUnits = array( + "\n" => "\\n", + "\r" => "", + ); + if (BX_ESCAPE_STR_APOS == $iQuoteType) { + $aUnits["'"] = "\\'"; + $aUnits[''] = ""; + } elseif (BX_ESCAPE_STR_QUOTE == $iQuoteType) { + $aUnits['"'] = '\\"'; + $aUnits[''] = ''; + } else { + $aUnits['"'] = '"'; + $aUnits["'"] = '''; + $aUnits[""] = '</script>'; + } + return str_replace(array_keys($aUnits), array_values($aUnits), $mixedInput); +} + +/** + * Return input string/array ready to pass to html attribute with filtered symbols like ', " etc + * + * @param $mixedInput - string/array which should be filtered + * @param $iQuoteType - string escaping BX_ESCAPE_STR_AUTO, BX_ESCAPE_STR_APOS or BX_ESCAPE_STR_QUOTE + * @return converted string / array + */ +function bx_html_attribute ($mixedInput, $iQuoteType = BX_ESCAPE_STR_AUTO) +{ + $aUnits = array (); + if (BX_ESCAPE_STR_APOS == $iQuoteType) + $aUnits["'"] = "\\'"; + elseif (BX_ESCAPE_STR_QUOTE == $iQuoteType) + $aUnits['"'] = '"'; + else + $aUnits = array("\"" => """, "'" => "'"); + + return str_replace(array_keys($aUnits), array_values($aUnits), $mixedInput); +} + +/** + * Escapes string/array ready to pass to php script with filtered symbols like ', " etc + * + * @param mixed $mixedInput - string/array which should be filtered + * @return converted string / array + */ +function bx_php_string_apos ($mixedInput) +{ + return str_replace("'", "\\'", $mixedInput); +} +function bx_php_string_quot ($mixedInput) +{ + return str_replace('"', '\\"', $mixedInput); +} + +/** + * Gets file contents by URL. + * + * @param string $sFileUrl - file URL to be read. + * @param array $aParams - an array of parameters to be pathed with URL. + * @param string $sMethod - post or get. + * @param array $aHeaders - custom headers. + * @param string $sHttpCode - HTTP code to return + * @param array $aBasicAuth - array with 'user' and 'password' for Basic HTTP Auth + * @return string the file's contents. + */ +function bx_file_get_contents($sFileUrl, $aParams = array(), $sMethod = 'get', $aHeaders = array(), &$sHttpCode = null, $aBasicAuth = array(), $iTimeout = 0, $aCustomCurlParams = array()) +{ + if(!in_array($sMethod, ['post', 'post-raw', 'post-json', 'post-json-object'])) + $sFileUrl = bx_append_url_params($sFileUrl, $aParams); + + $sResult = ''; + if(function_exists('curl_init')) { + $rConnect = curl_init(); + + curl_setopt($rConnect, CURLOPT_USERAGENT, 'UNA ' . (defined('BX_DOL_VERSION') ? constant('BX_DOL_VERSION') : '')); + curl_setopt($rConnect, CURLOPT_TIMEOUT, BxDolDb::getInstance() ? getParam('sys_default_curl_timeout') : 10); + curl_setopt($rConnect, CURLOPT_URL, $sFileUrl); + curl_setopt($rConnect, CURLOPT_RETURNTRANSFER, 1); + + if (0 !== $iTimeout) { + curl_setopt($rConnect, CURLOPT_CONNECTTIMEOUT, $iTimeout); + curl_setopt($rConnect, CURLOPT_TIMEOUT, $iTimeout); + } + + if(getParam('sys_curl_ssl_allow_untrusted') == 'on'){ + curl_setopt($rConnect, CURLOPT_SSL_VERIFYPEER, false); + curl_setopt($rConnect, CURLOPT_SSL_VERIFYHOST, false); + } + + if (!ini_get('open_basedir')) + curl_setopt($rConnect, CURLOPT_FOLLOWLOCATION, 1); + + if ($aBasicAuth) + curl_setopt($rConnect, CURLOPT_USERPWD, $aBasicAuth['user'] . ':' . $aBasicAuth['password']); + + if ('post' == $sMethod) { + curl_setopt($rConnect, CURLOPT_POST, true); + curl_setopt($rConnect, CURLOPT_POSTFIELDS, http_build_query($aParams)); + } + elseif ('post-raw' == $sMethod) { + curl_setopt($rConnect, CURLOPT_POST, true); + curl_setopt($rConnect, CURLOPT_POSTFIELDS, $aParams); + } + elseif ('post-json' == $sMethod) { + curl_setopt($rConnect, CURLOPT_POST, true); + curl_setopt($rConnect, CURLOPT_POSTFIELDS, json_encode($aParams)); + $aHeaders[] = 'Content-Type: application/json'; + } + elseif ('post-json-object' == $sMethod) { + curl_setopt($rConnect, CURLOPT_POST, true); + curl_setopt($rConnect, CURLOPT_POSTFIELDS, json_encode($aParams, JSON_FORCE_OBJECT)); + $aHeaders[] = 'Content-Type: application/json'; + } + elseif ($sMethod != 'get') { + curl_setopt($rConnect, CURLOPT_CUSTOMREQUEST, $sMethod); + } + + if ($aHeaders) + curl_setopt($rConnect, CURLOPT_HTTPHEADER, $aHeaders); + + if (defined('BX_DOL_URL_ROOT') && 0 === strpos($sFileUrl, BX_DOL_URL_ROOT)) { + $sAllCookies = ''; + foreach($_COOKIE as $sKey => $mValue){ + if(is_array($mValue)){ + foreach ($mValue as $k => $v) + $sAllCookies .= "{$sKey}[{$k}]={$v};"; + } + else{ + $sAllCookies .= $sKey . '=' . $mValue . ';'; + } + } + curl_setopt($rConnect, CURLOPT_COOKIE, $sAllCookies); + } + + if ($aCustomCurlParams) + foreach ($aCustomCurlParams as $sName => $mixedValue) + curl_setopt($rConnect, $sName, $mixedValue); + + $sResult = curl_exec($rConnect); + + if (curl_errno($rConnect) == 60) { // CURLE_SSL_CACERT + curl_setopt($rConnect, CURLOPT_CAINFO, BX_DIRECTORY_PATH_PLUGINS . 'curl/cacert/cacert.pem'); + $sResult = curl_exec($rConnect); + } + + if (NULL !== $sHttpCode) + $sHttpCode = curl_getinfo($rConnect, CURLINFO_HTTP_CODE); + + curl_close($rConnect); + } + else { + + $iSaveTimeout = false; + if (0 !== $iTimeout) { + $iSaveTimeout = ini_get('default_socket_timeout'); + ini_set('default_socket_timeout', $iTimeout); + } + + $sResult = @file_get_contents($sFileUrl); + + if (0 !== $iTimeout && false !== $iSaveTimeout) { + ini_set('default_socket_timeout', $iSaveTimeout); + } + } + + return $sResult; +} + +function bx_make_utf8($s) +{ + // Test it and see if it is UTF-8 or not + if (false !== mb_detect_encoding($s, ["UTF-8"], true)) + return $s; + + $sEncoding = mb_detect_encoding($s, ['ASCII', 'BASE64', 'HTML-ENTITIES', 'Windows-1251', 'KOI8-R'], true); + if ($sEncoding === false) + return $s; + + return mb_convert_encoding($s, "UTF-8", $sEncoding); +} + +function bx_get_site_info($sSourceUrl, $aProcessAdditionalTags = array()) +{ + $aResult = array(); + $sContent = bx_file_get_contents($sSourceUrl); + + if ($sContent) { + $sCharset = ''; + preg_match("//i", $sContent, $aMatch); + if (isset($aMatch[1])) + $sCharset = $aMatch[1]; + + $sContent = preg_replace("/]*>(.*?)<\/script>/i", '', $sContent); + $sContent = preg_replace("/]*>(.*?)<\/style>/i", '', $sContent); + if (preg_match("/]*>(.*?)<\/title>/i", $sContent, $aMatch)) + $aResult['title'] = bx_make_utf8(strip_tags($aMatch[1]), $sCharset); + else + $aResult['title'] = parse_url($sSourceUrl, PHP_URL_HOST); + + $aResult['description'] = bx_make_utf8(bx_parse_html_tag($sContent, 'meta', 'name', 'description', 'content', $sCharset), $sCharset); + $aResult['keywords'] = bx_make_utf8(bx_parse_html_tag($sContent, 'meta', 'name', 'keywords', 'content', $sCharset), $sCharset); + + if ($aProcessAdditionalTags) { + + foreach ($aProcessAdditionalTags as $k => $a) { + $aResult[$k] = bx_parse_html_tag( + $sContent, + isset($a['tag']) ? $a['tag'] : 'meta', + isset($a['name_attr']) ? $a['name_attr'] : 'itemprop', + isset($a['name']) ? $a['name'] : $k, + isset($a['content_attr']) ? $a['content_attr'] : 'content', + $sCharset, + isset($a['specialchars_decode']) ? $a['specialchars_decode'] : true); + + if ((isset($a['name']) && 'og:image' == $a['name']) || (isset($a['tag']) && 'link' == $a['tag'])) { + $aResult[$k] = bx_get_site_info_fix_relative_url ($sSourceUrl, $aResult[$k]); + } + } + + } + } + + return $aResult; +} + +/** + * Fix relative URL to make it absolute + * @param $sSourceUrl main URL + * @param $s URL to fix + * @return absolute URL or URL wothout changes + */ +function bx_get_site_info_fix_relative_url ($sSourceUrl, $s) +{ + if (0 === stripos($s, 'http://') || 0 === stripos($s, 'https://') || 0 === stripos($s, 'ftp://') || !$s) + return $s; + + if ('/' == $s[0]) { + $a = parse_url($sSourceUrl); + return $a['scheme'] . '://' . $a['host'] . (empty($a['port']) || 80 == $a['port'] || 443 == $a['port'] ? '' : ':' . $a['port']) . $s; + } + + return $sSourceUrl . ('/' === substr($sSourceUrl, -1) ? $s : '/' . $s); +} + +function bx_parse_html_tag ($sContent, $sTag, $sAttrNameName, $sAttrNameValue, $sAttrContentName, $sCharset = false, $bSpecialCharsDecode = true) +{ + // This regex is designed to be more flexible with attribute orders and spacing + $regex = "/<{$sTag}\s+(?:[^>]*?\s+)?{$sAttrNameName}\s*=\s*['\"]?{$sAttrNameValue}['\"]?\s+[^>]*{$sAttrContentName}\s*=\s*['\"]([^'\"]*)['\"][^>]*>/i"; + if (!preg_match($regex, $sContent, $aMatch)) { + // Try reversing the attribute order in case the first regex fails + $regex = "/<{$sTag}\s+(?:[^>]*?\s+)?{$sAttrContentName}\s*=\s*['\"]([^'\"]*)['\"]\s+[^>]*{$sAttrNameName}\s*=\s*['\"]?{$sAttrNameValue}['\"]?[^>]*>/i"; + preg_match($regex, $sContent, $aMatch); + } + + // Extract the attribute content if available + $s = isset($aMatch[1]) ? $aMatch[1] : ''; + + // Optionally convert character encoding + if ($s && $sCharset) { + $s = mb_convert_encoding($s, 'UTF-8', $sCharset); + } + + // Optionally decode special HTML characters + if ($bSpecialCharsDecode) { + $s = htmlspecialchars_decode($s); + } + + return $s; +} + +// calculation ini_get('upload_max_filesize') in bytes as example +function return_bytes($val) +{ + $val = trim($val); + $last = strtolower($val[strlen($val)-1]); + $val = (int)$val; + switch($last) { + // The 'G' modifier is available since PHP 5.1.0 + case 'k': + $val *= 1024; + break; + case 'm': + $val *= 1024 * 1024; + break; + case 'g': + $val *= 1024 * 1024 * 1024; + break; + } + return $val; +} + +// Generate Random Password +function genRndPwd($iLength = 8, $bSpecialCharacters = true) +{ + $sPassword = ''; + $sChars = "abcdefghijkmnpqrstuvwxyzABCDEFGHJKLMNPQRSTUVWXYZ23456789"; + + if($bSpecialCharacters === true) + $sChars .= "!?=/&+,."; + + for($i = 0; $i < $iLength; $i++) { + $x = mt_rand(0, strlen($sChars) -1); + $sPassword .= $sChars[$x]; + } + + return $sPassword; +} + +// Generate Random Salt for Password encryption +function genRndSalt() +{ + return genRndPwd(8, true); +} + +/** + * Encrypt user password. + * When BX_PWD_ALGO is 'custom', then bx_custom_pwd_encrypt function with custom algorythm must be defined in inc/header.inc.php file. + * @param $sPwd clear password + * @param $sSalt salt + * @return password hash + */ +function encryptUserPwd($sPwd, $sSalt) +{ + $sAlgo = defined('BX_PWD_ALGO') ? BX_PWD_ALGO : ''; + + switch ($sAlgo) { + + case 'custom': + return bx_custom_pwd_encrypt($sPwd, $sSalt); + + case 'crypt': + return crypt($sPwd, BX_PWD_ALGO_SALT); + + case 'sha1_crypt_salt': + return sha1(crypt($sPwd, BX_PWD_ALGO_SALT) . $sSalt); + + case 'sha1_md5_salt': + default: + return sha1(md5($sPwd) . $sSalt); + } +} + +/** + * Hash profile ID + */ +function encryptUserId($sId) +{ + if (!($oProfile = BxDolProfile::getInstance($sId))) + return false; + + if (!($oAccount = $oProfile->getAccountObject())) + return false; + + $aAccountInfo = $oAccount->getInfo(); + return sha1(md5($sId) . md5($aAccountInfo['salt']) . BX_DOL_SECRET); +} + +function bx_get_reset_password_key($sValue, $sField = 'email', $iLifetime = 0) +{ + if(empty($iLifetime)) { + $iLifetime = (int)getParam('sys_account_reset_password_key_lifetime'); + if(empty($iLifetime)) + $iLifetime = 86400; + } + + $oKey = BxDolKey::getInstance(); + if(!$oKey) + return false; + + return $oKey->getNewKey(array($sField => $sValue), $iLifetime); +} + +function bx_get_reset_password_link($sValue, $sField = 'email', $iLifetime = 0) +{ + $sKey = bx_get_reset_password_key($sValue, $sField, $iLifetime); + if(!$sKey) + return false; + + return bx_get_reset_password_link_by_key($sKey); +} + +function bx_get_reset_password_link_by_key($sKey) +{ + return bx_absolute_url(BxDolPermalinks::getInstance()->permalink('page.php?i=forgot-password', array('key' => $sKey))); +} + +function bx_get_reset_password_redirect($iAccountId) +{ + $sResult = ''; + $sRedirect = getParam('sys_account_reset_password_redirect'); + switch($sRedirect) { + case 'home': + $sResult = BxDolPermalinks::getInstance()->permalink('page.php?i=home'); + break; + + case 'profile': + case 'profile_edit': + if(empty($iAccountId)) + break; + + $oAccount = BxDolAccount::getInstance($iAccountId); + if(!$oAccount) + break; + + $aAccountInfo = $oAccount->getInfo(); + if(empty($aAccountInfo) || !is_array($aAccountInfo) || empty($aAccountInfo['profile_id'])) + break; + + $oProfile = BxDolProfile::getInstance((int)$aAccountInfo['profile_id']); + if(!$oProfile) + break; + + $sResult = $oProfile->{'get' . ($sRedirect == 'profile_edit' ? 'Edit' : '') . 'Url'}(); + break; + + case 'custom': + $sResult = getParam('sys_account_reset_password_redirect_custom'); + break; + } + + if(!empty($sResult)) + $sResult = bx_absolute_url($sResult); + + return $sResult; +} + +function bx_get ($sName, $sMethod = false) +{ + if (isset($_GET[$sName]) && ('get' == $sMethod || !$sMethod)) + return $_GET[$sName]; + elseif (isset($_POST[$sName]) && ('post' == $sMethod || !$sMethod)) + return $_POST[$sName]; + else + return false; +} + +function bx_set ($sName, $sValue, $sMethod = false) +{ + if(!$sMethod) + $sMethod = 'get'; + + $bResult = true; + switch($sMethod) { + case 'get': + $_GET[$sName] = $sValue; + break; + + case 'post': + $_POST[$sName] = $sValue; + break; + + default: + $bResult = false; + } + + return $bResult; +} + +function bx_get_with_prefix ($sPrefix, $sMethod = false) +{ + $aSources = array('get' => &$_GET, 'post' => &$_POST); + + $aFiltered = array(); + foreach($aSources as $sName => $aSource) + if($sMethod == $sName || !$sMethod) + $aFiltered = array_merge($aFiltered, array_filter($aSource, function($sKey) use ($sPrefix) { + return strpos($sKey, $sPrefix) === 0; + }, ARRAY_FILTER_USE_KEY)); + + $aUpdated = array(); + array_walk($aFiltered, function($sValue, $sKey) use ($sPrefix, &$aUpdated) { + $aUpdated[trim(str_replace($sPrefix, '', $sKey), '_-')] = $sValue; + }); + + return $aUpdated; +} + +function bx_get_base_url_inline($aParams = array()) +{ + $aBaseLink = parse_url(BX_DOL_URL_ROOT); + $sPageLink = (!empty($aBaseLink['scheme']) ? $aBaseLink['scheme'] : 'http') . '://' . $aBaseLink['host'] . (!empty($aBaseLink['port']) ? ':' . $aBaseLink['port'] : ''); + if(!empty($_SERVER['REQUEST_URI'])) + $sPageLink .= $_SERVER['REQUEST_URI']; + + list($sPageLink, $aPageParams) = bx_get_base_url($sPageLink); + + if(!empty($_SERVER['QUERY_STRING'])) { + $aPageParamsAdd = array(); + parse_str($_SERVER['QUERY_STRING'], $aPageParamsAdd); + if(!empty($aPageParamsAdd) && is_array($aPageParamsAdd)) + $aPageParams = array_merge($aPageParams, $aPageParamsAdd); + } + + if(!empty($aParams) && is_array($aParams)) + $aPageParams = array_merge($aPageParams, $aParams); + + return array($sPageLink, $aPageParams); +} + +function bx_get_base_url_popup($aParams = array()) +{ + list($sPageLink, $aPageParams) = bx_get_base_url($_SERVER['HTTP_REFERER']); + + if(!empty($aParams) && is_array($aParams)) + $aPageParams = array_merge($aPageParams, $aParams); + + return array($sPageLink, $aPageParams); +} + +function bx_get_base_url($sPageLink) +{ + $sPageLink = BxDolPermalinks::getInstance()->unpermalink($sPageLink, false); + + $sPageParams = ''; + if(strpos($sPageLink, '?') !== false) + list($sPageLink, $sPageParams) = explode('?', $sPageLink); + + $aPageParams = array(); + if(!empty($sPageParams)) + parse_str($sPageParams, $aPageParams); + + return array($sPageLink, $aPageParams); +} + +function bx_get_page_info() +{ + list($sPageLink, $aPageParams) = bx_get_base_url_inline(); + + if(isset($aPageParams['i'], $aPageParams['id']) && ($oPage = BxDolPage::getObjectInstanceByURI($aPageParams['i'])) !== false) { + $sPageModule = $oPage->getModule(); + if(bx_srv('system', 'is_module_context', [$sPageModule]) && ($oProfile = BxDolProfile::getInstanceByContentAndType($aPageParams['id'], $sPageModule)) !== false) + return [ + 'context_module' => $sPageModule, + 'context_id' => $aPageParams['id'], + 'context_profile_id' => $oProfile->id() + ]; + } + + if(isset($aPageParams['profile_id']) && ($oProfile = BxDolProfile::getInstance($aPageParams['profile_id'])) !== false) { + $sProfileModule = $oProfile->getModule(); + if(bx_srv('system', 'is_module_context', [$sProfileModule])) + return [ + 'context_module' => $sProfileModule, + 'context_id' => $oProfile->getContentId(), + 'context_profile_id' => $aPageParams['profile_id'] + ]; + } + + return false; +} + +function bx_get_location_bounds_latlng($fLatitude, $fLongitude, $iRadiusInKm) +{ + $fEquatorLatInKm = 111.321; + $aRv = array(); + $aRv['max_lat'] = $fLatitude + $iRadiusInKm / $fEquatorLatInKm; + $aRv['min_lat'] = $fLatitude - ($aRv['max_lat'] - $fLatitude); + $aRv['max_lng'] = $fLongitude + $iRadiusInKm / (cos($aRv['min_lat'] * M_PI / 180) * $fEquatorLatInKm); + $aRv['min_lng'] = $fLongitude - ($aRv['max_lng'] - $fLongitude); + return $aRv; + +} + +function bx_encode_url_params ($a, $aExcludeKeys = array (), $aOnlyKeys = false) +{ + $s = ''; + foreach ($a as $sKey => $sVal) { + if (in_array($sKey, $aExcludeKeys)) + continue; + if (false !== $aOnlyKeys && !in_array($sKey, $aOnlyKeys)) + continue; + if (is_array($sVal)) { + foreach ($sVal as $sSubVal) { + $s .= rawurlencode($sKey) . '[]=' . rawurlencode(is_array($sSubVal) ? 'array' : $sSubVal) . '&'; + } + } else { + $s .= rawurlencode($sKey) . '=' . rawurlencode($sVal) . '&'; + } + } + return $s; +} + +/** + * It works similar to `parse_str` php function, but it doesn't decode URL params + */ +function bx_parse_str($s) +{ + $a = []; + $aPairs = explode('&', $s); + + foreach ($aPairs as $i) { + list($sName, $mixedValue) = explode('=', $i, 2); + $sName = rtrim($sName, '[]'); + + if (isset($a[$sName])) { + if (is_array($a[$sName])) + $a[$sName][] = $mixedValue; + else + $a[$sName] = [$a[$sName], $mixedValue]; + } + else { + $a[$sName] = $mixedValue; + } + } + + return $a; +} + +function bx_append_url_params ($sUrl, $mixedParams, $bEncodeParams = true, $aIgnoreParams = []) +{ + if (!$mixedParams) + return $sUrl; + + $sParams = false === strpos($sUrl, '?') ? '?' : '&'; + + if (is_array($mixedParams)) { + foreach($mixedParams as $sKey => $sValue) { + if (!is_array($sValue)) { + if ($bEncodeParams) { + if (!in_array($sKey, $aIgnoreParams)) + $sKey = rawurlencode($sKey); + if (!in_array($sValue, $aIgnoreParams)) + $sValue = rawurlencode($sValue); + } + $sParams .= $sKey . '=' . $sValue . '&'; + } + else { + foreach($sValue as $sSubValue) { + if ($bEncodeParams) { + if (!in_array($sKey, $aIgnoreParams)) + $sKey = rawurlencode($sKey); + if (!in_array($sSubValue, $aIgnoreParams)) + $sSubValue = rawurlencode($sSubValue); + } + $sParams .= $sKey . '[]=' . $sSubValue . '&'; + } + } + } + $sParams = substr($sParams, 0, -1); + } else { + $sParams .= $mixedParams; + } + return $sUrl . $sParams; +} + +function bx_process_url_param($sValue, $sPattern = "/^[\d\w_-]+$/") +{ + $mixedValue = bx_process_input($sValue); + return $mixedValue !== false && preg_match($sPattern, $mixedValue) ? $mixedValue : ''; +} + +function bx_rrmdir($directory) +{ + if (substr($directory,-1) == "/") + $directory = substr($directory,0,-1); + + if (!file_exists($directory) || !is_dir($directory)) + return false; + elseif (!is_readable($directory)) + return false; + + if (!($directoryHandle = opendir($directory))) + return false; + + while ($contents = readdir($directoryHandle)) { + if ($contents != '.' && $contents != '..') { + $path = $directory . "/" . $contents; + + if (is_dir($path)) + bx_rrmdir($path); + else + unlink($path); + } + } + + closedir($directoryHandle); + + if (!rmdir($directory)) + return false; + + return true; +} + +function bx_clear_folder ($sPath, $aExts = array ()) +{ + if (substr($$sPath,-1) == "/") + $sPath = substr($sPath,0,-1); + + if (!file_exists($sPath) || !is_dir($sPath)) + return false; + elseif (!is_readable($sPath)) + return false; + + if (!($h = opendir($sPath))) + return false; + + while ($sFile = readdir($h)) { + if ('.' == $sFile || '..' == $sFile) + continue; + + $sFullPath = $sPath . '/' . $sFile; + + if (is_dir($sFullPath)) + continue; + + if (!$aExts || (($sExt = pathinfo($sFullPath, PATHINFO_EXTENSION)) && in_array($sExt, $aExts))) + @unlink($sFullPath); + } + + closedir($h); + + return true; +} + +function bx_ltrim_str ($sString, $sPrefix, $sReplace = '') +{ + if ($sReplace && substr($sString, 0, strlen($sReplace)) == $sReplace) + return $sString; + if (substr($sString, 0, strlen($sPrefix)) == $sPrefix) + return $sReplace . substr($sString, strlen($sPrefix)); + return $sString; +} + +function bx_rtrim_str ($sString, $sPrefix, $sReplace = '') +{ + if ($sReplace && substr($sString, -strlen($sReplace)) == $sReplace) + return $sString; + if (substr($sString, -strlen($sPrefix)) == $sPrefix) + return substr($sString, 0, -strlen($sPrefix)) . $sReplace; + return $sString; +} + +/** + * Strip all lines with no information for example: , + */ +function bx_trim_nl_duplicates($s) +{ + $sStrip = implode('', array_keys(get_html_translation_table(HTML_ENTITIES))); + return implode('', array_filter(mb_split("[\n\r]", $s), function($s) use ($sStrip) { + return trim(strip_tags($s, '<img><input><object><select><svg><video>'), $sStrip) !== ''; + })); +} + +/** + * Convert array to attributes string + * + * Example: + * @code + * $a = array('name' => 'test', 'value' => 5); + * $s = bx_convert_array2attrs($a); + * echo $s; // outputs: name="test" value="5" + * @endcode + * + * @param $a - array of attributes + * @param $sClasses - classes to merge with 'class' attribute + * @param $sStyles - styles to merge with 'style' attribute + * @return string + */ +function bx_convert_array2attrs ($a, $sClasses = false, $sStyles = false) +{ + $sRet = ''; + + if (!$a || !is_array($a)) + $a = array(); + + if ($sClasses) { + $sClasses = trim($sClasses); + $a['class'] = $sClasses . (!empty($a['class']) ? ' ' . $a['class'] : ''); + } + + if ($sStyles) { + $sStyles = trim($sStyles); + if (';' != $sStyles[strlen($sStyles)-1]) + $sStyles .= ';'; + $a['style'] = $sStyles . (!empty($a['style']) ? ' ' . $a['style'] : ''); + } + + foreach ($a as $sKey => $sValue) { + if(is_null($sValue)) // pass NULL values + continue; + + $sValueC = bx_html_attribute($sValue, BX_ESCAPE_STR_QUOTE); + + $sRet .= " $sKey=\"$sValueC\""; + } + + return $sRet; +} + +function bx_unicode_urldecode($s) +{ + preg_match_all('/%u([[:alnum:]]{4})/', $s, $a); + + foreach ($a[1] as $uniord) { + $dec = hexdec($uniord); + $utf = ''; + + if ($dec < 128) { + $utf = chr($dec); + } else if ($dec < 2048) { + $utf = chr(192 + (($dec - ($dec % 64)) / 64)); + $utf .= chr(128 + ($dec % 64)); + } else { + $utf = chr(224 + (($dec - ($dec % 4096)) / 4096)); + $utf .= chr(128 + ((($dec % 4096) - ($dec % 64)) / 64)); + $utf .= chr(128 + ($dec % 64)); + } + + $s = str_replace('%u'.$uniord, $utf, $s); + } + + return urldecode($s); +} + +/** + * Raise an audit event + * @param int $iContentId - content id + * @param string $sContentModule - module name + * @param string $sAction - system action key + * @param array $aParams - array of parameters + */ +function bx_audit($iContentId, $sContentModule, $sAction, $aParams, $iProfileId = 0) +{ + if (!getParam('sys_audit_enable') || getParam('sys_audit_acl_levels') == '') + return; + + if ($iProfileId == 0) + $iProfileId = bx_get_logged_profile_id(); + + if (!BxDolAcl::getInstance()->isMemberLevelInSet(explode(',', getParam('sys_audit_acl_levels')), $iProfileId)) + return; + + $sContentTitle = $sContentInfoObject = $sContextProfileTitle = $sData = $sActionParams = ''; + $iContextProfileId = 0; + + if (isset($aParams['profile_id'])) + $iProfileId = (int)$aParams['profile_id']; + + if (isset($aParams['content_title'])) + $sContentTitle = $aParams['content_title']; + + if (isset($aParams['context_profile_id'])) + $iContextProfileId = (int)$aParams['context_profile_id']; + + if (isset($aParams['context_profile_title'])) + $sContextProfileTitle = $aParams['context_profile_title']; + + if (isset($aParams['action_params']) && is_array($aParams['action_params']) && count($aParams['action_params'])) + $sActionParams = serialize($aParams['action_params']); + + if (isset($aParams['content_info_object'])) + $sContentInfoObject = $aParams['content_info_object']; + + if (isset($aParams['data']) && is_array($aParams['data']) && count($aParams['data'])) + $sData = serialize($aParams['data']); + + $sProfileTitle = BxDolProfile::getInstance($iProfileId)->getDisplayName(); + + $oDb = BxDolDb::getInstance(); + $sSql = $oDb->prepare("INSERT INTO `sys_audit`(`added`, `profile_id`, `profile_title`, `content_id`, `content_title`, `content_module`, `context_profile_id`, `context_profile_title`, `action_lang_key`, `action_lang_key_params`, `content_info_object`, `extras`) VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)" + ,time(), $iProfileId, $sProfileTitle, $iContentId, $sContentTitle, $sContentModule, $iContextProfileId, $sContextProfileTitle, $sAction, $sActionParams ,$sContentInfoObject, $sData); + return !$oDb->query($sSql); +} + +/** + * Raise an alert + * @param string $sUnit - system type + * @param string $sAction - system action + * @param int $iObjectId - object id + * @param int $iSender - sender (action's author) profile id, if it is false - then currectly logged in profile id is used + * @param array $aExtras - extra parameters + */ +function bx_alert($sUnit, $sAction, $iObjectId, $iSender = false, $aExtras = array()) +{ + $o = new BxDolAlerts($sUnit, $sAction, $iObjectId, $iSender, $aExtras); + $o->alert(); +} + +/** + * Check whether serice method exists or not + * @param $mixed module name or module id + * @param $sMethod service method name in format 'method_name', corresponding class metod is serviceMethodName + * @param $sClass class to search for service method, by default it is main module class + * @return boolean check result + */ +function bx_is_srv($mixedModule, $sMethod, $sClass = "Module", $bIgnoreInactive = false) +{ + return BxDolRequest::serviceExists($mixedModule, $sMethod, $sClass, $bIgnoreInactive); +} + +/** + * Check whether serice method exists or not in 'Ignore Inactive' mode. + */ +function bx_is_srv_ii($mixedModule, $sMethod, $sClass = "Module") +{ + return BxDolRequest::serviceExists($mixedModule, $sMethod, $sClass, true); +} + +/** + * Perform serice call + * @param $mixed module name or module id + * @param $sMethod service method name in format 'method_name', corresponding class metod is serviceMethodName + * @param $aParams params to pass to service method + * @param $sClass class to search for service method, by default it is main module class + * @return service call result + */ +function bx_srv($mixed, $sMethod, $aParams = array(), $sClass = 'Module', $bIgnoreCache = false, $bIgnoreInactive = false) +{ + return BxDolService::call($mixed, $sMethod, $aParams, $sClass, $bIgnoreCache, $bIgnoreInactive); +} + +/** + * Perform serice call in 'Ignore Inactive' mode. + */ +function bx_srv_ii($mixed, $sMethod, $aParams = array(), $sClass = 'Module', $bIgnoreCache = false) +{ + return BxDolService::call($mixed, $sMethod, $aParams, $sClass, $bIgnoreCache, true); +} + +/** + * Perform serice call in 'Ignore Cache' mode. + */ +function bx_srv_ic($mixed, $sMethod, $aParams = array(), $sClass = 'Module', $bIgnoreInactive = false) +{ + return BxDolService::call($mixed, $sMethod, $aParams, $sClass, true, $bIgnoreInactive); +} + +function bx_replace_markers($mixed, $aMarkers) +{ + if (empty($aMarkers)) + return $mixed; + + if (is_array($mixed)) { + foreach ($mixed as $sKey => $sValue) + $mixed[$sKey] = bx_replace_markers ($sValue, $aMarkers); + } else { + foreach ($aMarkers as $sKey => $sValue) + $mixed = str_replace('{' . $sKey . '}', is_null($sValue) ? '' : $sValue, $mixed); + } + + return $mixed; +} + +function bx_site_hash($sSalt = '', $isSkipVersion = false) +{ + return md5($sSalt . ($isSkipVersion ? '' : bx_get_ver() . getParam('sys_revision')) . BX_DOL_SECRET . BX_DOL_URL_ROOT); +} + +/** + * Transform string to method name string, for example it changes 'some_method' string to 'SomeMethod' string + * @param $s string where words are separated with underscore + * @param $aWordsDelimiter word delimeters + * @return string where every word begins with capital letter + */ +function bx_gen_method_name ($s, $aWordsDelimiter = array('_')) +{ + return str_replace(' ', '', ucwords(str_replace($aWordsDelimiter, ' ', $s))); +} + +/** + * Trigger user error + * @param $sMsg message to display + * @param $iNumLevelsBack add additional debug backtracing N levels back + */ +function bx_trigger_error ($sMsg, $iNumLevelsBack = 0) +{ + $a = debug_backtrace(); + $sMsgAdd = "<br />\n related code in <b>{$a[$iNumLevelsBack]['file']}</b> on line <b>{$a[$iNumLevelsBack]['line']}</b> <br />\n"; + trigger_error ($sMsg . $sMsgAdd, E_USER_ERROR); +} + +/** + * Get system DB version, for files version @see BX_DOL_VERSION, these versions must match + */ +function bx_get_ver ($bInvalidateCache = false) +{ + $oDb = BxDolDb::getInstance(); + + if ($bInvalidateCache) + $oDb->cleanMemory('sys_version'); + + $sQuery = $oDb->prepare("SELECT `version` FROM `sys_modules` WHERE `name` = 'system'"); + return $oDb->fromMemory('sys_version', 'getOne', $sQuery); +} + +function bx_check_debug_mode() +{ + if(!bx_is_dbg()) + return; + + ini_set('display_errors', 'On'); + error_reporting(E_ALL); +} + +/** + * Check if site maintetance mode is enabled. + * Maintetance mode is enabled when '.bx_maintenance' file exists in the script root folder, + * please note that this is hidden file and some file managers don't show it. + * @param $bShowHttpError show 503 HTTP error if site is in mainenance mode + * @return true if site is in maintenance mode, or false otherwise + */ +function bx_check_maintenance_mode ($bShowHttpError = false) +{ + $bMaintetance = file_exists(BX_DIRECTORY_PATH_ROOT . BX_MAINTENANCE_FILE) && !defined('BX_DOL_UPGRADING'); + + if ($bMaintetance && $bShowHttpError) + bx_show_service_unavailable_error_and_exit ('Site is temporarily unavailable due to scheduled maintenance, please try again in a minute.', 600); + + return $bMaintetance; +} + +/** + * Check for minimal requirements. + * if BX_DISABLE_REQUIREMENTS_CHECK is defined then this requirements checking is skipped. + * @param $bShowHttpError show 503 HTTP error if site doesn't meet minimal requirements + * @return false if requirements are met, or array of errors of requirements aren't met + */ +function bx_check_minimal_requirements ($bShowHttpError = false) +{ + if (defined('BX_DISABLE_REQUIREMENTS_CHECK')) + return false; + + $aErrors = array(); + + $aErrors[] = (ini_get('register_globals') == 0) ? '' : '<b>register_globals</b> is on (you need to disable it, or your site will be unsafe)'; + $aErrors[] = (ini_get('safe_mode') == 0) ? '' : '<b>safe_mode</b> is on (you need to disable it)'; + $aErrors[] = (version_compare(PHP_VERSION, '5.3.0', '<')) ? 'PHP version is too old (please update to <b>PHP 5.3.0</b> at least)' : ''; + $aErrors[] = (!extension_loaded( 'mbstring')) ? '<b>mbstring</b> extension not installed (the script cannot work without it)' : ''; + $aErrors[] = (ini_get('allow_url_include') == 0 || version_compare(PHP_VERSION, '8.0.0', '>=')) ? '' : '<b>allow_url_include</b> is on (you need to disable it, or your site will be unsafe)'; + + $aErrors = array_diff($aErrors, array('')); // delete empty + + $bFailedMinimalRequirements = !empty($aErrors); + + if ($bFailedMinimalRequirements && $bShowHttpError) { + $sErrors = implode(" <br /> ", $aErrors); + bx_show_service_unavailable_error_and_exit($sErrors); + } + + return $bFailedMinimalRequirements ? $aErrors : false; +} + +/** + * Check if redirect to the correct hostname is required, for example redirect from site.com to www.site.com + * @param $bProcessRedirect process redirect and exit if needed + */ +function bx_check_redirect_to_correct_hostname ($bProcessRedirect = false) +{ + $aUrl = parse_url(BX_DOL_URL_ROOT); + $iPortDefault = 'https' == $aUrl['scheme'] ? '443' : '80'; + + $bRedirectRequired = isset($_SERVER['HTTP_HOST']) && 0 !== strcasecmp($_SERVER['HTTP_HOST'], $aUrl['host']) && 0 !== strcasecmp($_SERVER['HTTP_HOST'], $aUrl['host'] . ':' . (!empty($aUrl['port']) ? $aUrl['port'] : $iPortDefault)); + + if ($bRedirectRequired && $bProcessRedirect) { + header("Location:" . bx_get_self_url(), true, 301); + exit; + } + + return $bRedirectRequired; +} + +/** + * Get URL of current page + */ +function bx_get_self_url () +{ + $aUrl = parse_url(BX_DOL_URL_ROOT); + $sPort = empty($aUrl['port']) || 80 == $aUrl['port'] || 443 == $aUrl['port'] ? '' : ':' . $aUrl['port']; + return "{$aUrl['scheme']}://{$aUrl['host']}{$sPort}{$_SERVER['REQUEST_URI']}"; +} + +/** + * Check if redirect to remove install folder. + * If BX_SKIP_INSTALL_CHECK is defined then this redirect checking is skipped. + * @param $bProcessRedirect process redirect and exit if needed + */ +function bx_check_redirect_to_remove_install_folder ($bProcessRedirect = false) +{ + $bRemoveInstallFolder = !defined ('BX_SKIP_INSTALL_CHECK') && file_exists(BX_DIRECTORY_PATH_ROOT . 'install'); + + if ($bRemoveInstallFolder && $bProcessRedirect) { + header('Location:' . BX_DOL_URL_ROOT . 'install/index.php?action=remove_install'); + exit; + } + + return $bRemoveInstallFolder; +} + +/** + * Show HTTP 503 service unavailable error and exit + */ +function bx_show_service_unavailable_error_and_exit ($sMsg = false, $iRetryAfter = 86400) +{ + header('HTTP/1.0 503 Service Unavailable', true, 503); + header('Retry-After: 600'); + echo $sMsg ? $sMsg : 'Service temporarily unavailable'; + exit; +} + +/** + * The function is sumilar to php readfile, but it send all required headers and can send file by chunks and suports file seek + * @param $sPath path to file to output to the browser + * @param $sFilename filename without path, ig file is saved from browser, then this name is used, not used(empty) by default + * @param $sMimeType file mime type, by default 'application/octet-stream' + * @param $iCacheAge file cache age, by default 0 + * @param $sCachePrivacy cache privacy 'public' (default value) or 'private' + * @param $sContentDisposition content disposition header ('inline' or 'attachment' usually + * @return true on success or false on error + */ +function bx_smart_readfile($sPath, $sFilename = '', $sMimeType = 'application/octet-stream', $iCacheAge = 0, $sCachePrivacy = 'public', $sContentDisposition = 'inline') +{ + if (!file_exists($sPath)) + return false; + + $fp = @fopen($sPath, 'rb'); + + $size = filesize($sPath); + $length = $size; + $start = 0; + $end = $size - 1; + + header('Content-Type: ' . $sMimeType); + header('Cache-Control: ' . $sCachePrivacy . ', must-revalidate, max-age=' . $iCacheAge); + header("Expires: " . gmdate('D, d M Y H:i:s', time() + $iCacheAge) . ' GMT'); + header("Last-Modified: " . gmdate('D, d M Y H:i:s', @filemtime($sPath)) . ' GMT'); + header("Accept-Ranges: bytes"); + if ($sFilename) + header('Content-Disposition: ' . $sContentDisposition . '; filename="' . $sFilename . '"'); + + if (isset($_SERVER['HTTP_RANGE'])) { + + $c_start = $start; + $c_end = $end; + + list(, $range) = explode('=', $_SERVER['HTTP_RANGE'], 2); + if (strpos($range, ',') !== false) { + header('HTTP/1.1 416 Requested Range Not Satisfiable'); + header("Content-Range: bytes $start-$end/$size"); + return false; + } + if ($range == '-') { + $c_start = $size - substr($range, 1); + }else{ + $range = explode('-', $range); + $c_start = $range[0]; + $c_end = (isset($range[1]) && is_numeric($range[1])) ? $range[1] : $size; + } + $c_end = ($c_end > $end) ? $end : $c_end; + if ($c_start > $c_end || $c_start > $size - 1 || $c_end >= $size) { + header('HTTP/1.1 416 Requested Range Not Satisfiable'); + header("Content-Range: bytes $start-$end/$size"); + return false; + } + $start = $c_start; + $end = $c_end; + $length = $end - $start + 1; + fseek($fp, $start); + header('HTTP/1.1 206 Partial Content'); + } + header("Content-Range: bytes $start-$end/$size"); + header("Content-Length: ".$length); + + set_time_limit(0); + $buffer = 1024 * 8; + while(!feof($fp) && ($p = ftell($fp)) <= $end) { + + if ($p + $buffer > $end) { + $buffer = $end - $p + 1; + } + echo fread($fp, $buffer); + flush(); + } + + fclose($fp); + + return true; +} + +/** + * Wrap in A tag links in TEXT string + * @param $text - text string without tags + * @param $sAttrs - attributes string to add to the added A tag + * @param $bHtmlSpecialChars - apply htmlspecialchars before processing + * @return string where all links are wrapped in A tag + */ +function bx_linkify($text, $sAttrs = '', $bHtmlSpecialChars = false) +{ + if ($bHtmlSpecialChars) + $text = htmlspecialchars($text, ENT_NOQUOTES, 'UTF-8'); + + $re = "@\b((https?://)|(www\.))(([0-9a-zA-Z_!~*'().&=+$%-]+:)?[0-9a-zA-Z_!~*'().&=+$%-]+\@)?(([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-zA-Z_!~*'()-]+\.)*([0-9a-zA-Z][0-9a-zA-Z-]{0,61})?[0-9a-zA-Z]\.[a-zA-Z]{2,16})(:[0-9]{1,4})?((/[0-9a-zA-Z_!~*'().;?:\@&=+$,%#-]+)*/?)@"; + preg_match_all($re, $text, $matches, PREG_OFFSET_CAPTURE); + + $matches = $matches[0]; + + if ($i = count($matches)) + $bAddNofollow = getParam('sys_add_nofollow') == 'on'; + + while ($i--) + { + $sAttrsLocal = $sAttrs; + $url = $matches[$i][0]; + if (!preg_match('@^https?://@', $url)) + $url = 'http://'.$url; + + if (strncmp(BX_DOL_URL_ROOT, $url, strlen(BX_DOL_URL_ROOT)) !== 0) { + $sAttrsLocal .= ' target="_blank" '; + if ($bAddNofollow) + $sAttrsLocal .= ' rel="nofollow" '; + } + + $text = substr_replace($text, '<a ' . $sAttrsLocal . ' href="'.$url.'">'.$matches[$i][0].'</a>', $matches[$i][1], strlen($matches[$i][0])); + } + + // email pattern + $mail_pattern = "/([A-z0-9\._-]+\@[A-z0-9_-]+\.)([A-z0-9\_\-\.]{1,}[A-z])/"; + $text = preg_replace($mail_pattern, '<a href="mailto:$1$2">$1$2</a>', $text); + + return $text; +} + +function bx_linkify_embeded($sText) +{ + $sRegex = '/\b((https?:\/\/)|(www\.))((([0-9a-zA-Z_!~*\'().&=+$%-]+:)?[0-9a-zA-Z_!~*\'().&=+$%-]+@)?(([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-zA-Z_!~*\'()-]+\.)*([0-9a-zA-Z][0-9a-zA-Z-]{0,61})?[0-9a-zA-Z]\.[a-zA-Z]{2,16})(:[0-9]{1,4})?((\/[0-9a-zA-Z_!~*\'().;?:@&=+$,%#-]*)*))/'; + $aMatches = []; + preg_match_all($sRegex, $sText, $aMatches, PREG_SET_ORDER); + + // Reverse the matches to mimic JavaScript's reverse order processing + $aMatches = array_reverse($aMatches); + + $sUrlRoot = BX_DOL_URL_ROOT; + $sUrlRootApi = bx_api_get_base_url(); + + $sLink = ''; + foreach($aMatches as $aMatch) { + if(!strstr($aMatch[0], $sUrlRoot) && ($sUrlRootApi === false || !strstr($aMatch[0], $sUrlRootApi))) { + $sLink = $aMatch[0]; // Returns the first URL that doesn't include the restricted domains + } + } + + $sResult = ''; + if($sLink) { + bx_import('BxDolEmbed'); + if(($oEmbed = BxDolEmbed::getObjectInstance('sys_system')) !== false) + $sResult = $oEmbed->getLinkHTML($sLink); + } + + return $sResult; +} + +/** + * Wrap in A tag links in HTML string, which aren't wrapped in A tag yet + * @param $sHtmlOrig - HTML string + * @param $sAttrs - attributes string to add to the added A tag + * @return modified HTML string, in case of errror original string is returned + */ +function bx_linkify_html($sHtmlOrig, $sAttrs = '') +{ + if (!trim($sHtmlOrig)) + return $sHtmlOrig; + + $sId = 'bx-linkify-' . md5(microtime()); + $dom = new DOMDocument(); + @$dom->loadHTML('<?xml encoding="UTF-8"><div id="' . $sId . '">' . $sHtmlOrig . '</div>'); + $xpath = new DOMXpath($dom); + + foreach ($xpath->query('//text()') as $text) { + if (!empty($text->parentNode) && !empty($text->parentNode->tagName) && 'a' == $text->parentNode->tagName) + continue; + $frag = $dom->createDocumentFragment(); + @$frag->appendXML(bx_linkify($text->nodeValue, $sAttrs, true)); + $text->parentNode->replaceChild($frag, $text); + } + + if (version_compare(PHP_VERSION, '5.3.6') >= 0) + $s = $dom->saveHTML($dom->getElementById($sId)); + else + $s = $dom->saveXML($dom->getElementById($sId), LIBXML_NOEMPTYTAG); + + if (false === $s) // in case of error return original string + return $sHtmlOrig; + + if (false !== ($iPos = mb_strpos($s, '<html><body>')) && $iPos < mb_strpos($s, $sId)) + $s = mb_substr($s, $iPos + 12, -15); // strip <html><body> tags and everything before them + + return mb_substr($s, 54, -6); // strip added tags +} + +/** + * Returns current site protocol http:// or https:// + */ +function bx_proto() +{ + return 0 === strncmp('https', BX_DOL_URL_ROOT, 5) ? 'https' : 'http'; +} + +/** + * Checks protocol in the link + */ +function bx_has_proto($sLink) +{ + return preg_match('@^https?://@', $sLink); +} + +function bx_is_empty_array ($a) +{ + if (!is_array($a)) + return true; + if (empty($a)) + return true; + foreach ($a as $k => $v) + if ($v) + return false; + return true; +} + +function bx_is_full_array ($a) +{ + if (!is_array($a)) + return false; + if (empty($a)) + return false; + foreach ($a as $k => $v) + if (empty($v)) + return false; + return true; +} + +function bx_is_url_in_content ($sContent, $bSkipLocalUrls = false) +{ + if ($bSkipLocalUrls) + $sContent = str_replace(BX_DOL_URL_ROOT, '', $sContent); + + $a = array( + 'http://', + 'https://', + 'https/', + 'http/', + 'www.', + '.com' + ); + foreach ($a as $s) + if (false !== strpos($sContent, $s)) + return true; + + return false; +} + +function bx_is_dynamic_request () +{ + return bx_get('dynamic') || (isset($_SERVER['HTTP_X_REQUESTED_WITH']) && 'XMLHttpRequest' == $_SERVER['HTTP_X_REQUESTED_WITH']); +} + +function bx_is_htmx_request () +{ + return !empty($_SERVER['HTTP_HX_REQUEST']); +} + +function bx_get_htmx_target () +{ + if(!bx_is_htmx_request()) + return false; + + return isset($_SERVER['HTTP_HX_TARGET']) ? $_SERVER['HTTP_HX_TARGET'] : false; +} + +function bx_get_htmx_attrs ($aAttrs, $mPreload = false) +{ + if(!$aAttrs) + return ''; + + if($mPreload === true) + $mPreload = 'mousedown'; + + $aHxAttrs = []; + array_walk($aAttrs, function($mixedValue, $sIndex) use (&$aHxAttrs) { + $aHxAttrs['hx-' . $sIndex] = $mixedValue; + }); + + return bx_convert_array2attrs($aHxAttrs) . ($mPreload ? ' preload="' . $mPreload . '"' : ''); +} + +function bx_idn_to_utf8($sUrl, $bReturnDomain = false) +{ + return bx_idn_to('idn_to_utf8', $sUrl, $bReturnDomain); +} + +function bx_idn_to_ascii($sUrl, $bReturnDomain = false) +{ + return bx_idn_to('idn_to_ascii', $sUrl, $bReturnDomain); +} + +function bx_idn_to($sMethod, $sUrl, $bReturnDomain = false) +{ + $aUrl = parse_url($sUrl); + if($aUrl === false) + return $sUrl; + + $sResult = $aUrl['host']; + if(function_exists($sMethod)) + $sResult = $sMethod($sResult, IDNA_DEFAULT, (defined('INTL_IDNA_VARIANT_UTS46') ? INTL_IDNA_VARIANT_UTS46 : INTL_IDNA_VARIANT_2003)); + + if($bReturnDomain) + return $sResult; + + $sResult = (!empty($aUrl['scheme']) ? $aUrl['scheme'] . '://' : '' ) . $sResult; + $sResult = $sResult . (!empty($aUrl['path']) ? $aUrl['path'] : ''); + $sResult = $sResult . (!empty($aUrl['query']) ? '?' . $aUrl['query'] : ''); + + return $sResult; +} + +function bx_is_mobile() +{ + if(!isset($_SERVER['HTTP_USER_AGENT'])) + return false; + + $s = $_SERVER['HTTP_USER_AGENT']; + return preg_match('/(android|bb\d+|meego|una).+mobile|avantgo|bada\/|blackberry|blazer|compal|elaine|fennec|hiptop|iemobile|ip(hone|od)|iris|kindle|lge |maemo|midp|mmp|mobile.+firefox|netfront|opera m(ob|in)i|palm( os)?|phone|p(ixi|re)\/|plucker|pocket|psp|series(4|6)0|symbian|treo|up\.(browser|link)|vodafone|wap|windows ce|xda|xiino/i', $s) || preg_match('/1207|6310|6590|3gso|4thp|50[1-6]i|770s|802s|a wa|abac|ac(er|oo|s\-)|ai(ko|rn)|al(av|ca|co)|amoi|an(ex|ny|yw)|aptu|ar(ch|go)|as(te|us)|attw|au(di|\-m|r |s )|avan|be(ck|ll|nq)|bi(lb|rd)|bl(ac|az)|br(e|v)w|bumb|bw\-(n|u)|c55\/|capi|ccwa|cdm\-|cell|chtm|cldc|cmd\-|co(mp|nd)|craw|da(it|ll|ng)|dbte|dc\-s|devi|dica|dmob|do(c|p)o|ds(12|\-d)|el(49|ai)|em(l2|ul)|er(ic|k0)|esl8|ez([4-7]0|os|wa|ze)|fetc|fly(\-|_)|g1 u|g560|gene|gf\-5|g\-mo|go(\.w|od)|gr(ad|un)|haie|hcit|hd\-(m|p|t)|hei\-|hi(pt|ta)|hp( i|ip)|hs\-c|ht(c(\-| |_|a|g|p|s|t)|tp)|hu(aw|tc)|i\-(20|go|ma)|i230|iac( |\-|\/)|ibro|idea|ig01|ikom|im1k|inno|ipaq|iris|ja(t|v)a|jbro|jemu|jigs|kddi|keji|kgt( |\/)|klon|kpt |kwc\-|kyo(c|k)|le(no|xi)|lg( g|\/(k|l|u)|50|54|\-[a-w])|libw|lynx|m1\-w|m3ga|m50\/|ma(te|ui|xo)|mc(01|21|ca)|m\-cr|me(rc|ri)|mi(o8|oa|ts)|mmef|mo(01|02|bi|de|do|t(\-| |o|v)|zz)|mt(50|p1|v )|mwbp|mywa|n10[0-2]|n20[2-3]|n30(0|2)|n50(0|2|5)|n7(0(0|1)|10)|ne((c|m)\-|on|tf|wf|wg|wt)|nok(6|i)|nzph|o2im|op(ti|wv)|oran|owg1|p800|pan(a|d|t)|pdxg|pg(13|\-([1-8]|c))|phil|pire|pl(ay|uc)|pn\-2|po(ck|rt|se)|prox|psio|pt\-g|qa\-a|qc(07|12|21|32|60|\-[2-7]|i\-)|qtek|r380|r600|raks|rim9|ro(ve|zo)|s55\/|sa(ge|ma|mm|ms|ny|va)|sc(01|h\-|oo|p\-)|sdk\/|se(c(\-|0|1)|47|mc|nd|ri)|sgh\-|shar|sie(\-|m)|sk\-0|sl(45|id)|sm(al|ar|b3|it|t5)|so(ft|ny)|sp(01|h\-|v\-|v )|sy(01|mb)|t2(18|50)|t6(00|10|18)|ta(gt|lk)|tcl\-|tdg\-|tel(i|m)|tim\-|t\-mo|to(pl|sh)|ts(70|m\-|m3|m5)|tx\-9|up(\.b|g1|si)|utst|v400|v750|veri|vi(rg|te)|vk(40|5[0-3]|\-v)|vm40|voda|vulc|vx(52|53|60|61|70|80|81|83|85|98)|w3c(\-| )|webc|whit|wi(g |nc|nw)|wmlb|wonu|x700|yas\-|your|zeto|zte\-/i', substr($s, 0, 4)); +} + +function bx_get_device_pixel_ratio() +{ + $iRatio = 1; + if(!isset($_COOKIE['devicePixelRatio'])) + return $iRatio; + + $iDevicePixelRatio = intval($_COOKIE['devicePixelRatio']); + if($iDevicePixelRatio >= 2) + $iRatio = 2; + + return $iRatio; +} + +/** + * Log to logs object + * @param $sObject - logs object + * @param $mixed - string or array to log + */ +function bx_log($sObject, $mixed) +{ + if (class_exists('BxDolLogs', true) && $o = BxDolLogs::getObjectInstance($sObject)) + return $o->add($mixed); + else + return false; +} + +function bx_birthday2age($sBirthday) +{ + $iPosSpace = strpos($sBirthday, ' '); + if($iPosSpace !== false) + $sBirthday = trim(substr($sBirthday, 0, $iPosSpace)); + + $aDate = explode('-', $sBirthday); + + $iCdYear = (int)date('Y'); + $iCdMonth = (int)date('n'); + $iCdDay = (int)date('j'); + + $iResult = $iCdYear - (int)$aDate[0]; + if($iCdMonth < (int)$aDate[1] || ($iCdMonth == (int)$aDate[1] && $iCdDay < (int)$aDate[2])) + $iResult -= 1; + + return $iResult; +} + +function bx_setcookie($sName, $sValue = "", $oExpiresOrOptions = 0, $sPath = 'auto', $sDomain = '', $bSecure = 'auto', $bHttpOnly = false) +{ + + $aUrl = 'auto' === $sPath || 'auto' === $bSecure ? parse_url(BX_DOL_URL_ROOT) : []; + + if (defined('BX_MULTISITE_URL_COOKIE')) { + $aUrl = parse_url(BX_MULTISITE_URL_COOKIE); + $sDomain = $aUrl['host']; + } + + if (bx_is_api()) + $sPath = trim(getParam('sys_api_cookie_path')); + elseif ('auto' === $sPath) + $sPath = isset($aUrl['path']) && !empty($aUrl['path']) ? $aUrl['path'] : '/'; + + if (bx_is_api()) + $bSecure = !!getParam('sys_api_cookie_secure'); + elseif ('auto' === $bSecure) + $bSecure = 0 === strcasecmp('https', $aUrl['scheme']); + + if (PHP_VERSION_ID < 70300) { + if (!defined('BX_MULTISITE_URL_COOKIE') && ('memberPassword' == $sName || 'memberSession' == $sName)) + $sPath .= '; SameSite=' . (bx_is_api() ? getParam('sys_api_cookie_samesite') : getParam('sys_samesite_cookies')); + return setcookie($sName, $sValue, $oExpiresOrOptions, $sPath, $sDomain, $bSecure, $bHttpOnly); + } + else { + $aOptions = is_array($oExpiresOrOptions) ? $oExpiresOrOptions : [ + 'expires' => $oExpiresOrOptions, + 'path' => $sPath, + 'domain' => $sDomain, + 'secure' => $bSecure, + 'httponly' => $bHttpOnly, + ]; + if (!defined('BX_MULTISITE_URL_COOKIE') && !isset($aOptions['samesite']) && ('memberPassword' == $sName || 'memberSession' == $sName)) + $aOptions['samesite'] = bx_is_api() ? getParam('sys_api_cookie_samesite') : getParam('sys_samesite_cookies'); + return setcookie($sName, $sValue, $aOptions); + } +} + +function bx_get_ip_hash($sIp) +{ + return sprintf("%u", crc32(crc32($sIp) + crc32(BX_DOL_SECRET))); +} + +function is_private_ip ($sIp) +{ + if (filter_var($sIp, FILTER_VALIDATE_IP, FILTER_FLAG_IPV4 | FILTER_FLAG_IPV6) !== $sIp) + return false; + + return filter_var($sIp, FILTER_VALIDATE_IP, FILTER_FLAG_IPV4 | FILTER_FLAG_IPV6 | FILTER_FLAG_NO_PRIV_RANGE | FILTER_FLAG_NO_RES_RANGE) !== $sIp; +} + +function bx_absolute_url($sUrl, $sPrefix = BX_DOL_URL_ROOT) +{ + if (!preg_match('/^https?:\/\//', $sUrl)) + $sUrl = $sPrefix . $sUrl; + return $sUrl; +} + +function bx_is_api() +{ + return defined('BX_API') || bx_get('api') ? true : false; +} + +function bx_api_get_sql($q) +{ + $sql = false; + $t = false; + if ($q == 'accounts_count'){ + $sql = 'SELECT Count(*) FROM sys_accounts'; + $t = 'One'; + } + + if ($sql){ + $oDb = BxDolDb::getInstance(); + if ($t == 'One') + echo json_encode($oDb->getOne($sql)); + else + echo json_encode($oDb->getAll($sql)); + exit; + } +} + +function bx_api_check_access() +{ + if (!getParam('sys_api_enable')) { + header('HTTP/1.0 403 Forbidden'); + BxDolLanguages::getInstance(); + echo json_encode(['status' => 403, 'error' => _t("_Access denied")]); + exit; + } + + $aHeaders = function_exists('getallheaders') ? getallheaders() : false; + if ($aHeaders) { + $sOriginHeader = isset($aHeaders['Origin']) ? $aHeaders['Origin'] : false; + $sAuthHeader = isset($aHeaders['Authorization']) ? $aHeaders['Authorization'] : false; + } + else { + $sOriginHeader = isset($_SERVER['HTTP_ORIGIN']) ? $_SERVER['HTTP_ORIGIN'] : false; + $sAuthHeader = isset($_SERVER['HTTP_AUTHORIZATION']) ? $_SERVER['HTTP_AUTHORIZATION'] : false; + } + + if ($sAuthHeader && getParam('sys_api_access_by_key')) { + if (!BxDolApiQuery::getInstance()->getKey(str_replace('Bearer ', '', $sAuthHeader))) { + header('HTTP/1.0 403 Forbidden'); + BxDolLanguages::getInstance(); + echo json_encode(['status' => 403, 'error' => _t("_Access denied")]); + exit; + } + if(bx_get('r') == 'q'){ + bx_api_get_sql(bx_get('q')); + } + } + elseif (getParam('sys_api_access_by_origin') && $sOriginHeader) { + + if (parse_url($sOriginHeader, PHP_URL_HOST) != parse_url(BX_DOL_URL_ROOT, PHP_URL_HOST)) { + + if (!BxDolApiQuery::getInstance()->getOrigin($sOriginHeader)) { + header('HTTP/1.0 403 Forbidden'); + BxDolLanguages::getInstance(); + echo json_encode(['status' => 403, 'error' => _t("_Access denied")]); + exit; + } + + header('Access-Control-Allow-Origin: ' . $sOriginHeader); + header('Access-Control-Allow-Credentials: true'); + + if(bx_get('r') == 'q'){ + bx_api_get_sql(bx_get('q')); + } + + if ('OPTIONS' == $_SERVER['REQUEST_METHOD']) { + header('Access-Control-Allow-Methods: POST, GET'); + header('Access-Control-Allow-Headers: Accept-Encoding, Authorization, Cache-Control, Connection, Host, Origin, Pragma, Referer, User-Agent, X-Custom-Header, X-Requested-With'); + exit; + } + } + } + else { + header('HTTP/1.0 403 Forbidden'); + BxDolLanguages::getInstance(); + echo json_encode(['status' => 403, 'error' => _t("_Access denied")]); + exit; + } + + // TODO: Temporarily to use logged state + // bx_login(1); + // check_logged(); +} + +function bx_api_get_base_url() +{ + if(($sResult = getParam('sys_api_url_root_email')) != '') + return $sResult; + + if(($sResult = getParam('sys_api_url_root_push')) != '') + return $sResult; + + return false; +} + +function bx_api_get_relative_url($sUrl, $sPrefix = BX_DOL_URL_ROOT) +{ + return '/' . bx_ltrim_str($sUrl, $sPrefix); +} + +function bx_api_get_block($sType, $sData, $aParams = []) +{ $aData = ['id' => isset($aParams['id']) ? $aParams['id'] : 1 , 'type' => $sType, 'data' => $sData]; + if (isset($aParams['ext'])) + $aData = array_merge($aData, $aParams['ext']); + return $aData; +} + +function bx_api_get_msg($sMessage, $aParams = []) +{ + return bx_api_get_block('msg', $sMessage != '' ? _t($sMessage) : '', $aParams); +} + +function bx_api_get_image($sStorage, $iId) +{ + $oS = BxDolStorage::getObjectInstance($sStorage); + $aFile = $oS->getFile($iId); + $sUrl = $oS->getFileUrlById($iId); + $iWidth = 500; + $iHeight = 500; + + if(!empty($aFile['dimensions'])){ + $aTmp = explode('x', $aFile['dimensions']); + $iWidth = (int) $aTmp[0]; + $iHeight = (int) $aTmp[1]; + } + if (!empty($sUrl)){ + return [ + 'storage' => $sStorage, + 'src' => $sUrl, + 'width' => $iWidth, + 'height' => $iHeight, + ]; + } + return false; +} + +function bx_api_get_browse_params($sParams, $bParamsOnly = false) +{ + if(!$sParams || !is_string($sParams)) + return []; + + $aParams = json_decode($sParams, true); + if(isset($aParams['params']['validate']) && !is_array($aParams['params']['validate'])) + $aParams['params']['validate'] = !empty($aParams['params']['validate']) ? explode(',', $aParams['params']['validate']) : []; + + if(!$bParamsOnly) + return $aParams; + + if(!isset($aParams['params'])) + return []; + + return $aParams['params']; +} +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/inc/version.inc.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/inc/version.inc.php new file mode 100644 index 0000000000..17209ebdb3 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/inc/version.inc.php @@ -0,0 +1,12 @@ +<?php defined('BX_DOL') or defined('BX_DOL_INSTALL') or die('hack attempt'); +/** + * Copyright (c) UNA, Inc - https://una.io + * MIT License - https://opensource.org/licenses/MIT + * + * @defgroup UnaCore UNA Core + * @{ + */ + +define('BX_DOL_VERSION', '14.0.0-RC1'); ///< system files version, for DB version @see bx_get_ver, DB and files version must match + +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/general/classes/BxBaseModGeneralFormEntry.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/general/classes/BxBaseModGeneralFormEntry.php new file mode 100644 index 0000000000..1d17356e14 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/general/classes/BxBaseModGeneralFormEntry.php @@ -0,0 +1,1160 @@ +<?php defined('BX_DOL') or die('hack attempt'); +/** + * Copyright (c) UNA, Inc - https://una.io + * MIT License - https://opensource.org/licenses/MIT + * + * @defgroup BaseGeneral Base classes for modules + * @ingroup UnaModules + * + * @{ + */ + +/** + * Create/edit entry form + */ +class BxBaseModGeneralFormEntry extends BxTemplFormView +{ + protected static $_isCssJsGeneralModuleAdded = false; + + protected $MODULE; + + protected $_oModule; + + protected $_aMetatagsFieldsWithKeywords = array(); + protected $_oMetatagsObject = null; + protected $_oMetatagsContentId = 0; + + protected $_sGhostTemplate = 'form_ghost_template.html'; + + protected $_aTrackFieldsChanges; + + protected $_iContentId; + + protected $_bAllowChangeUserForAdmins; + + public function __construct($aInfo, $oTemplate = false) + { + if (!isset($this->_bAllowChangeUserForAdmins)) + $this->_bAllowChangeUserForAdmins = true; + + parent::__construct($aInfo, $oTemplate); + + $this->_oModule = BxDolModule::getInstance($this->MODULE); + + $this->_aTrackFieldsChanges = array(); + + $CNF = &$this->_oModule->_oConfig->CNF; + + if (isset($CNF['FIELD_ADDED']) && isset($this->aInputs[$CNF['FIELD_ADDED']])) { + $this->aInputs[$CNF['FIELD_ADDED']]['date_filter'] = BX_DATA_INT; + $this->aInputs[$CNF['FIELD_ADDED']]['date_format'] = BX_FORMAT_DATE; + } + + if (isset($CNF['FIELD_CHANGED']) && isset($this->aInputs[$CNF['FIELD_CHANGED']])) { + $this->aInputs[$CNF['FIELD_CHANGED']]['date_filter'] = BX_DATA_INT; + $this->aInputs[$CNF['FIELD_CHANGED']]['date_format'] = BX_FORMAT_DATE; + } + + if (isset($CNF['FIELD_TEXT']) && isset($this->aInputs[$CNF['FIELD_TEXT']]) && isset($CNF['FIELD_TEXT_ID'])) { + $this->aInputs[$CNF['FIELD_TEXT']]['attrs'] = array_merge ( + array ('id' => $CNF['FIELD_TEXT_ID']), + is_array($this->aInputs[$CNF['FIELD_TEXT']]['attrs']) ? $this->aInputs[$CNF['FIELD_TEXT']]['attrs'] : array () + ); + } + + if (isset($CNF['FIELD_LABELS']) && isset($this->aInputs[$CNF['FIELD_LABELS']]) && !empty($CNF['OBJECT_METATAGS']) && ($oMetatags = BxDolMetatags::getObjectInstance($CNF['OBJECT_METATAGS'])) && $oMetatags->keywordsIsEnabled()) { + $this->aInputs[$CNF['FIELD_LABELS']]['meta_object'] = $CNF['OBJECT_METATAGS']; + } + + if (isset($CNF['FIELD_LOCATION_PREFIX']) && isset($this->aInputs[$CNF['FIELD_LOCATION_PREFIX']])) { + $this->aInputs[$CNF['FIELD_LOCATION_PREFIX']]['manual_input'] = true; + } + + // add ability to change author by admins in some apps + if (!empty($CNF['FIELD_AUTHOR']) && ($this->_oModule->_isModerator() || $this->_oModule->_isAdministrator()) && $this->_isChangeUserForAdmins($this->aParams['display'])) + $this->aInputs = array_merge([ + $CNF['FIELD_AUTHOR'] => [ + 'type' => 'custom', + 'name' => $CNF['FIELD_AUTHOR'], + 'db' => ['pass' => 'Xss'], + 'caption' => _t('_sys_form_input_caption_author') + ], + ], $this->aInputs); + + if (isset($CNF['FIELD_PHOTO']) && isset($this->aInputs[$CNF['FIELD_PHOTO']])) { + $this->aInputs[$CNF['FIELD_PHOTO']]['storage_object'] = $CNF['OBJECT_STORAGE']; + $this->aInputs[$CNF['FIELD_PHOTO']]['uploaders'] = !empty($this->aInputs[$CNF['FIELD_PHOTO']]['value']) ? unserialize($this->aInputs[$CNF['FIELD_PHOTO']]['value']) : $CNF['OBJECT_UPLOADERS']; + $this->aInputs[$CNF['FIELD_PHOTO']]['images_transcoder'] = $CNF['OBJECT_IMAGES_TRANSCODER_PREVIEW']; + $this->aInputs[$CNF['FIELD_PHOTO']]['storage_private'] = 0; + $this->aInputs[$CNF['FIELD_PHOTO']]['multiple'] = true; + $this->aInputs[$CNF['FIELD_PHOTO']]['content_id'] = 0; + $this->aInputs[$CNF['FIELD_PHOTO']]['ghost_template'] = ''; + } + + $aPrivacyFields = $this->_getPrivacyFields(); + foreach($aPrivacyFields as $sField => $sObject) + $this->_preparePrivacyField($sField, $sObject); + + foreach($this->aInputs as $sKey => $aInput) { + if ($aInput['type'] == 'nested_form'){ + $this->genGhostTemplateForInputNestedForm ($this->aInputs[$sKey]); + } + } + } + + protected function _isChangeUserForAdmins($sDisplay) + { + $CNF = &$this->_oModule->_oConfig->CNF; + + if(!$this->_bAllowChangeUserForAdmins) + return false; + + if(isset($CNF['OBJECT_FORM_ENTRY_DISPLAY_ADD']) && $sDisplay == $CNF['OBJECT_FORM_ENTRY_DISPLAY_ADD']) + return true; + + if(isset($CNF['OBJECT_FORM_ENTRY_DISPLAY_EDIT']) && $sDisplay == $CNF['OBJECT_FORM_ENTRY_DISPLAY_EDIT']) + return true; + + return false; + } + + function getCode($bDynamicMode = false) + { + $CNF = &$this->_oModule->_oConfig->CNF; + + if(!$bDynamicMode && bx_is_dynamic_request()) + $bDynamicMode = true; + + $sResult = parent::getCode($bDynamicMode); + + $aPrivacyFields = $this->_getPrivacyFields(); + foreach($aPrivacyFields as $sField => $sObject) + $this->_addCssJsPrivacyField($sField, $sObject, $bDynamicMode); + + if(isset($CNF['PARAM_MULTICAT_ENABLED']) && $CNF['PARAM_MULTICAT_ENABLED'] === true) { + $sInclude2 = ''; + $sInclude2 .= $this->_oModule->_oTemplate->addJs(array('BxDolCategories.js'), $bDynamicMode); + $sInclude2 .= $this->_oModule->_oTemplate->addCss(array('categories.css'), $bDynamicMode); + + $sResult .= ($bDynamicMode ? $sInclude2 : '') . $this->_oModule->_oTemplate->getJsCode('categories'); + } + + return $sResult; + } + + /** + * Nested forms processing + */ + function genInputNestedForm (&$aInput, $sInfo = '', $sError = '') + { + $sUniqId = genRndPwd (8, false); + $aNestedForms = array(); + if (!$this->isSubmitted()){ + $aGhostTemplateParams = is_object($aInput['ghost_template']) ? $aInput['ghost_template']->aParams : $aInput['ghost_template']['params']; + + $aNestedValues = $this->_oModule->_oDb->getNestedBy(array( + 'type' => 'content_id', + 'id' => $this->_iContentId, + 'key_name' => $aGhostTemplateParams['db']['key'] + ), $aGhostTemplateParams['db']['table']); + + foreach($aNestedValues as $aNestedValue) { + $aNestedValuesRv = array(); + $oForm = $this->getNestedFormObject($aInput); + + foreach($aNestedValue as $aNestedKey => $aNestedItem) { + if ($oForm->aParams['db']['key'] == $aNestedKey) + $aNestedValuesRv[$aNestedKey . '[]'] = $aNestedItem; + else + $aNestedValuesRv[$aNestedKey] = $aNestedItem; + } + + $oForm->initChecker($aNestedValuesRv); + array_push( + $aNestedForms, + array( + 'key_value' => $aNestedValuesRv[$oForm->aParams['db']['key'] . '[]'], + 'key_name' => $aInput['name'], + 'form_code' => $oForm->genRows(), + 'js_instance_name' => 'oBxNestedForm_' . $sUniqId, + 'nested_type' => $aInput['name'], + ) + ); + } + } + else{ + $aInput['ghost_templates'] = $aInput['ghost_template']; + $this->genGhostTemplateForInputNestedForm ($aInput); + foreach($aInput['ghost_templates'] as $oForm) { + if (isset($oForm->aInputs)){ + array_push( + $aNestedForms, + array( + 'key_value' => $oForm->aInputs[$aInput['name']]['value'], + 'key_name' => $aInput['name'], + 'form_code' => $oForm->genRows(), + 'js_instance_name' => 'oBxNestedForm_' . $sUniqId, + 'nested_type' => $aInput['name'], + ) + ); + } + } + } + + return $this->oTemplate->parseHtmlByName('form_field_nested_form.html', array( + 'bx_repeat:items' => $aNestedForms, + 'info' => $sInfo, + 'error' => $sError, + 'uniq_id' => $sUniqId, + 'js_instance_name' => 'oBxNestedForm_' . $sUniqId, + 'options' => json_encode(array( + 'uniq_id' => $sUniqId, + 'js_instance_name' => 'oBxNestedForm_' . $sUniqId, + 'template_ghost' => $this->genGhostTemplate($aInput), + 'form_name' => $aInput['value'], + 'action_uri' => $this->_oModule->_oConfig->getBaseUri(), + 'nested_type' => $aInput['name'], + )), + )); + } + + function genNestedForm (&$aInput) + { + $sResult = ''; + $aGhostTemplateParams = is_object($aInput['ghost_template']) ? $aInput['ghost_template']->aParams : $aInput['ghost_template']['params']; + + $aNestedValues = $this->_oModule->_oDb->getNestedBy([ + 'type' => 'content_id', + 'id' => $this->_iContentId, + 'key_name' => $aGhostTemplateParams['db']['key'] + ], $aGhostTemplateParams['db']['table']); + + foreach($aNestedValues as $aNestedValue) { + $oForm = $this->getNestedFormObject($aInput, true); + + $aNestedValuesRv = []; + foreach($aNestedValue as $aNestedKey => $aNestedItem) { + if ($oForm->aParams['db']['key'] == $aNestedKey) + $aNestedValuesRv[$aNestedKey . '[]'] = $aNestedItem; + else + $aNestedValuesRv[$aNestedKey] = $aNestedItem; + } + + $oForm->initChecker($aNestedValuesRv); + + $sValue = ''; + if($aInput['rateable']) { + $iId = BxDolFormQuery::getFormField($this->id, $aInput['name'], $this->_iContentId, $aNestedValuesRv[$oForm->aParams['db']['key'] . '[]']); + + $sVoteElement = ''; + $sVoteCounter = ''; + if(($oVote = BxDolVote::getObjectInstance($aInput['rateable'], $iId)) !== null) { + $sVoteElement = $oVote->getElementInline(['show_counter_empty' => true, 'show_counter' => false, 'show_counter_style' => 'simple', 'dynamic_mode' => $this->_bDynamicMode]); + $sVoteCounter = $oVote->getCounter(['show_counter_empty' => true, 'show_counter' => true, 'show_counter_style' => 'simple', 'dynamic_mode' => $this->_bDynamicMode]); + } + + $sValue = $this->oTemplate->parseHtmlByName('form_view_rateable_row.html', [ + 'value' => $oForm->getCode(), + 'rate_btn' => $sVoteElement, + 'rate' => $sVoteCounter, + ]); + } + else + $sValue = $oForm->getCode(); + + $sResult .= $this->oTemplate->parseHtmlByName('form_view_nested_row.html', [ + 'value' => $sValue + ]); + } + + if(!$sResult) + return ''; + + $aTmplVarsIcon = []; + if(!empty($aInput['icon'])) { + list($sIcon, $sIconUrl, $sIconA, $sIconHtml) = BxTemplFunctions::getInstanceWithTemplate($this->oTemplate)->getIcon($aInput['icon']); + + $aTmplVarsIcon = [ + 'bx_if:icon' => [ + 'condition' => (bool)$sIcon, + 'content' => ['icon' => $sIcon], + ], + 'bx_if:icon-html' => [ + 'condition' => (bool)$sIconHtml, + 'content' => ['icon' => $sIconHtml], + ], + 'bx_if:image_inline' => [ + 'condition' => false, + 'content' => ['image' => ''], + ] + ]; + } + + return $this->oTemplate->parseHtmlByName('form_view_row.html', [ + 'type' => $aInput['type'], + 'class' => '', + 'bx_if:show_icon' => [ + 'condition' => !empty($aTmplVarsIcon), + 'content' => $aTmplVarsIcon + ], + 'caption' => isset($aInput['caption']) ? bx_process_output($aInput['caption']) : '', + 'class_value' => '', + 'value' => $sResult + ]); + } + + protected function genGhostTemplateForInputNestedForm (&$aInput) + { + $oForm = $this->getNestedFormObject($aInput); + $aInput['ghost_template'] = array ( + 'params' => array( + 'nested_form_template' => 'form_field_nested_form_wrapper.html', + 'db' => array( + 'table' => $oForm->aParams['db']['table'], + 'key' => $oForm->aParams['db']['key'], + 'submit_name' => $oForm->aParams['db']['key'], + ), + ), + 'inputs' => $oForm->aInputs + ); + } + + function getNestedFormObject (&$aInput, $bViewMode = false) + { + $oForm = BxDolForm::getObjectInstance($aInput['value'], $aInput['value'] . ($bViewMode ? '_view' : '')); + foreach($oForm->aInputs as $sKey => $aInput2) { + $sName = $oForm->aInputs[$sKey]['name']; + if (strpos($sName,'[]') === false) + $oForm->aInputs[$sKey]['name'] = $sName . '[]'; + } + return $oForm; + } + + /** + * Add field(s) which will be tracked during content update. + */ + public function addTrackFields($mixedFields, $mixedContent) + { + if(empty($mixedContent) || empty($mixedFields)) + return; + + if(!is_array($mixedContent)) { + $mixedContent = $this->_oModule->_oDb->getContentInfoById((int)$mixedContent); + if(empty($mixedContent) || !is_array($mixedContent)) + return; + } + + if(!is_array($mixedFields)) + $mixedFields = array($mixedFields); + + foreach($mixedFields as $sField) { + if(!isset($mixedContent[$sField])) + continue; + + $this->_aTrackFieldsChanges[$sField] = array( + 'old' => $mixedContent[$sField], + ); + } + } + + /** + * Checks if the field was changed. + */ + public function isTrackFieldChanged($sField, $bReturnValues = false) + { + if(!isset($this->_aTrackFieldsChanges[$sField]) || $this->_aTrackFieldsChanges[$sField] === false) + return false; + + return $bReturnValues ? $this->_aTrackFieldsChanges[$sField] : true; + } + + function initChecker ($aValues = array (), $aSpecificValues = array()) + { + $CNF = &$this->_oModule->_oConfig->CNF; + + $bValues = $aValues && !empty($aValues['id']); + + $this->_iContentId = isset($aValues['id']) ? $aValues['id'] : false; + + if (!empty($CNF['FIELD_LOCATION_PREFIX']) && isset($this->aInputs[$CNF['FIELD_LOCATION_PREFIX']]) && isset($aValues[$CNF['FIELD_ID']]) && !empty($CNF['OBJECT_METATAGS']) && ($oMetatags = BxDolMetatags::getObjectInstance($CNF['OBJECT_METATAGS'])) && $oMetatags->locationsIsEnabled()) + $this->aInputs[$CNF['FIELD_LOCATION_PREFIX']]['value'] = $oMetatags->locationsString($aValues[$CNF['FIELD_ID']], false); + + if (isset($CNF['FIELD_PHOTO']) && isset($this->aInputs[$CNF['FIELD_PHOTO']])) { + + $aContentInfo = false; + if ($aValues && !empty($aValues['id'])) { + $aContentInfo = $this->_oModule->_oDb->getContentInfoById ($aValues['id']); + $this->aInputs[$CNF['FIELD_PHOTO']]['content_id'] = $aValues['id']; + } + + $this->aInputs[$CNF['FIELD_PHOTO']]['ghost_template'] = $this->_oModule->_oTemplate->parseHtmlByName($this->_sGhostTemplate, $this->_getPhotoGhostTmplVars($aContentInfo)); + } + + if (isset($CNF['FIELD_LABELS']) && isset($this->aInputs[$CNF['FIELD_LABELS']]) && !empty($CNF['OBJECT_METATAGS']) && ($oMetatags = BxDolMetatags::getObjectInstance($CNF['OBJECT_METATAGS'])) && $oMetatags->keywordsIsEnabled() && !empty($aValues['id'])) { + $this->aInputs[$CNF['FIELD_LABELS']]['content_id'] = $aValues['id']; + if(($aLabels = $oMetatags->keywordsGet($aValues['id']))) + $this->aInputs[$CNF['FIELD_LABELS']]['value'] = array_intersect($aLabels, BxDolLabel::getInstance()->getLabels(array('type' => 'values'))); + } + + if (isset($CNF['FIELD_ANONYMOUS'], $this->aInputs[$CNF['FIELD_ANONYMOUS']]) && isset($CNF['FIELD_AUTHOR'], $aValues[$CNF['FIELD_AUTHOR']])) { + $this->aInputs[$CNF['FIELD_ANONYMOUS']]['checked'] = $aValues[$CNF['FIELD_AUTHOR']] < 0; + } + + if (isset($CNF['FIELD_MULTICAT']) && isset($this->aInputs[$CNF['FIELD_MULTICAT']]) && $CNF['PARAM_MULTICAT_ENABLED']) { + if ($bValues) + $this->aInputs[$CNF['FIELD_MULTICAT']]['content_id'] = $aValues['id']; + } + + $aPrivacyFields = $this->_getPrivacyFields(); + foreach($aPrivacyFields as $sField => $sObject) + $this->_preloadPrivacyField($sField, $sObject, $aValues); + + if(isset($CNF['FIELD_AUTHOR'], $this->aInputs[$CNF['FIELD_AUTHOR']])) { + if (isset($aValues[$CNF['FIELD_AUTHOR']]) && $aValues[$CNF['FIELD_AUTHOR']]) + $aValues[$CNF['FIELD_AUTHOR']] = abs($aValues[$CNF['FIELD_AUTHOR']]); + else + $aValues[$CNF['FIELD_AUTHOR']] = bx_get_logged_profile_id(); + } + + parent::initChecker ($aValues, $aSpecificValues); + + foreach($aPrivacyFields as $sField => $sObject) + $this->_validatePrivacyField($sField, $sObject, $aValues); + } + + public function insert ($aValsToAdd = array(), $isIgnore = false) + { + $CNF = &$this->_oModule->_oConfig->CNF; + + $iAuthor = -1; + if(isset($CNF['FIELD_AUTHOR'])) { + $sFa = $CNF['FIELD_AUTHOR']; + + $iAnonymous = isset($CNF['FIELD_ANONYMOUS'], $this->aInputs[$CNF['FIELD_ANONYMOUS']]) && $this->getCleanValue($CNF['FIELD_ANONYMOUS']) ? -1 : 1; + + if(empty($aValsToAdd[$sFa])) { + if(!isset($this->aInputs[$sFa]) || empty($this->getCleanValue($sFa))) + $iAuthor = bx_get_logged_profile_id(); + else + $iAuthor = $this->getCleanValue($sFa); + + $aValsToAdd[$sFa] = $iAnonymous * $iAuthor; + } + else { + $iAuthor = $aValsToAdd[$sFa]; + + $aValsToAdd[$sFa] *= $iAnonymous; + } + } + + if (isset($CNF['FIELD_ADDED']) && empty($aValsToAdd[$CNF['FIELD_ADDED']]) && empty($this->getCleanValue($CNF['FIELD_ADDED']))) + $aValsToAdd[$CNF['FIELD_ADDED']] = time(); + + if (isset($CNF['FIELD_CHANGED']) && empty($aValsToAdd[$CNF['FIELD_CHANGED']]) && empty($this->getCleanValue($CNF['FIELD_CHANGED']))) + $aValsToAdd[$CNF['FIELD_CHANGED']] = time(); + + if (CHECK_ACTION_RESULT_ALLOWED === $this->_oModule->checkAllowedSetThumb() && isset($CNF['FIELD_THUMB'])) { + $aThumb = isset($_POST[$CNF['FIELD_THUMB']]) ? bx_process_input ($_POST[$CNF['FIELD_THUMB']], BX_DATA_INT) : false; + $aValsToAdd[$CNF['FIELD_THUMB']] = 0; + if (!empty($aThumb)){ + if(is_array($aThumb) && ($iFileThumb = array_pop($aThumb))) + $aValsToAdd[$CNF['FIELD_THUMB']] = $iFileThumb; + else + $aValsToAdd[$CNF['FIELD_THUMB']] = $aThumb; + } + } + + if(!empty($CNF['OBJECT_METATAGS'])) + $this->_processMetas($aValsToAdd); + + if(isset($CNF['FIELD_STATUS']) && !empty($CNF['FIELDS_DELAYED_PROCESSING']) && !empty($CNF['OBJECT_VIDEOS_TRANSCODERS']['mp4'])) { + $oTranscoder = BxDolTranscoder::getObjectInstance($CNF['OBJECT_VIDEOS_TRANSCODERS']['mp4']); + + $aFields = $CNF['FIELDS_DELAYED_PROCESSING']; + if(is_string($aFields)) + $aFields = explode(',', $aFields); + + foreach($aFields as $sField) { + $mixedFieldValues = $this->getCleanValue($sField); + if(empty($mixedFieldValues)) + continue; + + $oStorage = BxDolStorage::getObjectInstance($this->aInputs[$sField]['storage_object']); + if(!$oStorage) + continue; + + if(!is_array($mixedFieldValues)) + $mixedFieldValues = array($mixedFieldValues); + + foreach($mixedFieldValues as $mixedFieldValue) { + $aInfo = $oStorage->getFile((int)$mixedFieldValue); + if(empty($aInfo) || !is_array($aInfo)) + continue; + + if(strncmp($aInfo['mime_type'], 'video/', 6) != 0) + continue; + + if($oTranscoder->isFileReady((int)$mixedFieldValue)) + continue; + + $aValsToAdd[$CNF['FIELD_STATUS']] = 'awaiting'; + break 2; + } + } + } + + if(isset($CNF['FIELD_STATUS_ADMIN']) && empty($aValsToAdd[$CNF['FIELD_STATUS_ADMIN']]) && !$this->_oModule->_isModerator() && !$this->_oModule->_oConfig->isAutoApproveEnabled()) + $aValsToAdd[$CNF['FIELD_STATUS_ADMIN']] = BX_BASE_MOD_GENERAL_STATUS_PENDING; + + $bMulticatEnabled = $this->_isMulticatEnabled(); + if ($bMulticatEnabled) + $this->processMulticatBefore($CNF['FIELD_MULTICAT'], $aValsToAdd); + $iContentId = parent::insert ($aValsToAdd, $isIgnore); + + if(!empty($iContentId)) { + foreach($this->aInputs as $aInput) { + if ($aInput['type'] == 'nested_form') { + if (is_array($aInput['ghost_template']) && !isset($aInput['ghost_template']['inputs'])) { + foreach ($aInput['ghost_template'] as $oFormNested) { + $iNestedContentId = $oFormNested->insert(array('content_id' => $iContentId)); + + if ($aInput['rateable']) { + BxDolFormQuery::addFormField($this->id, $aInput['name'], $iContentId, $iAuthor, $this->_oModule->getName(), $iNestedContentId); + } + } + } + } + } + + if ($bMulticatEnabled) + $this->processMulticatAfter($CNF['FIELD_MULTICAT'], $iContentId); + } + + foreach($this->aInputs as $aInput) { + if (isset($aInput['rateable']) && $aInput['rateable'] && $aInput['type'] != 'nested_form'){ + BxDolFormQuery::addFormField($this->id, $aInput['name'], $iContentId, $iAuthor, $this->_oModule->getName()); + } + } + + return $iContentId; + } + + function update ($iContentId, $aValsToAdd = array(), &$aTrackTextFieldsChanges = null) + { + $CNF = &$this->_oModule->_oConfig->CNF; + + $aContentInfo = $this->_oModule->_oDb->getContentInfoById($iContentId); + + $iAuthor = -1; + if(isset($CNF['FIELD_AUTHOR'])) { + $sFa = $CNF['FIELD_AUTHOR']; + + if(!empty($aValsToAdd[$sFa])) + $iAuthor = $aValsToAdd[$sFa]; + else if(isset($this->aInputs[$sFa]) && !empty($this->getCleanValue($sFa))) + $iAuthor = $this->getCleanValue($sFa); + else if(!empty($aContentInfo[$sFa])) + $iAuthor = $aContentInfo[$sFa]; + else + $iAuthor = bx_get_logged_profile_id(); + + $iAuthor = abs($iAuthor); + $iAnonymous = isset($CNF['FIELD_ANONYMOUS'], $this->aInputs[$CNF['FIELD_ANONYMOUS']]) && $this->getCleanValue($CNF['FIELD_ANONYMOUS']) ? -1 : 1; + + $aValsToAdd[$sFa] = $iAnonymous * $iAuthor; + } + + if(isset($CNF['FIELD_CHANGED']) && empty($aValsToAdd[$CNF['FIELD_CHANGED']]) && empty($this->getCleanValue($CNF['FIELD_CHANGED']))) + $aValsToAdd[$CNF['FIELD_CHANGED']] = time(); + + if(CHECK_ACTION_RESULT_ALLOWED === $this->_oModule->checkAllowedSetThumb($iContentId) && isset($CNF['FIELD_THUMB']) && ($aThumb = bx_get($CNF['FIELD_THUMB'])) !== false) { + $aThumb = bx_process_input($aThumb, BX_DATA_INT); + + $aValsToAdd[$CNF['FIELD_THUMB']] = 0; + if(!empty($aThumb)) { + if(is_array($aThumb) && ($iFileThumb = array_pop($aThumb))) + $aValsToAdd[$CNF['FIELD_THUMB']] = $iFileThumb; + else + $aValsToAdd[$CNF['FIELD_THUMB']] = $aThumb; + } + } + + if(!empty($CNF['OBJECT_METATAGS'])) + $this->_processMetas($aValsToAdd); + + if(isset($CNF['FIELD_STATUS']) && isset($aContentInfo[$CNF['FIELD_STATUS']]) && $aContentInfo[$CNF['FIELD_STATUS']] == 'failed') + $aValsToAdd[$CNF['FIELD_STATUS']] = 'active'; + + $bMulticatEnabled = $this->_isMulticatEnabled(); + if ($bMulticatEnabled) + $this->processMulticatBefore($CNF['FIELD_MULTICAT'], $aValsToAdd); + + $mixedResult = parent::update($iContentId, $aValsToAdd, $aTrackTextFieldsChanges); + + foreach($this->aInputs as $aInput) { + if ($aInput['type'] == 'nested_form'){ + if (is_array($aInput['ghost_template']) && !isset($aInput['ghost_template']['inputs'])) { + foreach ($aInput['ghost_template'] as $oFormNested) { + $aSpecificValues = $oFormNested->getSpecificValues(); + $iNestedContentId = $oFormNested->getSubmittedValue($aInput['name'], BX_DOL_FORM_METHOD_SPECIFIC, $aSpecificValues); + + if (empty($iNestedContentId)){ + $iNestedContentId = $oFormNested->insert(array('content_id' => $iContentId)); + if ($aInput['rateable']){ + BxDolFormQuery::addFormField($this->id, $aInput['name'], $iContentId, $iAuthor, $this->_oModule->getName(), $iNestedContentId); + } + } + else{ + $oFormNested->update($iNestedContentId, array('content_id' => $iContentId)); + } + } + } + } + } + + if ($bMulticatEnabled) + $this->processMulticatAfter($CNF['FIELD_MULTICAT'], $iContentId); + + foreach($this->aInputs as $aInput) { + if (isset($aInput['rateable']) && $aInput['rateable'] && $aInput['type'] != 'nested_form'){ + BxDolFormQuery::addFormField($this->id, $aInput['name'], $iContentId, $iAuthor, $this->_oModule->getName()); + } + } + + if($mixedResult !== false) + $this->_processTrackFields($iContentId); + + return $mixedResult; + } + + function getHtmlEditorQueryParams($aInput) + { + $aQueryParams = parent::getHtmlEditorQueryParams($aInput); + if (isset($this->MODULE)){ + $aQueryParams['m'] = $this->MODULE; + } + if (isset($this->_iContentId) && $this->_iContentId){ + $aQueryParams['cid'] = $this->_iContentId; + } + $aQueryParams['fi'] = ''; + + /** + * @hooks + * @hookdef hook-system-editor_query_params 'system', 'editor_query_params' - hook to override http(s) request's query params, which is used in HTML editor + * - $unit_name - equals `system` + * - $action - equals `editor_query_params` + * - $object_id - not used + * - $sender_id - not used + * - $extra_params - array of additional params with the following array keys: + * - `form` - [object] an instance of form, @see BxDolForm + * - `override_result` - [array] by ref, query string params, can be overridden in hook processing + * @hook @ref hook-system-editor_query_params + */ + bx_alert('system', 'editor_query_params', 0, 0, [ + 'form' => $this, + 'override_result' => &$aQueryParams + ]); + + return $aQueryParams; + } + + protected function _associalFileWithContent($oStorage, $iFileId, $iProfileId, $iContentId, $sPictureField = '') + { + $oStorage->updateGhostsContentId ($iFileId, $iProfileId, $iContentId, $this->_isAdmin($iContentId)); + } + + protected function _getPhotoGhostTmplVars($aContentInfo = array()) + { + $CNF = &$this->_oModule->_oConfig->CNF; + + return array ( + 'name' => $this->aInputs[$CNF['FIELD_PHOTO']]['name'], + 'content_id' => (int)$this->aInputs[$CNF['FIELD_PHOTO']]['content_id'], + 'editor_id' => isset($CNF['FIELD_TEXT_ID']) ? $CNF['FIELD_TEXT_ID'] : '', + 'thumb_id' => isset($CNF['FIELD_THUMB']) && isset($aContentInfo[$CNF['FIELD_THUMB']]) ? $aContentInfo[$CNF['FIELD_THUMB']] : 0, + 'name_thumb' => isset($CNF['FIELD_THUMB']) ? $CNF['FIELD_THUMB'] : '', + 'bx_if:set_thumb' => array ( + 'condition' => CHECK_ACTION_RESULT_ALLOWED === $this->_oModule->checkAllowedSetThumb($this->aInputs[$CNF['FIELD_PHOTO']]['content_id']), + 'content' => array ( + 'name_thumb' => isset($CNF['FIELD_THUMB']) ? $CNF['FIELD_THUMB'] : '', + 'txt_pict_use_as_thumb' => _t(!empty($CNF['T']['txt_pict_use_as_thumb']) ? $CNF['T']['txt_pict_use_as_thumb'] : '_sys_txt_form_entry_input_picture_use_as_thumb') + ), + ), + ); + } + + function delete ($iContentId, $aContentInfo = array()) + { + $CNF = &$this->_oModule->_oConfig->CNF; + + // delete associated files + + $a = array('OBJECT_STORAGE', 'OBJECT_STORAGE_FILES', 'OBJECT_STORAGE_PHOTOS', 'OBJECT_STORAGE_VIDEOS', 'OBJECT_STORAGE_SOUNDS'); + foreach ($a as $k) { + if (!empty($CNF[$k])) { + $oStorage = BxDolStorage::getObjectInstance($CNF[$k]); + if ($oStorage) + $oStorage->queueFilesForDeletionFromGhosts($aContentInfo[$CNF['FIELD_AUTHOR']], $iContentId); + } + } + + // delete associated objects data + + if (!empty($CNF['OBJECT_VIEWS'])) { + $o = BxDolView::getObjectInstance($CNF['OBJECT_VIEWS'], $iContentId); + if ($o) $o->onObjectDelete(); + } + + if (!empty($CNF['OBJECT_VOTES'])) { + $o = BxDolVote::getObjectInstance($CNF['OBJECT_VOTES'], $iContentId); + if ($o) $o->onObjectDelete(); + } + + if (!empty($CNF['OBJECT_SCORES'])) { + $o = BxDolScore::getObjectInstance($CNF['OBJECT_SCORES'], $iContentId); + if ($o) $o->onObjectDelete(); + } + + if (!empty($CNF['OBJECT_COMMENTS'])) { + $o = BxDolCmts::getObjectInstance($CNF['OBJECT_COMMENTS'], $iContentId); + if ($o) $o->onObjectDelete(); + } + + if (!empty($CNF['OBJECT_REPORTS'])) { + $o = BxDolReport::getObjectInstance($CNF['OBJECT_REPORTS'], $iContentId); + if ($o) $o->onObjectDelete(); + } + + if (!empty($CNF['OBJECT_METATAGS'])) { + $o = BxDolMetatags::getObjectInstance($CNF['OBJECT_METATAGS']); + if ($o) $o->onDeleteContent($iContentId); + } + + // delete SEO links + + BxDolPage::deleteSeoLink ($this->_oModule->getName(), $this->_oModule->getName(), $iContentId); + + // delete db record + + BxDolFormQuery::removeFormField($this->id, $iContentId); + + return parent::delete($iContentId); + } + + protected function _isAdmin ($iContentId = 0) + { + return $this->_oModule->_isModerator(); + } + + public function processFiles ($sFieldFile, $iContentId = 0, $isAssociateWithContent = false) + { + $CNF = &$this->_oModule->_oConfig->CNF; + + if (!isset($this->aInputs[$sFieldFile])) + return true; + + $mixedFileIds = $this->getCleanValue($sFieldFile); + if(!$mixedFileIds) + return true; + + $oStorage = BxDolStorage::getObjectInstance($this->aInputs[$sFieldFile]['storage_object']); + if (!$oStorage) + return false; + + $iProfileId = $this->getContentOwnerProfileId($iContentId); + + $aGhostFiles = $oStorage->getGhosts ($iProfileId, $isAssociateWithContent ? 0 : $iContentId, true, $this->_isAdmin($iContentId)); + if (!$aGhostFiles) + return true; + + foreach ($aGhostFiles as $aFile) { + if (is_array($mixedFileIds) && !in_array($aFile['id'], $mixedFileIds)) + continue; + + if ($aFile['private']) + $oStorage->setFilePrivate ($aFile['id'], 1); + + if ($iContentId) + $this->_associalFileWithContent($oStorage, $aFile['id'], $iProfileId, $iContentId, $sFieldFile); + } + + return true; + } + + function _deleteFile ($iFileId, $sStorage = '') + { + $CNF = &$this->_oModule->_oConfig->CNF; + + if (!$iFileId) + return true; + + $sStorage = !empty($sStorage) ? $sStorage : $CNF['OBJECT_STORAGE']; + $oStorage = BxDolStorage::getObjectInstance($sStorage); + if (!$oStorage) + return false; + + if (!$oStorage->getFile($iFileId)) + return true; + + $iProfileId = bx_get_logged_profile_id(); + return $oStorage->deleteFile($iFileId, $iProfileId); + } + + function addCssJs () + { + if ((!isset($this->aParams['view_mode']) || !$this->aParams['view_mode']) && !self::$_isCssJsGeneralModuleAdded) { + $this->_oModule->_oTemplate->addCss('forms.css'); + $this->_oModule->_oTemplate->addJs('modules/base/general/js/|forms.js'); + self::$_isCssJsGeneralModuleAdded = true; + } + + return parent::addCssJs (); + } + + function genViewRowValue(&$aInput) + { + $s = parent::genViewRowValue($aInput); + + if ($this->_oMetatagsObject && in_array($aInput['name'], $this->_aMetatagsFieldsWithKeywords) && $s) + $s = $this->_oMetatagsObject->metaParse($this->_oMetatagsContentId, $s); + + return $s; + } + + function genViewRowWrapped(&$aInput) + { + $sResult = parent::genViewRowWrapped($aInput); + if(!$aInput['rateable']) + return $sResult; + + $sValue = $this->genViewRowValue($aInput); + if(null === $sValue) + return ''; + + // process rateable fields + $iId = BxDolFormQuery::getFormField($this->id, $aInput['name'], $this->_iContentId); + if(($oVote = BxDolVote::getObjectInstance($aInput['rateable'], $iId)) !== null) { + $sVoteElement = $oVote->getElementInline(['show_counter_empty' => true, 'show_counter' => false, 'show_counter_style' => 'simple', 'dynamic_mode' => $this->_bDynamicMode]); + $sVoteCounter = $oVote->getCounter(['show_counter_empty' => true, 'show_counter' => true, 'show_counter_style' => 'simple', 'dynamic_mode' => $this->_bDynamicMode]); + + return $this->oTemplate->parseHtmlByName('form_view_rateable_row.html', [ + 'value' => $sResult, + 'rate_btn' => $sVoteElement, + 'rate' => $sVoteCounter, + ]); + } + + return $sResult; + } + + function setMetatagsKeywordsData($iId, $a, $o) + { + $this->_oMetatagsContentId = $iId; + $this->_aMetatagsFieldsWithKeywords = $a; + $this->_oMetatagsObject = $o; + } + + function getContentOwnerProfileId ($iContentId) + { + return $this->_oModule->serviceGetContentOwnerProfileId($iContentId); + } + + protected function _processTrackFields($mixedContent) + { + if(empty($mixedContent) || empty($this->_aTrackFieldsChanges)) + return; + + if(!is_array($mixedContent)) { + $mixedContent = $this->_oModule->_oDb->getContentInfoById((int)$mixedContent); + if(empty($mixedContent) || !is_array($mixedContent)) + return; + } + + foreach($this->_aTrackFieldsChanges as $sField => $aValues) + if($mixedContent[$sField] == $aValues['old']) + $this->_aTrackFieldsChanges[$sField] = false; + else + $this->_aTrackFieldsChanges[$sField]['new'] = $mixedContent[$sField]; + } + + protected function _processMetas(&$aValsToAdd) + { + $CNF = &$this->_oModule->_oConfig->CNF; + + $sKey = 'FIELD_LABELS'; + if(isset($CNF[$sKey]) && isset($this->aInputs[$CNF[$sKey]]) && empty($aValsToAdd[$CNF[$sKey]])) { + $aLabels = $this->getCleanValue($CNF[$sKey]); + if(!empty($aLabels) && is_array($aLabels)) + $aValsToAdd[$CNF[$sKey]] = serialize($aLabels); + else + $aValsToAdd[$CNF[$sKey]] = ''; + } + + $sKey1 = 'FIELD_LOCATION'; + $sKey2 = 'FIELD_LOCATION_PREFIX'; + if(isset($CNF[$sKey1]) && isset($CNF[$sKey2]) && isset($this->aInputs[$CNF[$sKey1]]) && empty($aValsToAdd[$CNF[$sKey1]])) { + $aLocation = BxDolMetatags::locationsRetrieveFromForm($CNF[$sKey2], $this); + if(!empty($aLocation) && is_array($aLocation)) + $aValsToAdd[$CNF[$sKey1]] = serialize(BxDolMetatags::locationsParseComponents($aLocation)); + } + } + + protected function _getPrivacyFields($aKeysF2O = array()) + { + $CNF = &$this->_oModule->_oConfig->CNF; + + if(isset($CNF['PRIVACY_FIELD_TO_OBJECT']) && is_array($CNF['PRIVACY_FIELD_TO_OBJECT'])) + return $CNF['PRIVACY_FIELD_TO_OBJECT']; + + if(empty($aKeysF2O)) + $aKeysF2O = array('FIELD_ALLOW_VIEW_TO' => 'OBJECT_PRIVACY_VIEW'); + + $aResult = array(); + foreach($aKeysF2O as $sKeyField => $sKeyObject) { + if(!isset($CNF[$sKeyField]) || !isset($this->aInputs[$CNF[$sKeyField]]) || !isset($CNF[$sKeyObject])) + continue; + + $aResult[$CNF[$sKeyField]] = $CNF[$sKeyObject]; + } + + return $aResult; + } + + function _addCssJsPrivacyField($sField, $sPrivacyObject, $bDynamicMode = false) + { + $oPrivacy = BxDolPrivacy::getObjectInstance($sPrivacyObject); + if(!$oPrivacy) + return; + + $this->aInputs[$sField]['content'] = $oPrivacy->addCssJs($bDynamicMode) . $this->aInputs[$sField]['content']; + } + + protected function _preparePrivacyField($sField, $sPrivacyObject) + { + $oPrivacy = BxDolPrivacy::getObjectInstance($sPrivacyObject); + if(!$oPrivacy) + return; + + $aSave = array('db' => array('pass' => 'Xss')); + array_walk($this->aInputs[$sField], function ($a, $k, $aSave) { + if (in_array($k, array('info', 'caption', 'value'))) + $aSave[0][$k] = $a; + }, array(&$aSave)); + + $aGroupChooser = $oPrivacy->getGroupChooser($sPrivacyObject, 0, array( + 'object' => $this->aParams['object'], + 'display' => $this->aParams['display'] + )); + + $this->aInputs[$sField] = array_merge($this->aInputs[$sField], $aGroupChooser, $aSave); + } + + protected function _preloadPrivacyField($sField, $sPrivacyObject, $aValues) + { + $CNF = &$this->_oModule->_oConfig->CNF; + + $oPrivacy = BxDolPrivacy::getObjectInstance($sPrivacyObject); + if(!$oPrivacy) + return; + + $iContentId = !empty($aValues[$CNF['FIELD_ID']]) ? (int)$aValues[$CNF['FIELD_ID']] : 0; + $iProfileId = !empty($iContentId) ? (int)$this->getContentOwnerProfileId($iContentId) : bx_get_logged_profile_id(); + $iGroupId = !empty($aValues[$sField]) ? $aValues[$sField] : 0; + + if(!isset($this->aInputs[$sField]['content'])) + $this->aInputs[$sField]['content'] = ''; + + $this->aInputs[$sField]['content'] .= $oPrivacy->initGroupChooser($sPrivacyObject, $iProfileId, array( + 'content_id' => $iContentId, + 'group_id' => $iGroupId, + 'html_ids' => array( + 'form' => $this->getId() + ) + )); + } + + protected function _validatePrivacyField($sField, $sPrivacyObject, $aValues) + { + $mixedValue = $this->aInputs[$sField]['value']; + + $bValue = false; + foreach($this->aInputs[$sField]['values'] as $aValue) + if(isset($aValue['key']) && $aValue['key'] == $mixedValue) { + $bValue = true; + break; + } + + if(!$bValue) { + $sTitle = ''; + if(is_numeric($mixedValue) && (int)$mixedValue < 0 && ($oContext = BxDolProfile::getInstance(abs((int)$mixedValue))) !== false) + $sTitle = $oContext->getDisplayName(); + else + $sTitle = _t('_sys_ps_group_title_unknown'); + + $this->aInputs[$sField]['values'] = array_merge(array( + array('key' => $mixedValue, 'value' => $sTitle), + array('key' => '', 'value' => '----', 'attrs' => array('disabled' => 'disabled')) + ), $this->aInputs[$sField]['values']); + } + } + + /** + * + * MultiCategories related methods. + * + */ + + protected function processMulticatBefore($sFieldName, &$aValsToAdd){ + if (isset($this->aInputs[$sFieldName])){ + $this->aInputs[$sFieldName]['value'] = array_unique(array_filter($this->aInputs[$sFieldName]['value'], function($sTmp){ + return trim($sTmp); + })); + $aValsToAdd[$sFieldName] = implode(',', $this->aInputs[$sFieldName]['value']); + } + } + + protected function processMulticatAfter($sFieldName, $iContentId){ + $CNF = &$this->_oModule->_oConfig->CNF; + $bAutoActivation = (isset($CNF['PARAM_MULTICAT_AUTO_ACTIVATION_FOR_CATEGORIES']) && getParam($CNF['PARAM_MULTICAT_AUTO_ACTIVATION_FOR_CATEGORIES']) == 'on') ? true : false; + $oCategories = BxDolCategories::getInstance(); + if (isset($this->aInputs[$sFieldName])){ + $oCategories->delete($this->_oModule->getName(), $iContentId); + foreach($this->aInputs[$sFieldName]['value'] as $sValue) { + $oCategories->add($this->_oModule->getName(), bx_get_logged_profile_id(), $sValue, $iContentId, $bAutoActivation); + } + } + } + + protected function genCustomViewRowValueMulticat(&$aInput) + { + $oCategories = BxDolCategories::getInstance(); + $aValues = $oCategories->getData(array('type' => 'by_module_and_object', 'module' => $this->_oModule->getName(), 'object_id' => (!empty($aInput['content_id']) ? (int)$aInput['content_id'] : 0 ))); + if (count($aValues) > 0){ + $aVars = array('bx_repeat:cats' => array()); + foreach ($aValues as $sValue) { + $aVars['bx_repeat:cats'][] = array( + 'url' => $oCategories->getUrl($this->_oModule->getName(), $sValue), + 'name' => _t($sValue), + 'bx_if:more' => array( + 'condition' => $sValue === end($aValues) ? false : true, + 'content' => array('1') + ), + ); + } + + if (!$aVars['bx_repeat:cats']) + return ''; + + return $this->_oModule->_oTemplate->parseHtmlByName('category_list_inline.html', $aVars); + } + return ''; + } + + protected function genCustomInputMulticat(&$aInput) + { + $sJsObject = $this->_oModule->_oConfig->getJsObject('categories'); + $aValuesForSelect = BxDolCategories::getInstance()->getData(array('type' => 'by_module_and_author', 'module' => $this->_oModule->getName(), 'author' => bx_get_logged_profile_id())); + + $aSelectedItems = array(); + if (isset($aInput['value']) && is_array($aInput['value'])) + $aInput['value'] = array_filter($aInput['value']); + + if(!empty($aInput['value'])) { + if (!is_array($aInput['value'])) + $aValues = BxDolCategories::getInstance()->getData(array('type' => 'by_module_and_object', 'module' => $this->_oModule->getName(), 'object_id' => (!empty($aInput['content_id']) ? (int)$aInput['content_id'] : 0 ))); + else + $aValues = $aInput['value']; + + $aValues = array_filter($aValues); + foreach($aValues as $sValue) { + if (!array_key_exists($sValue, $aValuesForSelect)){ + $aValuesForSelect[$sValue] = array('key' => $sValue, 'value' => $sValue); + } + } + foreach($aValues as $sValue) { + $sInput = $this->genCustomInputMulticatSelect($aInput, $aValuesForSelect, $sValue); + $aSelectedItems[] = array('js_object' => $sJsObject, 'select_cat' => $sInput); + } + } + else{ + $aSelectedItems = array( + array('js_object' => $sJsObject, 'select_cat' => $this->genCustomInputMulticatSelect($aInput, $aValuesForSelect)) + ); + } + return $this->_oModule->_oTemplate->parseHtmlByName('form_categories.html', array( + 'bx_repeat:items' => $aSelectedItems, + 'js_object' => $sJsObject, + 'select_cat' => $this->genCustomInputMulticatSelect($aInput, $aValuesForSelect, -1), + 'input_cat' => $this->genCustomInputMulticatInput($aInput), + 'js_object' => $sJsObject, + 'btn_add' => $this->genCustomInputMulticatButton($aInput), + 'btn_add_new' => $this->genCustomInputMulticatButtonNew($aInput) + )); + } + + protected function genCustomInputMulticatSelect($aInput, $aValues, $mixedValue = '') + { + foreach($aValues as $sKey => $aValue) { + $aValues[$sKey]['value'] = _t($aValue['key']); + } + $aValues = array_merge(array('1' => array('key' => false, 'value' => _t('_sys_please_select'))), $aValues); + + $aInput['type'] = 'select'; + $aInput['name'] .= '[]'; + $aInput['value'] = $mixedValue; + $aInput['values'] = $aValues; + return $this->genInput($aInput); + } + + protected function genCustomInputMulticatInput($aInput) + { + $aInput['type'] = 'text'; + $aInput['name'] .= '[]'; + $aInput['value'] = ''; + return $this->genInput($aInput); + } + + protected function genCustomInputMulticatButton($aInput) + { + $sName = $aInput['name']; + $aInput['type'] = 'button'; + $aInput['name'] .= '_add'; + $aInput['value'] = _t('_sys_txt_categories_button_caption_add'); + $aInput['attrs']['class'] = 'bx-def-margin-right bx-def-margin-sec-top'; + $aInput['attrs']['onclick'] = $this->_oModule->_oConfig->getJsObject('categories') . ".categoryAdd(this, '" . $sName . "');"; + return $this->genInputButton($aInput); + } + + protected function genCustomInputMulticatButtonNew($aInput) + { + $sName = $aInput['name']; + $aInput['type'] = 'button'; + $aInput['name'] .= '_add'; + $aInput['value'] = _t('_sys_txt_categories_button_caption_addnew'); + $aInput['attrs']['class'] = 'bx-def-margin-sec-top'; + $aInput['attrs']['onclick'] = $this->_oModule->_oConfig->getJsObject('categories') . ".categoryAddNew(this, '" . $sName . "');"; + return $this->genInputButton($aInput); + } + + protected function genCustomInputAuthor ($aInput) + { + if(empty($aInput['custom']) || !is_array($aInput['custom'])) + $aInput['custom'] = array(); + $aInput['custom']['only_once'] = 1; + + $aInput['ajax_get_suggestions'] = BX_DOL_URL_ROOT . "modules/?r=" . $this->_oModule->_oConfig->getUri() . "/ajax_get_profiles"; + if (bx_is_api()){ + $aInput['ajax_get_suggestions'] = $this->_oModule->_oConfig->getName() . "/get_profiles¶ms[]="; + $aProfile = BxDolProfile::getInstance($aInput['value'])->getUnitAPI(0, ['template' => 'unit_wo_info']); + $aInput['value_data'] = [$aProfile['author_data']]; + } + return $this->genCustomInputUsernamesSuggestions($aInput); + } + + protected function _isMulticatEnabled(){ + $CNF = $this->_oModule->_oConfig->CNF; + return isset($CNF['PARAM_MULTICAT_ENABLED']) && $CNF['PARAM_MULTICAT_ENABLED'] === true && isset($CNF['FIELD_MULTICAT']); + } +} + +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/general/classes/BxBaseModGeneralModule.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/general/classes/BxBaseModGeneralModule.php new file mode 100644 index 0000000000..c8a9abccb8 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/general/classes/BxBaseModGeneralModule.php @@ -0,0 +1,4418 @@ +<?php defined('BX_DOL') or die('hack attempt'); +/** + * Copyright (c) UNA, Inc - https://una.io + * MIT License - https://opensource.org/licenses/MIT + * + * @defgroup BaseGeneral Base classes for modules + * @ingroup UnaModules + * + * @{ + */ + +define('BX_BASE_MOD_GENERAL_STATUS_ACTIVE', 'active'); +define('BX_BASE_MOD_GENERAL_STATUS_HIDDEN', 'hidden'); +define('BX_BASE_MOD_GENERAL_STATUS_PENDING', 'pending'); + +bx_import('BxDolAcl'); + +/** + * Base module class. + */ +class BxBaseModGeneralModule extends BxDolModule +{ + protected $_bIsApi; + protected $_iProfileId; + protected $_aSearchableNamesExcept; + protected $_aFormParams; + + protected $_aBrowsingFiltersKeys; + + function __construct(&$aModule) + { + parent::__construct($aModule); + + $this->_bIsApi = bx_is_api(); + $this->_iProfileId = bx_get_logged_profile_id(); + $this->_aSearchableNamesExcept = array( + 'allow_view_to' + ); + + $this->_aFormParams = array( + 'display' => false, + 'dynamic_mode' => false, + 'ajax_mode' => false, + 'absolute_action_url' => false, + 'visibility_autoselect' => false, + 'context_id' => 0, + 'custom' => array() + ); + + $this->_aBrowsingFiltersKeys = ['mode']; + } + + // ====== ACTIONS METHODS + + public function isEntryActive($aContentInfo) + { + $CNF = &$this->_oConfig->CNF; + + $iProfileId = bx_get_logged_profile_id(); + $bModerator = $this->_isModerator(); + + $mixedResult = null; + /** + * @hooks + * @hookdef hook-bx_base_general-is_entry_active '{module_name}', 'is_entry_active' - hook to override whether an entry (content) active or not + * - $unit_name - module name + * - $action - equals `is_entry_active` + * - $object_id - not used + * - $sender_id - not used + * - $extra_params - array of additional params with the following array keys: + * - `viewer_id` - [int] viewer profile id + * - `is_moderator` - [boolean] is viewer has moderator status or not + * - `content_info` - [array] content info array as key&value pairs + * - `override_result` - [boolean] by ref, boolean value which determines whether entry (content) active or not, can be overridden in hook processing + * @hook @ref hook-bx_base_general-is_entry_active + */ + bx_alert($this->getName(), 'is_entry_active', 0, 0, [ + 'viewer_id' => $iProfileId, + 'is_moderator' => $bModerator, + 'content_info' => $aContentInfo, + 'override_result' => &$mixedResult + ]); + if($mixedResult !== null) + return $mixedResult; + + if($this->isEntryAuthor($aContentInfo, $iProfileId) || $bModerator) + return true; + + if(!empty($CNF['FIELD_ALLOW_VIEW_TO']) && (int)$aContentInfo[$CNF['FIELD_ALLOW_VIEW_TO']] < 0) { + $iContextProfileId = abs((int)$aContentInfo[$CNF['FIELD_ALLOW_VIEW_TO']]); + $oContextProfile = BxDolProfile::getInstance($iContextProfileId); + + $aAdmins = bx_srv($oContextProfile->getModule(), 'get_admins_to_manage_content', [$iContextProfileId]); + if(!empty($aAdmins) && in_array($iProfileId, $aAdmins)) + return true; + } + + if(isset($CNF['FIELD_STATUS']) && $aContentInfo[$CNF['FIELD_STATUS']] != 'active') + return false; + + if(isset($CNF['FIELD_STATUS_ADMIN']) && isset($aContentInfo[$CNF['FIELD_STATUS_ADMIN']]) && $aContentInfo[$CNF['FIELD_STATUS_ADMIN']] != 'active') + return false; + + return true; + } + + public function isEntryAuthor($aContentInfo, $iProfileId = 0) + { + $CNF = &$this->_oConfig->CNF; + + if(!$iProfileId) + $iProfileId = bx_get_logged_profile_id(); + + $mixedResult = null; + /** + * @hooks + * @hookdef hook-bx_base_general-is_entry_author '{module_name}', 'is_entry_author' - hook to check if a viewer is an author of viewed entry (content) or not + * - $unit_name - module name + * - $action - equals `is_entry_author` + * - $object_id - not used + * - $sender_id - not used + * - $extra_params - array of additional params with the following array keys: + * - `viewer_id` - [int] viewer profile id + * - `content_info` - [array] content info array as key&value pairs + * - `override_result` - [boolean] by ref, boolean value which determines whether the viewer is an author of viewed entry (content) or not, can be overridden in hook processing + * @hook @ref hook-bx_base_general-is_entry_author + */ + bx_alert($this->getName(), 'is_entry_author', 0, 0, [ + 'viewer_id' => $iProfileId, + 'content_info' => $aContentInfo, + 'override_result' => &$mixedResult + ]); + if($mixedResult !== null) + return $mixedResult; + + return abs($aContentInfo[$CNF['FIELD_AUTHOR']]) == $iProfileId; + } + + public function actionUpdateImage($sFiledName, $iContentId, $sValue) + { + $mixedResult = $this->serviceUpdateImage($sFiledName, $iContentId, $sValue); + if($mixedResult !== false) + echo $mixedResult; + } + + public function actionUpdateImagePosition($iContentId, $sFiledName, $sH, $sV) + { + $this->serviceUpdateImagePosition($iContentId, $sFiledName, $sH, $sV); + } + + public function actionApprove() + { + $CNF = &$this->_oConfig->CNF; + + if(!isset($CNF['FIELD_STATUS_ADMIN'])) + return echoJson([]); + + $iContentId = (int)bx_get('content_id'); + $aContentInfo = $this->_oDb->getContentInfoById($iContentId); + if(empty($aContentInfo) || !is_array($aContentInfo) || $aContentInfo[$CNF['FIELD_STATUS_ADMIN']] != BX_BASE_MOD_GENERAL_STATUS_PENDING) + return echoJson([]); + + if(($mixedCheckResult = $this->checkAllowedApprove($aContentInfo)) !== CHECK_ACTION_RESULT_ALLOWED) + return echoJson(['msg' => $mixedCheckResult]); + + $oForm = $this->_getApproveForm($iContentId, $aContentInfo); + $oForm->initChecker(); + + if(!$oForm->isSubmitted() || !$oForm->isValid()) { + $sPopupId = $this->getName() . '_approve_' . $iContentId; + $sPopupTitle = '_sys_manage_popup_approve_title'; + if(!empty($CNF['T']['txt_approve_popup_title'])) + $sPopupTitle = $CNF['T']['txt_approve_popup_title']; + + return echoJson(['popup' => BxTemplFunctions::getInstance()->popupBox($sPopupId, _t($sPopupTitle), $oForm->getCode(true))]); + } + + if($oForm->getCleanValue('do_send')) { + $aResult = []; + if($this->_sendApproveMessage($iContentId, $aContentInfo, $oForm)) + $aResult = ['msg' => _t('_sys_manage_txt_sent')]; + else + $aResult = ['msg' => _t('_sys_manage_err_cannot_perform_action')]; + + return echoJson($aResult); + } + + if($oForm->getCleanValue('do_submit')) { + $aResult = []; + if($this->_oDb->updateEntriesBy([$CNF['FIELD_STATUS_ADMIN'] => BX_BASE_MOD_GENERAL_STATUS_ACTIVE], [$CNF['FIELD_ID'] => $iContentId])) { + $this->checkAllowedApprove($aContentInfo, true); + + $this->onApprove($aContentInfo); + + /* + * Process metas. + * Note. It's essential to process metas a the very end, + * because all data related to an entry should be already + * processed and are ready to be passed to alert. + */ + $this->processMetasAdd($iContentId); + + $aResult = ['msg' => _t('_sys_manage_txt_approved'), 'reload' => 1]; + } + else + $aResult = ['msg' => _t('_sys_manage_err_cannot_perform_action')]; + + return echoJson($aResult); + } + } + + public function serviceSetStatus($iId, $sValue, $sStatus = '') + { + $CNF = &$this->_oConfig->CNF; + + if(!$sStatus && !empty($CNF['FIELD_STATUS_ADMIN'])) + $sStatus = $CNF['FIELD_STATUS_ADMIN']; + + $aStatuses = []; + if(!empty($CNF['FIELD_STATUS_ADMIN'])) + $aStatuses[] = $CNF['FIELD_STATUS_ADMIN']; + if(!empty($CNF['FIELD_STATUS'])) + $aStatuses[] = $CNF['FIELD_STATUS']; + + if(!in_array($sStatus, $aStatuses)) + return false; + + if((int)$this->_oDb->updateEntriesBy([$sStatus => $sValue], [$CNF['FIELD_ID'] => $iId]) == 0) + return false; + + if($sValue == BX_BASE_MOD_GENERAL_STATUS_ACTIVE) + $this->onPublished($iId); + } + + public function actionRss () + { + $aArgs = func_get_args(); + $this->_rss($aArgs); + } + + public function actionGetAttachLinkForm() + { + $CNF = &$this->_oConfig->CNF; + + $iContentId = ($iContentId = bx_get($CNF['FIELD_ATTACH_LINK_CONTENT_ID'])) !== false ? (int)$iContentId : 0; + + echo $this->_oTemplate->getAttachLinkForm($iContentId); + } + + public function actionSubmitAttachLinkForm() + { + echoJson($this->getFormAttachLink()); + } + + public function actionAddAttachLink() + { + $CNF = &$this->_oConfig->CNF; + + $sUrl = bx_process_input(bx_get($CNF['FIELD_ATTACH_LINK_URL'])); + if(empty($sUrl)) + return echoJson([]); + + $sUrl = htmlspecialchars_decode($sUrl); + $oStreamContext = stream_context_create([ + 'http' => [ + 'timeout' => getParam('sys_default_socket_timeout'), + ] + ]); + + $sHeader = 'Content-Type'; + $aHeaders = @get_headers($sUrl, 1, $oStreamContext); + if(!empty($aHeaders) && is_array($aHeaders) && !empty($aHeaders[$sHeader])) { + $mixedContentType = $aHeaders[$sHeader]; + if(!is_array($mixedContentType)) + $mixedContentType = [$mixedContentType]; + + foreach($mixedContentType as $sContentType) + if(strpos($sContentType, 'image') !== false) + return echoJson([]); + } + + echoJson($this->addAttachLink([ + $CNF['FIELD_ATTACH_LINK_CONTENT_ID'] => ($iContentId = bx_get($CNF['FIELD_ATTACH_LINK_CONTENT_ID'])) !== false ? (int)$iContentId : 0, + $CNF['FIELD_ATTACH_LINK_URL'] => $sUrl + ])); + } + + public function actionDeleteAttachLink() + { + $CNF = &$this->_oConfig->CNF; + + $iUserId = $this->getUserId(); + $iLinkId = bx_process_input(bx_get('id'), BX_DATA_INT); + if(empty($iLinkId)) + return echoJson([]); + + $aLink = $this->_oDb->getLinksBy(['type' => 'id', 'id' => $iLinkId, 'profile_id' => $iUserId]); + if(empty($aLink) || !is_array($aLink)) + return echoJson([]); + + if(!empty($aLink['media_id'])) + BxDolStorage::getObjectInstance($CNF['OBJECT_STORAGE_PHOTOS'])->deleteFile($aLink['media_id']); + + $aResult = []; + if($this->_oDb->deleteLink($iLinkId)) + $aResult = ['code' => 0, 'url' => $aLink['url']]; + else + $aResult = ['code' => 1, 'message' => _t(!empty($CNF['txt_link_form_err_delete']) ? $CNF['txt_link_form_err_delete'] : $this->getName() . '_form_post_input_link_err_delete')]; + + echoJson($aResult); + } + + public function actionGetCreatePostForm() + { + $sName = $this->_oConfig->getName(); + + $aParams = bx_process_input(array_intersect_key($_GET, $this->_aFormParams)); + $aParams = array_merge($this->_aFormParams, $aParams); + $aParams['context_id'] = (bool)$aParams['context_id'] ? (int)$aParams['context_id'] : false; + + $mixedResponse = $this->serviceGetCreatePostForm($aParams); + if(empty($mixedResponse)) + return echoJson(array()); + else if(is_array($mixedResponse)) { + $mixedResponse['module'] = $sName; + return echoJson($mixedResponse); + } + + return echoJson(array( + 'module' => $sName, + 'content' => $mixedResponse + )); + } + + public function actionGetNotes() + { + $CNF = &$this->_oConfig->CNF; + if(empty($CNF['OBJECT_NOTES'])) + return echoJson([]); + + $iContentId = (int)bx_get('content_id'); + + $oCmtsNotes = BxDolCmts::getObjectInstance($CNF['OBJECT_NOTES'], $iContentId, true, $this->_oTemplate); + $aCmtsNotes = $oCmtsNotes->getCommentsBlock([], ['in_designbox' => false]); + if(empty($aCmtsNotes) || !is_array($aCmtsNotes)) + return echoJson([]); + + $sPostfix = $iContentId < 0 ? '_rc' : ''; + + $sPopupId = $this->getName() . '_notes_' . $iContentId; + $sPopupTitle = !empty($CNF['T']['txt_cmts_notes_popup_view_title' . $sPostfix]) ? $CNF['T']['txt_cmts_notes_popup_view_title' . $sPostfix] : '_cmt_nts_popup_view_title' . $sPostfix; + echoJson(['popup' => BxTemplFunctions::getInstance()->popupBox($sPopupId, _t($sPopupTitle), $aCmtsNotes['content'])]); + } + + public function actionNested() + { + $sAction = bx_get('a'); + $sMethodName = 'subaction' . ucfirst($sAction); + if (!method_exists($this, $sMethodName)) { + return; + } + $this->$sMethodName(); + } + + public function actionEmbed($iContentId, $sUnitTemplate = '', $sAddCode = '') + { + $oTemplate = BxDolTemplate::getInstance(); + + $aContentInfo = $this->_oDb->getContentInfoById($iContentId); + if(empty($aContentInfo)) + $oTemplate->getEmbed(false); + + if(empty($sUnitTemplate)) + $sUnitTemplate = 'unit_gallery.html'; + + $CNF = &$this->_oConfig->CNF; + + if(!empty($CNF['OBJECT_VIEWS'])) { + $oView = BxDolView::getObjectInstance($CNF['OBJECT_VIEWS'], $iContentId); + if($oView && $oView->isEnabled()) + $oView->doView(); + } + + $oTemplate->getEmbed($this->_oTemplate->unit($aContentInfo, true, $sUnitTemplate) . $sAddCode); + } + + public function subactionDelete() + { + header('Content-type: text/html; charset=utf-8'); + + $iNestedId = (int)bx_get('id'); + $sNestedForm = bx_get('s'); + + $oForm = BxDolForm::getObjectInstance($sNestedForm, $sNestedForm); + if (!$oForm){ + echo _t('_sys_request_page_not_found_cpt'); + return; + } + + $aNested = $this->_oDb->getNestedBy(array('type' => 'id', 'id' => $iNestedId, 'key_name' => $oForm->aParams['db']['key']), $oForm->aParams['db']['table']); + if (empty($aNested)){ + echo _t('_sys_request_page_not_found_cpt'); + return; + } + + $aContentInfo = $this->_oDb->getContentInfoById ($aNested['content_id']); + if (!$aContentInfo){ + echo _t('_sys_request_page_not_found_cpt'); + return; + } + + elseif (CHECK_ACTION_RESULT_ALLOWED !== ($sMsg = $this->checkAllowedEdit ($aContentInfo))) { + echo $sMsg; + } + elseif (!$this->_oDb->deleteNestedById($iNestedId, $oForm->aParams['db']['key'], $oForm->aParams['db']['table'])) { + echo _t('_sys_txt_error_occured'); + } + else { + echo 'ok'; + } + } + + /** + * Get possible recipients for start conversation form + */ + public function actionAjaxGetProfiles () + { + $sTerm = bx_get('term'); + + $a = BxDolService::call('system', 'profiles_search', array($sTerm), 'TemplServiceProfiles'); + + header('Content-Type:text/javascript; charset=utf-8'); + echo(json_encode($a)); + } + + public function serviceGetProfiles ($sParams) + { + $aOptions = json_decode($sParams, true); + if (!$sParams || !isset($aOptions['term'])) + return []; + + return BxDolService::call('system', 'profiles_search', array($aOptions['term']), 'TemplServiceProfiles'); + } + + public function actionGetBrowsingFilters() + { + $aParams = $this->_prepareBrowsingFiltersParamsGet(); + + $sContent = $this->_oTemplate->getBrowsingFilters($aParams); + if(empty($sContent)) + return echoJson([]); + + echoJson([ + 'code' => 0, + 'popup' => [ + 'html' => $sContent, + 'options' => [ + 'closeOnOuterClick' => false, + 'removeOnClose' => false, + ] + ], + ]); + } + + public function actionApplyBrowsingFilters() + { + $aParams = $this->_prepareBrowsingFiltersParamsGet(); + + $aBrowseParams = ['mode' => $aParams['mode'], 'empty_message' => true]; + unset($aParams['mode']); + $aBrowseParams['params'] = $aParams; + + $mixedResult = $this->serviceBrowse($aBrowseParams); + if(empty($mixedResult)) + return echoJson([]); + + if(is_array($mixedResult) && isset($mixedResult['content'])) + $mixedResult = $mixedResult['content']; + + return echoJson([ + 'code' => 0, + 'content' => $mixedResult, + 'eval' => $this->_oConfig->getJsObject('main') . '.onApplyBrowsingFilter(oData)' + ]); + } + + protected function _prepareBrowsingFiltersParamsGet($mParams = false) + { + $aParams = []; + $bParams = !empty($mParams) && is_array($mParams); + + foreach($this->_aBrowsingFiltersKeys as $sKey) + if($bParams) { + if(isset($mParams[$sKey])) + $aParams[$sKey] = $mParams[$sKey]; + } + else { + if(($sValue = bx_get($sKey)) !== false) + $aParams[$sKey] = $sValue; + } + + return $aParams; + } + + // ====== SERVICE METHODS + + public function serviceIsBadgesAvaliable() + { + if(!isAdmin() && !$this->_isAdministrator()) + return false; + + $aBadges = BxDolBadges::getInstance()->getData([ + 'type' => 'by_module&object', + 'object_id' => 0, + 'module' => $this->getName() + ]); + + return count($aBadges) > 0 ? true : false; + } + + public function serviceGetSafeServices() + { + return array( + // other + 'ModuleIcon' => '', + 'GetLink' => '', + // browse + 'GetSearchResultUnit' => '', + 'Browse' => '', + 'BrowseFeatured' => '', + 'BrowseFavorite' => '', + // forms + 'GetCreatePostForm' => '', + 'EntityCreate' => '', + 'EntityEdit' => '', + 'EntityDelete' => '', + 'UpdateImage' => '', + // page blocks + 'EntityTextBlock' => '', + 'EntityInfo' => '', + 'EntityInfoFull' => '', + 'EntityInfoExtended' => '', + 'EntityLocation' => '', + 'EntityComments' => '', + 'EntityAttachments' => '', + 'CategoriesMultiList' => '', + // menu + 'EntityAllActions' => '', + 'EntityActions' => '', + 'EntitySocialSharing' => '', + 'MyEntriesActions' => '', + + 'GetProfiles' => '', + ); + } + + /** + * @page service Service Calls + * @section bx_base_general Base General + * @subsection bx_base_general-other Other + * @subsubsection bx_base_general-module_icon module_icon + * + * @code bx_srv('bx_posts', 'module_icon', [...]); @endcode + * + * Get module icon as CSS class name with FontAwesome icon name class and color class + * + * @see BxBaseModGeneralModule::serviceModuleIcon + */ + /** + * @ref bx_base_general-module_icon "module_icon" + */ + public function serviceModuleIcon () + { + return isset($this->_oConfig->CNF['ICON']) ? $this->_oConfig->CNF['ICON'] : ''; + } + + public function serviceGetAuthor ($iContentId) + { + $mixedResult = $this->_getFieldValue('FIELD_AUTHOR', $iContentId); + return $mixedResult !== false ? (int)$mixedResult : 0; + } + + public function serviceGetPrivacyView ($iContentId) + { + return $this->_getFieldValue('FIELD_ALLOW_VIEW_TO', $iContentId); + } + + public function serviceGetDateAdded ($iContentId) + { + $mixedResult = $this->_getFieldValue('FIELD_ADDED', $iContentId); + return $mixedResult !== false ? (int)$mixedResult : 0; + } + + public function serviceGetDateChanged ($iContentId) + { + $mixedResult = $this->_getFieldValue('FIELD_CHANGED', $iContentId); + return $mixedResult !== false ? (int)$mixedResult : 0; + } + + /** + * @page service Service Calls + * @section bx_base_general Base General + * @subsection bx_base_general-other Other + * @subsubsection bx_base_general-get_link get_link + * + * @code bx_srv('bx_posts', 'get_link', [...]); @endcode + * + * Get URL for the specified content. + * @param $iContentId content id + * + * @see BxBaseModGeneralModule::serviceGetLink + */ + /** + * @ref bx_base_general-get_link "get_link" + */ + public function serviceGetLink ($iContentId) + { + $CNF = &$this->_oConfig->CNF; + if(empty($CNF['URI_VIEW_ENTRY'])) + return ''; + + $aContentInfo = $this->_oDb->getContentInfoById($iContentId); + if(empty($aContentInfo)) + return ''; + + return bx_absolute_url(BxDolPermalinks::getInstance()->permalink('page.php?i=' . $CNF['URI_VIEW_ENTRY'] . '&id=' . $aContentInfo[$CNF['FIELD_ID']])); + } + + public function serviceGetTitle ($iContentId) + { + $mixedResult = $this->_getFieldValue('FIELD_TITLE', $iContentId); + return $mixedResult !== false ? $mixedResult : ''; + } + + public function serviceGetText ($iContentId) + { + $mixedResult = $this->_getFieldValue('FIELD_TEXT', $iContentId); + if (false === $mixedResult) + return ''; + + $CNF = &$this->_oConfig->CNF; + if (!empty($CNF['OBJECT_METATAGS']) && is_string($mixedResult)) { + $oMetatags = BxDolMetatags::getObjectInstance($CNF['OBJECT_METATAGS']); + $mixedResult = $oMetatags->metaParse($iContentId, $mixedResult); + } + + return $mixedResult; + } + + public function serviceGetLocation ($iContentId) + { + $CNF = &$this->_oConfig->CNF; + + if(empty($CNF['OBJECT_METATAGS'])) + return []; + + $mixedResult = $this->_getFieldValue('FIELD_LOCATION', $iContentId); + if(false === $mixedResult) + return []; + + $oMeta = false; + if(!($oMeta = BxDolMetatags::getObjectInstance($CNF['OBJECT_METATAGS'])) || !$oMeta->locationsIsEnabled()) + return false; + + $aLocation = $oMeta->locationGet($iContentId); + if(empty($aLocation) || !is_array($aLocation)) + return false; + + return array_values(array_slice($aLocation, 1)); + } + + public function serviceGetEmbed ($iContentId) + { + $sTitle = $this->_getFieldValue('FIELD_TITLE', $iContentId); + return $this->_oTemplate->parseHtmlByName('embed.html', [ + 'title' => $sTitle, + 'url' => BX_DOL_URL_ROOT . $this->_oConfig->getBaseUri() . 'embed/' . $iContentId . '/' + ]); + } + + public function serviceGetInfo ($iContentId, $bSearchableFieldsOnly = true) + { + $CNF = &$this->_oConfig->CNF; + + $aContentInfo = $this->_getFields($iContentId); + if(empty($aContentInfo)) + return array(); + + if(!$bSearchableFieldsOnly) + return $aContentInfo; + + if(empty($CNF['PARAM_SEARCHABLE_FIELDS'])) + return array(); + + $aFields = explode(',', getParam($CNF['PARAM_SEARCHABLE_FIELDS'])); + if(empty($aFields)) + return array(); + + $aResult = array(); + foreach($aFields as $sField) + if(isset($aContentInfo[$sField])) + $aResult[$sField] = $aContentInfo[$sField]; + + return $aResult; + } + + public function serviceGetInfoApi ($iContentId, $bExtendedUnits = false) + { + $aData = $this->serviceGetInfo($iContentId, false); + if($aData) + $aData = $this->getDataAPI($aData, ['extended' => $bExtendedUnits]); + + return $aData; + } + + /** + * @page service Service Calls + * @section bx_base_general Base General + * @subsection bx_base_general-browsing Browsing + * @subsubsection bx_base_general-get_search_result_unit get_search_result_unit + * + * @code bx_srv('bx_posts', 'get_search_result_unit', [3,"unit_gallery.html"]); @endcode + * + * Get browsing unit for the specified content + * @param $iContentId content id + * @param $sUnitTemplate unit template, such as: unit_full.html, unit_gallery.html, unit_live_search.html + * + * @see BxBaseModGeneralModule::serviceGetSearchResultUnit + */ + /** + * @ref bx_base_general-get_search_result_unit "get_search_result_unit" + */ + public function serviceGetSearchResultUnit ($iContentId, $sUnitTemplate = '') + { + $aContentInfo = $this->_oDb->getContentInfoById($iContentId); + if($this->_bIsApi) + return $this->getDataAPI($aContentInfo); + + if(empty($aContentInfo)) + return ''; + + if(empty($sUnitTemplate)) + $sUnitTemplate = 'unit.html'; + + return $this->_oTemplate->unit($aContentInfo, true, $sUnitTemplate); + } + + public function serviceGetAll ($aParams = array()) + { + if(empty($aParams) || !is_array($aParams)) + $aParams = array('type' => 'all'); + + return $this->_oDb->getEntriesBy($aParams); + } + + public function serviceGetAllByAuthor ($iProfileId) + { + return $this->_oDb->getEntriesByAuthor((int)$iProfileId); + } + + public function serviceGetSortableFieldsExtended($aInputsAdd = array()) + { + $CNF = &$this->_oConfig->CNF; + if(empty($CNF['OBJECT_FORM_ENTRY'])) + return array(); + + $aResult = array(); + + $aSortableFields = []; + + $aDisplays = []; + if(!empty($CNF['OBJECT_FORM_ENTRY_DISPLAY_ADD'])) { + $aDisplays[] = $CNF['OBJECT_FORM_ENTRY_DISPLAY_ADD']; + } + if(!empty($CNF['OBJECT_FORM_ENTRY_DISPLAY_EDIT'])) { + $aDisplays[] = $CNF['OBJECT_FORM_ENTRY_DISPLAY_EDIT']; + } + + $aInputsAll = BxDolFormQuery::getFormInputs($CNF['OBJECT_FORM_ENTRY']); + foreach($aInputsAll as $aInput){ + $aInputsAll[$aInput['name']] = $aInput; + } + + $aInputs = BxDolFormQuery::getFormInputs($CNF['OBJECT_FORM_ENTRY'], $aDisplays); + foreach($aInputs as $aInput){ + $aInputs[$aInput['name']] = $aInput; + if ($aInput['type'] == 'text'){ + $aSortableFields[] = $aInput['name']; + } + } + + if(!empty($CNF['FIELD_ADDED']) && isset($aInputsAll[$CNF['FIELD_ADDED']])){ + $aSortableFields[] = $CNF['FIELD_ADDED']; + } + + if(!empty($CNF['FIELD_CHANGED']) && isset($aInputsAll[$CNF['FIELD_CHANGED']])){ + $aSortableFields[] = $CNF['FIELD_CHANGED']; + } + + foreach($aSortableFields as $sSortableField){ + $aResult[$sSortableField . '_asc'] = [ + 'name' => $sSortableField, + 'caption' => $aInputsAll[$sSortableField]['caption'], + 'direction' => 'asc' + ]; + + $aResult[$sSortableField . '_desc'] = [ + 'name' => $sSortableField, + 'caption' => $aInputsAll[$sSortableField]['caption'], + 'direction' => 'desc' + ]; + } + + /** + * @hooks + * @hookdef hook-bx_base_general-get_sortable_fields '{module_name}', 'get_sortable_fields' - hook to override a list of sortable fields + * - $unit_name - module name + * - $action - equals `get_sortable_fields` + * - $object_id - not used + * - $sender_id - not used + * - $extra_params - array of additional params with the following array keys: + * - `override_result` - [array] a list of searchable fields, can be overridden in hook processing + * @hook @ref hook-bx_base_general-get_sortable_fields + */ + bx_alert($this->getName(), 'get_sortable_fields', 0, 0, [ + 'extended' => true, + 'override_result' => &$aResult + ]); + + return $aResult; + } + + public function serviceGetSearchableFieldsExtended($aInputsAdd = array()) + { + $CNF = &$this->_oConfig->CNF; + if(empty($CNF['OBJECT_FORM_ENTRY'])) + return array(); + + $aResult = array(); + if(!empty($CNF['FIELD_AUTHOR']) && !in_array($CNF['FIELD_AUTHOR'], $this->_aSearchableNamesExcept)) + $aResult[$CNF['FIELD_AUTHOR']] = array( + 'type' => 'text_auto', + 'caption' => $CNF['T']['form_field_author'], + 'info' => '', + 'value' => '', + 'values' => '', + 'pass' => '' + ); + + if(!empty($CNF['FIELD_LABELS']) && !in_array($CNF['FIELD_LABELS'], $this->_aSearchableNamesExcept)) + $aResult[$CNF['FIELD_LABELS']] = array( + 'type' => 'checkbox_set', + 'caption' => isset($CNF['T']['form_field_labels']) ? $CNF['T']['form_field_author'] : '_sys_form_input_labels', + 'info' => '', + 'value' => '', + 'values' => '', + 'pass' => '', + 'search_operator' => 'like' + ); + + + $aInputs = array(); + if(!empty($CNF['OBJECT_FORM_ENTRY_DISPLAY_ADD'])) { + $oForm = BxDolForm::getObjectInstance($CNF['OBJECT_FORM_ENTRY'], $CNF['OBJECT_FORM_ENTRY_DISPLAY_ADD'], $this->_oTemplate); + + $aInputs = array_merge($aInputs, $oForm->aInputs); + } + if(!empty($CNF['OBJECT_FORM_ENTRY_DISPLAY_EDIT'])) { + $oForm = BxDolForm::getObjectInstance($CNF['OBJECT_FORM_ENTRY'], $CNF['OBJECT_FORM_ENTRY_DISPLAY_EDIT'], $this->_oTemplate); + + $aInputs = array_merge($aInputs, $oForm->aInputs); + } + + if(!empty($aInputsAdd) && is_array($aInputsAdd)) + $aInputs = array_merge($aInputs, $aInputsAdd); + + foreach($aInputs as $aInput){ + if(in_array($aInput['type'], BxDolSearchExtended::$SEARCHABLE_TYPES) && !in_array($aInput['name'], $this->_aSearchableNamesExcept)) { + $aField = array( + 'type' => $aInput['type'], + 'caption_system' => $aInput['caption_system_src'], + 'caption' => $aInput['caption_src'], + 'info' => $aInput['info_src'], + 'value' => !empty($aInput['value']) ? $aInput['value'] : '', + 'values' => !empty($aInput['values_src']) ? $aInput['values_src'] : '', + 'pass' => !empty($aInput['db']['pass']) ? $aInput['db']['pass'] : '', + ); + + if(isset($aInput['search_type'])) + $aField['search_type'] = $aInput['search_type']; + + if(isset($aInput['search_operator'])) + $aField['search_operator'] = $aInput['search_operator']; + + $aResult[$aInput['name']] = $aField; + } + } + + /** + * @hooks + * @hookdef hook-bx_base_general-get_searchable_fields '{module_name}', 'get_searchable_fields' - hook to override a list of searchable fields + * - $unit_name - module name + * - $action - equals `get_searchable_fields` + * - $object_id - not used + * - $sender_id - not used + * - $extra_params - array of additional params with the following array keys: + * - `override_result` - [array] a list of searchable fields, can be overridden in hook processing + * @hook @ref hook-bx_base_general-get_searchable_fields + */ + bx_alert($this->getName(), 'get_searchable_fields', 0, 0, [ + 'extended' => true, + 'override_result' => &$aResult + ]); + + return $aResult; + } + + public function serviceGetSearchResultExtended($aParams, $iStart = 0, $iPerPage = 0, $bFilterMode = false) + { + if((empty($aParams) || !is_array($aParams)) && !$bFilterMode) + return array(); + + return $this->_oDb->getEntriesBy(array('type' => 'search_ids', 'search_params' => $aParams, 'start' => $iStart, 'per_page' => $iPerPage)); + } + + public function serviceGetSearchableFields ($aInputsAdd = array()) + { + $CNF = $this->_oConfig->CNF; + + if(!isset($CNF['PARAM_SEARCHABLE_FIELDS']) || !isset($CNF['OBJECT_FORM_ENTRY']) || !isset($CNF['OBJECT_FORM_ENTRY_DISPLAY_ADD'])) + return array(); + + $oForm = BxDolForm::getObjectInstance($CNF['OBJECT_FORM_ENTRY'], $CNF['OBJECT_FORM_ENTRY_DISPLAY_ADD'], $this->_oTemplate); + if(!$oForm) + return array(); + + $aInputs = $oForm->aInputs; + if(!empty($aInputsAdd) && is_array($aInputsAdd)) + $aInputs = array_merge($aInputs, $aInputsAdd); + + $aTextTypes = array('text', 'textarea'); + $aTextFields = array(); + foreach($aInputs as $r) + if(in_array($r['type'], $aTextTypes)) + $aTextFields[$r['name']] = $r['caption']; + + return $aTextFields; + } + + public function serviceUpdateImage($sFiledName, $iContentId, $sValue) + { + $CNF = &$this->_oConfig->CNF; + + $aData = $this->_oDb->getContentInfoById($iContentId); + if(empty($aData) || !is_array($aData)) + return false; + + if($this->checkAllowedEdit($aData) !== CHECK_ACTION_RESULT_ALLOWED) + return false; + + //TODO add transcoder settings + $oImgStorage = BxDolStorage::getObjectInstance($CNF['OBJECT_STORAGE']); + if(!$oImgStorage) + return false; + + $this->_oDb->updateEntriesBy([$sFiledName => $sValue], [$CNF['FIELD_ID'] => $iContentId]); + + $this->serviceUpdateImagePosition($iContentId, $sFiledName, '', ''); + + $this->onUpdateImage($iContentId, $sFiledName, $sValue); + + return $oImgStorage->getFileUrlById($sValue); + } + + public function serviceUpdateImagePosition($iContentId, $sFiledName, $sH, $sV) + { + $CNF = &$this->_oConfig->CNF; + + $sFieldNamePos = 'FIELD_' . strtoupper($sFiledName) . '_POSITION'; + if(!isset($CNF[$sFieldNamePos])) + return false; + + $sValue = ''; + if($sH != '' || $sV != '') + $sValue = json_encode(['x' => $sH, 'y' => $sV]); + + $this->_oDb->updateEntriesBy([$CNF[$sFieldNamePos] => $sValue], [$CNF['FIELD_ID'] => $iContentId]); + + return true; + } + + public function serviceManageTools($sType = 'common') + { + if(!isLogged()) + return ''; + + $oGrid = BxDolGrid::getObjectInstance($this->_oConfig->getGridObject($sType)); + if(!$oGrid) + return ''; + + if($this->_bIsApi) + return [ + bx_api_get_block('grid', $oGrid->getCodeAPI()) + ]; + + $CNF = &$this->_oConfig->CNF; + + $mixedMenu = ''; + if(BxDolAcl::getInstance()->isMemberLevelInSet(192)) { + $oPermalink = BxDolPermalinks::getInstance(); + + $aMenuItems = array(); + if(!empty($CNF['OBJECT_GRID_COMMON']) && !empty($CNF['T']['menu_item_manage_my'])) + $aMenuItems[] = array('id' => 'manage-common', 'name' => 'manage-common', 'class' => '', 'link' => $oPermalink->permalink($CNF['URL_MANAGE_COMMON']), 'target' => '_self', 'title' => _t($CNF['T']['menu_item_manage_my']), 'active' => 1); + if(!empty($CNF['OBJECT_GRID_ADMINISTRATION']) && !empty($CNF['T']['menu_item_manage_all'])) + $aMenuItems[] = array('id' => 'manage-administration', 'name' => 'manage-administration', 'class' => '', 'link' => $oPermalink->permalink($CNF['URL_MANAGE_ADMINISTRATION']), 'target' => '_self', 'title' => _t($CNF['T']['menu_item_manage_all']), 'active' => 1); + + if(count($aMenuItems) > 1) { + $mixedMenu = new BxTemplMenu(array( + 'template' => 'menu_block_submenu_ver.html', + 'menu_items' => $aMenuItems + ), $this->_oTemplate); + $mixedMenu->setSelected($this->_aModule['name'], 'manage-' . $sType); + } + } + + if(!empty($CNF['OBJECT_MENU_SUBMENU']) && isset($CNF['URI_MANAGE_COMMON']) && ($oSubmenu = BxDolMenu::getObjectInstance($CNF['OBJECT_MENU_SUBMENU'])) !== false) + $oSubmenu->setSelected($this->_aModule['name'], $CNF['URI_MANAGE_COMMON']); + + $this->_oTemplate->addCss(array('manage_tools.css')); + $this->_oTemplate->addJs(array('manage_tools.js')); + $this->_oTemplate->addJsTranslation(array('_sys_grid_search')); + return array( + 'content' => $this->_oTemplate->getJsCode('manage_tools', array('sObjNameGrid' => $this->_oConfig->getGridObject($sType))) . $oGrid->getCode(), + 'menu' => $mixedMenu + ); + } + + public function serviceGetMenuAddonManageTools() + { + return 0; + } + + public function serviceGetMenuAddonManageToolsProfileStats($iProfileId = 0) + { + return 0; + } + + /** + * @page service Service Calls + * @section bx_base_general Base General + * @subsection bx_base_general-browsing Browsing + * @subsubsection bx_base_general-browse browse + * + * @code bx_srv('bx_posts', 'browse', [...]); @endcode + * @code {{~bx_posts:browse[{"mode":"author", "params":{"author":"10"}}]~}} @endcode + * + * Universal browse method. + * @param $aParams custom browse params, possible params are the following: + * - mode - browse mode, such as 'recent', 'featured', etc + * - params - custom params to browse method, for example 'unit_view' can be passed here + * - design_box - design box style, @see BxBaseFunctions::DesignBoxContent + * - empty_message - display or not "empty" message when there is no content + * - ajax_paginate - use AJAX paginate or not + * + * @see BxBaseModGeneralModule::serviceBrowse + */ + /** + * @ref bx_base_general-browse "browse" + */ + public function serviceBrowse ($aParams = array()) + { + if($this->_bIsApi && is_string($aParams)){ + $aParams = json_decode($aParams, true); + if (isset($aParams['params'])) { + if(isset($aParams['params']['type'])) + $aParams['mode'] = $aParams['params']['type']; + + if(isset($aParams['params']['filters'])) { + foreach($aParams['params']['filters'] as $sKey => $sValue) + $aParams['params'][$sKey] = $sValue; + + $aParams['params']['filters'] = [ + 'values' => $aParams['params']['filters'] + ]; + } + + if(isset($aParams['params']['validate']) && !is_array($aParams['params']['validate'])) + $aParams['params']['validate'] = !empty($aParams['params']['validate']) ? explode(',', $aParams['params']['validate']) : []; + } + } + + if (isset($aParams['params']['condition'])) + unset($aParams['params']['condition']); + + return $this->serviceBrowseWithCondition ($aParams); + } + + public function serviceBrowseWithCondition ($aParams = array()) + { + $aDefaults = array ( + 'mode' => 'recent', + 'params' => false, + 'design_box' => BX_DB_PADDING_DEF, + 'empty_message' => false, + 'ajax_paginate' => true, + 'class_search_result' => 'SearchResult' + ); + + $aParams = array_merge($aDefaults, $aParams); + + return $this->_serviceBrowse ($aParams['mode'], $aParams['params'], $aParams['design_box'], $aParams['empty_message'], $aParams['ajax_paginate'], $aParams['class_search_result']); + } + + /** + * @page service Service Calls + * @section bx_base_general Base General + * @subsection bx_base_general-browsing Browsing + * @subsubsection bx_base_general-browse_featured browse_featured + * + * @code bx_srv('bx_posts', 'browse_featured', [...]); @endcode + * + * Display featured entries + * @param $sUnitView browsing unity view, + * such as: full, extended, gallery, showcase + * @param $bEmptyMessage display or not "empty" message when there is no content + * @param $bAjaxPaginate use AJAX paginate or not + * + * @see BxBaseModGeneralModule::serviceBrowseFeatured + */ + /** + * @ref bx_base_general-browse_featured "browse_featured" + */ + public function serviceBrowseFeatured ($sUnitView = false, $bEmptyMessage = false, $bAjaxPaginate = true) + { + return $this->_serviceBrowse ('featured', $sUnitView ? array('unit_view' => $sUnitView) : false, BX_DB_PADDING_DEF, $bEmptyMessage, $bAjaxPaginate); + } + + /** + * @page service Service Calls + * @section bx_base_general Base General + * @subsection bx_base_general-browsing Browsing + * @subsubsection bx_base_general-browse_favorite browse_favorite + * + * @code bx_srv('bx_posts', 'browse_favorite', [...]); @endcode + * + * Display entries which were added to favorite list by some member + * @param $iProfileId profile ID + * @param $aParams additional browse params, see BxBaseModGeneralModule::serviceBrowse + * + * @see BxBaseModGeneralModule::serviceBrowseFavorite BxBaseModGeneralModule::serviceBrowse + */ + /** + * @ref bx_base_general-browse_favorite "browse_favorite" + */ + public function serviceBrowseFavorite ($iProfileId = 0, $aParams = array()) + { + $CNF = &$this->_oConfig->CNF; + + $oProfile = null; + if((int)$iProfileId) + $oProfile = BxDolProfile::getInstance($iProfileId); + if(!$oProfile && bx_get('profile_id') !== false) + $oProfile = BxDolProfile:: getInstance(bx_process_input(bx_get('profile_id'), BX_DATA_INT)); + if(!$oProfile) + $oProfile = BxDolProfile::getInstance(); + if(!$oProfile) + return ''; + + $bEmptyMessage = true; + if(isset($aParams['empty_message'])) { + $bEmptyMessage = (bool)$aParams['empty_message']; + unset($aParams['empty_message']); + } + + if(bx_get('list_id') !== false && !isset($aParams['list_id'])) + $aParams['list_id'] = (int) bx_get('list_id'); + + $aBlock = $this->_serviceBrowse ('favorite', array_merge(array('user' => $oProfile->id()), $aParams), BX_DB_PADDING_DEF, $bEmptyMessage); + if(!$aBlock) + return $aBlock; + + $sTitle = _t('_sys_txt_default_favorite_list'); + if(!empty($aParams['list_id']) && ($oFavorite = BxDolFavorite::getObjectInstance($CNF['OBJECT_FAVORITES'], 0, true))) { + $aList = $oFavorite->getQueryObject()->getList(['type' => 'id', 'list_id' => $aParams['list_id']]); + if(!empty($aList) && is_array($aList)) + $sTitle = $aList['title']; + } + + return array_merge($aBlock, ['markers' => [ + 'title' => $sTitle + ]]); + } + + /** + * @page service Service Calls + * @section bx_base_general Base General + * @subsection bx_base_general-browsing Browsing + * @subsubsection bx_base_general-browse_favorite_lists browse_favorite_lists + * + * @code bx_srv('bx_posts', 'browse_favorite_lists', [...]); @endcode + * + * Display entries which were added to favorite lists grouped by lists by some member + * @param $iProfileId profile ID + * @param $aParams additional browse params, see BxBaseModGeneralModule::serviceBrowse + * + * @see BxBaseModGeneralModule::serviceBrowseFavoriteLists BxBaseModGeneralModule::serviceBrowse + */ + /** + * @ref bx_base_general-browse_favorite_lists "browse_favorite_lists" + */ + public function serviceBrowseFavoriteLists ($iProfileId = 0, $aParams = array()) + { + $CNF = &$this->_oConfig->CNF; + + $oProfile = null; + if((int)$iProfileId) + $oProfile = BxDolProfile::getInstance($iProfileId); + if(!$oProfile && bx_get('profile_id') !== false) + $oProfile = BxDolProfile:: getInstance(bx_process_input(bx_get('profile_id'), BX_DATA_INT)); + if(!$oProfile) + $oProfile = BxDolProfile::getInstance(); + if(!$oProfile) + return ''; + + $iStart = (bx_get('list_start') !== false ? (int)bx_get('list_start') : 0); + $iPerPage = (int)getParam($CNF['PARAM_PER_PAGE_FOR_FAVORITES_LISTS']); + + return $this->_oTemplate->getFavoriteList($oProfile, $iStart, $iPerPage, $aParams); + } + + /** + * @page service Service Calls + * @section bx_base_general Base General + * @subsection bx_base_general-browsing Browsing + * @subsubsection bx_base_general-browse_by_category category + * + * @code bx_srv('bx_posts', 'browse_by_category', [...]); @endcode + * + * Display entries in category + * @param $sUnitView browsing unity view, + * such as: full, extended, gallery, showcase + * @param $bEmptyMessage display or not "empty" message when there is no content + * @param $bAjaxPaginate use AJAX paginate or not + * + * @see BxBaseModGeneralModule::serviceBrowseByCategory BxBaseModGeneralModule::serviceBrowse + */ + /** + * @ref bx_base_general-browse_by_category "browse_by_category" + */ + public function serviceBrowseCategory($sUnitView = false, $bEmptyMessage = true, $bAjaxPaginate = true, $aParams = []) + { + $sType = 'category'; + + $aParams = array_merge(['category' => bx_process_input(bx_get('category'), BX_DATA_INT)], $aParams); + if($sUnitView) + $aParams['unit_view'] = $sUnitView; + + return $this->_serviceBrowse($sType, $aParams, BX_DB_PADDING_DEF, $bEmptyMessage, $bAjaxPaginate); + } + + /** + * @page service Service Calls + * @section bx_base_general Base General + * @subsection bx_base_general-browsing Browsing + * @subsubsection bx_base_general-browse_favorite_list_actions browse_favorite_list_actions + * + * @code bx_srv('bx_posts', 'browse_favorite_list_actions', [...]); @endcode + * + * Display menu actions for favorite lists + * + * @see BxBaseModGeneralModule::serviceFavoritesListActions + */ + /** + * @ref bx_base_general-browse_favorite_list_actions "browse_favorite_list_actions" + */ + public function serviceFavoritesListActions() + { + $iListId = 0; + if(bx_get('list_id') !== false) + $iListId = (int) bx_get('list_id'); + + $oProfile = null; + if(bx_get('profile_id') !== false) + $oProfile = BxDolProfile:: getInstance(bx_process_input(bx_get('profile_id'), BX_DATA_INT)); + if(!$oProfile) + return false; + + $CNF = &$this->_oConfig->CNF; + $oFavorite = BxDolFavorite::getObjectInstance($CNF['OBJECT_FAVORITES'], 0, true); + + $aList = $oFavorite->getQueryObject()->getList(array('type' => 'id', 'list_id' => $iListId)); + if($iListId != 0 && (empty($aList) || !is_array($aList))) + return false; + + $sRv = ''; + if (!empty($aList) && $oFavorite->isAllowedEditList($aList['author_id'])){ + $aMarkers = array( + 'js_object' => $oFavorite->getJsObjectName(), + 'list_id' => $iListId, + ); + + $oMenu = BxDolMenu::getObjectInstance('sys_favorite_list'); + + $oMenu->addMarkers($aMarkers); + $sMenu = $oMenu->getCode(); + + $sRv .= $sMenu . $oFavorite->getJsScript(); + } + + $aMarkers = array( + 'id' => $iListId, + 'module' => $this->_aModule['name'], + 'url' => $this->_getFavoriteListUrl($iListId, $oProfile->id()), + 'title' => $iListId > 0 ? $aList['title'] : _t('_sys_txt_default_favorite_list') + ); + + $oMenu = BxDolMenu::getObjectInstance('sys_social_sharing'); + $oMenu->addMarkers($aMarkers); + $sRv .= $sMenu = $oMenu->getCode(); + return $sRv; + } + + /** + * @page service Service Calls + * @section bx_base_general Base General + * @subsection bx_base_general-menu Menu + * @subsubsection bx_base_general-favorites_list_info favorites_list_info + * + * @code bx_srv('bx_posts', 'favorites_list_info', [...]); @endcode + * + * Favorites list info + * @param $aParams array with additional custom params + * which may overwrite some default values + * + * @see BxBaseModGeneralModule::serviceFavoritesListInfo + */ + /** + * @ref bx_base_general-favorites_list_info "favorites_list_info" + */ + public function serviceFavoritesListInfo($aParams = array()) + { + $CNF = &$this->_oConfig->CNF; + + $iListId = 0; + if(bx_get('list_id') !== false) + $iListId = (int) bx_get('list_id'); + + $oFavorite = BxDolFavorite::getObjectInstance($CNF['OBJECT_FAVORITES'], 0, true); + $aList = $oFavorite->getQueryObject()->getList(array('type' => 'id', 'list_id' => $iListId)); + if($iListId != 0 && (empty($aList) || !is_array($aList))) + return false; + + $oProfile = null; + if(bx_get('profile_id') !== false) + $oProfile = BxDolProfile:: getInstance(bx_process_input(bx_get('profile_id'), BX_DATA_INT)); + + if(!$oProfile) + return false; + + return $this->_oTemplate->getFavoritesListInfo($aList, $oProfile); + } + + /** + * Display entries posted into particular context + * @return HTML string + */ + public function serviceBrowseContext ($iProfileId = 0, $aParams = array()) + { + return $this->_serviceBrowseWithParam ('context', 'profile_id', $iProfileId, $aParams); + } + + public function _serviceBrowseWithParam ($sParamName, $sParamGet, $sParamVal, $aParams = array()) + { + if(!$sParamVal) + $sParamVal = bx_process_input(bx_get($sParamGet), BX_DATA_INT); + if(!$sParamVal) + return ''; + + $bEmptyMessage = true; + if(isset($aParams['empty_message'])) { + $bEmptyMessage = (bool)$aParams['empty_message']; + unset($aParams['empty_message']); + } + + $bAjaxPaginate = true; + if(isset($aParams['ajax_paginate'])) { + $bAjaxPaginate = (bool)$aParams['ajax_paginate']; + unset($aParams['ajax_paginate']); + } + + return $this->_serviceBrowse ($sParamName, array_merge(array($sParamName => $sParamVal), $aParams), BX_DB_PADDING_DEF, $bEmptyMessage, $bAjaxPaginate); + } + + public function getFormsHelper () + { + $sClass = 'FormsEntryHelper'; + $oObject = null; + + bx_alert('system', 'get_forms_helper', 0, 0, [ + 'class' => &$sClass, + 'object' => &$oObject + ]); + + if($oObject !== null) + return $oObject; + + bx_import($sClass, $this->_aModule); + $sClass = $this->_aModule['class_prefix'] . $sClass; + return new $sClass($this); + } + + public function serviceFormsHelper () + { + return $this->getFormsHelper(); + } + + /** + * Add entry using provided fields' values. + * @return array with result: 'code' is 0 on success or non-zero on error, 'message' is error message in case of error, 'content' is content info array in case of success + */ + public function serviceEntityAdd ($iProfile, $aValues, $sDisplay = false) + { + $oFormsHelper = $this->getFormsHelper(); + return $oFormsHelper->addData($iProfile, $aValues, $sDisplay); + } + + /** + * Perform redirect after content creation + * @return nothing, rediret header is sent + */ + public function serviceRedirectAfterAdd($aContentInfo) + { + $oFormsHelper = $this->getFormsHelper(); + $oFormsHelper->redirectAfterAdd($aContentInfo); + } + + /** + * Get form object for add, edit, view or delete the content + * @param $sType 'add', 'edit', 'view' or 'delete' + * @param $aParams optional array with parameters(display name, etc) + * @return form object or false on error + */ + public function serviceGetObjectForm ($sType, $aParams = array()) + { + if(!in_array($sType, array('add', 'edit', 'view', 'delete'))) + return false; + + $iLoggedId = (int)bx_get_logged_profile_id(); + $mixedContextId = isset($aParams['context_id']) ? $aParams['context_id'] : false; + + $oContextProfile = false; + $bContext = $mixedContextId !== false; + if($bContext) { + $oContextProfile = BxDolProfile::getInstance(abs($mixedContextId)); + $bContext = $oContextProfile !== false; + + if($bContext && $oContextProfile->checkAllowedPostInProfile() !== CHECK_ACTION_RESULT_ALLOWED) + return false; + } + + $CNF = &$this->_oConfig->CNF; + $oFormsHelper = $this->getFormsHelper(); + + $sParamsKey = 'ajax_mode'; + if(isset($aParams[$sParamsKey]) && (bool)$aParams[$sParamsKey] === true) + $oFormsHelper->setAjaxMode((bool)$aParams[$sParamsKey]); + + $sParamsKey = 'absolute_action_url'; + if(isset($aParams[$sParamsKey]) && (bool)$aParams[$sParamsKey] === true) + $oFormsHelper->setAbsoluteActionUrl((bool)$aParams[$sParamsKey]); + + if($bContext) + $oFormsHelper->setContextId($mixedContextId); + + $sDisplay = !empty($aParams['display']) ? $aParams['display'] : false; + + $sFunc = 'getObjectForm' . ucfirst($sType); + $oForm = $oFormsHelper->$sFunc($sDisplay); + + $sKey = 'FIELD_ALLOW_VIEW_TO'; + if(!empty($CNF[$sKey]) && !empty($oForm->aInputs[$CNF[$sKey]]) && (!$bContext || $mixedContextId < 0)) { + $bContextOwner = $bContext && abs($mixedContextId) == $iLoggedId; + + if(!$bContext || $bContextOwner) { + $iGc = 0; + $iKeyGh = false; + foreach($oForm->aInputs[$CNF[$sKey]]['values'] as $iKey => $aValue) { + if(isset($aValue['type']) && in_array($aValue['type'], array('group_header', 'group_end'))) { + if($iKeyGh !== false && $iGc == 0) { + unset($oForm->aInputs[$CNF[$sKey]]['values'][$iKeyGh]); + $iKeyGh = false; + + if($aValue['type'] == 'group_end') + unset($oForm->aInputs[$CNF[$sKey]]['values'][$iKey]); + } + + if($aValue['type'] == 'group_header') { + $iGc = 0; + $iKeyGh = $iKey; + } + + continue; + } + + //--- Show 'Public' privacy group only in Public post form. + if(!$bContext && $aValue['key'] == BX_DOL_PG_ALL) { + $iGc += 1; + continue; + } + + //--- Show a default privacy groups in Profile (for Owner) post form. + if($bContextOwner && ((int)$aValue['key'] >= 0 || $mixedContextId == $aValue['key'])) { + $iGc += 1; + continue; + } + + unset($oForm->aInputs[$CNF[$sKey]]['values'][$iKey]); + } + } + else { + $oForm->aInputs[$CNF[$sKey]]['value'] = $mixedContextId; + $oForm->aInputs[$CNF[$sKey]]['type'] = 'hidden'; + } + } + + $sKey = 'FIELD_LABELS'; + if(!empty($CNF[$sKey]) && !empty($oForm->aInputs[$CNF[$sKey]]) && empty($oForm->aInputs[$CNF[$sKey]]['value']) && $bContext) { + $iContextProfileId = $oContextProfile->id(); + $sContextModule = $oContextProfile->getModule(); + + if(bx_srv($sContextModule, 'is_fan', [$iContextProfileId, $iLoggedId])) { + $aContextInfo = bx_srv($sContextModule, 'get_content_info_by_profile_id', [$iContextProfileId]); + if(!empty($aContextInfo['hashtag'])) + $oForm->aInputs[$CNF[$sKey]]['value'] = [$aContextInfo['hashtag']]; + } + } + + /** + * @hooks + * @hookdef hook-system-get_object_form 'system', 'get_object_form' - hook to override an object of create content form, @see BxDolForm + * - $unit_name - equals `system` + * - $action - equals `get_object_form` + * - $object_id - not used + * - $sender_id - not used + * - $extra_params - array of additional params with the following array keys: + * - `module` - [string] module name + * - `type` - [string] 'add', 'edit', 'view' or 'delete' form display type + * - `params` - [array] form params array as key&value pairs + * - `form` - [object] by ref, an object of create content form, @see BxDolForm, can be overridden in hook processing + * @hook @ref hook-system-get_object_form + */ + bx_alert('system', 'get_object_form', 0, 0, [ + 'module' => $this->_oConfig->getName(), + 'type' => $sType, + 'params' => $aParams, + 'form' => &$oForm + ]); + + return $oForm; + } + + /** + * + * + * Create entry form + * @return HTML string + */ + public function serviceEntityCreate ($sParams = false) + { + $bParamsArray = is_array($sParams); + + $sDisplay = is_string($sParams) ? $sParams : false; + if($bParamsArray && !empty($sParams['display'])) + $sDisplay = $sParams['display']; + + $oFormsHelper = $this->getFormsHelper(); + if($bParamsArray && isset($sParams['dynamic_mode'])) + $oFormsHelper->setDynamicMode($sParams['dynamic_mode']); + + $mixedResult = $oFormsHelper->addDataForm($sDisplay); + + if (bx_is_api()){ + return $mixedResult; + } + + if(isset($mixedResult['_dt']) && $mixedResult['_dt'] == 'json') { + echoJson($mixedResult); + exit; + } + + return $mixedResult; + } + + /** + * @page service Service Calls + * @section bx_base_general Base General + * @subsection bx_base_general-forms Forms + * @subsubsection bx_base_general-get_create_post_form get_create_post_form + * + * @code bx_srv('bx_posts', 'get_create_post_form'); @endcode + * + * Get content creation form + * @param $aParams additional parameters array: + * context_id, ajax_mode, absolute_action_url, displays + * + * @see BxBaseModGeneralModule::serviceGetCreatePostForm + */ + /** + * @ref bx_base_general-get_create_post_form "get_create_post_form" + */ + public function serviceGetCreatePostForm($aParams = []) + { + $aParams = array_merge($this->_aFormParams, $aParams); + + if($aParams['context_id'] !== false && ($aContextInfo = BxDolProfileQuery::getInstance()->getInfoById(abs($aParams['context_id'])))) + if(bx_srv($aContextInfo['type'], 'check_allowed_post_in_profile', [$aContextInfo['content_id'], $this->getName()]) !== CHECK_ACTION_RESULT_ALLOWED) + return ''; + + $oForm = $this->serviceGetObjectForm('add', $aParams); + if(!$oForm) + return ''; + + return $this->serviceEntityCreate($aParams); + } + + /** + * @page service Service Calls + * @section bx_base_general Base General + * @subsection bx_base_general-forms Forms + * @subsubsection bx_base_general-entity_edit entity_edit + * + * @code bx_srv('bx_posts', 'entity_edit', [...]); @endcode + * + * Get content edit form + * @param $iContentId content ID + * @param $sDisplay optional form display name + * + * @see BxBaseModGeneralModule::serviceEntityEdit + */ + /** + * @ref bx_base_general-entity_edit "entity_edit" + */ + public function serviceEntityEdit ($iContentId = 0, $sDisplay = false) + { + $mixedResult = $this->_serviceEntityForm ('editDataForm', $iContentId, $sDisplay); + if(!bx_is_api()) + return $mixedResult; + + $aResult = []; + if(is_a($mixedResult, 'BxTemplFormView')){ + $iContentId = $this->_getContent($iContentId, false); + $aResult = bx_api_get_block('form', $mixedResult->getCodeAPI(), ['ext' => ['name' => $this->getName(), 'request' => ['url' => '/api.php?r=' . $this->_aModule['name'] . '/entity_edit¶ms[]=' . $iContentId . '¶ms[]=' . $mixedResult->aParams['display'], 'immutable' => true]]]); + } + else + $aResult = $mixedResult; + + return [ + $aResult + ]; + } + + /** + * @page service Service Calls + * @section bx_base_general Base General + * @subsection bx_base_general-forms Forms + * @subsubsection bx_base_general-entity_delete entity_delete + * + * @code bx_srv('bx_posts', 'entity_delete', [...]); @endcode + * + * Get content delete form + * @param $iContentId content ID + * + * @see BxBaseModGeneralModule::serviceEntityDelete + */ + /** + * @ref bx_base_general-entity_delete "entity_delete" + */ + public function serviceEntityDelete ($iContentId = 0) + { + $mixedResult = $this->_serviceEntityForm ('deleteDataForm', $iContentId); + if(!bx_is_api()) + return $mixedResult; + + $aResult = []; + if(is_a($mixedResult, 'BxTemplFormView')){ + $iContentId = $this->_getContent($iContentId, false); + $aResult = bx_api_get_block('form', $mixedResult->getCodeAPI(), ['ext' => ['name' => $this->getName(), 'request' => ['url' => '/api.php?r=' . $this->_aModule['name'] . '/entity_delete¶ms[]=' . $iContentId . '¶ms[]=' . $mixedResult->aParams['display'], 'immutable' => true]]]); + } + else + $aResult = $mixedResult; + + return [ + $aResult + ]; + } + + /** + * @page service Service Calls + * @section bx_base_general Base General + * @subsection bx_base_general-page_blocks Page Blocks + * @subsubsection bx_base_general-entity_text_block entity_text_block + * + * @code bx_srv('bx_posts', 'entity_text_block', [...]); @endcode + * + * Get content text/description + * @param $iContentId content ID + * + * @see BxBaseModGeneralModule::serviceEntityTextBlock + */ + /** + * @ref bx_base_general-entity_text_block "entity_text_block" + */ + public function serviceEntityTextBlock ($iContentId = 0) + { + return $this->_serviceEntityForm ('viewDataEntry', $iContentId); + } + + /** + * @page service Service Calls + * @section bx_base_general Base General + * @subsection bx_base_general-page_blocks Page Blocks + * @subsubsection bx_base_general-entity_info entity_info + * + * @code bx_srv('bx_posts', 'entity_info', [...]); @endcode + * + * Get content info + * @param $iContentId content ID + * + * @see BxBaseModGeneralModule::serviceEntityInfo + */ + /** + * @ref bx_base_general-entity_info "entity_info" + */ + public function serviceEntityInfo ($iContentId = 0, $sDisplay = false) + { + return $this->_serviceEntityForm ('viewDataForm', $iContentId, $sDisplay); + } + + /** + * @page service Service Calls + * @section bx_base_general Base General + * @subsection bx_base_general-page_blocks Page Blocks + * @subsubsection bx_base_general-entity_info_full entity_info_full + * + * @code bx_srv('bx_posts', 'entity_info_full', [...]); @endcode + * + * Get full content info + * @param $iContentId content ID + * + * @see BxBaseModGeneralModule::serviceEntityInfoFull + */ + /** + * @ref bx_base_general-entity_info_full "entity_info_full" + */ + public function serviceEntityInfoFull ($iContentId = 0) + { + $CNF = &$this->_oConfig->CNF; + + $sDisplayName = 'OBJECT_FORM_ENTRY_DISPLAY_VIEW_FULL'; + return $this->_serviceEntityForm ('viewDataForm', $iContentId, !empty($CNF[$sDisplayName]) ? $CNF[$sDisplayName] : false); + } + + /** + * @page service Service Calls + * @section bx_base_general Base General + * @subsection bx_base_general-page_blocks Page Blocks + * @subsubsection bx_base_general-entity_info_extended entity_info_extended + * + * @code bx_srv('bx_posts', 'entity_info_extended', [...]); @endcode + * + * Get extended content info + * @param $iContentId content ID + * + * @see BxBaseModGeneralModule::serviceEntityInfoExtended + */ + /** + * @ref bx_base_general-entity_info_extended "entity_info_extended" + */ + public function serviceEntityInfoExtended ($iContentId = 0) + { + return $this->_serviceTemplateFunc ('entryInfo', $iContentId); + } + + /** + * @page service Service Calls + * @section bx_base_general Base General + * @subsection bx_base_general-page_blocks Page Blocks + * @subsubsection bx_base_general-entity_location entity_location + * + * @code bx_srv('bx_posts', 'entity_location', [...]); @endcode + * + * Get content location + * @param $iContentId content ID + * + * @see BxBaseModGeneralModule::serviceEntityLocation + */ + /** + * @ref bx_base_general-entity_location "entity_location" + */ + public function serviceEntityLocation ($iContentId = 0) + { + $CNF = &$this->_oConfig->CNF; + + $mixedContent = $this->_getContent($iContentId); + if($mixedContent === false) + return false; + + list($iContentId, $aContentInfo) = $mixedContent; + + $oFormsHelper = $this->getFormsHelper(); + $oFormView = $oFormsHelper->getObjectFormView(); + if(!$oFormView) + return false; + + $oFormView->initChecker($aContentInfo); + if(empty($CNF['FIELD_LOCATION']) || !$oFormView->isInputVisible($CNF['FIELD_LOCATION'])) + return false; + + return $this->_oTemplate->entryLocation ($iContentId); + } + + /** + * @page service Service Calls + * @section bx_base_general Base General + * @subsection bx_base_general-page_blocks Page Blocks + * @subsubsection bx_base_general-entity_comments entity_comments + * + * @code bx_srv('bx_posts', 'entity_comments', [...]); @endcode + * + * Get content comments + * @param $iContentId content ID + * + * @see BxBaseModGeneralModule::serviceEntityComments + */ + /** + * @ref bx_base_general-entity_comments "entity_comments" + */ + public function serviceEntityComments ($iContentId = 0) + { + $CNF = &$this->_oConfig->CNF; + if(empty($CNF['OBJECT_COMMENTS'])) + return ''; + + return $this->_entityComments($CNF['OBJECT_COMMENTS'], $iContentId); + } + + /** + * @page service Service Calls + * @section bx_base_general Base General + * @subsection bx_base_general-page_blocks Page Blocks + * @subsubsection bx_base_general-entity_attachments entity_attachments + * + * @code bx_srv('bx_posts', 'entity_attachments', [...]); @endcode + * + * Get content attachments + * @param $iContentId content ID + * + * @see BxBaseModGeneralModule::serviceEntityAttachments + */ + /** + * @ref bx_base_general-entity_attachments "entity_attachments" + */ + public function serviceEntityAttachments ($iContentId = 0) + { + return $this->_serviceTemplateFunc ('entryAttachments', $iContentId); + } + + /** + * Delete content entry + * @param $iContentId content id + * @return error message or empty string on success + */ + public function serviceDeleteEntity ($iContentId, $sFuncDelete = 'deleteData') + { + $oFormsHelper = $this->getFormsHelper(); + return $oFormsHelper->$sFuncDelete($iContentId); + } + + /** + * @page service Service Calls + * @section bx_base_general Base General + * @subsection bx_base_general-menu Menu + * @subsubsection bx_base_general-my_entries_actions my_entries_actions + * + * @code bx_srv('bx_posts', 'my_entries_actions', [...]); @endcode + * + * My entries actions menu + * @param $iProfileId profiles ID, + * if omitted it try to get it from 'profile_id' GET param + * + * @see BxBaseModGeneralModule::serviceMyEntriesActions + */ + /** + * @ref bx_base_general-my_entries_actions "my_entries_actions" + */ + public function serviceMyEntriesActions ($iProfileId = 0) + { + $CNF = &$this->_oConfig->CNF; + if(empty($CNF['OBJECT_MENU_ACTIONS_MY_ENTRIES'])) + return false; + + if (!$iProfileId) + $iProfileId = bx_process_input(bx_get('profile_id'), BX_DATA_INT); + if (!$iProfileId || !($oProfile = BxDolProfile::getInstance($iProfileId))) + return false; + + if ($iProfileId != $this->_iProfileId) + return false; + + $oMenu = BxTemplMenu::getObjectInstance($CNF['OBJECT_MENU_ACTIONS_MY_ENTRIES']); + return $oMenu ? $oMenu->getCode() : false; + } + + /** + * @page service Service Calls + * @section bx_base_general Base General + * @subsection bx_base_general-menu Menu + * @subsubsection bx_base_general-entity_all_actions entity_all_actions + * + * @code bx_srv('bx_posts', 'entity_all_actions', [...]); @endcode + * + * Entry actions and social sharing actions + * @param $mixedContent content ID + * @param $aParams additional params + * + * @see BxBaseModGeneralModule::serviceEntityAllActions + */ + /** + * @ref bx_base_general-entity_all_actions "entity_all_actions" + */ + public function serviceEntityAllActions ($mixedContent = false, $aParams = array()) + { + $mixedResult = $this->getEntryAllActions($mixedContent, $aParams); + + if(bx_is_api()) + return [bx_api_get_block('entity_actions', $mixedResult)]; + else + return $this->_oTemplate->entryAllActions($mixedResult); + } + + /** + * @page service Service Calls + * @section bx_base_general Base General + * @subsection bx_base_general-menu Menu + * @subsubsection bx_base_general-entity_actions entity_actions + * + * @code bx_srv('bx_posts', 'entity_actions', [...]); @endcode + * + * Entry actions, without social sharing actions + * @param $iContentId content ID + * + * @see BxBaseModGeneralModule::serviceEntityActions + */ + /** + * @ref bx_base_general-entity_actions "entity_actions" + */ + public function serviceEntityActions ($iContentId = 0) + { + $iContentId = $this->_getContent($iContentId, false); + if($iContentId === false) + return false; + + $oMenu = BxTemplMenu::getObjectInstance($this->_oConfig->CNF['OBJECT_MENU_ACTIONS_VIEW_ENTRY']); + return $oMenu ? $oMenu->getCode() : false; + } + + /** + * @page service Service Calls + * @section bx_base_general Base General + * @subsection bx_base_general-page_blocks Page Blocks + * @subsubsection bx_base_general-entity_reports entity_reports + * + * @code bx_srv('bx_posts', 'entity_reports', [...]); @endcode + * + * Get content reports + * @param $iContentId content ID + * + * @see BxBaseModGeneralModule::serviceEntityReports + */ + /** + * @ref bx_base_general-entity_reports "entity_reports" + */ + public function serviceEntityReports ($iContentId = 0) + { + $mixedContent = $this->_getContent($iContentId); + list($iContentId, $aContentInfo) = $mixedContent; + + if($iContentId === false) + return false; + + $CNF = &$this->_oConfig->CNF; + + if (!isset($CNF['OBJECT_REPORTS']) || !isset($CNF['OBJECT_NOTES'])) + return false; + + if(!$aContentInfo || !(BxDolAcl::getInstance()->isMemberLevelInSet(192) || (isset($CNF['FIELD_AUTHOR']) && bx_get_logged_profile_id() == $aContentInfo[$CNF['FIELD_AUTHOR']]))) + return false; + + $oReport = BxDolReport::getObjectInstance($CNF['OBJECT_REPORTS'], $iContentId, true); + if(!$oReport) + return false; + + return $oReport->getReportedByWithComments($CNF['OBJECT_NOTES']); + } + + /** + * @page service Service Calls + * @section bx_base_general Base General + * @subsection bx_base_general-page_blocks Page Blocks + * @subsubsection bx_base_general-reports_count_by_status reports_count_by_status + * + * @code bx_srv('bx_posts', 'reports_count_by_status', [...]); @endcode + * + * Get number of reports with specified status + * @param $iStatus status ID + * + * @see BxBaseModGeneralModule::serviceReportsCountByStatus + */ + /** + * @ref bx_base_general-entity_reports "entity_reports" + */ + public function serviceReportsCountByStatus ($iStatus) + { + $CNF = &$this->_oConfig->CNF; + + if (!isset($CNF['OBJECT_REPORTS']) || !isset($CNF['OBJECT_NOTES'])) + return false; + + $oReport = BxDolReport::getObjectInstance($CNF['OBJECT_REPORTS'], 0, false); + return $oReport->getCountByStatus($iStatus); + } + + /** + * @page service Service Calls + * @section bx_base_general Base General + * @subsection bx_base_general-menu Menu + * @subsubsection bx_base_general-entity_social_sharing entity_social_sharing + * + * @code bx_srv('bx_posts', 'entity_social_sharing', [...]); @endcode + * + * Entry social sharing actions + * @param $mixedContent content ID or array with integer content ID and + * array with content info, or false + * @param $aParams array with additional custom params + * which may overwrite some default values + * + * @see BxBaseModGeneralModule::serviceEntitySocialSharing + */ + /** + * @ref bx_base_general-entity_social_sharing "entity_social_sharing" + */ + public function serviceEntitySocialSharing($mixedContent = false, $aParams = array()) + { + if(!empty($mixedContent)) { + if(!is_array($mixedContent)) + $mixedContent = array((int)$mixedContent, array()); + } + else { + $mixedContent = $this->_getContent(); + if($mixedContent === false) + return false; + } + + list($iContentId, $aContentInfo) = $mixedContent; + + $CNF = &$this->_oConfig->CNF; + + $sUri = !empty($aParams['uri']) ? $aParams['uri'] : ''; + if(empty($sUri) && !empty($CNF['URI_VIEW_ENTRY'])) + $sUri = $CNF['URI_VIEW_ENTRY']; + + $sUrl = !empty($sUri) ? BxDolPermalinks::getInstance()->permalink('page.php?i=' . $sUri . '&id=' . $iContentId) : ''; + + $sTitle = !empty($aParams['title']) ? $aParams['title'] : ''; + if(empty($sTitle) && !empty($aContentInfo[$CNF['FIELD_TITLE']])) + $sTitle = $aContentInfo[$CNF['FIELD_TITLE']]; + + $aMarkers = array( + 'id' => $iContentId, + 'module' => $this->_aModule['name'], + 'url' => bx_absolute_url($sUrl), + 'title' => $sTitle, + ); + + $iIdThumb = !empty($aParams['id_thumb']) ? (int)$aParams['id_thumb'] : 0; + if(empty($iIdThumb) && !empty($CNF['FIELD_THUMB']) && !empty($aContentInfo[$CNF['FIELD_THUMB']])) + $iIdThumb = (int)$aContentInfo[$CNF['FIELD_THUMB']]; + + if ($iIdThumb) { + $sTranscoder = !empty($aParams['object_transcoder']) ? $aParams['object_transcoder'] : ''; + $sStorage = !empty($aParams['object_storage']) ? $aParams['object_storage'] : ''; + if(empty($sStorage) && !empty($CNF['OBJECT_STORAGE'])) + $sStorage = $CNF['OBJECT_STORAGE']; + + if(!empty($sTranscoder)) + $o = BxDolTranscoder::getObjectInstance($sTranscoder); + else if(!empty($sStorage)) + $o = BxDolStorage::getObjectInstance($sStorage); + + $sImgUrl = $o ? $o->getFileUrlById($iIdThumb) : ''; + if($sImgUrl) + $aMarkers['img_url'] = $sImgUrl; + } + + $oMenu = BxDolMenu::getObjectInstance('sys_social_sharing'); + $oMenu->addMarkers($aMarkers); + $sMenu = $oMenu->getCode(); + + if(empty($sMenu)) + return ''; + + return $this->_oTemplate->parseHtmlByName('entry-share.html', array( + 'menu' => $sMenu + )); + } + + /** + * Entry context block + */ + public function serviceEntityContext ($iContentId = 0) + { + return $this->_serviceTemplateFunc ('entryContext', $iContentId); + } + + /** + * Blocks for lables tree browsing + */ + public function serviceGetLablesTree() + { + $aBreadcrumbs = array(); + $this->_getLablesBreadcrumbsArray(bx_get('label'), $aBreadcrumbs); + return $this->_getLablesTreeLevel($aBreadcrumbs); + } + + public function serviceGetLablesBreadcrumbs() + { + if (bx_get('label')){ + $aBreadcrumbs = array(); + $this->_getLablesBreadcrumbsArray(bx_process_input(bx_get('label'), BX_DATA_INT), $aBreadcrumbs); + $aLabels = array(); + foreach (array_reverse($aBreadcrumbs) as $aLabel){ + $aLabels[] = array( + 'value' => $aLabel['value'], + 'url' => $this->_getLablesBrowseUrl($aLabel['id']) + ); + } + + return $this->_oTemplate->parseHtmlByName('labels_breadcrumbs.html', array('bx_repeat:items' => $aLabels)); + } + return ''; + } + + public function serviceBrowseByLabel() + { + $CNF = &$this->_oConfig->CNF; + if (empty($CNF['OBJECT_METATAGS'])) + return ''; + + $sMode = 'recent'; + if(bx_srv('system', 'is_module_content', [$this->_aModule['name']])) + $sMode = 'public'; + + $sClassSearchResult ='SearchResult'; + + bx_import($sClassSearchResult, $this->_aModule['name']); + $sClass = $this->_aModule['class_prefix'] . $sClassSearchResult; + + $o = new $sClass($sMode, false); + $o->setDesignBoxTemplateId(BX_DB_PADDING_DEF); + $o->setDisplayEmptyMsg(true); + $o->setAjaxPaginate(false); + $o->setUnitParams(array('context' => $sMode)); + + if (bx_get('label')){ + $iLabelId = (int)bx_get('label'); + $oLabel = BxDolLabel::getInstance(); + $aLabel = $oLabel->getLabels(array('type' => 'id', 'id' => $iLabelId)); + $oMetatags = BxDolMetatags::getObjectInstance($CNF['OBJECT_METATAGS']); + $sTmp =$oMetatags->keywordsSetSearchCondition($o, $aLabel['value']); + } + + if ($o->isError) + return ''; + + if ($s = $o->processing()) + return $s; + else + return ''; + } + + public function serviceBrowseByCategories($sUnitView, $bEmptyMessage, $bAjaxPaginate, $sMode, $iPerPage) + { + $CNF = &$this->_oConfig->CNF; + $sClassSearchResult ='SearchResult'; + + bx_import($sClassSearchResult, $this->_aModule['name']); + $sClass = $this->_aModule['class_prefix'] . $sClassSearchResult; + $o = new $sClass($sMode, array('unit_view' => $sUnitView, 'paginate' => array('perPage' => 10, 'start' => 0, 'num' => 11))); + $o->setDesignBoxTemplateId(BX_DB_PADDING_DEF); + $o->setAjaxPaginate($bAjaxPaginate); + $o->setCategoryObject('multi'); + + $aCategoriesOutput = array(); + $aCategories = BxDolCategories::getInstance()->getData(array('type' => 'by_module_with_num', 'module' => $this->_aModule['name'])); + + foreach($aCategories as $aCategory){ + if ($aCategory['num'] > 0){ + $o->setCustomSearchCondition(array('keyword' => $aCategory['value'])); + $o->setPaginatePerPage(2); + if (!$o->isError){ + $aResult = $o->processing(); + if ($aResult && $aResult['content'] != '') + $aCategoriesOutput[] = array('name' => _t($aCategory['value']), 'url' => '', 'content' => $aResult['content']); + } + } + } + + return $this->_oTemplate->parseHtmlByName('browse_by_categories.html', array( + 'bx_repeat:categories' => $aCategoriesOutput, + )); + + } + + /** + * Data for Notifications module + */ + public function serviceGetNotificationsData() + { + $sModule = $this->_aModule['name']; + + $sEventPrivacy = $sModule . '_allow_view_event_to'; + if(BxDolPrivacy::getObjectInstance($sEventPrivacy) === false) + $sEventPrivacy = ''; + + $aResult = [ + 'handlers' => [ + ['group' => $sModule . '_object', 'type' => 'insert', 'alert_unit' => $sModule, 'alert_action' => 'added', 'module_name' => $sModule, 'module_method' => 'get_notifications_post', 'module_class' => 'Module', 'module_event_privacy' => $sEventPrivacy], + ['group' => $sModule . '_object', 'type' => 'update', 'alert_unit' => $sModule, 'alert_action' => 'edited'], + ['group' => $sModule . '_object', 'type' => 'delete', 'alert_unit' => $sModule, 'alert_action' => 'deleted'], + + ['group' => $sModule . '_object_approved', 'type' => 'insert', 'alert_unit' => $sModule, 'alert_action' => 'approved', 'module_name' => $sModule, 'module_method' => 'get_notifications_post_approved', 'module_class' => 'Module', 'module_event_privacy' => $sEventPrivacy], + + ['group' => $sModule . '_comment', 'type' => 'insert', 'alert_unit' => $sModule, 'alert_action' => 'commentPost', 'module_name' => $sModule, 'module_method' => 'get_notifications_comment', 'module_class' => 'Module', 'module_event_privacy' => $sEventPrivacy], + ['group' => $sModule . '_comment', 'type' => 'delete', 'alert_unit' => $sModule, 'alert_action' => 'commentRemoved'], + + ['group' => $sModule . '_reply', 'type' => 'insert', 'alert_unit' => $sModule, 'alert_action' => 'replyPost', 'module_name' => $sModule, 'module_method' => 'get_notifications_reply', 'module_class' => 'Module', 'module_event_privacy' => $sEventPrivacy], + ['group' => $sModule . '_reply', 'type' => 'delete', 'alert_unit' => $sModule, 'alert_action' => 'replyRemoved'], + + ['group' => $sModule . '_vote', 'type' => 'insert', 'alert_unit' => $sModule, 'alert_action' => 'doVote', 'module_name' => $sModule, 'module_method' => 'get_notifications_vote', 'module_class' => 'Module', 'module_event_privacy' => $sEventPrivacy], + ['group' => $sModule . '_vote', 'type' => 'delete', 'alert_unit' => $sModule, 'alert_action' => 'undoVote'], + + ['group' => $sModule . '_reaction', 'type' => 'insert', 'alert_unit' => $sModule . '_reactions', 'alert_action' => 'doVote', 'module_name' => $sModule, 'module_method' => 'get_notifications_reaction', 'module_class' => 'Module', 'module_event_privacy' => $sEventPrivacy], + ['group' => $sModule . '_reaction', 'type' => 'delete', 'alert_unit' => $sModule . '_reactions', 'alert_action' => 'undoVote'], + + ['group' => $sModule . '_score_up', 'type' => 'insert', 'alert_unit' => $sModule, 'alert_action' => 'doVoteUp', 'module_name' => $sModule, 'module_method' => 'get_notifications_score_up', 'module_class' => 'Module', 'module_event_privacy' => $sEventPrivacy], + + ['group' => $sModule . '_score_down', 'type' => 'insert', 'alert_unit' => $sModule, 'alert_action' => 'doVoteDown', 'module_name' => $sModule, 'module_method' => 'get_notifications_score_down', 'module_class' => 'Module', 'module_event_privacy' => $sEventPrivacy], + + //--- Moderation related: For 'admins'. + ['group' => $sModule . '_object_pending_approval', 'type' => 'insert', 'alert_unit' => $sModule, 'alert_action' => 'pending_approval', 'module_name' => $sModule, 'module_method' => 'get_notifications_post_pending_approval', 'module_class' => 'Module', 'module_event_privacy' => $sEventPrivacy], + ], + 'settings' => [ + ['group' => 'content', 'unit' => $sModule, 'action' => 'added', 'types' => ['follow_member', 'follow_context']], + ['group' => 'content_updated', 'unit' => $sModule, 'action' => 'approved', 'types' => ['personal']], + ['group' => 'comment', 'unit' => $sModule, 'action' => 'commentPost', 'types' => ['personal', 'follow_member', 'follow_context']], + ['group' => 'reply', 'unit' => $sModule, 'action' => 'replyPost', 'types' => ['personal']], + ['group' => 'vote', 'unit' => $sModule, 'action' => 'doVote', 'types' => ['personal', 'follow_member', 'follow_context']], + ['group' => 'vote', 'unit' => $sModule . '_reactions', 'action' => 'doVote', 'types' => ['personal', 'follow_member', 'follow_context']], + ['group' => 'score_up', 'unit' => $sModule, 'action' => 'doVoteUp', 'types' => ['personal', 'follow_member', 'follow_context']], + ['group' => 'score_down', 'unit' => $sModule, 'action' => 'doVoteDown', 'types' => ['personal', 'follow_member', 'follow_context']], + + //--- Moderation related: For 'admins'. + ['group' => 'action_required', 'unit' => $sModule, 'action' => 'pending_approval', 'types' => ['personal']], + ], + 'alerts' => [ + ['unit' => $sModule, 'action' => 'added'], + ['unit' => $sModule, 'action' => 'edited'], + ['unit' => $sModule, 'action' => 'deleted'], + + ['unit' => $sModule, 'action' => 'approved'], + + ['unit' => $sModule, 'action' => 'commentPost'], + ['unit' => $sModule, 'action' => 'commentRemoved'], + + ['unit' => $sModule, 'action' => 'replyPost'], + ['unit' => $sModule, 'action' => 'replyRemoved'], + + ['unit' => $sModule, 'action' => 'doVote'], + ['unit' => $sModule, 'action' => 'undoVote'], + + ['unit' => $sModule . '_reactions', 'action' => 'doVote'], + ['unit' => $sModule . '_reactions', 'action' => 'undoVote'], + + ['unit' => $sModule, 'action' => 'doVoteUp'], + ['unit' => $sModule, 'action' => 'doVoteDown'], + + //--- Moderation related: For 'admins'. + ['unit' => $sModule, 'action' => 'pending_approval'], + ] + ]; + + if(!empty($this->_oConfig->CNF['FIELDS_DELAYED_PROCESSING'])) { + $aResult['handlers'] = array_merge($aResult['handlers'], [ + ['group' => $sModule . '_object_publish_failed', 'type' => 'insert', 'alert_unit' => $sModule, 'alert_action' => 'publish_failed', 'module_name' => $sModule, 'module_method' => 'get_notifications_post_publish_failed', 'module_class' => 'Module', 'module_event_privacy' => ''], + ['group' => $sModule . '_object_publish_succeeded', 'type' => 'insert', 'alert_unit' => $sModule, 'alert_action' => 'publish_succeeded', 'module_name' => $sModule, 'module_method' => 'get_notifications_post_publish_succeeded', 'module_class' => 'Module', 'module_event_privacy' => ''], + ]); + + $aResult['settings'] = array_merge($aResult['settings'], [ + ['group' => 'content_updated', 'unit' => $sModule, 'action' => 'publish_failed', 'types' => ['personal']], + ['group' => 'content_updated', 'unit' => $sModule, 'action' => 'publish_succeeded', 'types' => ['personal']], + ]); + + $aResult['alerts'] = array_merge($aResult['alerts'], [ + ['unit' => $sModule, 'action' => 'publish_failed'], + ['unit' => $sModule, 'action' => 'publish_succeeded'], + ]); + } + + return $aResult; + } + + /** + * Entry post for Notifications module + */ + public function serviceGetNotificationsPost($aEvent) + { + $CNF = &$this->_oConfig->CNF; + + $aContentInfo = $this->_oDb->getContentInfoById($aEvent['object_id']); + if(empty($aContentInfo) || !is_array($aContentInfo)) + return []; + + $sEntryUrl = bx_absolute_url(BxDolPermalinks::getInstance()->permalink('page.php?i=' . $CNF['URI_VIEW_ENTRY'] . '&id=' . $aContentInfo[$CNF['FIELD_ID']]), '{bx_url_root}'); + $sEntryCaption = isset($aContentInfo[$CNF['FIELD_TITLE']]) ? $aContentInfo[$CNF['FIELD_TITLE']] : strmaxtextlen($aContentInfo[$CNF['FIELD_TEXT']], 20, '...'); + $sEntrySummary = isset($aContentInfo[$CNF['FIELD_TEXT']]) ? $aContentInfo[$CNF['FIELD_TEXT']] : ''; + + return [ + 'entry_sample' => $CNF['T']['txt_sample_single'], + 'entry_url' => $sEntryUrl, + 'entry_caption' => $sEntryCaption, + 'entry_summary' => $sEntrySummary, + 'entry_author' => $aContentInfo[$CNF['FIELD_AUTHOR']], + 'entry_privacy' => '', //may be empty or not specified. In this case Public privacy will be used. + 'lang_key' => '', //may be empty or not specified, or a string, or an array('site' => '...', 'email' => '...', 'push' => '...'). In this case of empty/not specified the default one from Notification module will be used. + /* + * Custom settings for email and/or push notifications can be provided here. + * Only necessary parts of 'settings' array can be used. + * + 'settings' => array( + 'email' => array( + 'template' => '', //--- custom email template + 'markers' => '', //--- markers to parse email parts (subject, body) with + 'subject' => '' //--- custom email subject + ), + 'push' => array( + 'subject' => '' //--- custom push notification subject + ) + ) + */ + ]; + } + + public function serviceGetNotificationsPostPendingApproval($aEvent) + { + $aResult = $this->serviceGetNotificationsPost($aEvent); + + /** + * Unset Entry Author because the notification is addressed to 'admins'. + */ + if(isset($aResult['entry_author'])) + unset($aResult['entry_author']); + + return $aResult; + } + + public function serviceGetNotificationsPostApproved($aEvent) + { + return $this->serviceGetNotificationsPost($aEvent); + } + + public function serviceGetNotificationsPostPublishFailed($aEvent) + { + return $this->serviceGetNotificationsPost($aEvent); + } + + public function serviceGetNotificationsPostPublishSucceeded($aEvent) + { + return $this->serviceGetNotificationsPost($aEvent); + } + + + /** + * Entry post comment for Notifications module + */ + public function serviceGetNotificationsComment($aEvent) + { + $CNF = &$this->_oConfig->CNF; + + $iContentId = (int)$aEvent['object_id']; + $aContentInfo = $this->_oDb->getContentInfoById($iContentId); + if(empty($aContentInfo) || !is_array($aContentInfo)) + return []; + + $oComment = BxDolCmts::getObjectInstance($CNF['OBJECT_COMMENTS'], $iContentId); + if(!$oComment || !$oComment->isEnabled()) + return []; + + $sEntryUrl = bx_absolute_url(BxDolPermalinks::getInstance()->permalink('page.php?i=' . $CNF['URI_VIEW_ENTRY'] . '&id=' . $aContentInfo[$CNF['FIELD_ID']]), '{bx_url_root}'); + $sEntryCaption = isset($aContentInfo[$CNF['FIELD_TITLE']]) ? $aContentInfo[$CNF['FIELD_TITLE']] : strmaxtextlen($aContentInfo[$CNF['FIELD_TEXT']], 20, '...'); + $sEntrySummary = isset($aContentInfo[$CNF['FIELD_TEXT']]) ? $aContentInfo[$CNF['FIELD_TEXT']] : ''; + + $iCommentId = (int)$aEvent['subobject_id']; + + return [ + 'entry_sample' => $CNF['T']['txt_sample_single'], + 'entry_url' => $sEntryUrl, + 'entry_caption' => $sEntryCaption, + 'entry_summary' => $sEntrySummary, + 'entry_author' => $aContentInfo[$CNF['FIELD_AUTHOR']], + 'subentry_sample' => $CNF['T']['txt_sample_comment_single'], + 'subentry_url' => bx_absolute_url($oComment->getViewUrl($iCommentId, false), '{bx_url_root}'), + 'subentry_summary' => $oComment->getViewText($iCommentId), + 'lang_key' => '', //may be empty or not specified. In this case the default one from Notification module will be used. + ]; + } + + /** + * Entry post reply for Notifications module + */ + public function serviceGetNotificationsReply($aEvent) + { + $CNF = &$this->_oConfig->CNF; + + $oComment = BxDolCmts::getObjectInstance($CNF['OBJECT_COMMENTS'], 0, false); + if(!$oComment || !$oComment->isEnabled()) + return []; + + $iParentId = (int)$aEvent['object_id']; + $aParentInfo = $oComment->getQueryObject()->getCommentsBy(array('type' => 'id', 'id' => $iParentId)); + if(empty($aParentInfo) || !is_array($aParentInfo)) + return []; + + $iObjectId = (int)$aParentInfo['cmt_object_id']; + $oComment->init($iObjectId); + + $iCommentId = (int)$aEvent['subobject_id']; + + return [ + 'object_id' => $iObjectId, + 'entry_sample' => '_cmt_txt_sample_comment_single', + 'entry_url' => bx_absolute_url($oComment->getViewUrl($iParentId, false), '{bx_url_root}'), + 'entry_caption' => strmaxtextlen($aParentInfo['cmt_text'], 20, '...'), + 'entry_summary' => $oComment->getViewText($iParentId), + 'entry_author' => (int)$aParentInfo['cmt_author_id'], + 'subentry_sample' => '_cmt_txt_sample_reply_to', + 'subentry_url' => bx_absolute_url($oComment->getViewUrl($iCommentId, false), '{bx_url_root}'), + 'subentry_summary' => $oComment->getViewText($iCommentId), + 'lang_key' => '', //may be empty or not specified. In this case the default one from Notification module will be used. + ]; + } + + /** + * Entry post vote for Notifications module + */ + public function serviceGetNotificationsVote($aEvent) + { + $CNF = &$this->_oConfig->CNF; + + $iContentId = (int)$aEvent['object_id']; + $aContentInfo = $this->_oDb->getContentInfoById($iContentId); + if(empty($aContentInfo) || !is_array($aContentInfo)) + return []; + + $oVote = BxDolVote::getObjectInstance($CNF['OBJECT_VOTES'], $iContentId); + if(!$oVote || !$oVote->isEnabled()) + return []; + + $sEntryUrl = bx_absolute_url(BxDolPermalinks::getInstance()->permalink('page.php?i=' . $CNF['URI_VIEW_ENTRY'] . '&id=' . $aContentInfo[$CNF['FIELD_ID']]), '{bx_url_root}'); + $sEntryCaption = isset($aContentInfo[$CNF['FIELD_TITLE']]) ? $aContentInfo[$CNF['FIELD_TITLE']] : strmaxtextlen($aContentInfo[$CNF['FIELD_TEXT']], 20, '...'); + $sEntrySummary = isset($aContentInfo[$CNF['FIELD_TEXT']]) ? $aContentInfo[$CNF['FIELD_TEXT']] : ''; + + return [ + 'entry_sample' => $CNF['T']['txt_sample_single'], + 'entry_url' => $sEntryUrl, + 'entry_caption' => $sEntryCaption, + 'entry_summary' => $sEntrySummary, + 'entry_author' => $aContentInfo[$CNF['FIELD_AUTHOR']], + 'subentry_sample' => $CNF['T']['txt_sample_vote_single'], + 'lang_key' => '', //may be empty or not specified. In this case the default one from Notification module will be used. + ]; + } + + /** + * Entry post vote for Notifications module + */ + public function serviceGetNotificationsReaction($aEvent) + { + $CNF = &$this->_oConfig->CNF; + + $iContentId = (int)$aEvent['object_id']; + $aContentInfo = $this->_oDb->getContentInfoById($iContentId); + if(empty($aContentInfo) || !is_array($aContentInfo)) + return []; + + $oReaction = BxDolVote::getObjectInstance($CNF['OBJECT_REACTIONS'], $iContentId); + if(!$oReaction || !$oReaction->isEnabled()) + return []; + + $aSubentry = $oReaction->getTrackBy(array('type' => 'id', 'id' => (int)$aEvent['subobject_id'])); + if(empty($aSubentry) || !is_array($aSubentry)) + return []; + + $aSubentrySampleParams = array(); + $aReaction = $oReaction->getReaction($aSubentry['reaction']); + if(!empty($aReaction['title'])) + $aSubentrySampleParams[] = $aReaction['title']; + else + $aSubentrySampleParams[] = '_undefined'; + + $sEntryUrl = bx_absolute_url(BxDolPermalinks::getInstance()->permalink('page.php?i=' . $CNF['URI_VIEW_ENTRY'] . '&id=' . $aContentInfo[$CNF['FIELD_ID']]), '{bx_url_root}'); + $sEntryCaption = isset($aContentInfo[$CNF['FIELD_TITLE']]) ? $aContentInfo[$CNF['FIELD_TITLE']] : strmaxtextlen($aContentInfo[$CNF['FIELD_TEXT']], 20, '...'); + $sEntrySummary = isset($aContentInfo[$CNF['FIELD_TEXT']]) ? $aContentInfo[$CNF['FIELD_TEXT']] : ''; + + return [ + 'entry_sample' => $CNF['T']['txt_sample_single'], + 'entry_url' => $sEntryUrl, + 'entry_caption' => $sEntryCaption, + 'entry_summary' => $sEntrySummary, + 'entry_author' => $aContentInfo[$CNF['FIELD_AUTHOR']], + 'subentry_sample' => $CNF['T']['txt_sample_reaction_single'], + 'subentry_sample_params' => $aSubentrySampleParams, + 'lang_key' => '', //may be empty or not specified. In this case the default one from Notification module will be used. + ]; + } + + /** + * Entry post score -> vote up for Notifications module + */ + public function serviceGetNotificationsScoreUp($aEvent) + { + return $this->_serviceGetNotificationsScore('up', $aEvent); + } + + /** + * Entry post score -> vote up for Notifications module + */ + public function serviceGetNotificationsScoreDown($aEvent) + { + return $this->_serviceGetNotificationsScore('down', $aEvent); + } + + protected function _serviceGetNotificationsScore($sType, $aEvent) + { + $CNF = &$this->_oConfig->CNF; + + $iContentId = (int)$aEvent['object_id']; + $aContentInfo = $this->_oDb->getContentInfoById($iContentId); + if(empty($aContentInfo) || !is_array($aContentInfo)) + return array(); + + $oScore = BxDolScore::getObjectInstance($CNF['OBJECT_SCORES'], $iContentId); + if(!$oScore || !$oScore->isEnabled()) + return array(); + + $sEntryUrl = bx_absolute_url(BxDolPermalinks::getInstance()->permalink('page.php?i=' . $CNF['URI_VIEW_ENTRY'] . '&id=' . $aContentInfo[$CNF['FIELD_ID']]), '{bx_url_root}'); + $sEntryCaption = isset($aContentInfo[$CNF['FIELD_TITLE']]) ? $aContentInfo[$CNF['FIELD_TITLE']] : strmaxtextlen($aContentInfo[$CNF['FIELD_TEXT']], 20, '...'); + $sEntrySummary = isset($aContentInfo[$CNF['FIELD_TEXT']]) ? $aContentInfo[$CNF['FIELD_TEXT']] : ''; + + return [ + 'entry_sample' => $CNF['T']['txt_sample_single'], + 'entry_url' => $sEntryUrl, + 'entry_caption' => $sEntryCaption, + 'entry_summary' => $sEntrySummary, + 'entry_author' => $aContentInfo[$CNF['FIELD_AUTHOR']], + 'subentry_sample' => $CNF['T']['txt_sample_score_' . $sType . '_single'], + 'lang_key' => '', //may be empty or not specified. In this case the default one from Notification module will be used. + ]; + } + + /** + * Data for Timeline module + */ + public function serviceGetTimelineData() + { + $sModule = $this->_aModule['name']; + + return array( + 'handlers' => array( + array('group' => $sModule . '_object', 'type' => 'insert', 'alert_unit' => $sModule, 'alert_action' => 'added', 'module_name' => $sModule, 'module_method' => 'get_timeline_post', 'module_class' => 'Module', 'groupable' => 0, 'group_by' => ''), + array('group' => $sModule . '_object', 'type' => 'update', 'alert_unit' => $sModule, 'alert_action' => 'edited'), + array('group' => $sModule . '_object', 'type' => 'delete', 'alert_unit' => $sModule, 'alert_action' => 'deleted') + ), + 'alerts' => array( + array('unit' => $sModule, 'action' => 'added'), + array('unit' => $sModule, 'action' => 'edited'), + array('unit' => $sModule, 'action' => 'deleted'), + ) + ); + } + + /** + * Entry post for Timeline module + */ + public function serviceGetTimelinePost($aEvent, $aBrowseParams = array()) + { + $aContentInfo = $this->_oDb->getContentInfoById($aEvent['object_id']); + if(empty($aContentInfo) || !is_array($aContentInfo)) + return false; + + $CNF = &$this->_oConfig->CNF; + + if((!empty($CNF['FIELD_STATUS']) && $aContentInfo[$CNF['FIELD_STATUS']] != 'active') || (!empty($CNF['FIELD_STATUS_ADMIN']) && $aContentInfo[$CNF['FIELD_STATUS_ADMIN']] != 'active')) + return false; + + $iUserId = $this->getUserId(); + $iAuthorId = (int)$aContentInfo[$CNF['FIELD_AUTHOR']]; + $iAuthorIdAbs = abs($iAuthorId); + + /** + * Don't show anonymous posts on the post's owner timeline. + */ + if($iAuthorId < 0 && $iAuthorIdAbs != $iUserId && ((is_numeric($aEvent['owner_id']) && $iAuthorIdAbs == (int)$aEvent['owner_id']) || (is_array($aEvent['owner_id']) && in_array($iAuthorIdAbs, $aEvent['owner_id'])))) + return false; + + //--- Views + $oViews = isset($CNF['OBJECT_VIEWS']) ? BxDolView::getObjectInstance($CNF['OBJECT_VIEWS'], $aContentInfo[$CNF['FIELD_ID']]) : null; + + $aViews = array(); + if ($oViews && $oViews->isEnabled()) + $aViews = array( + 'system' => $CNF['OBJECT_VIEWS'], + 'object_id' => $aContentInfo[$CNF['FIELD_ID']], + 'count' => $aContentInfo['views'] + ); + + //--- Votes + $oVotes = isset($CNF['OBJECT_VOTES']) ? BxDolVote::getObjectInstance($CNF['OBJECT_VOTES'], $aContentInfo[$CNF['FIELD_ID']]) : null; + + $aVotes = array(); + if ($oVotes && $oVotes->isEnabled()) + $aVotes = array( + 'system' => $CNF['OBJECT_VOTES'], + 'object_id' => $aContentInfo[$CNF['FIELD_ID']], + 'count' => $aContentInfo['votes'] + ); + + //--- Reactions + $oReactions = isset($CNF['OBJECT_REACTIONS']) ? BxDolVote::getObjectInstance($CNF['OBJECT_REACTIONS'], $aContentInfo[$CNF['FIELD_ID']]) : null; + + $aReactions = array(); + if ($oReactions && $oReactions->isEnabled()) + $aReactions = array( + 'system' => $CNF['OBJECT_REACTIONS'], + 'object_id' => $aContentInfo[$CNF['FIELD_ID']], + 'count' => $aContentInfo['rvotes'] + ); + + //--- Scores + $oScores = isset($CNF['OBJECT_SCORES']) ? BxDolScore::getObjectInstance($CNF['OBJECT_SCORES'], $aContentInfo[$CNF['FIELD_ID']]) : null; + + $aScores = array(); + if ($oScores && $oScores->isEnabled()) + $aScores = array( + 'system' => $CNF['OBJECT_SCORES'], + 'object_id' => $aContentInfo[$CNF['FIELD_ID']], + 'score' => $aContentInfo['score'] + ); + + //--- Reports + $oReports = isset($CNF['OBJECT_REPORTS']) ? BxDolReport::getObjectInstance($CNF['OBJECT_REPORTS'], $aContentInfo[$CNF['FIELD_ID']]) : null; + + $aReports = array(); + if ($oReports && $oReports->isEnabled()) + $aReports = array( + 'system' => $CNF['OBJECT_REPORTS'], + 'object_id' => $aContentInfo[$CNF['FIELD_ID']], + 'count' => $aContentInfo['reports'] + ); + + //--- Comments + $oCmts = isset($CNF['OBJECT_COMMENTS']) ? BxDolCmts::getObjectInstance($CNF['OBJECT_COMMENTS'], $aContentInfo[$CNF['FIELD_ID']]) : null; + + $aComments = array(); + if($oCmts && $oCmts->isEnabled()) + $aComments = array( + 'system' => $CNF['OBJECT_COMMENTS'], + 'object_id' => $aContentInfo[$CNF['FIELD_ID']], + 'count' => $aContentInfo['comments'] + ); + + //--- Title & Description + $sTitle = !empty($aContentInfo[$CNF['FIELD_TITLE']]) ? $aContentInfo[$CNF['FIELD_TITLE']] : ''; + if(empty($sTitle) && !empty($aContentInfo[$CNF['FIELD_TEXT']])) + $sTitle = $aContentInfo[$CNF['FIELD_TEXT']]; + + $iOwnerId = $iAuthorIdAbs; + if(isset($aEvent['object_privacy_view']) && (int)$aEvent['object_privacy_view'] < 0) + $iOwnerId = abs($aEvent['object_privacy_view']); + + $bCache = true; + $aContent = $this->_getContentForTimelinePost($aEvent, $aContentInfo, $aBrowseParams); + if(isset($aContent['_cache'])) { + $bCache = (bool)$aContent['_cache']; + + unset($aContent['_cache']); + } + + return array( + '_cache' => $bCache, + 'owner_id' => $iOwnerId, + 'object_owner_id' => $iAuthorId, + 'icon' => !empty($CNF['ICON']) ? $CNF['ICON'] : '', + 'sample' => isset($CNF['T']['txt_sample_single_with_article']) ? $CNF['T']['txt_sample_single_with_article'] : $CNF['T']['txt_sample_single'], + 'sample_wo_article' => $CNF['T']['txt_sample_single'], + 'sample_action' => isset($CNF['T']['txt_sample_action']) ? $CNF['T']['txt_sample_action'] : '', + 'url' => bx_absolute_url(BxDolPermalinks::getInstance()->permalink('page.php?i=' . $CNF['URI_VIEW_ENTRY'] . '&id=' . $aContentInfo[$CNF['FIELD_ID']])), + 'content' => $aContent, //a string to display or array to parse default template before displaying. + 'date' => $aContentInfo[$CNF['FIELD_ADDED']], + 'views' => $aViews, + 'votes' => $aVotes, + 'reactions' => $aReactions, + 'scores' => $aScores, + 'reports' => $aReports, + 'comments' => $aComments, + 'title' => $sTitle, //may be empty. + 'description' => '' //may be empty. + ); + } + + public function serviceGetTimelinePostAllowedView($aEvent) + { + $iContentId = (int)$aEvent['object_id']; + $aContentInfo = $this->_oDb->getContentInfoById($iContentId); + if(empty($aContentInfo) || !is_array($aContentInfo)) + return _t('_sys_txt_access_denied'); + + return $this->serviceCheckAllowedViewForProfile($aContentInfo); + } + + /** + * Check particular action permission without content + * @param $sAction action to check, for example: Browse, Add + * @param $iContentId content ID + * @return message on error, or CHECK_ACTION_RESULT_ALLOWED when allowed + */ + public function serviceCheckAllowed($sAction, $isPerformAction = false) + { + $sMethod = 'checkAllowed' . bx_gen_method_name($sAction); + if (!method_exists($this, $sMethod)) + return _t('_sys_request_method_not_found_cpt'); + + return $this->$sMethod($isPerformAction); + } + + /** + * Check particular action permission with content + * @param $sAction action to check, for example: View, Edit + * @param $iContentId content ID + * @return message on error, or CHECK_ACTION_RESULT_ALLOWED when allowed + */ + public function serviceCheckAllowedWithContent($sAction, $iContentId, $isPerformAction = false) + { + if (!$iContentId || !($aContentInfo = $this->_oDb->getContentInfoById($iContentId))) + return _t('_sys_request_page_not_found_cpt'); + + $sMethod = 'checkAllowed' . bx_gen_method_name($sAction); + if (!method_exists($this, $sMethod)) + return _t('_sys_request_method_not_found_cpt'); + + return $this->$sMethod($aContentInfo, $isPerformAction); + } + + /** + * Check particular action permission with content for specified profile + * @param $sAction action to check, for example: View, Edit + * @param $iContentId content ID + * @param $iProfileId profile ID which the permissions to be cheked for + * @return message on error, or CHECK_ACTION_RESULT_ALLOWED when allowed + */ + public function serviceCheckAllowedWithContentForProfile($sAction, $iContentId, $iProfileId, $isPerformAction = false) + { + if (!$iContentId || !($aContentInfo = $this->_oDb->getContentInfoById($iContentId))) + return _t('_sys_request_page_not_found_cpt'); + + $sMethod = 'checkAllowed' . bx_gen_method_name($sAction) . 'ForProfile'; + if (!method_exists($this, $sMethod)) + return _t('_sys_request_method_not_found_cpt'); + + return $this->$sMethod($aContentInfo, $iProfileId, $isPerformAction); + } + + public function serviceCheckAllowedCommentsView($iContentId, $sObjectComments) + { + //negative id used in comments for reports + if ($iContentId < 0) + return CHECK_ACTION_RESULT_ALLOWED; + + return $this->serviceCheckAllowedWithContent('comments_view', $iContentId); + } + + public function serviceCheckAllowedCommentsPost($iContentId, $sObjectComments) + { + //negative id used in comments for reports + if ($iContentId < 0) + return CHECK_ACTION_RESULT_ALLOWED; + + return $this->serviceCheckAllowedWithContent('comments_post', $iContentId); + } + + public function serviceGetContentOwnerProfileId ($iContentId) + { + $CNF = &$this->_oConfig->CNF; + + // file owner must be author of the content or profile itself in case of profile based module + if ($iContentId) { + $sModule = $this->getName(); + if ($this instanceof iBxDolProfileService && BxDolService::call($sModule, 'act_as_profile')) { + $oProfile = BxDolProfile::getInstanceByContentAndType($iContentId, $sModule); + } + else { + $aContentInfo = $this->_oDb->getContentInfoById($iContentId); + $iContentAuthor = (int)$aContentInfo[$CNF['FIELD_AUTHOR']]; + if($iContentAuthor < 0) + $iContentAuthor = abs($iContentAuthor); + + $oProfile = $aContentInfo ? BxDolProfile::getInstance($iContentAuthor) : null; + } + + $iProfileId = $oProfile ? $oProfile->id() : bx_get_logged_profile_id(); + } + else + $iProfileId = bx_get_logged_profile_id(); + + return $iProfileId; + } + + public function serviceGetBadges($iContentId, $bIsSingle = false, $bIsCompact = false) + { + $sModule = $this->getName(); + + $oBadges = BxDolBadges::getInstance(); + $aBadges = $oBadges->getData(array( + 'type' => ($bIsSingle ? 'by_module&object2_single' : 'by_module&object2'), + 'module' => $sModule, + 'object_id' => $iContentId + )); + + $sResult = false; + /** + * @hooks + * @hookdef hook-system-get_badges 'system', 'get_badges' - hook to override bages assigned to an entry (content) + * - $unit_name - equals `system` + * - $action - equals `get_badges` + * - $object_id - not used + * - $sender_id - not used + * - $extra_params - array of additional params with the following array keys: + * - `module` - [string] module name + * - `content_id` - [int] content id + * - `is_single` - [boolean] only one badge can be used or not + * - `is_compact` - [boolean] badge in compact mode or not + * - `badges` - [array] a list of all badges assigned to the content + * - `override_result` - [string] or [boolean] by ref, if string is returned then it will be used as resulting badges code, can be overridden in hook processing + * @hook @ref hook-system-get_badges + */ + bx_alert('system', 'get_badges', 0, 0, [ + 'module' => $sModule, + 'content_id' => $iContentId, + 'is_single' => $bIsSingle, + 'is_compact' => $bIsCompact, + 'badges' => $aBadges, + 'override_result' => &$sResult + ]); + if($sResult !== false) + return $sResult; + + if(empty($aBadges) || !is_array($aBadges)) + return ''; + + if (bx_is_api()){ + return $aBadges; + } + + if($bIsSingle) + return BxDolService::call('system', 'get_badge', array($aBadges[0], $bIsCompact), 'TemplServices'); + + $aBadgesOutput = array(); + foreach($aBadges as $aBadge) + $aBadgesOutput[] = array('badge' => BxDolService::call('system', 'get_badge', array($aBadge, $bIsCompact), 'TemplServices')); + + return $this->_oTemplate->parseHtmlByName('badges.html', array( + 'bx_repeat:items' => $aBadgesOutput, + )); + } + + /** + * @page service Service Calls + * @section bx_base_general Base General + * @subsection bx_base_general-page_blocks Page Blocks + * @subsubsection bx_base_general-categories_multi_list categories_multi_list + * + * @code bx_srv('bx_posts', 'categories_multi_list', [...]); @endcode + * + * Display multi-categorories block with number of posts in each category + * @param $bDisplayEmptyCats display empty categories + * + * @see BxBaseModGeneralModule::serviceCategoriesMultiList + */ + /** + * @ref bx_base_general-categories_multi_list "categories_multi_list" + */ + public function serviceCategoriesMultiList($bDisplayEmptyCats = true) + { + $aContextInfo = bx_get_page_info(); + + $mProfileContextId = false; + if ($aContextInfo !== false) + $mProfileContextId = $aContextInfo['context_profile_id']; + + $oCategories = BxDolCategories::getInstance(); + if ($mProfileContextId) + $aCats = $oCategories->getData([ + 'type' => 'by_module&context_with_num', + 'module' => $this->getName(), + 'context_id' => $mProfileContextId + ]); + else{ + $aCats = $oCategories->getData([ + 'type' => 'by_module_with_num', + 'module' => $this->getName() + ]); + } + $aVars = array('bx_repeat:cats' => array()); + foreach ($aCats as $oCat) { + $sValue = $oCat['value']; + $iNum = $oCat['num']; + + $aVars['bx_repeat:cats'][] = array( + 'url' => $oCategories->getUrl($this->getName(), $sValue, $mProfileContextId ? '&context_id=' . $mProfileContextId : ''), + 'name' => _t($sValue), + 'value' => $sValue, + 'num' => $iNum, + ); + } + + if (!$aVars['bx_repeat:cats']) + return ''; + + return $this->_oTemplate->parseHtmlByName('category_list_multi.html', $aVars); + } + + /** + * ====== + * PERMISSION METHODS + * ====== + */ + public function serviceCheckAllowedViewForProfile ($aDataEntry, $isPerformAction = false, $iProfileId = false) + { + $mixedResult = $this->_serviceCheckAllowedViewForProfile ($aDataEntry, $isPerformAction, $iProfileId); + + /** + * @hooks + * @hookdef hook-system-check_allowed_view 'system', 'check_allowed_view' - hook to override the result of checking whether 'view' action is allowed or not to specified profile + * - $unit_name - equals `system` + * - $action - equals `check_allowed_view` + * - $object_id - not used + * - $sender_id - not used + * - $extra_params - array of additional params with the following array keys: + * - `module` - [string] module name + * - `content_info` - [array] content info array as key&value pairs + * - `profile_id` - [boolean] or [int] profile id to be checked the availability of the action to + * - `override_result` - [string] or [int] by ref, check action result, can be overridden in hook processing. Return string with an error if action isn't allowed or CHECK_ACTION_RESULT_ALLOWED, @see BxDolAcl + * @hook @ref hook-system-check_allowed_view + */ + bx_alert('system', 'check_allowed_view', 0, 0, [ + 'module' => $this->getName(), + 'content_info' => $aDataEntry, + 'profile_id' => $iProfileId, + 'override_result' => &$mixedResult + ]); + + return $mixedResult; + } + + public function checkAllowedSetThumb ($iContentId = 0) + { + return CHECK_ACTION_RESULT_ALLOWED; + } + + /** + * @return CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. So make sure to make "true === " checking. + */ + public function checkAllowedBrowse () + { + $mixedResult = null; + /** + * @hooks + * @hookdef hook-system-check_allowed_browse 'system', 'check_allowed_browse' - hook to override the result of checking whether 'browse' action is allowed or not to currently logged in profile + * It's equivalent to @ref hook-system-check_allowed_view + * except `content_info` parameter in $extra_params is missing + * @hook @ref hook-system-check_allowed_browse + */ + bx_alert('system', 'check_allowed_browse', 0, 0, [ + 'module' => $this->getName(), + 'profile_id' => $this->_iProfileId, + 'override_result' => &$mixedResult + ]); + if($mixedResult !== null) + return $mixedResult; + + return CHECK_ACTION_RESULT_ALLOWED; + } + + /** + * @return CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. So make sure to make strict(===) checking. + */ + public function checkAllowedView ($aDataEntry, $isPerformAction = false) + { + return $this->serviceCheckAllowedViewForProfile ($aDataEntry, $isPerformAction); + } + + /** + * @return CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. So make sure to make strict(===) checking. + */ + public function checkAllowedViewForProfile ($aDataEntry, $iProfileId, $isPerformAction = false) + { + return $this->serviceCheckAllowedViewForProfile ($aDataEntry, $isPerformAction, $iProfileId); + } + + /** + * @return CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. So make sure to make strict(===) checking. + */ + public function checkAllowedAdd ($isPerformAction = false) + { + // check ACL + $aCheck = checkActionModule($this->_iProfileId, 'create entry', $this->getName(), $isPerformAction); + if ($aCheck[CHECK_ACTION_RESULT] !== CHECK_ACTION_RESULT_ALLOWED) + return $aCheck[CHECK_ACTION_MESSAGE]; + return CHECK_ACTION_RESULT_ALLOWED; + } + + /** + * @return CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. So make sure to make strict(===) checking. + */ + public function checkAllowedApprove ($aDataEntry, $isPerformAction = false) + { + $CNF = &$this->_oConfig->CNF; + $sError = '_sys_txt_access_denied'; + + if($this->_oConfig->isAutoApproveEnabled()) + return _t($sError); + + if($aDataEntry[$CNF['FIELD_STATUS_ADMIN']] != BX_BASE_MOD_GENERAL_STATUS_PENDING) + return _t($sError); + + // moderator always have access + if ($this->_isModerator($isPerformAction)) + return CHECK_ACTION_RESULT_ALLOWED; + + // check for context's admins + if (!empty($CNF['FIELD_ALLOW_VIEW_TO']) && (int)$aDataEntry[$CNF['FIELD_ALLOW_VIEW_TO']] < 0) { + $oProfile = BxDolProfile::getInstance(-(int)$aDataEntry[$CNF['FIELD_ALLOW_VIEW_TO']]); + if ($oProfile){ + $sModule = $oProfile->getModule(); + $aEntity = BxDolRequest::serviceExists($sModule, 'get_all') ? BxDolService::call($sModule, 'get_all', array(array('type' => 'id', 'id' => $oProfile->getContentId()))) : array(); + + $oModule = BxDolModule::getInstance($sModule); + + // check for context's extra roles with rights + if (method_exists($oModule, 'isAllowedModuleActionByProfile')) { + $bResult = $oModule->isAllowedModuleActionByProfile($oProfile->getContentId(), $this->getName(), 'edit_any'); + if ($bResult !== NULL) return $bResult; + } + + // if allowed edit a group then allowed to edit anything inside its context + if(isset($aEntity) && $oModule->checkAllowedEdit($aEntity) === CHECK_ACTION_RESULT_ALLOWED){ + return CHECK_ACTION_RESULT_ALLOWED; + } + } + } + + return _t($sError); + } + + /** + * @return CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. So make sure to make strict(===) checking. + */ + public function checkAllowedEdit ($aDataEntry, $isPerformAction = false) + { + // moderator and owner always have access + if ($this->isEntryAuthor($aDataEntry, $this->_iProfileId) || $this->_isModerator($isPerformAction)) + return CHECK_ACTION_RESULT_ALLOWED; + + // check for context's admins + if (!empty($this->_oConfig->CNF['FIELD_ALLOW_VIEW_TO']) && (int)$aDataEntry[$this->_oConfig->CNF['FIELD_ALLOW_VIEW_TO']] < 0) { + $oProfile = BxDolProfile::getInstance(-(int)$aDataEntry[$this->_oConfig->CNF['FIELD_ALLOW_VIEW_TO']]); + if ($oProfile){ + $sModule = $oProfile->getModule(); + $aEntity = BxDolRequest::serviceExists($sModule, 'get_all') ? BxDolService::call($sModule, 'get_all', array(array('type' => 'id', 'id' => $oProfile->getContentId()))) : array(); + + $oModule = BxDolModule::getInstance($sModule); + + // check for context's extra roles with rights + if (method_exists($oModule, 'isAllowedModuleActionByProfile')) { + $bResult = $oModule->isAllowedModuleActionByProfile($oProfile->getContentId(), $this->getName(), 'edit_any'); + if ($bResult !== NULL) return $bResult; + } + + // if allowed edit a group then allowed to edit anything inside its context + if(isset($aEntity) && $oModule->checkAllowedEdit($aEntity) === CHECK_ACTION_RESULT_ALLOWED){ + return CHECK_ACTION_RESULT_ALLOWED; + } + } + } + + return _t('_sys_txt_access_denied'); + } + + /** + * @return CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. So make sure to make strict(===) checking. + */ + public function checkAllowedDelete (&$aDataEntry, $isPerformAction = false) + { + // moderator always has access + if ($this->_isAdministrator($isPerformAction)) + return CHECK_ACTION_RESULT_ALLOWED; + + // check ACL + $aCheck = checkActionModule($this->_iProfileId, 'delete entry', $this->getName(), $isPerformAction); + if ($this->isEntryAuthor($aDataEntry, $this->_iProfileId) && $aCheck[CHECK_ACTION_RESULT] === CHECK_ACTION_RESULT_ALLOWED) + return CHECK_ACTION_RESULT_ALLOWED; + + // check for context's admins + if (isset($this->_oConfig->CNF['FIELD_ALLOW_VIEW_TO']) && (int)$aDataEntry[$this->_oConfig->CNF['FIELD_ALLOW_VIEW_TO']] < 0){ + $oProfile = BxDolProfile::getInstance(-(int)$aDataEntry[$this->_oConfig->CNF['FIELD_ALLOW_VIEW_TO']]); + if ($oProfile){ + $sModule = $oProfile->getModule(); + $aEntity = BxDolRequest::serviceExists($sModule, 'get_all') ? BxDolService::call($sModule, 'get_all', array(array('type' => 'id', 'id' => $oProfile->getContentId()))) : array(); + + $oModule = BxDolModule::getInstance($sModule); + + // check for context's extra roles with rights + if (method_exists($oModule, 'isAllowedModuleActionByProfile')) { + $bResult = $oModule->isAllowedModuleActionByProfile($oProfile->getContentId(), $this->getName(), 'delete_any'); + if ($bResult !== NULL) return $bResult; + } + + // if allowed delete a group then allowed to delete anything inside its context + if(isset($aEntity) && $oModule->checkAllowedDelete($aEntity) === CHECK_ACTION_RESULT_ALLOWED){ + return CHECK_ACTION_RESULT_ALLOWED; + } + } + } + + return _t('_sys_txt_access_denied'); + } + + /** + * @return CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. So make sure to make strict(===) checking. + */ + public function checkAllowedSetMembership (&$aDataEntry, $isPerformAction = false) + { + // admin always has access + if (isAdmin()) + return CHECK_ACTION_RESULT_ALLOWED; + + // check ACL + $aCheck = checkActionModule($this->_iProfileId, 'set acl level', 'system', $isPerformAction); + if ($aCheck[CHECK_ACTION_RESULT] !== CHECK_ACTION_RESULT_ALLOWED) + return $aCheck[CHECK_ACTION_MESSAGE]; + + return CHECK_ACTION_RESULT_ALLOWED; + } + + /** + * @return CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. So make sure to make strict(===) checking. + */ + public function checkAllowedEditAnyEntry ($isPerformAction = false) + { + return $this->checkAllowedEditAnyEntryForProfile($isPerformAction, $this->_iProfileId); + } + + /** + * @return CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. So make sure to make strict(===) checking. + */ + public function checkAllowedDeleteAnyEntry ($isPerformAction = false) + { + return $this->checkAllowedDeleteAnyEntryForProfile($isPerformAction, $this->_iProfileId); + } + + /** + * @return CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. So make sure to make strict(===) checking. + */ + public function checkAllowedEditAnyEntryForProfile ($isPerformAction = false, $iProfileId = false) + { + if(!$iProfileId) + $iProfileId = $this->_iProfileId; + + $aCheck = checkActionModule($iProfileId, MEMBERSHIP_ACTION_EDIT_ANY_ENTRY, $this->getName(), $isPerformAction); + if($aCheck[CHECK_ACTION_RESULT] === CHECK_ACTION_RESULT_ALLOWED) + return CHECK_ACTION_RESULT_ALLOWED; + + return _t('_sys_txt_access_denied'); + } + + /** + * @return CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. So make sure to make strict(===) checking. + */ + public function checkAllowedDeleteAnyEntryForProfile ($isPerformAction = false, $iProfileId = false) + { + if(!$iProfileId) + $iProfileId = $this->_iProfileId; + + $aCheck = checkActionModule($iProfileId, MEMBERSHIP_ACTION_DELETE_ANY_ENTRY, $this->getName(), $isPerformAction); + if($aCheck[CHECK_ACTION_RESULT] === CHECK_ACTION_RESULT_ALLOWED) + return CHECK_ACTION_RESULT_ALLOWED; + + return _t('_sys_txt_access_denied'); + } + + /** + * @return CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. So make sure to make "true === " checking. + */ + public function checkAllowedCommentsView ($aContentInfo, $isPerformAction = false) + { + return $this->checkAllowedView ($aContentInfo, $isPerformAction); + } + + /** + * @return CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. So make sure to make "true === " checking. + */ + public function checkAllowedCommentsPost ($aContentInfo, $isPerformAction = false) + { + return $this->checkAllowedView ($aContentInfo, $isPerformAction); + } + + protected function _serviceCheckAllowedViewForProfile ($aDataEntry, $isPerformAction, $iProfileId) + { + $CNF = &$this->_oConfig->CNF; + + if(!$iProfileId) + $iProfileId = $this->_iProfileId; + + if(empty($aDataEntry) || !is_array($aDataEntry)) + return _t('_sys_txt_not_found'); + + // moderator and owner always have access + if(!empty($iProfileId) && (abs($aDataEntry[$CNF['FIELD_AUTHOR']]) == (int)$iProfileId || $this->_isModeratorForProfile($isPerformAction, $iProfileId))) + return CHECK_ACTION_RESULT_ALLOWED; + + // check ACL + $aCheck = checkActionModule($iProfileId, 'view entry', $this->getName(), $isPerformAction); + if($aCheck[CHECK_ACTION_RESULT] !== CHECK_ACTION_RESULT_ALLOWED) + return $aCheck[CHECK_ACTION_MESSAGE]; + + // check privacy + if(!empty($CNF['OBJECT_PRIVACY_VIEW'])) { + $oPrivacy = BxDolPrivacy::getObjectInstance($CNF['OBJECT_PRIVACY_VIEW']); + if ($oPrivacy && !$oPrivacy->check($aDataEntry[$CNF['FIELD_ID']], $iProfileId)) + return _t('_sys_access_denied_to_private_content'); + } + + return CHECK_ACTION_RESULT_ALLOWED; + } + + public function _serviceBrowse ($sMode, $aParams = false, $iDesignBox = BX_DB_PADDING_DEF, $bDisplayEmptyMsg = false, $bAjaxPaginate = true, $sClassSearchResult = 'SearchResult') + { + if (CHECK_ACTION_RESULT_ALLOWED !== ($sMsg = $this->checkAllowedBrowse())) + return bx_is_api() ? [bx_api_get_msg($sMsg)] : MsgBox($sMsg); + + bx_import($sClassSearchResult, $this->_aModule); + $sClass = $this->_aModule['class_prefix'] . $sClassSearchResult; + $o = new $sClass($sMode, $aParams); + + $o->setDesignBoxTemplateId($iDesignBox); + $o->setDisplayEmptyMsg($bDisplayEmptyMsg); + $o->setAjaxPaginate($bAjaxPaginate); + $o->setUnitParams(array('context' => $sMode)); + if (isset($aParams['condition']) && is_array($aParams['condition'])) + $o->setCustomCurrentCondition($aParams['condition']); + + if ($o->isError) + return ''; + + if ($s = $o->processing()) + return bx_is_api() ? [bx_api_get_block('browse', $s)] : $s; + else + return ''; + } + + /** + * Shows a list of profiles. + */ + protected function _serviceBrowseQuick($aProfiles, $iStart = 0, $iLimit = 4, $aAdditionalParams = array()) + { + // get paginate object + $oPaginate = new BxTemplPaginate(array( + 'on_change_page' => "return !loadDynamicBlockAutoPaginate(this, '{start}', '{per_page}', " . bx_js_string(json_encode($aAdditionalParams)) . ");", + 'num' => count($aProfiles), + 'per_page' => $iLimit, + 'start' => $iStart, + )); + + // remove last item from connection array, because we've got one more item for pagination calculations only + if (count($aProfiles) > $iLimit) + array_pop($aProfiles); + + // get profiles HTML + $s = ''; + foreach ($aProfiles as $mixedProfile) { + $bProfile = is_array($mixedProfile); + + $oProfile = BxDolProfile::getInstance($bProfile ? (int)$mixedProfile['id'] : (int)$mixedProfile); + if(!$oProfile) + continue; + + $aUnitParams = array('template' => array('name' => 'unit', 'size' => 'thumb')); + if(BxDolModule::getInstance($oProfile->getModule()) instanceof BxBaseModGroupsModule) + $aUnitParams['template']['name'] = 'unit_wo_cover'; + + if($bProfile && is_array($mixedProfile['info'])) + $aUnitParams['template']['vars'] = $mixedProfile['info']; + + $s .= $oProfile->getUnit(0, $aUnitParams); + } + + $aTmplVarsPaginate = []; + if($iStart || $oPaginate->getNum() > $iLimit) + $aTmplVarsPaginate = ['paginate' => $oPaginate->getSimplePaginate()]; + + return $this->_oTemplate->parseHtmlByName('browse_quick.html', array( + 'code' => $s, + 'bx_if:show_paginate' => [ + 'condition' => !empty($aTmplVarsPaginate), + 'content' => $aTmplVarsPaginate + ] + )); + } + + // ====== COMMON METHODS + public function onPublished($iContentId) + { + $CNF = &$this->_oConfig->CNF; + + $aContentInfo = $this->_oDb->getContentInfoById($iContentId); + if(!$aContentInfo) + return; + + /* + * Process metas. + * Note. It's essential to process metas a the very end, + * because all data related to an entry should be already + * processed and are ready to be passed to alert. + */ + $this->processMetasAdd($iContentId); + + $this->alertAfterAdd($aContentInfo); + } + + public function onFailed($iContentId) + { + $CNF = &$this->_oConfig->CNF; + + $aContentInfo = $this->_oDb->getContentInfoById($iContentId); + if(!$aContentInfo) + return; + + /** + * @hooks + * @hookdef hook-bx_base_general-failed '{module_name}', 'failed' - hook after content creation when publishing was failed + * - $unit_name - module name + * - $action - equals `failed` + * - $object_id - content id + * - $sender_id - content author profile id + * - $extra_params - array of additional params with the following array keys: + * - `object_author_id` - [int] content author profile id + * @hook @ref hook-bx_base_general-failed + */ + bx_alert($this->getName(), 'failed', $iContentId, $aContentInfo[$CNF['FIELD_AUTHOR']], [ + 'object_author_id' => $aContentInfo[$CNF['FIELD_AUTHOR']] + ]); + } + + public function onApprove($mixedContent) + { + $CNF = &$this->_oConfig->CNF; + + if(!is_array($mixedContent)) + $mixedContent = $this->_oDb->getContentInfoById((int)$mixedContent); + + $this->alertAfterApprove($mixedContent); + + $this->onPublished($mixedContent[$CNF['FIELD_ID']]); + } + + public function onUpdateImage($iContentId, $sFiledName, $sFiledValue, $iProfileId = 0) {} + + public function alertAfterAdd($aContentInfo) {} + + public function alertAfterEdit($aContentInfo) {} + + public function alertAfterApprove($aContentInfo) + { + $CNF = &$this->_oConfig->CNF; + + $iId = (int)$aContentInfo[$CNF['FIELD_ID']]; + + $sModule = $this->getName(); + $aParams = $this->_alertParams($aContentInfo); + + /** + * @hooks + * @hookdef hook-bx_base_general-approved '{module_name}', 'approved' - hook when module content has been approved + * - $unit_name - module name + * - $action - equals `approved` + * - $object_id - content id + * - $sender_id - not used, always `false` + * - $extra_params - array of additional params with the following array keys: + * - `source` - [string] uniq string for particular content in the following format `{module}_{content}` + * - `object_author_id` - [int] content author profile id + * @hook @ref hook-bx_base_general-approved + */ + bx_alert($sModule, 'approved', $iId, false, $aParams); + } + + /** + * Get array of params to be passed in Add/Edit Alert. + */ + protected function _alertParams($aContentInfo) + { + $CNF = &$this->_oConfig->CNF; + + return [ + 'source' => $this->_oConfig->getName() . '_' . (int)$aContentInfo[$CNF['FIELD_ID']], + + 'object_author_id' => (int)$aContentInfo[$CNF['FIELD_AUTHOR']] + ]; + } + + public function processMetasAdd($iContentId) + { + $CNF = &$this->_oConfig->CNF; + + if(empty($CNF['OBJECT_METATAGS'])) + return false; + + $aContentInfo = $this->_oDb->getContentInfoById($iContentId); + + $bFldStatus = !empty($CNF['FIELD_STATUS']); + $bFldStatusAdmin = !empty($CNF['FIELD_STATUS_ADMIN']); + $bContentInfo = $aContentInfo && (!$bFldStatus || ($bFldStatus && $aContentInfo[$CNF['FIELD_STATUS']] == 'active')) && (!$bFldStatusAdmin || ($bFldStatusAdmin && $aContentInfo[$CNF['FIELD_STATUS_ADMIN']] == 'active')); + if(!$bContentInfo) + return false; + + $oMetatags = BxDolMetatags::getObjectInstance($CNF['OBJECT_METATAGS']); + $oMetatags->metaAddAuto($iContentId, $aContentInfo, $CNF, $CNF['OBJECT_FORM_ENTRY_DISPLAY_ADD']); + + $sKey = 'FIELD_LOCATION'; + if($oMetatags->locationsIsEnabled() && !empty($CNF[$sKey]) && !empty($aContentInfo[$CNF[$sKey]])) { + $aLocation = unserialize($aContentInfo[$CNF[$sKey]]); + if(!empty($aLocation) && is_array($aLocation)) + call_user_func_array(array($oMetatags, 'locationsAdd'), array_merge(array($iContentId), array_values($aLocation))); + } + + $sKey = 'FIELD_LABELS'; + if($oMetatags->keywordsIsEnabled() && !empty($CNF[$sKey]) && !empty($aContentInfo[$CNF[$sKey]])) { + $aLabels = unserialize($aContentInfo[$CNF[$sKey]]); + if(!empty($aLabels) && is_array($aLabels)) + foreach ($aLabels as $sLabel) { + if(!preg_match("/(\pL[\pL\pN_]+)/u", $sLabel)) + continue; + + $oMetatags->keywordsAddOne($iContentId, $sLabel, false); + } + } + + return true; + } + + public function processMetasEdit($iContentId, $oForm) + { + $CNF = &$this->_oConfig->CNF; + + if(empty($CNF['OBJECT_METATAGS'])) + return false; + + $aContentInfo = $this->_oDb->getContentInfoById($iContentId); + + $bFldStatus = isset($CNF['FIELD_STATUS']); + $bFldStatusAdmin = isset($CNF['FIELD_STATUS_ADMIN']); + $bContentInfo = $aContentInfo && (!$bFldStatus || ($bFldStatus && $aContentInfo[$CNF['FIELD_STATUS']] == 'active')) && (!$bFldStatusAdmin || ($bFldStatusAdmin && $aContentInfo[$CNF['FIELD_STATUS_ADMIN']] == 'active')); + if(!$bContentInfo) + return false; + + $oMetatags = BxDolMetatags::getObjectInstance($CNF['OBJECT_METATAGS']); + $oMetatags->metaAddAuto($iContentId, $aContentInfo, $CNF, $CNF['OBJECT_FORM_ENTRY_DISPLAY_EDIT']); + + $sKey = 'FIELD_LOCATION'; + if($oMetatags->locationsIsEnabled() && !empty($CNF[$sKey]) && !empty($aContentInfo[$CNF[$sKey]])) { + $aLocation = unserialize($aContentInfo[$CNF[$sKey]]); + if(!empty($aLocation) && is_array($aLocation)) + call_user_func_array(array($oMetatags, 'locationsAdd'), array_merge(array($iContentId), array_values($aLocation))); + } + + $sKey = 'FIELD_LABELS'; + if($oMetatags->keywordsIsEnabled() && !empty($CNF[$sKey]) && !empty($aContentInfo[$CNF[$sKey]])) { + $aLabels = unserialize($aContentInfo[$CNF[$sKey]]); + if(!empty($aLabels) && is_array($aLabels)) + foreach ($aLabels as $sLabel) { + if(!preg_match("/(\pL[\pL\pN_]+)/u", $sLabel)) + continue; + + $oMetatags->keywordsAddOne($iContentId, $sLabel, false); + } + } + + return true; + } + + public function addAttachLink($aValues, $sDisplay = false) + { + $CNF = &$this->_oConfig->CNF; + + if(!$sDisplay) + $sDisplay = $CNF['OBJECT_FORM_ATTACH_LINK_DISPLAY_ADD']; + + $oForm = BxDolForm::getObjectInstance($CNF['OBJECT_FORM_ATTACH_LINK'], $sDisplay, $this->_oTemplate); + if(!$oForm) + return array('message' => '_sys_txt_error_occured'); + + $oForm->aFormAttrs['method'] = BX_DOL_FORM_METHOD_SPECIFIC; + $oForm->aParams['csrf']['disable'] = true; + if(!empty($oForm->aParams['db']['submit_name'])) { + $sSubmitName = $oForm->aParams['db']['submit_name']; + if(!isset($oForm->aInputs[$sSubmitName])) { + if(isset($oForm->aInputs[$CNF['FIELD_ATTACH_LINK_CONTROLS']])) + foreach($oForm->aInputs[$CNF['FIELD_ATTACH_LINK_CONTROLS']] as $mixedIndex => $aInput) { + if(!is_numeric($mixedIndex) || empty($aInput['name']) || $aInput['name'] != $sSubmitName) + continue; + + $aValues[$sSubmitName] = $aInput['value']; + } + } + else + $aValues[$sSubmitName] = $oForm->aInputs[$sSubmitName]['value']; + } + + $oForm->aInputs['url']['checker']['params']['preg'] = $this->_oConfig->getPregPattern('url'); + + $oForm->initChecker(array(), $aValues); + if(!$oForm->isSubmittedAndValid()) + return array('message' => '_sys_txt_error_occured'); + + return $this->_addLink($oForm); + } + + public function getFormAttachLink($iContentId = 0) + { + $CNF = &$this->_oConfig->CNF; + + $oForm = BxDolForm::getObjectInstance($CNF['OBJECT_FORM_ATTACH_LINK'], $CNF['OBJECT_FORM_ATTACH_LINK_DISPLAY_ADD'], $this->_oTemplate); + $oForm->aFormAttrs['action'] = BX_DOL_URL_ROOT . $this->_oConfig->getBaseUri() . 'submit_attach_link_form/'; + $oForm->aInputs[$CNF['FIELD_ATTACH_LINK_CONTENT_ID']]['value'] = $iContentId; + $oForm->aInputs[$CNF['FIELD_ATTACH_LINK_URL']]['checker']['params']['preg'] = $this->_oConfig->getPregPattern('url'); + + $oForm->initChecker(); + if($oForm->isSubmittedAndValid()) + return $this->_addLink($oForm); + + return ['form' => $oForm->getCode(), 'form_id' => $oForm->id]; + } + + protected function _addLink(&$oForm) + { + $CNF = &$this->_oConfig->CNF; + + $iUserId = $this->getUserId(); + + $iContentId = (int)$oForm->getCleanValue($CNF['FIELD_ATTACH_LINK_CONTENT_ID']); + $sLink = rtrim($oForm->getCleanValue('url'), '/'); + $sHost = parse_url($sLink, PHP_URL_HOST); + if($sHost && is_private_ip(gethostbyname($sHost))) + return ['message' => _t('_sys_txt_error_occured')]; + + $aMatches = []; + preg_match($this->_oConfig->getPregPattern('url'), $sLink, $aMatches); + $sLink = (empty($aMatches[2]) ? 'http://' : '') . $aMatches[0]; + + $aSiteInfo = bx_get_site_info($sLink, [ + 'thumbnailUrl' => ['tag' => 'link', 'content_attr' => 'href'], + 'OGImage' => ['name_attr' => 'property', 'name' => 'og:image'], + ]); + + $sTitle = !empty($aSiteInfo['title']) ? $aSiteInfo['title'] : $sHost; + $sDescription = !empty($aSiteInfo['description']) ? $aSiteInfo['description'] : ''; + + $sMediaUrl = ''; + if(!empty($aSiteInfo['thumbnailUrl'])) + $sMediaUrl = $aSiteInfo['thumbnailUrl']; + else if(!empty($aSiteInfo['OGImage'])) + $sMediaUrl = $aSiteInfo['OGImage']; + + $iMediaId = 0; + $oStorage = null; + if(!empty($sMediaUrl)) { + $oStorage = BxDolStorage::getObjectInstance($CNF['OBJECT_STORAGE_PHOTOS']); + + $iMediaId = $oStorage->storeFileFromUrl($sMediaUrl, true, $iUserId); + } + + $iId = (int)$oForm->insert(['profile_id' => $iUserId, 'media_id' => $iMediaId, 'url' => $sLink, 'title' => $sTitle, 'text' => $sDescription, 'added' => time()]); + if(!empty($iId)) { + if(!empty($oStorage) && !empty($iMediaId)) + $oStorage->afterUploadCleanup($iMediaId, $iUserId); + + return [ + 'id' => $iId, + $CNF['FIELD_ATTACH_LINK_CONTENT_ID'] => $iContentId, + 'url' => $sLink, + 'item' => $this->_oTemplate->getAttachLinkItem($iUserId, $iId) + ]; + } + + return ['message' => _t('_bx_timeline_txt_err_cannot_perform_action')]; + } + + public function getEntryImageData($aContentInfo, $sField = 'FIELD_THUMB', $aTranscoders = array()) + { + if(empty($aTranscoders)) + $aTranscoders = array('OBJECT_TRANSCODER_COVER', 'OBJECT_IMAGES_TRANSCODER_COVER', 'OBJECT_IMAGES_TRANSCODER_GALLERY'); + + $CNF = &$this->_oConfig->CNF; + if(empty($CNF[$sField]) || empty($aContentInfo[$CNF[$sField]]) || empty($CNF['OBJECT_STORAGE'])) + return false; + + $iId = (int)$aContentInfo[$CNF[$sField]]; + $aFile = BxDolStorage::getObjectInstance($CNF['OBJECT_STORAGE'])->getFile($iId); + if(!empty($aFile) && is_array($aFile) && strpos($aFile['mime_type'], 'svg') !== false) + return array('id' => $iId, 'object' => $CNF['OBJECT_STORAGE']); + + foreach($aTranscoders as $sTranscoder) + if(!empty($CNF[$sTranscoder])) + return array('id' => $iId, 'transcoder' => $CNF[$sTranscoder]); + + return array('id' => $iId, 'object' => $CNF['OBJECT_STORAGE']); + } + + public function getEntryAllActions ($mixedContent = false, $aParams = []) + { + $CNF = &$this->_oConfig->CNF; + + if(!empty($mixedContent)) { + if(!is_array($mixedContent)) + $mixedContent = array((int)$mixedContent, (method_exists($this->_oDb, 'getContentInfoById')) ? $this->_oDb->getContentInfoById((int)$mixedContent) : array()); + } + else { + $mixedContent = $this->_getContent(); + if($mixedContent === false) + return false; + } + + list($iContentId, $aContentInfo) = $mixedContent; + + $sObjectMenu = !empty($aParams['object_menu']) ? $aParams['object_menu'] : ''; + if(empty($sObjectMenu) && !empty($CNF['OBJECT_MENU_ACTIONS_VIEW_ENTRY_ALL'])) + $sObjectMenu = $CNF['OBJECT_MENU_ACTIONS_VIEW_ENTRY_ALL']; + + if(empty($sObjectMenu)) + return false; + + $sEntryTitle = !empty($aParams['entry_title']) ? $aParams['entry_title'] : ''; + if(empty($sEntryTitle) && !empty($CNF['FIELD_TITLE']) && !empty($aContentInfo[$CNF['FIELD_TITLE']])) + $sEntryTitle = $aContentInfo[$CNF['FIELD_TITLE']]; + + $sEntryUrl = !empty($aParams['entry_url']) ? $aParams['entry_url'] : ''; + if(empty($sEntryUrl) && !empty($CNF['URI_VIEW_ENTRY'])) + $sEntryUrl = bx_absolute_url(BxDolPermalinks::getInstance()->permalink('page.php?i=' . $CNF['URI_VIEW_ENTRY'] . '&id=' . $iContentId)); + + $iEntryThumb = !empty($aParams['entry_thumb']) ? (int)$aParams['entry_thumb'] : 0; + if(empty($iEntryThumb) && !empty($CNF['FIELD_THUMB']) && !empty($aContentInfo[$CNF['FIELD_THUMB']])) + $iEntryThumb = (int)$aContentInfo[$CNF['FIELD_THUMB']]; + + $sObjectStorage = !empty($aParams['object_storage']) ? $aParams['object_storage'] : false; + if(empty($sObjectStorage) && !empty($CNF['OBJECT_STORAGE'])) + $sObjectStorage = $CNF['OBJECT_STORAGE']; + + $sObjectTranscoder = !empty($aParams['object_transcoder']) ? $aParams['object_transcoder'] : false; + + $aMarkers = [ + 'id' => $iContentId, + 'module' => $this->_oConfig->getName(), + 'title' => !empty($sEntryTitle) ? $sEntryTitle : '', + 'url' => !empty($sEntryUrl) ? $sEntryUrl : '', + 'img_url' => '' + ]; + + if(!empty($iEntryThumb)) { + if(!empty($sObjectTranscoder)) + $o = BxDolTranscoder::getObjectInstance($sObjectTranscoder); + else if(!empty($sObjectStorage)) + $o = BxDolStorage::getObjectInstance($sObjectStorage); + + $sImageUrl = $o ? $o->getFileUrlById($iEntryThumb) : ''; + if(!empty($sImageUrl)) + $aMarkers['img_url'] = $sImageUrl; + } + + $oActions = BxDolMenu::getObjectInstance($sObjectMenu, $this->_oTemplate); + if(!$oActions) + return false; + + $oActions->setContentId($iContentId); + $oActions->addMarkers($aMarkers); + + return $oActions->{bx_is_api() ? 'getCodeAPI' : 'getCode'}(); + } + + public function getProfileId() + { + return bx_get_logged_profile_id(); + } + + public function getProfileInfo($iUserId = false) + { + $oProfile = $this->getObjectUser($iUserId); + + $oAccount = null; + if($oProfile && !($oProfile instanceof BxDolProfileUndefined) && !($oProfile instanceof BxDolProfileAnonymous)) + $oAccount = $oProfile->getAccountObject(); + $bAccount = !empty($oAccount); + + if(!$bAccount) + $oProfile = BxDolProfileUndefined::getInstance(); + + return array( + 'id' => $oProfile->id(), + 'name' => $oProfile->getDisplayName(), + 'email' => $bAccount ? $oAccount->getEmail() : '', + 'link' => $oProfile->getUrl(), + 'icon' => $oProfile->getIcon(), + 'thumb' => $oProfile->getThumb(), + 'avatar' => $oProfile->getAvatar(), + 'active' => $oProfile->isActive(), + ); + } + + public function getObjectUser($iUserId = false) + { + bx_import('BxDolProfile'); + return BxDolProfile::getInstanceMagic($iUserId); + } + + public function getObjectFavorite($sSystem = '', $iId = 0) + { + $CNF = &$this->_oConfig->CNF; + if(empty($sSystem) && !empty($CNF['OBJECT_FAVORITES'])) + $sSystem = $CNF['OBJECT_FAVORITES']; + + if(empty($sSystem)) + return false; + + $oFavorite = BxDolFavorite::getObjectInstance($sSystem, $iId, true, $this->_oTemplate); + if(!$oFavorite || !$oFavorite->isEnabled()) + return false; + + return $oFavorite; + } + + public function getUserId() + { + return isLogged() ? bx_get_logged_profile_id() : 0; + } + + public function getUserIp() + { + return getVisitorIP(); + } + + public function getUserInfo($iUserId = 0) + { + $oProfile = BxDolProfile::getInstanceMagic($iUserId); + + return array( + $oProfile->getDisplayName(), + $oProfile->getUrl(), + $oProfile->getThumb(), + $oProfile->getUnit(), + $oProfile->getUnit(0, array('template' => 'unit_wo_info')) + ); + } + + public function getUserInfoWithBadges($iUserId = 0) + { + $oProfile = BxDolProfile::getInstanceMagic($iUserId); + + return array( + $oProfile->getDisplayName(), + $oProfile->getUrl(), + $oProfile->getThumb(), + $oProfile->getUnit(), + $oProfile->getUnit(0, array('template' => 'unit_wo_info')), + $oProfile->getBadges() + ); + } + + public function isMenuItemVisible($sObject, &$aItem, &$aContentInfo) + { + $CNF = &$this->_oConfig->CNF; + + // default visible settings + if(!BxDolAcl::getInstance()->isMemberLevelInSet($aItem['visible_for_levels'])) + return false; + + if (!empty($aItem['visibility_custom'])) { + $oMenu = BxDolMenu::getObjectInstance($sObject); + if ($oMenu && !BxDolService::callSerialized($aItem['visibility_custom'], $oMenu->getMarkers())) + return false; + } + + // get custom function name to check menu item visibility + $sFuncCheckAccess = false; + if(isset($CNF['MENU_ITEM_TO_METHOD'][$sObject][$aItem['name']])) + $sFuncCheckAccess = $CNF['MENU_ITEM_TO_METHOD'][$sObject][$aItem['name']]; + + // check custom visibility settings defined in module config class + if(!isset($aContentInfo)) + $aContentInfo = array(); + + if($sFuncCheckAccess && CHECK_ACTION_RESULT_ALLOWED !== call_user_func_array(array($this, $sFuncCheckAccess), array(&$aContentInfo))) + return false; + + return true; + } + + public function _isModerator ($isPerformAction = false) + { + return $this->_isModeratorForProfile($isPerformAction, $this->_iProfileId); + } + + public function _isModeratorForProfile($isPerformAction = false, $iProfileId = false) + { + return CHECK_ACTION_RESULT_ALLOWED === $this->checkAllowedEditAnyEntryForProfile ($isPerformAction, $iProfileId); + } + + public function _isAdministrator ($isPerformAction = false) + { + return $this->_isAdministratorForProfile($isPerformAction, $this->_iProfileId); + } + + public function _isAdministratorForProfile($isPerformAction = false, $iProfileId = false) + { + return CHECK_ACTION_RESULT_ALLOWED === $this->checkAllowedDeleteAnyEntryForProfile ($isPerformAction, $iProfileId); + } + + public function _prepareAuditParams($aContentInfo, $bIsSaveData = true, $aOverrideAuditParams = array()) + { + $CNF = &$this->_oConfig->CNF; + + $iContextId = isset($CNF['FIELD_ALLOW_VIEW_TO']) && (!empty($aContentInfo[$CNF['FIELD_ALLOW_VIEW_TO']]) && (int)$aContentInfo[$CNF['FIELD_ALLOW_VIEW_TO']] < 0) ? - $aContentInfo[$CNF['FIELD_ALLOW_VIEW_TO']] : 0; + + $AuditParams = array( + 'content_title' => (isset($CNF['FIELD_TITLE']) && isset($aContentInfo[$CNF['FIELD_TITLE']])) ? $aContentInfo[$CNF['FIELD_TITLE']] : '', + 'context_profile_id' => $iContextId, + 'content_info_object' => isset($CNF['OBJECT_CONTENT_INFO']) ? $CNF['OBJECT_CONTENT_INFO'] : '', + 'data' => ($bIsSaveData ? $aContentInfo : array()) + ); + if ($iContextId > 0) + $AuditParams['context_profile_title'] = BxDolProfile::getInstance($iContextId)->getDisplayName(); + + $AuditParams = array_merge($AuditParams, $aOverrideAuditParams); + + return $AuditParams; + } + + public function _getFavoriteListUrl ($iListId, $iProfileId) + { + $CNF = &$this->_oConfig->CNF; + return bx_absolute_url(BxDolPermalinks::getInstance()->permalink('page.php?i=' . $CNF['URI_FAVORITES_LIST'] . '&profile_id=' . $iProfileId . '&list_id=' . $iListId)); + } + + public function getDataAPI($aData, $aParams = []) + { + $aDataApi = $this->decodeDataAPI($aData, $aParams); + + $sModule = $this->getName(); + $aExtras = [ + 'module' => $sModule, + 'data' => $aData, + 'params' => $aParams, + 'data_api' => &$aDataApi, + ]; + + /** + * @hooks + * @hookdef hook-system-decode_data_api 'system', 'decode_data_api' - hook to override content data prepared for sending in API response + * - $unit_name - equals `system` + * - $action - equals `decode_data_api` + * - $object_id - not used + * - $sender_id - not used + * - $extra_params - array of additional params with the following array keys: + * - `module` - [string] module name + * - `data` - [array] content info array as key&value pairs + * - `params` - [array] params array as key&value pairs + * - `data_api` - [array] by ref, content data prepared for sending in API response, can be overridden in hook processing + * @hook @ref hook-system-decode_data_api + */ + bx_alert('system', 'decode_data_api', 0, 0, $aExtras); + + /** + * @hooks + * @hookdef hook-bx_base_general-decode_data_api '{module_name}', 'decode_data_api' - hook to override content data prepared for sending in API response + * It's equivalent to @ref hook-system-decode_data_api + * @hook @ref hook-bx_base_general-decode_data_api + */ + bx_alert($sModule, 'decode_data_api', 0, 0, $aExtras); + + return $aDataApi; + } + + public function decodeDataAPI($aData, $aParams = []) + { + return $aData; + } + + // ====== PROTECTED METHODS + + protected function _serviceEntityForm ($sFormMethod, $iContentId = 0, $sDisplay = false, $sCheckFunction = false, $bErrorMsg = true) + { + $iContentId = $this->_getContent($iContentId, false); + if($iContentId === false) + return false; + + $oFormsHelper = $this->getFormsHelper(); + return $oFormsHelper->$sFormMethod((int)$iContentId, $sDisplay, $sCheckFunction, $bErrorMsg); + } + + protected function _serviceTemplateFunc ($sFunc, $iContentId, $sFuncGetContent = 'getContentInfoById') + { + return $this->_serviceTemplateFuncEx($sFunc, $iContentId, array('function_get_content' => $sFuncGetContent)); + } + + protected function _serviceTemplateFuncEx ($sFunc, $iContentId, $aParams = array()) + { + if (!isset($aParams['function_get_content'])) + $aParams['function_get_content'] = 'getContentInfoById'; + + $mixedContent = $this->_getContent($iContentId, $aParams['function_get_content']); + if($mixedContent === false) + return false; + + list($iContentId, $aContentInfo) = $mixedContent; + + unset($aParams['function_get_content']); + + if (!empty($aParams)) + return $this->_oTemplate->$sFunc($aContentInfo, $aParams); + else + return $this->_oTemplate->$sFunc($aContentInfo); + } + + protected function _getApproveForm($iContentId, $aContentInfo) + { + $CNF = &$this->_oConfig->CNF; + + $sForm = 'sys_manage'; + if(!empty($CNF['OBJECT_FORM_MANAGE'])) + $sForm = $CNF['OBJECT_FORM_MANAGE']; + + $sFormDisplay = 'sys_manage_approve'; + if(!empty($CNF['OBJECT_FORM_MANAGE_APPROVE'])) + $sFormDisplay = $CNF['OBJECT_FORM_MANAGE_APPROVE']; + + $oForm = BxTemplFormView::getObjectInstance($sForm, $sFormDisplay); + $oForm->aFormAttrs['action'] = BX_DOL_URL_ROOT . $this->_oConfig->getBaseUri() . 'approve'; + $oForm->aInputs['content_id']['value'] = $iContentId; + foreach($oForm->aInputs['controls'] as $iKey => $mixedValue) + if(is_numeric($iKey) && isset($mixedValue['name']) && $mixedValue['name'] == 'do_submit') + $oForm->aInputs['controls'][$iKey]['value'] = _t('_sys_form_manage_input_do_submit_approve'); + + /** + * @hooks + * @hookdef hook-bx_base_general-get_approve_form '{module_name}', 'get_approve_form' - hook to override approve content form + * - $unit_name - module name + * - $action - equals `get_approve_form` + * - $object_id - not used + * - $sender_id - not used + * - $extra_params - array of additional params with the following array keys: + * - `content_id` - [int] content id + * - `content_info` - [array] content info array as key&value pairs + * - `override_result` - [object] by ref, an instance of approve content form, @see BxDolForm, can be overridden in hook processing + * @hook @ref hook-bx_base_general-get_approve_form + */ + bx_alert($this->_oConfig->getName(), 'get_approve_form', 0, 0, [ + 'content_id' => $iContentId, + 'content_info' => $aContentInfo, + 'override_result' => &$oForm + ]); + + return $oForm; + } + + protected function _sendApproveMessage($iContentId, $aContentInfo, &$oForm) + { + $CNF = &$this->_oConfig->CNF; + + $sETemplate = 't_ManageApprove'; + if(!empty($CNF['ETEMPLATE_MANAGE_APPROVE'])) + $sETemplate = $CNF['ETEMPLATE_MANAGE_APPROVE']; + + $aEParams = array( + 'content_title' => !empty($CNF['FIELD_TITLE']) && !empty($aContentInfo[$CNF['FIELD_TITLE']]) ? $aContentInfo[$CNF['FIELD_TITLE']] : '', + 'notes' => $oForm->getCleanValue('notes'), + ); + + /** + * @hooks + * @hookdef hook-bx_base_general-get_approve_message '{module_name}', 'get_approve_form' - hook to override approve content message + * - $unit_name - module name + * - $action - equals `get_approve_message` + * - $object_id - not used + * - $sender_id - not used + * - $extra_params - array of additional params with the following array keys: + * - `content_id` - [int] content id + * - `content_info` - [array] content info array as key&value pairs + * - `form` - [object] an instance of approve content form + * - `email_template` - [string] by ref, email template name, @see BxDolEmailTemplates, can be overridden in hook processing + * - `email_params` - [array] by ref, email template params, can be overridden in hook processing + * @hook @ref hook-bx_base_general-get_approve_message + */ + bx_alert($this->_oConfig->getName(), 'get_approve_message', 0, 0, [ + 'content_id' => $iContentId, + 'content_info' => $aContentInfo, + 'form' => $oForm, + 'email_template' => &$sETemplate, + 'email_params' => &$aEParams + ]); + + return sendMailTemplate($sETemplate, 0, $aContentInfo[$CNF['FIELD_AUTHOR']], $aEParams); + } + + protected function _processModerationNotifications($aContentInfo) + { + $CNF = &$this->_oConfig->CNF; + + if(empty($CNF['PARAM_AUTO_APPROVE']) || getParam($CNF['PARAM_AUTO_APPROVE']) == 'on') + return; + + $aRecipients = []; + if(getParam('sys_notify_to_approve_by_role') == 'on' && bx_srv('system', 'is_module_content', [$this->_oConfig->getName()]) && !empty($CNF['FIELD_ALLOW_VIEW_TO']) && (int)$aContentInfo[$CNF['FIELD_ALLOW_VIEW_TO']] < 0) { + $iContextProfileId = abs((int)$aContentInfo[$CNF['FIELD_ALLOW_VIEW_TO']]); + $oContextProfile = BxDolProfile::getInstance($iContextProfileId); + + $aRecipients = bx_srv($oContextProfile->getModule(), 'get_admins_to_manage_content', [$iContextProfileId]); + } + + $sModule = $this->getName(); + + if(empty($aRecipients)) + $aRecipients = BxDolAclQuery::getInstance()->getProfilesByAction([ + MEMBERSHIP_ACTION_EDIT_ANY_ENTRY, + MEMBERSHIP_ACTION_DELETE_ANY_ENTRY + ], [ + 'module' => $sModule, + 'ids_only' => true + ]); + + if(empty($aRecipients)) + return; + + foreach($aRecipients as $iRecipientId) + /** + * @hooks + * @hookdef hook-bx_base_general-pending_approval '{module_name}', 'pending_approval' - hook to notify admins/moderators about new pending approval content + * - $unit_name - module name + * - $action - equals `pending_approval` + * - $object_id - content id + * - $sender_id - content author profile id + * - $extra_params - array of additional params with the following array keys: + * - `object_author_id` - [int] admin/moderator profile id + * @hook @ref hook-bx_base_general-pending_approval + */ + bx_alert($sModule, 'pending_approval', $aContentInfo[$CNF['FIELD_ID']], $aContentInfo[$CNF['FIELD_AUTHOR']], [ + 'object_author_id' => (int)$iRecipientId + ]); + } + + protected function _rss ($aArgs, $sClass = 'SearchResult') + { + $sMode = array_shift($aArgs); + + if (CHECK_ACTION_RESULT_ALLOWED !== ($sMsg = $this->checkAllowedBrowse())) { + $this->_oTemplate->displayAccessDenied ($sMsg); + exit; + } + + $aParams = $this->_buildRssParams($sMode, $aArgs); + + bx_import ($sClass, $this->_aModule); + $sClass = $this->_aModule['class_prefix'] . $sClass; + $o = new $sClass($sMode, $aParams); + + if ($o->isError) + $this->_oTemplate->displayPageNotFound (); + else + $o->outputRSS(); + + exit; + } + + protected function _getContent($iContentId = 0, $sFuncGetContent = true) + { + if(!$iContentId) + $iContentId = bx_process_input(bx_get('id'), BX_DATA_INT); + + if(!$iContentId) + return false; + + if($sFuncGetContent === true) + $sFuncGetContent = 'getContentInfoById'; + + if(empty($sFuncGetContent) || !method_exists($this->_oDb, $sFuncGetContent)) + return $iContentId; + + $aContentInfo = $this->_oDb->$sFuncGetContent($iContentId); + if(!$aContentInfo) + return false; + + return array($iContentId, $aContentInfo); + } + + protected function _getContentForTimelinePost($aEvent, $aContentInfo, $aBrowseParams = array()) + { + $CNF = &$this->_oConfig->CNF; + + $sUrl = bx_absolute_url(BxDolPermalinks::getInstance()->permalink('page.php?i=' . $CNF['URI_VIEW_ENTRY'] . '&id=' . $aContentInfo[$CNF['FIELD_ID']])); + + //--- Image(s) + $aImages = $this->_getImagesForTimelinePost($aEvent, $aContentInfo, $sUrl, $aBrowseParams); + $aImagesAttach = $this->_getImagesForTimelinePostAttach($aEvent, $aContentInfo, $sUrl, $aBrowseParams); + + if(bx_is_api() && getParam('sys_api_extended_units') != 'on') { + $sTitle = ''; + if(isset($CNF['FIELD_TITLE']) && isset($aContentInfo[$CNF['FIELD_TITLE']])) + $sTitle = $aContentInfo[$CNF['FIELD_TITLE']]; + else if(isset($CNF['FIELD_TEXT']) && isset($aContentInfo[$CNF['FIELD_TEXT']])) + $sTitle = strmaxtextlen($aContentInfo[$CNF['FIELD_TEXT']], 20, '...'); + + $sAbstract = isset($CNF['FIELD_ABSTRACT']) && isset($aContentInfo[$CNF['FIELD_ABSTRACT']]) ? $aContentInfo[$CNF['FIELD_ABSTRACT']] : ''; + + $sText = isset($CNF['FIELD_TEXT']) && isset($aContentInfo[$CNF['FIELD_TEXT']]) ? $aContentInfo[$CNF['FIELD_TEXT']] : ''; + $sText = BxTemplFunctions::getInstance()->getStringWithLimitedLength(strip_tags($sText), 240); + + return [ + 'url' => $sUrl, + 'title' => $sTitle, + 'abstract' => $sAbstract, + 'text' => $sText, + 'images' => $aImages + ]; + } + + //--- Video(s) + $aVideos = $this->_getVideosForTimelinePost($aEvent, $aContentInfo, $sUrl, $aBrowseParams); + $aVideosAttach = $this->_getVideosForTimelinePostAttach($aEvent, $aContentInfo, $sUrl, $aBrowseParams); + + //--- Files(s) + $aFiles = $this->_getFilesForTimelinePost($aEvent, $aContentInfo, $sUrl, $aBrowseParams); + $aFilesAttach = $this->_getFilesForTimelinePostAttach($aEvent, $aContentInfo, $sUrl, $aBrowseParams); + + //--- Title + $sTitle = ''; + if(isset($CNF['FIELD_TITLE']) && isset($aContentInfo[$CNF['FIELD_TITLE']])) + $sTitle = $aContentInfo[$CNF['FIELD_TITLE']]; + else if(isset($CNF['FIELD_TEXT']) && isset($aContentInfo[$CNF['FIELD_TEXT']])) + $sTitle = strmaxtextlen($aContentInfo[$CNF['FIELD_TEXT']], 20, '...'); + + //--- Text + $sText = ''; + if(isset($CNF['FIELD_ABSTRACT']) && isset($aContentInfo[$CNF['FIELD_ABSTRACT']])) + $sText = $aContentInfo[$CNF['FIELD_ABSTRACT']]; + if(empty($sText) && isset($CNF['FIELD_TEXT']) && isset($aContentInfo[$CNF['FIELD_TEXT']])) + $sText = $aContentInfo[$CNF['FIELD_TEXT']]; + + if(!empty($CNF['OBJECT_METATAGS']) && is_string($sText)) { + $oMetatags = BxDolMetatags::getObjectInstance($CNF['OBJECT_METATAGS']); + $sText = $oMetatags->metaParse($aContentInfo[$CNF['FIELD_ID']], $sText); + } + + $sCategory = ''; + if (isset($CNF['OBJECT_CATEGORY']) && isset($CNF['OBJECT_CATEGORY']) && isset($aContentInfo[$CNF['FIELD_CATEGORY']])){ + $oCategory = BxDolCategory::getObjectInstance($CNF['OBJECT_CATEGORY']); + if ($oCategory) + $sCategory = $oCategory->getCategoryTitle($aContentInfo[$CNF['FIELD_CATEGORY']]); + } + + return array( + 'sample' => isset($CNF['T']['txt_sample_single_with_article']) ? $CNF['T']['txt_sample_single_with_article'] : $CNF['T']['txt_sample_single'], + 'sample_wo_article' => $CNF['T']['txt_sample_single'], + 'sample_action' => isset($CNF['T']['txt_sample_action']) ? $CNF['T']['txt_sample_action'] : '', + 'url' => $sUrl, + 'title' => $sTitle, + 'category' => $sCategory, + 'text' => $sText, + 'images' => $aImages, + 'images_attach' => $aImagesAttach, + 'videos' => $aVideos, + 'videos_attach' => $aVideosAttach, + 'files' => $aFiles, + 'files_attach' => $aFilesAttach + ); + } + + protected function _getImagesForTimelinePost($aEvent, $aContentInfo, $sUrl, $aBrowseParams = array()) + { + $CNF = &$this->_oConfig->CNF; + if (bx_is_api()){ + $aResult = []; + if(isset($CNF['FIELD_COVER']) && !empty($aContentInfo[$CNF['FIELD_COVER']])) { + $aResult[] = bx_api_get_image($CNF['OBJECT_STORAGE'], (int)$aContentInfo[$CNF['FIELD_COVER']]); + } + if(isset($CNF['FIELD_THUMB']) && !empty($aContentInfo[$CNF['FIELD_THUMB']])) { + $aResult[] = bx_api_get_image($CNF['OBJECT_STORAGE'], (int)$aContentInfo[$CNF['FIELD_THUMB']]); + } + return $aResult; + } + else{ + $iImageId = 0; + $sImageSm = $sImageMd = $sImageXl = ''; + if(isset($CNF['FIELD_COVER']) && !empty($aContentInfo[$CNF['FIELD_COVER']])) { + $iImageId = (int)$aContentInfo[$CNF['FIELD_COVER']]; + $sImageSm = $this->_oConfig->getImageUrl($iImageId, ['OBJECT_IMAGES_TRANSCODER_MINIATURE', 'OBJECT_IMAGES_TRANSCODER_THUMB']); + $sImageMd = $this->_oConfig->getImageUrl($iImageId, ['OBJECT_IMAGES_TRANSCODER_GALLERY', 'OBJECT_IMAGES_TRANSCODER_THUMB']); + $sImageXl = $this->_oConfig->getImageUrl($iImageId, ['OBJECT_IMAGES_TRANSCODER_COVER']); + } + + if($sImageMd == '' && isset($CNF['FIELD_THUMB']) && !empty($aContentInfo[$CNF['FIELD_THUMB']])) { + $iImageId = (int)$aContentInfo[$CNF['FIELD_THUMB']]; + $sImageSm = $this->_oConfig->getImageUrl($iImageId, ['OBJECT_IMAGES_TRANSCODER_MINIATURE', 'OBJECT_IMAGES_TRANSCODER_THUMB']); + $sImageMd = $this->_oConfig->getImageUrl($iImageId, ['OBJECT_IMAGES_TRANSCODER_GALLERY', 'OBJECT_IMAGES_TRANSCODER_THUMB']); + $sImageXl = $this->_oConfig->getImageUrl($iImageId, ['OBJECT_IMAGES_TRANSCODER_COVER']); + } + + if(empty($sImageMd)) + return []; + + if($sImageSm == '') + $sImageSm = $sImageMd; + + if($sImageXl == '') + $sImageXl = $sImageMd; + + return [[ + 'id' => $iImageId, + 'url' => $sUrl, + 'src' => $sImageMd, + 'src_small' => $sImageSm, + 'src_medium' => $sImageMd, + 'src_orig' => $sImageXl + ]]; + } + } + + protected function _getImagesForTimelinePostAttach($aEvent, $aContentInfo, $sUrl, $aBrowseParams = array()) + { + return array(); + } + + protected function _getVideosForTimelinePost($aEvent, $aContentInfo, $sUrl, $aBrowseParams = array()) + { + return array(); + } + + protected function _getVideosForTimelinePostAttach($aEvent, $aContentInfo, $sUrl, $aBrowseParams = array()) + { + return array(); + } + + protected function _getFilesForTimelinePost($aEvent, $aContentInfo, $sUrl, $aBrowseParams = array()) + { + return array(); + } + + protected function _getFilesForTimelinePostAttach($aEvent, $aContentInfo, $sUrl, $aBrowseParams = array()) + { + return array(); + } + + protected function _entityComments ($sObject, $iId = 0) + { + if (!$iId) + $iId = bx_process_input(bx_get('id'), BX_DATA_INT); + + if (!$iId) + return false; + + $oCmts = BxDolCmts::getObjectInstance($sObject, $iId); + if (!$oCmts || !$oCmts->isEnabled()) + return false; + + if (bx_is_api()){ + return [bx_srv('system', 'get_data_api', [['module' => $sObject, 'object_id' => $iId]], 'TemplCmtsServices')]; + } + return $oCmts->getCommentsBlock([], ['in_designbox' => false, 'show_empty' => false]); + } + + protected function _getFields($iContentId) + { + $aContentInfo = $this->_oDb->getContentInfoById($iContentId); + if(empty($aContentInfo)) + return array(); + + return BxDolContentInfo::formatFields($aContentInfo); + } + + protected function _getFieldValue($sField, $iContentId) + { + $CNF = &$this->_oConfig->CNF; + if(empty($CNF[$sField])) + return false; + + $aContentInfo = $this->_oDb->getContentInfoById($iContentId); + if(empty($aContentInfo) || empty($aContentInfo[$CNF[$sField]])) + return false; + + return $aContentInfo[$CNF[$sField]]; + } + + protected function _getFieldValueThumb($sField, $iContentId, $sTranscoder = '') + { + $CNF = &$this->_oConfig->CNF; + + if(empty($sTranscoder) || empty($CNF[$sField])) + return false; + + $aContentInfo = $this->_oDb->getContentInfoById($iContentId); + if(empty($aContentInfo) || empty($aContentInfo[$CNF[$sField]])) + return false; + + $oImagesTranscoder = BxDolTranscoderImage::getObjectInstance($sTranscoder); + if(!$oImagesTranscoder) + return false; + + return $oImagesTranscoder->getFileUrl($aContentInfo[$CNF[$sField]]); + } + + protected function _prepareResponse($aResponse, $bAsJson = false, $aAdditional = array()) + { + if(!$bAsJson) + return $aResponse; + + if(!empty($aAdditional) && is_array($aAdditional)) + $aResponse = array_merge($aResponse, $aAdditional); + + echoJson($aResponse); + exit; + } + + /** + * Blocks for lables tree browsing private functions + */ + + private function _getLablesBreadcrumbsArray($iLabelId, &$aBreadcrumbs) + { + $oLabel = BxDolLabel::getInstance(); + $aLabel = $oLabel->getLabels(array('type' => 'id', 'id' => $iLabelId)); + if ($aLabel){ + $aBreadcrumbs[$aLabel['id']] = array('id' => $aLabel['id'], 'value' => $aLabel['value']); + $this->_getLablesBreadcrumbsArray($aLabel['parent'], $aBreadcrumbs); + } + } + + private function _getLablesBrowseUrl($iLabelId) + { + list($sPageLink, $aPageParams) = bx_get_base_url_inline(); + return BxDolPermalinks::getInstance()->permalink(bx_append_url_params($sPageLink, array_merge($aPageParams, array('label' => $iLabelId)))); + } + + private function _getLablesTreeLevel($aBreadcrumbs, $iParent = 0) + { + $oLabel = BxDolLabel::getInstance(); + $aLabelsOutput = array(); + $aLabels = $oLabel->getLabels(array('type' => 'parent', 'parent' => $iParent)); + if (count($aLabels) > 0){ + foreach($aLabels as $aLabel) { + $sChild = $this->_getLablesTreeLevel($aBreadcrumbs, $aLabel['id']); + $bChildPresent = $sChild != '' ? true : false; + $bIsOpen = array_key_exists($aLabel['id'], $aBreadcrumbs) ? true : false; + if (!$bIsOpen){ + $sChild = ''; + } + $aLabelsOutput[] = array( + 'value' => $aLabel['value'], + 'url' => $this->_getLablesBrowseUrl($aLabel['id']), + 'child' => $sChild, + + 'selected' => bx_process_input(bx_get('label'), BX_DATA_INT) == $aLabel['id'] ? 'selected' : ''.$aLabel['id'], + 'bx_if:open' => array( + 'condition' => $bChildPresent && $bIsOpen, + 'content' => array() + ), + 'bx_if:can_open' => array( + 'condition' => $bChildPresent && !$bIsOpen, + 'content' => array() + ) + ); + } + return $this->_oTemplate->parseHtmlByName('labels_tree.html', + array( + 'bx_repeat:items' => $aLabelsOutput, + 'parent' => $iParent, + ) + ); + } + return ''; + } +} + +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/general/classes/BxBaseModGeneralSearchResult.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/general/classes/BxBaseModGeneralSearchResult.php new file mode 100644 index 0000000000..6683c12c0c --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/general/classes/BxBaseModGeneralSearchResult.php @@ -0,0 +1,310 @@ +<?php defined('BX_DOL') or die('hack attempt'); +/** + * Copyright (c) UNA, Inc - https://una.io + * MIT License - https://opensource.org/licenses/MIT + * + * @defgroup BaseGeneral Base classes for modules + * @ingroup UnaModules + * + * @{ + */ + +define('BX_SYS_PER_PAGE_BROWSE_SHOWCASE', 32); + +class BxBaseModGeneralSearchResult extends BxTemplSearchResult +{ + protected $oModule; + protected $sFilterName; + protected $bShowcaseView = false; + protected $aUnitViews = array(); + protected $sUnitViewDefault = 'gallery'; + + function __construct($sMode = '', $aParams = array()) + { + $this->_sMode = $sMode; + $this->_aParams = $aParams; + + $this->_bValidate = isset($this->_aParams['validate']) && is_array($this->_aParams['validate']); + + parent::__construct(); + } + + function getMain() + { + if(!$this->oModule) + $this->oModule = BxDolModule::getInstance($this->getModuleName()); + + return $this->oModule; + } + + function getContentInfoObject() + { + return BxDolContentInfo::getObjectInstance($this->getContentInfoName()); + } + + function getFieldsOwn() + { + $mixedFields = getParam($this->getModuleName() . '_browse_fields_own'); + if(empty($mixedFields)) + return false; + + if(($aFields = json_decode($mixedFields, true)) !== null) + return $aFields; + + $sDelimiter = ','; + if(strpos($mixedFields, $sDelimiter) !== false) + return explode($sDelimiter, $mixedFields); + + return false; + } + + function getFieldsJoin($sJoin) + { + $mixedFields = getParam($this->getModuleName() . '_browse_fields_join'); + if(empty($mixedFields)) + return false; + + return ($aJoins = json_decode($mixedFields, true)) !== null && !empty($aJoins[$sJoin]) ? $aJoins[$sJoin] : false; + } + + function getRssUnitLink (&$a) + { + $CNF = &$this->oModule->_oConfig->CNF; + + return bx_absolute_url(BxDolPermalinks::getInstance()->permalink('page.php?i=' . $CNF['URI_VIEW_ENTRY'] . '&id=' . $a[$CNF['FIELD_ID']])); + } + + function getRssPageUrl () + { + if (false === parent::getRssPageUrl()) + return false; + + $oPermalinks = BxDolPermalinks::getInstance(); + return bx_absolute_url($oPermalinks->permalink($this->aCurrent['rss']['link'])); + } + + function rss () + { + if (!isset($this->aCurrent['rss'])) + return ''; + + $this->aCurrent['paginate']['perPage'] = empty($this->oModule->_oConfig->CNF['PARAM_NUM_RSS']) ? 10 : getParam($this->oModule->_oConfig->CNF['PARAM_NUM_RSS']); + + return parent::rss(); + } + + function processingAPI () + { + $aResult = parent::processingAPI(); + + if(isset($this->_aParams['filters']) && is_array($this->_aParams['filters'])) { + $oModule = $this->getMain(); + + if(!empty($this->_aParams['filters']['values']) && is_array($this->_aParams['filters']['values'])) + $aResult['params']['filters'] = $this->_aParams['filters']['values']; + + $aResult['filters'] = $oModule->_oTemplate->getBrowsingFilters(['mode' => $this->_sMode]); + } + + return $aResult; + } + + protected function addCustomConditions($CNF, $oProfile, $sMode, $aParams) + { + $this->addConditionsForAuthorStatus($CNF); + + $this->addConditionsForCf($CNF); + + if(!empty($aParams['filter']) && is_array($aParams['filter'])) + $this->addConditionsForFilter($CNF, $sMode, $aParams); + } + + protected function addConditionsForAuthorStatus($CNF) + { + if (empty($CNF['FIELD_AUTHOR'])) + return; + + $this->aCurrent['restriction']['statusAuthor'] = [ + 'value' => 'active', + 'field' => 'status', + 'operator' => '=', + 'table' => 'sys_profiles', + ]; + + $this->aCurrent['join']['statusAuthor'] = [ + 'type' => 'INNER', + 'table' => 'sys_profiles', + 'mainField' => $CNF['FIELD_AUTHOR'], + 'mainFieldFunc' => 'ABS', + 'onField' => 'id', + 'joinFields' => array(), + ]; + } + + protected function addConditionsForCf($CNF) + { + if(empty($CNF['FIELD_CF'])) + return; + + $oCf = BxDolContentFilter::getInstance(); + if(!$oCf->isEnabled()) + return; + + $aConditions = $oCf->getConditions($this->aCurrent['table'], $CNF['FIELD_CF']); + if(!empty($aConditions) && is_array($aConditions)) + $this->aCurrent['restriction'] = array_merge($this->aCurrent['restriction'], $aConditions); + } + + protected function addConditionsForFilter($CNF, $sMode, $aParams) + { + $aFilter = $aParams['filter']; + + if(empty($aFilter['field']) || empty($aFilter['value'])) + return; + + $aRestriction = [ + 'value' => $aFilter['value'], + 'field' => $aFilter['field'], + 'operator' => '=', + ]; + + if(isset($aFilter['operator'])) + $aRestriction['operator'] = $aFilter['operator']; + + if(isset($aFilter['table'])) + switch($aFilter['table']) { + case 'table': + $aRestriction['table'] = $this->aCurrent['table']; + break; + + case 'tableSearch': + $aRestriction['table'] = $this->aCurrent['tableSearch']; + break; + + default: + $aRestriction['table'] = $aFilter['table']; + } + + $this->aCurrent['restriction']['filter'] = $aRestriction; + } + + /** + * Add conditions for private content + */ + protected function addConditionsForPrivateContent($CNF, $oProfile, $aCustomGroup = array()) + { + // default is bProcessPrivateContent = 1, + // so private items are shown as empty boxes with "Private" title + + // we can show public content when privacy object is available + + if(empty($CNF['OBJECT_PRIVACY_VIEW'])) + return; + + $oPrivacy = BxDolPrivacy::getObjectInstance($CNF['OBJECT_PRIVACY_VIEW']); + if(!$oPrivacy) + return; + + // for posts in some context we need to show all items, not only public content + if (!empty($this->aCurrent['restriction']['context']['value']) || !empty($this->aCurrent['restriction']['author']['value'])) { + $this->setProcessPrivateContent(true); + return; + } + + // build condition to show only public content + $aCondition = $oPrivacy->getContentPublicAsCondition($oProfile ? $oProfile->id() : 0, $aCustomGroup); + if(empty($aCondition) || !is_array($aCondition)) + return; + + if(isset($aCondition['restriction'])) { + $this->aCurrent['restriction'] = array_merge($this->aCurrent['restriction'], $aCondition['restriction']); + $this->aPrivateConditionsIndexes['restriction'] = array_keys($aCondition['restriction']); + } + if(isset($aCondition['join'])) { + $this->aCurrent['join'] = array_merge($this->aCurrent['join'], $aCondition['join']); + $this->aPrivateConditionsIndexes['join'] = array_keys($aCondition['join']); + } + + $this->setProcessPrivateContent(false); + } + + function showPagination($bAdmin = false, $bChangePage = true, $bPageReload = true) + { + if($this->bShowcaseView) + return ''; + + $sPagination = parent::showPagination ($bAdmin, $bChangePage, $bPageReload); + if(empty($sPagination)) + return ''; + + return $sPagination; + } + + protected function getItemPerPageInShowCase () + { + $iPerPageInShowCase = BX_SYS_PER_PAGE_BROWSE_SHOWCASE; + $CNF = &$this->oModule->_oConfig->CNF; + if (isset($CNF['PARAM_PER_PAGE_BROWSE_SHOWCASE'])) + $iPerPageInShowCase = getParam($CNF['PARAM_PER_PAGE_BROWSE_SHOWCASE']); + return $iPerPageInShowCase; + } + + function displayResultBlock() + { + if ($this->bShowcaseView) { + $this->addContainerClass(array('bx-base-unit-showcase-wrapper')); + $this->aCurrent['paginate']['perPage'] = $this->getItemPerPageInShowCase(); + $this->oModule->_oTemplate->addCss(array(BX_DIRECTORY_PATH_PLUGINS_PUBLIC . 'flickity/|flickity.css')); + $this->oModule->_oTemplate->addJs(array('flickity/flickity.pkgd.min.js','modules/base/general/js/|showcase.js')); + } + + return parent::displayResultBlock(); + } + + function displaySearchBox ($sContent, $sPaginate = '') + { + $aResult = parent::displaySearchBox($sContent, $sPaginate); + + if(isset($this->_aParams['filters']) && is_array($this->_aParams['filters'])) + $aResult['buttons'] = [ + ['title' => _t('_Filters'), 'href' => 'javascript:void(0)', 'onclick' => 'javascript:' . $this->_aParams['filters']['onclick']] + ]; + + return $aResult; + } + + function applyContainerId() + { + if(empty($this->aCurrent['name']) || empty($this->_sMode)) + return parent::applyContainerId(); + + return str_replace('_', '-', $this->aCurrent['name'] . '-search-result-block-' . $this->_sMode); + } + + function decodeDataAPI($a) + { + if(!is_array($a)) + return $a; + + $bExtendedUnits = getParam('sys_api_extended_units') == 'on'; + + foreach($a as $i => $r) + $a[$i] = $this->oModule->getDataAPI($r, ['extended' => $bExtendedUnits]); + + return $a; + } + + function _getPseudFromParam () + { + $mixedPseud = getParam($this->getModuleName() . '_browse_pseud'); + if(empty($mixedPseud)) + return false; + + if(($aPseud = json_decode($mixedPseud, true)) !== null) + return $aPseud; + + return false; + } +} + +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/general/classes/BxBaseModGeneralTemplate.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/general/classes/BxBaseModGeneralTemplate.php new file mode 100644 index 0000000000..2d5c3521d4 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/general/classes/BxBaseModGeneralTemplate.php @@ -0,0 +1,840 @@ +<?php defined('BX_DOL') or die('hack attempt'); +/** + * Copyright (c) UNA, Inc - https://una.io + * MIT License - https://opensource.org/licenses/MIT + * + * @defgroup BaseGeneral Base classes for modules + * @ingroup UnaModules + * + * @{ + */ + +/** + * Module representation. + */ +class BxBaseModGeneralTemplate extends BxDolModuleTemplate +{ + protected $MODULE; + + protected $_bIsApi; + + public $aMethodsToCallAddJsCss = array('entry', 'unit'); + + public function __construct(&$oConfig, &$oDb) + { + parent::__construct($oConfig, $oDb); + + $this->_bIsApi = bx_is_api(); + } + + public function addLocationBase() + { + parent::addLocationBase(); + + $this->addLocation('mod_general', BX_DIRECTORY_PATH_MODULES . 'base' . DIRECTORY_SEPARATOR . 'general' . DIRECTORY_SEPARATOR, BX_DOL_URL_MODULES . 'base/general/'); + } + + public function getJsCode($sType, $aParams = array(), $mixedWrap = true) + { + $sMask = "{var} {object} = new {class}({params});"; + $aMaskMarkers = array(); + if(is_array($mixedWrap)) { + if(!empty($mixedWrap['mask'])) + $sMask = $mixedWrap['mask']; + + if(!empty($mixedWrap['mask_markers']) && is_array($mixedWrap['mask_markers'])) + $aMaskMarkers = $mixedWrap['mask_markers']; + } + + $sJsClass = $this->_oConfig->getJsClass($sType); + if(!empty($aParams['js_class'])) { + $sJsClass = $aParams['js_class']; + unset($aParams['js_class']); + } + + $sJsObject = $this->_oConfig->getJsObject($sType); + if(!empty($aParams['js_object'])) { + $sJsObject = $aParams['js_object']; + unset($aParams['js_object']); + } + + $sBaseUri = $this->_oConfig->getBaseUri(); + $aParams = array_merge([ + 'sActionUri' => $sBaseUri, + 'sActionUrl' => BX_DOL_URL_ROOT . $sBaseUri, + 'sObjName' => $sJsObject, + 'aHtmlIds' => [], + 'oRequestParams' => [] + ], $aParams); + + $sContent = false; + /** + * @hooks + * @hookdef hook-system-get_js_code 'system', 'get_js_code' - hook to override an instance of JavaScript class associate with the page + * - $unit_name - equals `system` + * - $action - equals `get_js_code` + * - $object_id - not used + * - $sender_id - not used + * - $extra_params - array of additional params with the following array keys: + * - `mask` - [string] by ref, a mask to generate JS code, can be overridden in hook processing + * - `mask_markers` - [array] by ref, an array of markers to be parsed in the mask, can be overridden in hook processing + * - `object` - [string] by ref, a string with JS object name, can be overridden in hook processing + * - `class` - [string] by ref, a string with JS class name, can be overridden in hook processing + * - `params` - [array] by ref, an array of parameters as key&value pairs which will be passed to constructor, can be overridden in hook processing + * - `override_result` - [string] or [boolean] by ref, if string is returned then it will be used as resulting JS code, can be overridden in hook processing + * @hook @ref hook-system-get_js_code + */ + bx_alert('system', 'get_js_code', 0, 0, [ + 'mask' => &$sMask, + 'mask_markers' => &$aMaskMarkers, + 'object' => &$sJsObject, + 'class' => &$sJsClass, + 'params' => &$aParams, + 'override_result' => &$sContent, + ]); + + if($sContent === false) + $sContent = bx_replace_markers($sMask, array_merge([ + 'var' => 'var', + 'object' => $sJsObject, + 'class' => $sJsClass, + 'params' => json_encode($aParams) + ], $aMaskMarkers)); + + return ($mixedWrap === true || (is_array($mixedWrap) && isset($mixedWrap['wrap']) && $mixedWrap['wrap'] === true)) ? $this->_wrapInTagJsCode($sContent) : $sContent; + } + + public function getTitleAuto($aData, $iMaxLen = 20, $sEllipsisSign = '...') + { + $CNF = &$this->getModule()->_oConfig->CNF; + + if(isset($aData[$CNF['FIELD_TITLE']])) + return $this->getTitle($aData); + + $sResult = $this->getText($aData); + if(strlen($sResult) > 0 && $iMaxLen > 0) + $sResult = strmaxtextlen($sResult, $iMaxLen, $sEllipsisSign); + + return $sResult; + } + + public function getTitle($aData, $mixedProcessOutput = BX_DATA_TEXT) + { + $CNF = &$this->getModule()->_oConfig->CNF; + + if(!isset($aData[$CNF['FIELD_TITLE']])) + return ''; + + $sResult = $aData[$CNF['FIELD_TITLE']]; + if($mixedProcessOutput !== false && !empty($sResult)) + $sResult = bx_process_output($sResult, (int)$mixedProcessOutput); + + return $sResult; + } + + public function getAbstract($aData, $mixedProcessOutput = BX_DATA_TEXT) + { + $CNF = &$this->getModule()->_oConfig->CNF; + + if(!isset($CNF['FIELD_ABSTRACT']) || !isset($aData[$CNF['FIELD_ABSTRACT']])) + return ''; + + $sResult = $aData[$CNF['FIELD_ABSTRACT']]; + if($mixedProcessOutput !== false && !empty($sResult)) + $sResult = bx_process_output($sResult, (int)$mixedProcessOutput); + + return $sResult; + } + + public function getText($aData, $mixedProcessOutput = BX_DATA_HTML) + { + $CNF = &$this->getModule()->_oConfig->CNF; + + if(!isset($CNF['FIELD_TEXT']) || !isset($aData[$CNF['FIELD_TEXT']])) + return ''; + + $sResult = $aData[$CNF['FIELD_TEXT']]; + if($mixedProcessOutput !== false && !empty($sResult)) + $sResult = bx_process_output($sResult, (int)$mixedProcessOutput); + + return $sResult; + } + + protected function getSummary($aData, $sTitle = '', $sText = '', $sUrl = '') + { + $sAbstract = $this->getAbstract($aData); + if(!empty($sAbstract)) + return $sAbstract; + + $CNF = &$this->getModule()->_oConfig->CNF; + if(empty($CNF['PARAM_CHARS_SUMMARY'])) + return ''; + + // get summary + $sLinkMore = ' <a title="' . bx_html_attribute(_t('_sys_read_more', $sTitle)) . '" href="' . $sUrl . '"><i class="sys-icon ellipsis-h"></i></a>'; + return strmaxtextlen($sText, (int)getParam($CNF['PARAM_CHARS_SUMMARY']), $sLinkMore); + } + + public function getProfileLink($mixedProfile) + { + if(!is_array($mixedProfile)) + $mixedProfile = $this->getModule()->getProfileInfo((int)$mixedProfile); + + return $this->getLink('link', array( + 'href' => $mixedProfile['link'], + 'title' => bx_html_attribute(!empty($mixedProfile['title']) ? $mixedProfile['title'] : $mixedProfile['name']), + 'content' => $mixedProfile['name'] + )); + } + + public function getLink($sTemplate, $aParams) + { + return $this->parseHtmlByName($sTemplate . '.html', array( + 'href' => $aParams['href'], + 'title' => $aParams['title'], + 'content' => $aParams['content'] + )); + } + + function getContextAddon ($aData, $oProfile) + { + $CNF = &$this->getModule()->_oConfig->CNF; + $sUrl = 'page.php?i=' . $CNF['URI_ENTRIES_BY_CONTEXT'] . '&profile_id=' . $oProfile->id(); + $bActAsProfile = BxDolService::call($oProfile->getModule(), 'act_as_profile'); + if ($bActAsProfile) + $sUrl = 'page.php?i=' . $CNF['URI_AUTHOR_ENTRIES'] . '&profile_id=' . $oProfile->id(); + $sUrl = BxDolPermalinks::getInstance()->permalink($sUrl); + return _t($CNF['T']['txt_all_entries_in'], $sUrl, $oProfile->getDisplayName(), $this->getModule()->_oDb->getEntriesNumByContext($oProfile->id())); + } + + function getContextDesc ($aData) + { + return ''; + } + + public function getTmplVarsText($aData) + { + $CNF = &$this->getModule()->_oConfig->CNF; + + $aVars = $aData; + $aVars['entry_title'] = $this->getTitle($aData); + $aVars['entry_abstract'] = $this->getAbstract($aData); + $aVars['bx_if:show_entry_abstract'] = [ + 'condition' => !empty($aVars['entry_abstract']), + 'content' => [ + 'entry_abstract' => $aVars['entry_abstract'] + ] + ]; + $aVars['entry_text'] = $this->getText($aData); + $aVars['badges'] = $this->getModule()->serviceGetBadges($aData[$CNF['FIELD_ID']]); + if (!empty($CNF['OBJECT_METATAGS'])) { + $oMetatags = BxDolMetatags::getObjectInstance($CNF['OBJECT_METATAGS']); + + // keywords + if ($oMetatags->keywordsIsEnabled()) { + $aFields = array_merge($oMetatags->metaFields($aData, $CNF, $CNF['OBJECT_FORM_ENTRY_DISPLAY_VIEW']), array('entry_title', 'entry_text')); + foreach ($aFields as $sField) + $aVars[$sField] = $oMetatags->keywordsParse($aData[$CNF['FIELD_ID']], $aVars[$sField]); + } + + // mentions + if ($oMetatags->mentionsIsEnabled()) { + $aFields = array_merge($oMetatags->metaFields($aData, $CNF, $CNF['OBJECT_FORM_ENTRY_DISPLAY_VIEW'], true), array('entry_text')); + foreach ($aFields as $sField) + $aVars[$sField] = $oMetatags->mentionsParse($aData[$CNF['FIELD_ID']], $aVars[$sField]); + } + + // location + $aVars['location'] = $oMetatags->locationsIsEnabled() ? $oMetatags->locationsString($aData[$CNF['FIELD_ID']]) : ''; + } + + unset($aVars['recipients']); + + return $aVars; + } + + public function entryBreadcrumb($aContentInfo, $aTmplVarsItems = array()) + { + $CNF = &BxDolModule::getInstance($this->MODULE)->_oConfig->CNF; + return bx_is_api() ? ['id' => 2, 'type' => 'breadcrumb', 'data' => ['name' => BxDolModule::getInstance($this->MODULE)->_aModule['title'], 'url' => BxDolPermalinks::getInstance()->permalink($CNF['URL_HOME'])]] : $this->parseHtmlByName('breadcrumb.html', [ + 'url_home' => bx_absolute_url(BxDolPermalinks::getInstance()->permalink($CNF['URL_HOME'])), + 'icon_home' => $CNF['ICON'], + 'bx_repeat:items' => $aTmplVarsItems + ]); + } + + public function entryText ($aData, $sTemplateName = 'entry-text.html') + { + $aVars = $this->getTmplVarsText($aData); + + if (empty($aVars['entry_text'])) + return false; + + return bx_is_api() ? $aVars : $this->parseHtmlByName($sTemplateName, $aVars); + } + + public function entryLocation ($iContentId) + { + $CNF = &$this->getModule()->_oConfig->CNF; + + if (empty($CNF['OBJECT_METATAGS'])) + return ''; + + $oMetatags = BxDolMetatags::getObjectInstance($CNF['OBJECT_METATAGS']); + + if (!($sLocationString = $oMetatags->locationsString($iContentId))) + return ''; + + $aVars = array ( + 'location' => $sLocationString + ); + return $this->parseHtmlByName('entry-location.html', $aVars); + } + + public function entryInfo($aData, $aValues = array()) + { + $CNF = $this->_oConfig->CNF; + $aValuesDefault = array(); + + if (isset($aData[$CNF['FIELD_ADDED']])) + $aValuesDefault[] = array( + 'title' => _t('_sys_txt_field_created'), + 'value' => bx_time_js($aData[$CNF['FIELD_ADDED']]), + ); + + if (isset($aData[$CNF['FIELD_CHANGED']])) + $aValuesDefault[] = array( + 'title' => _t('_sys_txt_field_updated'), + 'value' => bx_time_js($aData[$CNF['FIELD_CHANGED']]), + ); + + $aValues = array_merge($aValuesDefault, $aValues); + + return $this->parseHtmlByName('entry-info.html', array( + 'bx_repeat:info' => $aValues, + )); + } + + public function getFavoriteList($oProfile, $iStart, $iPerPage, $aParams) + { + $CNF = $this->_oConfig->CNF; + + $bEmptyMessage = false; + if(isset($aParams['empty_message'])) { + $bEmptyMessage = (bool)$aParams['empty_message']; + unset($aParams['empty_message']); + } + + $oFavorite = BxDolFavorite::getObjectInstance($CNF['OBJECT_FAVORITES'], 0, true); + $aListsData = $oFavorite->getQueryObject()->getList(array('type' => 'active', 'author_id' => $oProfile->id(), 'need_default' => true, 'start' => $iStart, 'limit' => $iPerPage + 1)); + $iNum = count($aListsData); + if ($iNum > $iPerPage) + $aListsData = array_slice($aListsData, 0, $iPerPage); + + $oPrivacy = BxDolPrivacy::getObjectInstance($CNF['OBJECT_PRIVACY_LIST_VIEW']); + $aListsTmpl = array(); + foreach($aListsData as $iListId => $sName) { + $aParams['list_id'] = $iListId; + if ($oPrivacy->check($iListId) || $iListId == 0){ + $aTmp = $this->getModule()->_serviceBrowse ('favorite', array_merge(array('user' => $oProfile->id()), $aParams), BX_DB_PADDING_DEF, $bEmptyMessage, false); + if ($aTmp && $aTmp['content']){ + $aListsTmpl[] = array( + 'title' => $sName, + 'content_url' => $this->getModule()->_getFavoriteListUrl($iListId, $oProfile->id()), + 'content' => $aTmp['content'] + ); + } + } + else{ + $aListsTmpl[] = array( + 'title' => 'private list', + 'content_url' => 'javascript:', + 'content' => '' + ); + } + } + + $oPaginate = new BxTemplPaginate(array( + 'on_change_page' => "return !loadDynamicBlockAutoPaginate(this, '{start}', '{per_page}', " . bx_js_string(json_encode($aParams)) . ", 'list_start', 'list_per_page');", + 'num' => $iNum, + 'per_page' => $iPerPage, + 'start' => $iStart, + )); + if (count($aListsTmpl) > 0) + return $this->parseHtmlByName('favorite-lists.html', array('bx_repeat:items' => $aListsTmpl)) . $oPaginate->getSimplePaginate() . $oFavorite->getJsScript(); + + return false; + } + + public function getFavoritesListInfo($aList, $oProfile) + { + $CNF = $this->_oConfig->CNF; + + $iListId = !empty($aList['id']) ? (int)$aList['id'] : 0; + + $oFavorite = BxDolFavorite::getObjectInstance($CNF['OBJECT_FAVORITES'], 0, true); + $aListInfo = $oFavorite->getQueryObject()->getList(array('type' => 'info', 'list_id' => $iListId, 'author_id' => $oProfile->id())); + + $oPrivacy = BxDolPrivacy::getObjectInstance($CNF['OBJECT_PRIVACY_LIST_VIEW']); + $sTitle = ""; + if ($aListInfo['allow_view_favorite_list_to'] < 0){ + $oProfileContext = BxDolProfile::getInstance(abs($aListInfo['allow_view_favorite_list_to'])); + $sTitle = $oProfileContext->getDisplayName(); + } + else{ + if (empty($aListInfo['allow_view_favorite_list_to'])) + $aListInfo['allow_view_favorite_list_to'] = 3; + $aPrivaciInfo = $oPrivacy->getGroupsBy(array('type'=>'id' , 'id'=> $aListInfo['allow_view_favorite_list_to'])); + $sTitle = _t($aPrivaciInfo['title']); + } + + $aListsTmpl = array(); + + if (!empty($aListInfo['created'])){ + $aListsTmpl[] = array('title' => _t('_sys_form_favorite_list_title_created'), 'value' => bx_time_js($aListInfo['created'])); + } + + $aListsTmpl = array_merge($aListsTmpl, + array( + array('title' => _t('_sys_form_favorite_list_title_updated'), 'value' => bx_time_js($aListInfo['updated'])), + array('title' => _t('_sys_form_favorite_list_title_count'), 'value' => $aListInfo['count']), + array('title' => _t('_sys_form_favorite_list_title_visibility'), 'value' => $sTitle) + ) + ); + + return $this->parseHtmlByName('favorite-list-info.html', array('bx_repeat:items' => $aListsTmpl, 'author' => $oProfile->getUnit())); + } + + public function getBrowsingFilters($aParams) + { + if(empty($aParams['mode'])) + return ''; + + $mixedContent = $this->_getBrowsingFiltersContent($aParams); + if($this->_bIsApi) + return $mixedContent; + + if(empty($mixedContent)) + return ''; + + $sPopupId = $this->_oConfig->getHtmlIds('popup_bfilters_' . $aParams['mode']); + $sPopupContent = $this->parseHtmlByName('browsing_filters.html', [ + 'content' => $mixedContent + ]); + + return BxTemplFunctions::getInstance()->transBox($sPopupId, $sPopupContent, true); + } + + function entryAllActions($sActions) + { + if(empty($sActions)) + return ''; + + return $this->parseHtmlByName('entry-all-actions.html', array ( + 'actions' => $sActions + )); + } + + function entryAttachments ($aData, $aParams = array()) + { + return $this->entryAttachmentsByStorage($this->getModule()->_oConfig->CNF['OBJECT_STORAGE'], $aData, $aParams); + } + + function entryAttachmentsByStorage ($mixedStorage, $aData, $aParams = array()) + { + if(!is_array($mixedStorage)) + $mixedStorage = array($mixedStorage); + + $aResult = array(); + + if (bx_is_api()){ + foreach($mixedStorage as $sStorage) { + $aAttachments = $this->getAttachments($sStorage, $aData, $aParams); + if ($aAttachments){ + foreach($aAttachments as $aAttachment) { + $aItem = [ + 'file_name' => $aAttachment['file_name'], + 'mime_type' => $aAttachment['mime_type'], + 'ext' => $aAttachment['ext'], + 'type' => 'other', + 'size' => $aAttachment['size'], + 'url' => $aAttachment['bx_if:not_image']['content']['url_original'] + ]; + if ($aAttachment['bx_if:image']['condition'] == 1){ + $aItem['type'] = 'image'; + $aItem['data'] = bx_api_get_image($sStorage, $aAttachment['id']); + } + if ($aAttachment['bx_if:video']['condition'] == 1){ + $aItem['type'] = 'video'; + $aItem['data'] = bx_api_get_image($sStorage, $aAttachment['id']); + } + if ($aAttachment['bx_if:sound']['condition'] == 1){ + $aItem['type'] = 'sound'; + $aItem['data'] = bx_api_get_image($sStorage, $aAttachment['id']); + } + + $aResult[] = $aItem; + } + } + } + return [bx_api_get_block('entity_attachments', $aResult)]; + } + + foreach($mixedStorage as $sStorage) { + $aAttachments = $this->getAttachments($sStorage, $aData, $aParams); + if(empty($aAttachments) || !is_array($aAttachments)) + continue; + + $aResult = array_merge($aResult, $aAttachments); + } + + + + if(empty($aResult) || !is_array($aResult)) + return ''; + + $this->addCss(BX_DIRECTORY_PATH_PLUGINS_PUBLIC . 'flickity/|flickity.css'); + $this->addJs(array( + 'flickity/flickity.pkgd.min.js', + 'pdfjs/build/pdf.min.js', + )); + + return $this->parseHtmlByName('attachments.html', array( + 'bx_repeat:attachments' => $aResult, + 'pdfjs_worker_url' => $this->getJsUrl('pdfjs/build/pdf.worker.min.js'), + )); + } + + function entryContext ($aData, $iProfileId = false, $sFuncContextDesc = 'getContextDesc', $sTemplateName = 'context.html', $sFuncContextAddon = 'getContextAddon') + { + $CNF = &$this->getModule()->_oConfig->CNF; + + $iContextId = $aData[$CNF['FIELD_ALLOW_VIEW_TO']]; + if ($iContextId >= 0) + return ''; + + $iProfileId = - $iContextId; + + $oProfile = BxDolProfile::getInstance($iProfileId); + if (!$oProfile) + $oProfile = BxDolProfileUndefined::getInstance(); + + if (!$oProfile) + return ''; + + $sName = $oProfile->getDisplayName(); + $sAddon = $sFuncContextAddon ? $this->$sFuncContextAddon($aData, $oProfile) : ''; + $aVars = array ( + 'author_url' => $oProfile->getUrl(), + 'author_thumb_url' => $oProfile->getThumb(), + 'author_unit' => $oProfile->getUnit(0, array('template' => 'unit_wo_info')), + 'author_title' => $sName, + 'author_title_attr' => bx_html_attribute($sName), + 'author_desc' => $sFuncContextDesc ? $this->$sFuncContextDesc($aData) : '', + 'bx_if:addon' => array ( + 'condition' => (bool)$sAddon, + 'content' => array ( + 'content' => $sAddon, + ), + ), + ); + return $this->parseHtmlByName($sTemplateName, $aVars); + } + + protected function getAttachmentsImagesTranscoders ($sStorage = '') + { + $CNF = &$this->getModule()->_oConfig->CNF; + + $oTranscoder = BxDolTranscoderImage::getObjectInstance($CNF['OBJECT_IMAGES_TRANSCODER_PREVIEW']); + $oTranscoderView = !empty($CNF['OBJECT_IMAGES_TRANSCODER_PICTURE']) ? BxDolTranscoderImage::getObjectInstance($CNF['OBJECT_IMAGES_TRANSCODER_PICTURE']) : null; + + return array($oTranscoder, $oTranscoderView); + } + + protected function getAttachmentsVideoTranscoders ($sStorage = '') + { + $CNF = &$this->getModule()->_oConfig->CNF; + + if (isset($CNF['OBJECT_VIDEOS_TRANSCODERS']) && $CNF['OBJECT_VIDEOS_TRANSCODERS']) + return array ( + 'poster' => BxDolTranscoderImage::getObjectInstance($CNF['OBJECT_VIDEOS_TRANSCODERS']['poster']), + 'mp4' => BxDolTranscoderImage::getObjectInstance($CNF['OBJECT_VIDEOS_TRANSCODERS']['mp4']), + 'mp4_hd' => BxDolTranscoderImage::getObjectInstance($CNF['OBJECT_VIDEOS_TRANSCODERS']['mp4_hd']), + ); + + return false; + } + + public function getAttachmentsData ($sStorage, $aData, $aParams = array()) + { + return $this->getAttachments($sStorage, $aData, $aParams ); + } + + protected function getAttachments ($sStorage, $aData, $aParams = array()) + { + $CNF = &$this->getModule()->_oConfig->CNF; + + $oStorage = BxDolStorage::getObjectInstance($sStorage); + + list($oTranscoder, $oTranscoderPreview) = $this->getAttachmentsImagesTranscoders($sStorage); + $oTranscoderSound = isset($CNF['OBJECT_SOUNDS_TRANSCODER']) && $CNF['OBJECT_SOUNDS_TRANSCODER'] ? BxDolTranscoderImage::getObjectInstance($CNF['OBJECT_SOUNDS_TRANSCODER']) : null; + $aTranscodersVideo = $this->getAttachmentsVideoTranscoders($sStorage); + + $aGhostFiles = $oStorage->getGhosts ($this->getModule()->serviceGetContentOwnerProfileId($aData[$CNF['FIELD_ID']]), $aData[$CNF['FIELD_ID']]); + if (!$aGhostFiles) + return false; + + $sFilterField = isset($aParams['filter_field']) ? $aParams['filter_field'] : $CNF['FIELD_THUMB']; + if(!empty($sFilterField) && isset($aData[$sFilterField])) + foreach ($aGhostFiles as $k => $a) { + // don't show thumbnail in attachments + if ($a['id'] == $aData[$sFilterField]) + unset($aGhostFiles[$k]); + } + + if(!$aGhostFiles) + return false; + + $aAttachmnts = array(); + foreach ($aGhostFiles as $k => $a) { + $isImage = !empty($CNF['OBJECT_STORAGE_PHOTOS']) && $sStorage == $CNF['OBJECT_STORAGE_PHOTOS'] && $oTranscoder && (0 === strncmp('image/', $a['mime_type'], 6)) && $oTranscoder->isMimeTypeSupported($a['mime_type']); // preview for images, transcoder object for preview must be defined + $isVideo = !empty($CNF['OBJECT_STORAGE_VIDEOS']) && $sStorage == $CNF['OBJECT_STORAGE_VIDEOS'] && $aTranscodersVideo && (0 === strncmp('video/', $a['mime_type'], 6)) && $aTranscodersVideo['poster']->isMimeTypeSupported($a['mime_type']); // preview for videos, transcoder object for video must be defined + $isSound = !empty($CNF['OBJECT_STORAGE_SOUNDS']) && $sStorage == $CNF['OBJECT_STORAGE_SOUNDS'] && $oTranscoderSound && (0 === strncmp('audio/', $a['mime_type'], 6)) && $oTranscoderSound->isMimeTypeSupported($a['mime_type']); // preview for sounds, transcoder object for sounds must be defined + $sUrlOriginal = $oStorage->getFileUrlById($a['id']); + $sImgPopupId = 'bx-messages-atachment-popup-' . $a['id']; + + // images are displayed with preview and popup upon clicking + $a['bx_if:image'] = array ( + 'condition' => $isImage, + 'content' => array ( + 'url_original' => $isImage && $oTranscoderPreview ? $oTranscoderPreview->getFileUrl($a['id']) : $sUrlOriginal, + 'attr_file_name' => bx_html_attribute($a['file_name']), + 'popup_id' => $sImgPopupId, + 'url_preview' => $isImage ? $oTranscoder->getFileUrl($a['id']) : '', + 'popup' => BxTemplFunctions::getInstance()->transBox($sImgPopupId, '<img src="' . $sUrlOriginal . '" />', true, true), + ), + ); + + $sVideoUrlHd = ''; + if($isVideo) { + $sVideoUrl = $oStorage->getFileUrlById($a['id']); + $aVideoFile = $oStorage->getFile($a['id']); + + if (!empty($aVideoFile['dimensions']) && $aTranscodersVideo['mp4_hd']->isProcessHD($aVideoFile['dimensions'])) + $sVideoUrlHd = $aTranscodersVideo['mp4_hd']->getFileUrl($a['id']); + } + + // videos are displayed inline + $a['bx_if:video'] = array ( + 'condition' => $isVideo, + 'content' => array ( + 'video' => $isVideo && $aTranscodersVideo ? BxTemplFunctions::getInstance()->videoPlayer( + $aTranscodersVideo['poster']->getFileUrl($a['id']), + $aTranscodersVideo['mp4']->getFileUrl($a['id']), + $sVideoUrlHd, + false, '' + ) : '', + ), + ); + + // sounds are displayed inline + $a['bx_if:sound'] = array ( + 'condition' => $isSound, + 'content' => array ( + 'sound' => $isSound && $oTranscoderSound && ($oPlayer = BxDolPlayer::getObjectInstance()) ? $this->parseHtmlByName('attachment_sound.html', array( + 'file_name' => $a['file_name'], + 'file_url' => $oTranscoderSound ? $oTranscoderSound->getFileUrl($a['id']) : '', + 'player' => $oTranscoderSound && $oTranscoderSound->isFileReady($a['id']) ? + $oPlayer->getCodeAudio (BX_PLAYER_STANDARD, array( + 'mp3' => $oTranscoderSound->getFileUrl($a['id']), + )) : _t('_sys_txt_err_sound_not_transcoded_yet'), + )) : '', + ), + ); + + // non-images are displayed as text links to original file + $a['bx_if:not_image'] = array ( + 'condition' => !$isImage && !$isVideo && !$isSound, + 'content' => array ( + 'url_original' => $sUrlOriginal, + 'attr_file_name' => bx_html_attribute($a['file_name']), + 'file_name' => bx_process_output($a['file_name']), + ), + ); + + $aAttachmnts[] = $a; + } + + return $aAttachmnts; + } + + public function embedVideo($iFileId) + { + $CNF = $this->getModule()->_oConfig->CNF; + list($oPlayer, $oStorage, $aContentInfo, $a) = $this->_embedChecks('OBJECT_STORAGE_VIDEOS', $iFileId); + + // check if file is really video + $aTranscodersVideo = $this->getAttachmentsVideoTranscoders(); + if (!$aTranscodersVideo || (0 !== strncmp('video/', $a['mime_type'], 6)) || !$aTranscodersVideo['poster']->isMimeTypeSupported($a['mime_type'])) { + $this->displayErrorOccured('', BX_PAGE_EMBED); + exit; + } + + // check HD video version + $sVideoUrlHd = ''; + $sVideoUrl = $oStorage->getFileUrlById($a['id']); + $aVideoFile = $oStorage->getFile($a['id']); + + if (!empty($aVideoFile['dimensions']) && $aTranscodersVideo['mp4_hd']->isProcessHD($aVideoFile['dimensions'])) + $sVideoUrlHd = $aTranscodersVideo['mp4_hd']->getFileUrl($a['id']); + + // generate player code + $sCode = $oPlayer->getCodeVideo (BX_PLAYER_EMBED, array( + 'poster' => $aTranscodersVideo['poster']->getFileUrl($a['id']), + 'mp4' => array( + 'sd' => $aTranscodersVideo['mp4']->getFileUrl($a['id']), + 'hd' => $sVideoUrlHd + ), + )); + + // display page + $oTemplate = BxDolTemplate::getInstance(); + $oTemplate->setPageNameIndex (BX_PAGE_EMBED); + $oTemplate->setPageHeader ($a['file_name']); + $oTemplate->setPageContent ('page_main_code', $sCode); + $oTemplate->getPageCode(); + exit; + } + + public function embedSound($iFileId) + { + $CNF = $this->getModule()->_oConfig->CNF; + list($oPlayer, $oStorage, $aContentInfo, $a) = $this->_embedChecks('OBJECT_STORAGE_SOUNDS', $iFileId); + + // check if file is really audio + $oTranscoderSound = isset($CNF['OBJECT_SOUNDS_TRANSCODER']) ? BxDolTranscoderImage::getObjectInstance($CNF['OBJECT_SOUNDS_TRANSCODER']) : null; + if (!$oTranscoderSound || (0 !== strncmp('audio/', $a['mime_type'], 6)) || !$oTranscoderSound->isMimeTypeSupported($a['mime_type'])) { + $this->displayErrorOccured('', BX_PAGE_EMBED); + exit; + } + + if (!$oTranscoderSound->isFileReady($a['id'])) { + $oTranscoderSound->getFileUrl($a['id']); // queue for encoding + $this->displayMsg('_sys_txt_err_sound_not_transcoded_yet', true, BX_PAGE_EMBED); + exit; + } + + // generate player code + $sCode = $oPlayer->getCodeAudio (BX_PLAYER_EMBED, array( + 'mp3' => $oTranscoderSound->getFileUrl($a['id']), + )); + + // display page + $oTemplate = BxDolTemplate::getInstance(); + $oTemplate->setPageNameIndex (BX_PAGE_EMBED); + $oTemplate->setPageHeader ($a['file_name']); + $oTemplate->setPageContent ('page_main_code', $sCode); + $oTemplate->getPageCode(); + exit; + } + + protected function _embedChecks($sStorageKey, $iFileId) + { + // general checks + $oPlayer = BxDolPlayer::getObjectInstance(); + $CNF = $this->getModule()->_oConfig->CNF; + $sStorage = isset($CNF[$sStorageKey]) ? $CNF[$sStorageKey] : false; + if (!$oPlayer || !$sStorage || !($oStorage = BxDolStorage::getObjectInstance($sStorage))) { + $this->displayErrorOccured('', BX_PAGE_EMBED); + exit; + } + + // privacy check + $aGhost = $oStorage->getGhost($iFileId); + $aContentInfo = $aGhost && $aGhost['content_id'] ? $this->getModule()->_oDb->getContentInfoById($aGhost['content_id']) : false; + if (!$aGhost || ($aGhost['content_id'] && !$aContentInfo)) { + $this->displayPageNotFound('', BX_PAGE_EMBED); + exit; + } + + if (!$aGhost['content_id']) { + // if file is not associated with content yet, then only admin and owner can view it + if (!isAdmin() && CHECK_ACTION_RESULT_ALLOWED !== $this->getModule()->checkAllowedEditAnyEntry() && $aGhost['profile_id'] != bx_get_logged_profile_id()) { + $this->displayAccessDenied('', BX_PAGE_EMBED); + exit; + } + } + else { + // if file is associated with content, then check entry privacy + if (CHECK_ACTION_RESULT_ALLOWED !== $this->getModule()->checkAllowedView($aContentInfo)) { + $this->displayAccessDenied('', BX_PAGE_EMBED); + exit; + } + } + + // get file info + if (!($a = $oStorage->getFile($iFileId))) { + $this->displayPageNotFound('', BX_PAGE_EMBED); + exit; + } + + return array($oPlayer, $oStorage, $aContentInfo, $a); + } + + function _getImageSettings($sSettings) + { + $sCoverSettings = ''; + $aCoverData = json_decode($sSettings, true); + if (!empty($aCoverData)){ + $sCoverSettings = 'background-position: ' . $aCoverData['x'] . '% ' . $aCoverData['y'] . '%'; + } + return $sCoverSettings; + } + + function _prepareImage($aData, $sUniqId, $aUploaders, $sStorage, $sField, $bAllowTweak, $bAllowMultiple = false) + { + $oUploader = null; + $sJsName = $sJsCode = ''; + foreach ($aUploaders as $sUploaderObject) { + $oUploader = BxDolUploader::getObjectInstance($sUploaderObject, $sStorage, $sUniqId, $this); + $sGhostTemplate = '{file_id}'; + + $sJsCode .= $oUploader->getUploaderJs($sGhostTemplate, $bAllowMultiple, array_merge($oUploader->getUploaderJsParams(), [ + 'latest' => 1, + 'content_id' => $aData['id'], + 'storage_private' => '0', + 'is_init_ghosts' => 0, + 'is_init_reordering' => 0 + ])); + $sJsName = $oUploader->getNameJsInstanceUploader(); + } + + $this->addJs(['BxDolUploader.js']); + $this->addJsTranslation(['_sys_uploader_image_reposition_info']); + return $this->parseHtmlByName('image_tweak.html', [ + 'id' => $aData['id'], + 'js_object' => $sJsName, + 'unique_id' => $sUniqId, + 'id' => $aData['id'], + 'allow_tweak' => $bAllowTweak, + 'image_exists' => $aData[$sField] == 0 ? 'bx-image-edit-buttons-no-image' : '', + 'field' => $sField, + 'action_url' => BX_DOL_URL_ROOT . $this->_oConfig->getBaseUri(), + 'uploader' => $oUploader->getUploaderButton([ + 'content_id' => $aData['id'], + 'storage_private' => '0', + 'btn_class' => '', + 'button_title' => '', + 'attrs' => "class='hidden'" + ]), + 'uploader_js' => $sJsCode, + ]); + } + + public function addCssJs() + { + $this->addCss('main.css'); + } +} + +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/groups/classes/BxBaseModGroupsFormEntry.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/groups/classes/BxBaseModGroupsFormEntry.php new file mode 100644 index 0000000000..55b09e0595 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/groups/classes/BxBaseModGroupsFormEntry.php @@ -0,0 +1,137 @@ +<?php defined('BX_DOL') or die('hack attempt'); +/** + * Copyright (c) UNA, Inc - https://una.io + * MIT License - https://opensource.org/licenses/MIT + * + * @defgroup BaseGroups Base classes for groups modules + * @ingroup UnaModules + * + * @{ + */ + +/** + * Create/Edit Group Form. + */ +class BxBaseModGroupsFormEntry extends BxBaseModProfileFormEntry +{ + protected $_bDisplayInvite; + + public function __construct($aInfo, $oTemplate = false) + { + if (!isset($this->_bAllowChangeUserForAdmins)) + $this->_bAllowChangeUserForAdmins = true; + + parent::__construct($aInfo, $oTemplate); + + $CNF = &$this->_oModule->_oConfig->CNF; + + $this->_bDisplayInvite = isset($CNF['OBJECT_FORM_ENTRY_DISPLAY_INVITE']) && $CNF['OBJECT_FORM_ENTRY_DISPLAY_INVITE'] == $this->aParams['display']; + + if (isset($this->aInputs['initial_members'])) { + if(!isset($this->aInputs['initial_members']['value'])) + $this->aInputs['initial_members']['value'] = $this->_bDisplayInvite ? [] : [bx_get_logged_profile_id()]; + + if($this->_bDisplayInvite) + $this->aInputs['initial_members'] = array_merge($this->aInputs['initial_members'], [ + 'required' => 1, + 'checker' => [ + 'func' => 'Avail', + 'params' => [], + 'error' => _t('_Enter_value_here'), + ] + ]); + } + } + + function initChecker ($aValues = array (), $aSpecificValues = array()) + { + $CNF = &$this->_oModule->_oConfig->CNF; + + $bValues = $aValues && !empty($aValues['id']); + $aContentInfo = $bValues ? $this->_oModule->_oDb->getContentInfoById($aValues['id']) : false; + + if(isset($CNF['FIELD_PUBLISHED']) && $this->aParams['display'] == $CNF['OBJECT_FORM_ENTRY_DISPLAY_EDIT'] && isset($this->aInputs[$CNF['FIELD_PUBLISHED']])) + if($bValues && in_array($aValues[$CNF['FIELD_STATUS']], array('active', 'hidden'))) + unset($this->aInputs[$CNF['FIELD_PUBLISHED']]); + + parent::initChecker ($aValues, $aSpecificValues); + } + + public function insert ($aValsToAdd = array(), $isIgnore = false) + { + $CNF = &$this->_oModule->_oConfig->CNF; + + if(isset($CNF['FIELD_ADDED']) && empty($aValsToAdd[$CNF['FIELD_ADDED']])) { + $iAdded = 0; + if(isset($this->aInputs[$CNF['FIELD_ADDED']])) + $iAdded = $this->getCleanValue($CNF['FIELD_ADDED']); + + if(empty($iAdded)) + $iAdded = time(); + + $aValsToAdd[$CNF['FIELD_ADDED']] = $iAdded; + } + + if(isset($CNF['FIELD_PUBLISHED']) && empty($aValsToAdd[$CNF['FIELD_PUBLISHED']])) { + $iPublished = 0; + if(isset($this->aInputs[$CNF['FIELD_PUBLISHED']])) + $iPublished = $this->getCleanValue($CNF['FIELD_PUBLISHED']); + + if(empty($iPublished)) + $iPublished = time(); + + $aValsToAdd[$CNF['FIELD_PUBLISHED']] = $iPublished; + } + + $aValsToAdd[$CNF['FIELD_STATUS']] = (isset($CNF['FIELD_PUBLISHED']) && ($aValsToAdd[$CNF['FIELD_PUBLISHED']] > $aValsToAdd[$CNF['FIELD_ADDED']])) ? 'awaiting' : 'active'; + + return parent::insert ($aValsToAdd, $isIgnore); + } + + function update ($iContentId, $aValsToAdd = array(), &$aTrackTextFieldsChanges = null) + { + $CNF = &$this->_oModule->_oConfig->CNF; + + if(isset($CNF['FIELD_PUBLISHED'])) { + if(empty($aValsToAdd[$CNF['FIELD_PUBLISHED']]) && isset($this->aInputs[$CNF['FIELD_PUBLISHED']])) { + $iPublished = $this->getCleanValue($CNF['FIELD_PUBLISHED']); + if(empty($iPublished)) + $iPublished = time(); + + $aValsToAdd[$CNF['FIELD_PUBLISHED']] = $iPublished; + } + } + + $aContentInfo = $this->_oModule->_oDb->getContentInfoById($iContentId); + + $mixedResult = parent::update($iContentId, $aValsToAdd, $aTrackTextFieldsChanges); + if($mixedResult && ($iAuthorId = (int)$this->getCleanValue($CNF['FIELD_AUTHOR'])) && (int)$aContentInfo[$CNF['FIELD_AUTHOR']] != $iAuthorId) { + $oProfileAuthor = BxDolProfile::getInstance($iAuthorId); + $oProfileContent = BxDolProfile::getInstanceByContentAndType($iContentId, $this->MODULE); + if($oProfileAuthor !== false && $oProfileContent !== false) + $oProfileContent->move($oProfileAuthor->getAccountId()); + } + + return $mixedResult; + } + + protected function genCustomInputInitialMembers ($aInput) + { + $aInput['ajax_get_suggestions'] = BX_DOL_URL_ROOT . "modules/?r=" . $this->_oModule->_oConfig->getUri() . "/ajax_get_initial_members"; + if(bx_is_api()) { + $aInput['ajax_get_suggestions'] = $this->_oModule->_oConfig->getName() . "/get_initial_members¶ms[]="; + + $aInput['value_data'] = []; + if(!empty($aInput['value']) && is_array($aInput['value'])) + foreach($aInput['value'] as $iProfileId) + if(($oProfile = BxDolProfile::getInstance($iProfileId)) !== false) { + $aProfile = $oProfile->getUnitAPI(); + $aInput['value_data'][] = $aProfile['author_data']; + } + } + + return $this->genCustomInputUsernamesSuggestions($aInput); + } +} + +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/groups/classes/BxBaseModGroupsFormsEntryHelper.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/groups/classes/BxBaseModGroupsFormsEntryHelper.php new file mode 100644 index 0000000000..38e7bf8917 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/groups/classes/BxBaseModGroupsFormsEntryHelper.php @@ -0,0 +1,288 @@ +<?php defined('BX_DOL') or die('hack attempt'); +/** + * Copyright (c) UNA, Inc - https://una.io + * MIT License - https://opensource.org/licenses/MIT + * + * @defgroup BaseGroups Base classes for groups modules + * @ingroup UnaModules + * + * @{ + */ + +/** + * Group profile forms functions + */ +class BxBaseModGroupsFormsEntryHelper extends BxBaseModProfileFormsEntryHelper +{ + public function __construct($oModule) + { + parent::__construct($oModule); + } + + public function getObjectFormInvite ($sDisplay = false) + { + $CNF = &$this->_oModule->_oConfig->CNF; + + if($sDisplay === false) + $sDisplay = $CNF['OBJECT_FORM_ENTRY_DISPLAY_INVITE']; + + $oForm = BxDolForm::getObjectInstance($CNF['OBJECT_FORM_ENTRY'], $sDisplay, $this->_oModule->_oTemplate); + if($this->_bAjaxMode) + $oForm->setAjaxMode($this->_bAjaxMode); + + if($this->_bAbsoluteActionUrl) + $this->_setAbsoluteActionUrl('edit', $oForm); + + return $oForm; + } + + public function inviteForm ($iContentId, $sDisplay = false, $sCheckFunction = false, $bErrorMsg = true) + { + if (!$sCheckFunction) + $sCheckFunction = 'checkAllowedInvite'; + + $CNF = &$this->_oModule->_oConfig->CNF; + + // get content data and profile info + list($oProfile, $aContentInfo) = $this->_getProfileAndContentData($iContentId); + + if(!$aContentInfo) + return $bErrorMsg ? ($this->_bIsApi ? [bx_api_get_msg('_sys_txt_error_entry_is_not_defined')] : MsgBox('_sys_txt_error_entry_is_not_defined')) : ''; + + // check access + if(($sMsg = $this->_oModule->$sCheckFunction($aContentInfo)) !== CHECK_ACTION_RESULT_ALLOWED) + return $bErrorMsg ? ($this->_bIsApi ? [bx_api_get_msg($sMsg)] : MsgBox($sMsg)) : ''; + + // check and display form + $oForm = $this->getObjectFormInvite($sDisplay); + + if(!$oForm) + return $bErrorMsg ? ($this->_bIsApi ? [bx_api_get_msg('_sys_txt_error_occured')] : MsgBox(_t('_sys_txt_error_occured'))) : ''; + + $oForm->initChecker($aContentInfo); + if (!$oForm->isSubmittedAndValid()) + return $this->_bIsApi ? [bx_api_get_block('form', $oForm->getCodeAPI(), ['ext' => ['name' => $this->_oModule->getName(), 'request' => ['url' => '/api.php?r=' . $this->_oModule->getName() . '/entity_invite¶ms[]=' . $iContentId . '¶ms[]=' . $sDisplay, 'immutable' => true]]])] : $oForm->getCode(); + + $this->onDataInviteBefore($aContentInfo[$CNF['FIELD_ID']], $aContentInfo); + + if (!$oForm->update($aContentInfo[$CNF['FIELD_ID']])) { + if (!$oForm->isValid()) + return $this->_bIsApi ? [bx_api_get_block('form', $oForm->getCodeAPI(), ['ext' => ['name' => $this->_oModule->getName(), 'request' => ['url' => '/api.php?r=' . $this->_oModule->getName() . '/entity_invit¶ms[]=' . $iContentId . '¶ms[]=' . $sDisplay, 'immutable' => true]]])] : $oForm->getCode(); + else + return $this->_bIsApi ? [bx_api_get_msg('_sys_txt_error_entry_update')] : MsgBox(_t('_sys_txt_error_entry_update')); + } + + list($oProfile, $aContentInfo) = $this->_getProfileAndContentData($iContentId); + + $sResult = $this->onDataInviteAfter($aContentInfo[$CNF['FIELD_ID']], $aContentInfo); + if($sResult) + return $sResult; + + // Perform ACL action + $this->_oModule->$sCheckFunction($aContentInfo, true); + + // Redirect + if (bx_is_api()) + return [$this->redirectAfterEdit($aContentInfo)]; + else + $this->redirectAfterEdit($aContentInfo); + } + + protected function _getProfileAndContentData ($iContentId) + { + $CNF = &$this->_oModule->_oConfig->CNF; + + $aContentInfo = $this->_oModule->_oDb->getContentInfoById($iContentId); + if(!$aContentInfo) + return array(false, false); + + $oProfile = BxDolProfile::getInstanceMagic($aContentInfo[$CNF['FIELD_AUTHOR']]); + return array($oProfile, $aContentInfo); + } + + protected function _processPermissionsCheckForViewDataForm ($aContentInfo, $oProfile) + { + $sMsg = parent::_processPermissionsCheckForViewDataForm ($aContentInfo, $oProfile); + + $oPrivacy = BxDolPrivacy::getObjectInstance($this->_oModule->_oConfig->CNF['OBJECT_PRIVACY_VIEW']); + if ($sMsg && $oPrivacy->isPartiallyVisible($aContentInfo[$this->_oModule->_oConfig->CNF['FIELD_ALLOW_VIEW_TO']])) + return ''; + + return $sMsg; + } + + public function onDataAddAfter ($iAccountId, $iContentId) + { + if($s = parent::onDataAddAfter($iAccountId, $iContentId)) + return $s; + + $oGroupProfile = BxDolProfile::getInstanceByContentAndType($iContentId, $this->_oModule->_oConfig->getName()); + if(!$oGroupProfile) + return ''; + + $mInitialMembers = bx_get('initial_members'); + if($this->_bIsApi && $mInitialMembers && is_string($mInitialMembers)) + $mInitialMembers = explode(',', $mInitialMembers); + + $this->makeAuthorAdmin($oGroupProfile, $mInitialMembers); + + $this->inviteMembers($oGroupProfile, $mInitialMembers); + + return ''; + } + + public function onDataEditAfter ($iContentId, $aContentInfo, $aTrackTextFieldsChanges, $oProfile, $oForm) + { + if($s = parent::onDataEditAfter($iContentId, $aContentInfo, $aTrackTextFieldsChanges, $oProfile, $oForm)) + return $s; + + $oGroupProfile = BxDolProfile::getInstanceByContentAndType($iContentId, $this->_oModule->_oConfig->getName()); + if(!$oGroupProfile) + return ''; + + $this->inviteMembers ($oGroupProfile, bx_get('initial_members')); + + return ''; + } + + public function onDataInviteBefore ($iContentId, $aContentInfo) + { + return ''; + } + + public function onDataInviteAfter ($iContentId, $aContentInfo) + { + $oGroupProfile = BxDolProfile::getInstanceByContentAndType($iContentId, $this->_oModule->_oConfig->getName()); + if(!$oGroupProfile) + return ''; + + $this->inviteMembers($oGroupProfile, bx_get('initial_members')); + + return ''; + } + + protected function redirectAfterEdit($aContentInfo, $sUrl = '') + { + $CNF = &$this->_oModule->_oConfig->CNF; + + $sUrl = ''; + if(bx_get('initial_members')) { + if(isset($CNF['URL_ENTRY_MANAGE'])) + $sUrl = $CNF['URL_ENTRY_MANAGE']; + else if(isset($CNF['URL_ENTRY_FANS'])) + $sUrl = $CNF['URL_ENTRY_FANS']; + + $sUrl = bx_append_url_params($sUrl, ['profile_id' => $aContentInfo['profile_id']]); + } + else + $sUrl = 'page.php?i=' . $CNF['URI_VIEW_ENTRY'] . '&id=' . $aContentInfo[$CNF['FIELD_ID']]; + + if(bx_is_api()) + return bx_api_get_block('redirect', ['uri' => '/' . BxDolPermalinks::getInstance()->permalink($sUrl), 'timeout' => 1000]); + + /** + * @hooks + * @hookdef hook-bx_base_groups-redirect_after_edit '{module_name}', 'redirect_after_edit' - hook to override redirect URL which is used after content changing + * It's equivalent to @ref hook-bx_base_general-redirect_after_edit + * @hook @ref hook-bx_base_groups-redirect_after_edit + */ + bx_alert($this->_oModule->getName(), 'redirect_after_edit', 0, false, [ + 'content' => $aContentInfo, + 'override_result' => &$sUrl, + ]); + + $this->_redirectAndExit($sUrl); + } + + public function onDataDeleteAfter ($iContentId, $aContentInfo, $oProfile) + { + $CNF = &$this->_oModule->_oConfig->CNF; + + $oGroupProfile = BxDolProfile::getInstanceByContentAndType($iContentId, $this->_oModule->_oConfig->getName()); + + if(isset($CNF['TABLE_QUESTIONS'], $CNF['TABLE_ANSWERS'])) + $this->_oModule->_oDb->deleteQuestionnaires($iContentId); + + if ($oGroupProfile && isset($CNF['TABLE_ADMINS'])) + $this->_oModule->_oDb->deleteAdminsByGroupId($oGroupProfile->id()); + + if (isset($CNF['OBJECT_CONNECTIONS']) && $oGroupProfile && ($oConnection = BxDolConnection::getObjectInstance($CNF['OBJECT_CONNECTIONS']))) + $oConnection->onDeleteInitiatorAndContent($oGroupProfile->id()); + + if((isset($CNF['OBJECT_PRIVACY_VIEW']) && $oPrivacyView = BxDolPrivacy::getObjectInstance($CNF['OBJECT_PRIVACY_VIEW'])) !== false) + $oPrivacyView->deleteGroupCustomByContentId($iContentId); + + if((isset($CNF['OBJECT_PRIVACY_POST']) && $oPrivacyPost = BxDolPrivacy::getObjectInstance($CNF['OBJECT_PRIVACY_POST'])) !== false) + $oPrivacyPost->deleteGroupCustomByContentId($iContentId); + + return ''; + } + + protected function inviteMembers ($oGroupProfile, $aInitialProfiles) + { + $CNF = &$this->_oModule->_oConfig->CNF; + + if(empty($CNF['OBJECT_CONNECTIONS']) || !$aInitialProfiles) + return; + + $oConnection = BxDolConnection::getObjectInstance($CNF['OBJECT_CONNECTIONS']); + if(!$oConnection) + return; + + $iGroupId = $oGroupProfile->id(); + + if (!is_array($aInitialProfiles)) + $aInitialProfiles = [$aInitialProfiles]; + + // insert invited members, so they will join without confirmation + foreach($aInitialProfiles as $iProfileId) { + $oProfile = BxDolProfile::getInstance($iProfileId); + if(!$oProfile) + continue; + + if($oConnection->isConnected($iGroupId, $iProfileId, true) || $oConnection->isConnected($iGroupId, $iProfileId)) + continue; + + $this->_oModule->serviceAddMutualConnection ($iGroupId, $iProfileId, true); + } + } + + /** + * Make author admin if their is in initial invitations list + * @param $oGroupProfile group id + * @param $aInitialProfiles array of initial profile ids + * @return nothing + */ + protected function makeAuthorAdmin ($oGroupProfile, $aInitialProfiles) + { + $this->makeAdmin (bx_get_logged_profile_id(), $oGroupProfile, $aInitialProfiles); + } + + /** + * Make profile admin if he is in initial invitations list + * @param $iProfileId profile id + * @param $oGroupProfile group id + * @param $aInitialProfiles array of initial profile ids + * @return nothing + */ + protected function makeAdmin ($iProfileId, $oGroupProfile, $aInitialProfiles) + { + $CNF = &$this->_oModule->_oConfig->CNF; + + if (!isset($CNF['OBJECT_CONNECTIONS']) || !$CNF['OBJECT_CONNECTIONS'] || !is_array($aInitialProfiles) || !in_array($iProfileId, $aInitialProfiles)) + return; + + if (!($oConnection = BxDolConnection::getObjectInstance($CNF['OBJECT_CONNECTIONS']))) + return; + + if (!$oConnection->isConnected($oGroupProfile->id(), (int)$iProfileId)) + $oConnection->addConnection($oGroupProfile->id(), (int)$iProfileId); + if (!$oConnection->isConnected((int)$iProfileId, $oGroupProfile->id())) + $oConnection->addConnection((int)$iProfileId, $oGroupProfile->id()); + + if (!$this->_oModule->_oDb->isAdmin ($oGroupProfile->id(), $iProfileId)) + $this->_oModule->_oDb->toAdmins ($oGroupProfile->id(), $iProfileId); + } +} + +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/groups/classes/BxBaseModGroupsGridConnections.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/groups/classes/BxBaseModGroupsGridConnections.php new file mode 100644 index 0000000000..219c2823cd --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/groups/classes/BxBaseModGroupsGridConnections.php @@ -0,0 +1,482 @@ +<?php defined('BX_DOL') or die('hack attempt'); +/** + * Copyright (c) UNA, Inc - https://una.io + * MIT License - https://opensource.org/licenses/MIT + * + * @defgroup BaseGroups Base classes for groups modules + * @ingroup UnaModules + * + * @{ + */ + +class BxBaseModGroupsGridConnections extends BxDolGridConnections +{ + protected $_oModule; + protected $_sContentModule; + + protected $_bRoles; + protected $_aRoles; + + protected $_iGroupProfileId; + protected $_aContentInfo = array(); + + protected $_bPaidJoin; + protected $_bMember; + protected $_bManageMembers; + + public function __construct ($aOptions, $oTemplate = false) + { + $this->_oModule = BxDolModule::getInstance($this->_sContentModule); + + $CNF = &$this->_oModule->_oConfig->CNF; + + $this->_sObjectConnections = $CNF['OBJECT_CONNECTIONS']; + + parent::__construct ($aOptions, $oTemplate); + if(!$this->_bInit) + return; + + $this->_bRoles = $this->_oModule->_oConfig->isRoles(); + $this->_aRoles = $this->_oModule->_oConfig->getRoles(); + + $this->_iGroupProfileId = $this->_oProfile->id(); + + $this->_aContentInfo = $this->_oModule->_oDb->getContentInfoById($this->_oProfile->getContentId()); + if($this->_oModule->checkAllowedEdit($this->_aContentInfo) === CHECK_ACTION_RESULT_ALLOWED || $this->_iGroupProfileId == bx_get_logged_profile_id()) + $this->_bOwner = true; + + $this->_bPaidJoin = $this->_oModule->isPaidJoinByProfile($this->_iGroupProfileId); + + $this->_bMember = $this->_oModule->isFan($this->_aContentInfo[$CNF['FIELD_ID']]); + $this->_bManageMembers = $this->_oModule->checkAllowedManageFans($this->_iGroupProfileId) === CHECK_ACTION_RESULT_ALLOWED || $this->_oModule->checkAllowedManageAdmins($this->_iGroupProfileId) === CHECK_ACTION_RESULT_ALLOWED; + + $aSQLParts = $this->_oConnection->getConnectedInitiatorsAsSQLParts('p', 'id', $this->_iGroupProfileId, $this->_bOwner ? false : true); + $this->addMarkers(array( + 'profile_id' => $this->_iGroupProfileId, + 'join_connections' => $aSQLParts['join'], + 'content_module' => $this->_sContentModule, + )); + } + + public function getCode ($isDisplayHeader = true) + { + $sResult = parent::getCode($isDisplayHeader); + if(!$sResult) + return $sResult; + + if($this->_bRoles) + $sResult .= $this->_oModule->_oTemplate->getJsCode('main', array( + 'sObjNameGrid' => $this->_sObject, + )); + + return $sResult; + } + + public function performActionQuestionnaire() + { + $CNF = &$this->_oModule->_oConfig->CNF; + + if(($mixedResult = $this->_oModule->checkAllowedManageAdmins($this->_iGroupProfileId)) !== CHECK_ACTION_RESULT_ALLOWED) + return $this->_getActionResult(['msg' => $mixedResult]); + + if($this->_bIsApi) + $iId = bx_get($CNF['FIELD_ID']); + else + list($iId, $iViewedId) = $this->_prepareIds(); + + if(!$iId) + return $this->_getActionResult(['msg' => _t('_sys_txt_error_occured')]); + + $sPopupContent = $this->_oModule->_oTemplate->getPopupQuestionnaire($this->_aContentInfo[$CNF['FIELD_ID']], $iId); + if(!$sPopupContent) + return $this->_getActionResult([]); + + if($this->_bIsApi) + return [bx_api_get_block('simple_list', $sPopupContent)]; + + $oFunctions = BxTemplFunctions::getInstance(); + return $this->_getActionResult(['popup' => $oFunctions->transBox(str_replace('_', '-', $this->_sContentModule) . '-questionnaire-popup', $oFunctions->simpleBoxContent($sPopupContent))]); + } + + public function performActionSetRole() + { + if(!$this->_bRoles) + return $this->_getActionResult([]); + + if(($mixedResult = $this->_oModule->checkAllowedManageAdmins($this->_iGroupProfileId)) !== CHECK_ACTION_RESULT_ALLOWED) + return $this->_getActionResult(['msg' => $mixedResult]); + + list($iId, $iViewedId) = $this->_prepareIds(); + if(!$iId) + return $this->_getActionResult(['msg' => _t('_sys_txt_error_occured')]); + + if(empty($this->_aRoles) || !is_array($this->_aRoles)) + return $this->_getActionResult(['msg' => _t('_sys_txt_error_occured')]); + + $iRole = $this->_oModule->_oDb->getRole($this->_iGroupProfileId, $iId); + + if(!$this->_oModule->_oConfig->isMultiRoles()) { + $sJsObject = $this->_oModule->_oConfig->getJsObject('main'); + $sHtmlIdPrefix = str_replace('_', '-', $this->_sContentModule) . '-set-role-'; + + $aMenuItems = []; + foreach($this->_aRoles as $iRoleId => $sRoleTitle) + $aMenuItems[] = array( + 'id' => $sHtmlIdPrefix . $iRoleId, + 'name' => $sHtmlIdPrefix . $iRoleId, + 'class' => '', + 'link' => 'javascript:void(0)', + 'onclick' => $sJsObject . '.onClickSetRole(' . $iId . ', ' . $iRoleId . ')', + 'target' => '_self', + 'title' => $sRoleTitle, + 'active' => 1 + ); + + $oMenu = new BxTemplMenu(array('template' => 'menu_vertical.html', 'menu_id'=> $sHtmlIdPrefix . 'menu', 'menu_items' => $aMenuItems)); + if(!empty($iRole)) + $oMenu->setSelected('', $sHtmlIdPrefix . $iRole); + + $sPopupContent = $oMenu->getCode(); + } + else + $sPopupContent = $this->_oModule->_oTemplate->getPopupSetRole($this->_aRoles, $iId, $iRole); + + $oFunctions = BxTemplFunctions::getInstance(); + return $this->_getActionResult(['popup' => $oFunctions->transBox(str_replace('_', '-', $this->_sContentModule) . '-set-role-popup', $oFunctions->simpleBoxContent($sPopupContent))]); + } + + public function performActionSetRoleSubmit() + { + if(!$this->_bRoles) + return $this->_getActionResult([]); + + if(($mixedResult = $this->_oModule->checkAllowedManageAdmins($this->_iGroupProfileId)) !== CHECK_ACTION_RESULT_ALLOWED) + return $this->_getActionResult(['msg' => $mixedResult]); + + list($iId, $iViewedId) = $this->_prepareIds(); + + if(!$iId) + return $this->_getActionResult(['msg' => _t('_sys_txt_error_occured')]); + + if(!$this->_oModule->setRole($this->_iGroupProfileId, $iId, bx_process_input(bx_get('role'), BX_DATA_INT))) + return $this->_getActionResult(['msg' => _t('_error occured')]); + + return $this->_getActionResult(!$this->_bIsApi ? ['grid' => $this->getCode(false), 'blink' => $iId] : []); + } + + public function performActionDeleteAndBan() + { + $this->_replaceMarkers (); + + $aResult = []; + $iAffected = 0; + + $aIds = bx_get('ids'); + if(!$aIds || !is_array($aIds)) + return $this->_getActionResult($aResult); + + $oConnection = BxDolConnection::getObjectInstance('sys_profiles_bans'); + + foreach($aIds as $mixedId) { + if(!$this->_delete($mixedId)) + continue; + + if($oConnection !== false) { + list($iProfileId, $iContextId) = $this->__prepareIds($mixedId); + + $oConnection->addConnection($iContextId, $iProfileId, [ + 'module' => $this->_sContentModule + ]); + } + + $iAffected += 1; + } + + if($iAffected) + $aResult = !$this->_bIsApi ? ['grid' => $this->getCode(false)] : []; + else + $aResult = ['msg' => _t("_sys_grid_delete_failed")]; + + return $this->_getActionResult($aResult); + } + + protected function _getCellRole($mixedValue, $sKey, $aField, $aRow) + { + $iProfileRole = $this->_oModule->_oDb->getRole($this->_iGroupProfileId, $aRow[$this->_aOptions['field_id']]); + + if(!empty($iProfileRole) && $this->_oModule->_oConfig->isMultiRoles()) { + $aRoles = array(); + foreach($this->_aRoles as $iRole => $sRole) { + if(!$iRole) + continue; + + if($iProfileRole & (1 << ($iRole - 1))) + $aRoles[] = $sRole; + } + + $mixedValue = implode(', ', $aRoles); + } + else + $mixedValue = !empty($this->_aRoles[$iProfileRole]) ? $this->_aRoles[$iProfileRole] : _t('_uknown'); + + return parent::_getCellDefault($mixedValue, $sKey, $aField, $aRow); + } + + protected function _getCellHeaderRoleAdded($sKey, $aField) + { + if(!$this->_bPaidJoin || !($this->_bMember || $this->_bManageMembers)) + return $this->_bIsApi ? [] : ''; + + return parent::_getCellHeaderDefault ($sKey, $aField); + } + + protected function _getCellRoleAdded($mixedValue, $sKey, $aField, $aRow) + { + $mixedValue = ''; + if(!$this->_bPaidJoin || !($this->_bMember || $this->_bManageMembers)) + return $this->_bIsApi ? [] : $mixedValue; + + $iProfileId = (int)$aRow[$this->_aOptions['field_id']]; + if($this->_bManageMembers || $iProfileId == bx_get_logged_profile_id()) { + $aRole = $this->_oModule->_oDb->getRoles(array('type' => 'by_gf_id', 'group_profile_id' => $this->_iGroupProfileId, 'fan_id' => $iProfileId)); + if(!empty($aRole) && is_array($aRole)) { + if(!empty($aRole['added'])) { + if($this->_bIsApi) + return ['type' => 'time', 'data' => $aRole['added']]; + + $mixedValue = bx_time_js($aRole['added'], BX_FORMAT_DATE, true); + } + else { + if($this->_bIsApi) + return ['type' => 'text', 'data' => '']; + + $mixedValue = ''; + } + } + } + + return parent::_getCellDefault($mixedValue, $sKey, $aField, $aRow); + } + + protected function _getCellHeaderRoleExpired($sKey, $aField) + { + if(!$this->_bPaidJoin || !($this->_bMember || $this->_bManageMembers)) + return $this->_bIsApi ? [] : ''; + + return parent::_getCellHeaderDefault ($sKey, $aField); + } + + protected function _getCellRoleExpired($mixedValue, $sKey, $aField, $aRow) + { + $mixedValue = ''; + if(!$this->_bPaidJoin || !($this->_bMember || $this->_bManageMembers)) + return $this->_bIsApi ? [] : ''; + + $iProfileId = (int)$aRow[$this->_aOptions['field_id']]; + if($this->_bManageMembers || $iProfileId == bx_get_logged_profile_id()) { + $aRole = $this->_oModule->_oDb->getRoles(array('type' => 'by_gf_id', 'group_profile_id' => $this->_iGroupProfileId, 'fan_id' => $iProfileId)); + if(!empty($aRole) && is_array($aRole)) { + if(!empty($aRole['expired'])) { + if($this->_bIsApi) + return ['type' => 'time', 'data' => $aRole['expired']]; + + $mixedValue = bx_time_js($aRole['expired'], BX_FORMAT_DATE, true); + } + else { + if($this->_bIsApi) + return ['type' => 'text', 'data' => '']; + + $mixedValue = ''; + } + } + } + + return parent::_getCellDefault($mixedValue, $sKey, $aField, $aRow); + } + + protected function _getActionQuestionnaire ($sType, $sKey, $a, $isSmall = false, $isDisabled = false, $aRow = []) + { + $CNF = &$this->_oModule->_oConfig->CNF; + + if(!$this->_oModule->_oDb->areQuestionsAnswered($this->_aContentInfo[$CNF['FIELD_ID']], $aRow[$this->_aOptions['field_id']])) + return $this->_bIsApi ? [] : ''; + + return parent::_getActionDefault ($sType, $sKey, $a, $isSmall, $isDisabled, $aRow); + } + + protected function _getActionSetRole ($sType, $sKey, $a, $isSmall = false, $isDisabled = false, $aRow = []) + { + /** + * Note. The feature isn't available in API for now. + */ + if($this->_bIsApi) + return []; + + if ($this->_oModule->checkAllowedManageAdmins($this->_iGroupProfileId) !== CHECK_ACTION_RESULT_ALLOWED) + return $this->_bIsApi ? [] : ''; + + return parent::_getActionDefault ($sType, $sKey, $a, $isSmall, $isDisabled, $aRow); + } + + protected function _getActionSetRoleSubmit ($sType, $sKey, $a, $isSmall = false, $isDisabled = false, $aRow = []) + { + return $this->_bIsApi ? [] : ''; + } + + protected function _getActionAccept ($sType, $sKey, $a, $isSmall = false, $isDisabled = false, $aRow = []) + { + if ($aRow['mutual']) + return $this->_bIsApi ? [] : ''; + + if ($this->_oModule->checkAllowedManageFans($this->_iGroupProfileId) !== CHECK_ACTION_RESULT_ALLOWED) + return $this->_bIsApi ? [] : ''; + + if (isset($aRow[$this->_aOptions['field_id']])) + $a['attr']['bx_grid_action_data'] = $aRow[$this->_aOptions['field_id']] . ':' . $this->_iGroupProfileId; + + return parent::_getActionAccept($sType, $sKey, $a, $isSmall, $isDisabled, $aRow); + } + + protected function _getActionDelete ($sType, $sKey, $a, $isSmall = false, $isDisabled = false, $aRow = []) + { + if ($this->_oModule->checkAllowedManageFans($this->_iGroupProfileId) !== CHECK_ACTION_RESULT_ALLOWED) + return $this->_bIsApi ? [] : ''; + + if (isset($aRow[$this->_aOptions['field_id']])) + $a['attr']['bx_grid_action_data'] = $aRow[$this->_aOptions['field_id']] . ':' . $this->_iGroupProfileId; + + return parent::_getActionDelete($sType, $sKey, $a, $isSmall, $isDisabled, $aRow); + } + + protected function _getActionDeleteAndBan ($sType, $sKey, $a, $isSmall = false, $isDisabled = false, $aRow = []) + { + return $this->_getActionDelete($sType, $sKey, $a, $isSmall, $isDisabled, $aRow); + } + + /** + * Note. Methods related to 'To Admin'/'From Admin' functionality can be removed after UNA 12 will be released. + */ + protected function _getActionToAdmins ($sType, $sKey, $a, $isSmall = false, $isDisabled = false, $aRow = []) + { + if ($this->_oModule->_oDb->isAdmin($this->_iGroupProfileId, $aRow[$this->_aOptions['field_id']])) + return ''; + + return $this->_getActionManageAdmins ($sType, $sKey, $a, $isSmall, $isDisabled, $aRow); + } + + protected function _getActionFromAdmins ($sType, $sKey, $a, $isSmall = false, $isDisabled = false, $aRow = []) + { + if (!$this->_oModule->_oDb->isAdmin($this->_iGroupProfileId, $aRow[$this->_aOptions['field_id']])) + return ''; + + return $this->_getActionManageAdmins ($sType, $sKey, $a, $isSmall, $isDisabled, $aRow); + } + + protected function _getActionManageAdmins ($sType, $sKey, $a, $isSmall = false, $isDisabled = false, $aRow = []) + { + if (!$this->_oConnection->isConnected($aRow[$this->_aOptions['field_id']], $this->_iGroupProfileId, true)) + return ''; + + if ($this->_oModule->checkAllowedManageAdmins($this->_iGroupProfileId) !== CHECK_ACTION_RESULT_ALLOWED) + return ''; + + if (isset($aRow[$this->_aOptions['field_id']])) + $a['attr']['bx_grid_action_data'] = $aRow[$this->_aOptions['field_id']] . ':' . $this->_iGroupProfileId; + + return parent::_getActionDefault ($sType, $sKey, $a, $isSmall, $isDisabled, $aRow); + } + + /** + * 'To Admins' action handler + */ + public function performActionToAdmins() + { + $this->_performActionAdmins('toAdmins'); + } + + /** + * 'From Admins' action handler + */ + public function performActionFromAdmins() + { + $this->_performActionAdmins('fromAdmins'); + } + + public function _performActionAdmins($sFunc) + { + list ($iId, $iGroupProfileId) = $this->_prepareIds(); + + if (!$iId) { + echoJson(array('msg' => _t('_sys_txt_error_occured'))); + exit; + } + + if (CHECK_ACTION_RESULT_ALLOWED !== $this->_oModule->checkAllowedManageAdmins($iGroupProfileId)) { + echoJson(array('msg' => _t('_sys_txt_access_denied'))); + exit; + } + + if (!$this->_oModule->_oDb->$sFunc($iGroupProfileId, $iId)) { + echoJson(array('msg' => _t('_sys_txt_error_occured'))); + } + else { + + $sEmailTemplate = 'toAdmins' == $sFunc ? $this->_oModule->_oConfig->CNF['EMAIL_FAN_BECOME_ADMIN'] : $this->_oModule->_oConfig->CNF['EMAIL_ADMIN_BECOME_FAN']; + list($iGroupProfileId, $iProfileId) = $this->_prepareGroupProfileAndMemberProfile($iGroupProfileId, $iId); + if (bx_get_logged_profile_id() != $iProfileId) { + // notify about admin status + sendMailTemplate($sEmailTemplate, 0, $iProfileId, array( + 'EntryUrl' => BxDolProfile::getInstance($iGroupProfileId)->getUrl(), + 'EntryTitle' => BxDolProfile::getInstance($iGroupProfileId)->getDisplayName(), + ), BX_EMAIL_NOTIFY); + } + + // subscribe admins automatically + if ('toAdmins' == $sFunc && ($oConn = BxDolConnection::getObjectInstance('sys_profiles_subscriptions'))) + $oConn->addConnection($iProfileId, $iGroupProfileId); + + echoJson(array('grid' => $this->getCode(false), 'blink' => $iId)); + } + } + + protected function _delete ($mixedId) + { + list ($iId, $iViewedId) = $this->_prepareIds(); + + // send email notification + $sEmailTemplate = $this->_oConnection->isConnected($iViewedId, $iId, true) ? $this->_oModule->_oConfig->CNF['EMAIL_FAN_REMOVE'] : $this->_oModule->_oConfig->CNF['EMAIL_JOIN_REJECT']; + list($iGroupProfileId, $iProfileId) = $this->_prepareGroupProfileAndMemberProfile($iId, $iViewedId); + if (bx_get_logged_profile_id() != $iProfileId) { + sendMailTemplate($sEmailTemplate, 0, $iProfileId, array( + 'EntryUrl' => BxDolProfile::getInstance($iGroupProfileId)->getUrl(), + 'EntryTitle' => BxDolProfile::getInstance($iGroupProfileId)->getDisplayName(), + ), BX_EMAIL_NOTIFY); + } + + // delete admin associated with profile + $this->_oModule->_oDb->deleteAdminsByGroupId($iGroupProfileId, $iProfileId); + + return parent::_delete ($mixedId); + } + + /** + * @return array where first element is group profile id and second element is some other persons profile id + */ + protected function _prepareGroupProfileAndMemberProfile($iId1, $iId2) + { + if (BxDolProfile::getInstance($iId1)->getModule() == $this->_sContentModule) + return array($iId1, $iId2); + else + return array($iId2, $iId1); + } + + protected function _addJsCss() + { + parent::_addJsCss(); + + if($this->_bRoles) + $this->_oModule->_oTemplate->addJs(['modules/base/groups/js/|main.js', 'main.js']); + } +} + +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/groups/classes/BxBaseModGroupsModule.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/groups/classes/BxBaseModGroupsModule.php new file mode 100644 index 0000000000..73197ad685 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/groups/classes/BxBaseModGroupsModule.php @@ -0,0 +1,2481 @@ +<?php defined('BX_DOL') or die('hack attempt'); +/** + * Copyright (c) UNA, Inc - https://una.io + * MIT License - https://opensource.org/licenses/MIT + * + * @defgroup BaseGroups Base classes for groups modules + * @ingroup UnaModules + * + * @{ + */ + +define('BX_BASE_MOD_GROUPS_MMODE_MULTI_ROLES', 'multi_roles'); + +define('BX_BASE_MOD_GROUPS_ROLE_COMMON', 0); +define('BX_BASE_MOD_GROUPS_ROLE_ADMINISTRATOR', 1); +define('BX_BASE_MOD_GROUPS_ROLE_MODERATOR', 2); + +define('BX_BASE_MOD_GROUPS_ACTION_EDIT', 'edit'); +define('BX_BASE_MOD_GROUPS_ACTION_CHANGE_COVER', 'change_cover'); +define('BX_BASE_MOD_GROUPS_ACTION_INVITE', 'invite'); +define('BX_BASE_MOD_GROUPS_ACTION_MANAGE_FANS', 'manage_fans'); +define('BX_BASE_MOD_GROUPS_ACTION_MANAGE_ROLES', 'manage_roles'); +define('BX_BASE_MOD_GROUPS_ACTION_DELETE', 'delete'); +define('BX_BASE_MOD_GROUPS_ACTION_EDIT_CONTENT', 'edit_any'); +define('BX_BASE_MOD_GROUPS_ACTION_DELETE_CONTENT', 'delete_any'); +define('BX_BASE_MOD_GROUPS_ACTION_TIMELINE_POST_PIN', 'pin'); //for timeline posts only + +define('BX_BASE_MOD_GROUPS_PERIOD_UNIT_DAY', 'day'); +define('BX_BASE_MOD_GROUPS_PERIOD_UNIT_WEEK', 'week'); +define('BX_BASE_MOD_GROUPS_PERIOD_UNIT_MONTH', 'month'); +define('BX_BASE_MOD_GROUPS_PERIOD_UNIT_YEAR', 'year'); + +/** + * Groups profiles module. + */ +class BxBaseModGroupsModule extends BxBaseModProfileModule +{ + function __construct(&$aModule) + { + parent::__construct($aModule); + + $CNF = &$this->_oConfig->CNF; + + if(isset($CNF['FIELD_PUBLISHED'])) + $this->_aSearchableNamesExcept = array_merge($this->_aSearchableNamesExcept, array( + $CNF['FIELD_PUBLISHED'], + )); + } + + /** + * Get possible recipients for start conversation form + */ + public function actionAjaxGetInitialMembers () + { + $sTerm = bx_get('term'); + + $a = BxDolService::call('system', 'profiles_search', [$sTerm, ['module' => $this->_oConfig->getName()]], 'TemplServiceProfiles'); + + header('Content-Type:text/javascript; charset=utf-8'); + echo(json_encode($a)); + } + + public function serviceGetInitialMembers ($sParams) + { + $aOptions = json_decode($sParams, true); + if (!$sParams || !isset($aOptions['term'])) + return []; + + $a = BxDolService::call('system', 'profiles_search', [$aOptions['term'], ['module' => $this->_oConfig->getName()]], 'TemplServiceProfiles'); + + return $a; + } + + /** + * Process Process Invitation + */ + public function actionProcessInvite ($sKey, $iGroupProfileId, $bAccept) + { + $aData = $this->_oDb->getInviteByKey($sKey, $iGroupProfileId); + if (isset($aData['invited_profile_id'])){ + $CNF = &$this->_oConfig->CNF; + if (!isset($CNF['OBJECT_CONNECTIONS']) || !($oConnection = BxDolConnection::getObjectInstance($CNF['OBJECT_CONNECTIONS']))) + return ''; + $iInvitedProfileId = $aData['invited_profile_id']; + if ($iInvitedProfileId != bx_get_logged_profile_id()) + return ''; + if ($bAccept){ + if($oConnection && !$oConnection->isConnected($iInvitedProfileId, $iGroupProfileId)){ + $oConnection->addConnection($iInvitedProfileId, $iGroupProfileId); + $oConnection->addConnection($iGroupProfileId, $iInvitedProfileId); + } + } + $this->_oDb->deleteInviteByKey($sKey, $iGroupProfileId); + } + } + + public function actionCheckName() + { + $CNF = &$this->_oConfig->CNF; + + $sName = bx_process_input(bx_get('name')); + if(empty($sName)) + return echoJson(array()); + + $sResult = ''; + + $iId = (int)bx_get('id'); + if(!empty($iId)) { + $aPrice = $this->_oDb->getPrices(array('type' => 'by_id', 'value' => $iId)); + if(strcmp($sName, $aPrice[$CNF['FIELD_PRICE_NAME']]) == 0) + $sResult = $sName; + } + + echoJson(array( + 'name' => !empty($sResult) ? $sResult : $this->_oConfig->getPriceName($sName) + )); + } + + public function actionGetQuestionnaire() + { + $sSource = ''; + if(($sSource = bx_get('s')) !== false) + $sSource = bx_process_url_param($sSource); + + $sObject = ''; + if(($sObject = bx_get('o')) !== false) + $sObject = bx_process_url_param($sObject); + + $sAction = ''; + if(($sAction = bx_get('a')) !== false) + $sAction = bx_process_url_param($sAction); + + $iContentProfileId = 0; + if(($iContentProfileId = bx_get('cpi')) !== false) + $iContentProfileId = (int)$iContentProfileId; + + echoJson($this->serviceGetQuestionnaire($sSource, $sObject, $sAction, $iContentProfileId)); + } + + public function serviceManageTools($sType = 'common') + { + $this->_oTemplate->addJs(['modules/base/groups/js/|manage_tools.js']); + + return parent::serviceManageTools($sType); + } + + public function decodeDataAPI($aData, $aParams = []) + { + $CNF = $this->_oConfig->CNF; + + $aResult = parent::decodeDataAPI($aData, $aParams); + + if(isset($aParams['template']) && $aParams['template'] == 'unit_wo_info') + return $aResult; + + if(getParam('sys_api_conn_in_prof_units') == 'on' && ($oConnection = BxDolConnection::getObjectInstance($CNF['OBJECT_CONNECTIONS'])) !== false) { + $oProfile = BxDolProfile::getInstanceByContentAndType($aData[$CNF['FIELD_ID']], $this->_aModule['name']); + + $aResult['members_count'] = $oConnection->getConnectedInitiatorsCount($oProfile->id(), false); + $aResult['members_list'] = $oConnection->getConnectedListAPI($oProfile->id(), false, BX_CONNECTIONS_CONTENT_TYPE_INITIATORS); + } + $aResult['visibility'] = $aData[$CNF['FIELD_ALLOW_VIEW_TO']]; + + return $aResult; + } + + public function serviceGetMenuAddonManageTools() + { + $CNF = &$this->_oConfig->CNF; + + $aResult = parent::serviceGetMenuAddonManageTools(); + + if(!empty($CNF['FIELD_STATUS_ADMIN'])) + $aResult['counter1_value'] = $this->_oDb->getEntriesNumByParams([[ + 'key' => $CNF['FIELD_STATUS_ADMIN'], + 'value' => BX_BASE_MOD_GENERAL_STATUS_PENDING, + 'operator' => '=' + ]]); + + return $aResult; + } + + public function serviceGetOptionsMembersMode() + { + $CNF = &$this->_oConfig->CNF; + + return array( + array('key' => '', 'value' => _t('_None')), + array('key' => BX_BASE_MOD_GROUPS_MMODE_MULTI_ROLES, 'value' => _t($CNF['T']['option_members_mode_' . BX_BASE_MOD_GROUPS_MMODE_MULTI_ROLES])), + ); + } + + public function serviceGetSearchResultUnit ($iContentId, $sUnitTemplate = '') + { + if(empty($sUnitTemplate)) + $sUnitTemplate = 'unit.html'; + + return parent::serviceGetSearchResultUnit($iContentId, $sUnitTemplate); + } + + /** + * @see BxBaseModProfileModule::serviceGetSpaceTitle + */ + public function serviceGetSpaceTitle() + { + return _t($this->_oConfig->CNF['T']['txt_sample_single']); + } + + /** + * @see iBxDolProfileService::serviceGetParticipatingProfiles + */ + public function serviceGetParticipatingProfiles($iProfileId, $aConnectionObjects = false) + { + if (isset($this->_oConfig->CNF['OBJECT_CONNECTIONS'])){ + $aConnectionObjects = array($this->_oConfig->CNF['OBJECT_CONNECTIONS'], 'sys_profiles_subscriptions'); + return parent::serviceGetParticipatingProfiles($iProfileId, $aConnectionObjects); + } + return parent::serviceGetParticipatingProfiles($iProfileId); + } + + public function serviceGetSafeServices() + { + return array_merge(parent::serviceGetSafeServices(), [ + 'GetQuestionnaire' => '', + 'GetInitialMembers' => '', + 'EntityInvite' => '', + ]); + } + + /** + * Check if this module entry can be used as profile + */ + public function serviceActAsProfile () + { + return false; + } + + /** + * Check if this module is group profile + */ + public function serviceIsGroupProfile () + { + return true; + } + + public function serviceIsEnableForContext($iProfileId = 0) + { + $CNF = &$this->_oConfig->CNF; + + $sCnfKey = 'ENABLE_FOR_CONTEXT_IN_MODULES'; + if(empty($iProfileId) || empty($CNF[$sCnfKey]) || !is_array($CNF[$sCnfKey])) + return false; + + $oProfile = BxDolProfile::getInstance($iProfileId); + if(!$oProfile) + return false; + + if(!in_array($oProfile->getModule(), $CNF[$sCnfKey])) + return false; + + return true; + } + + /** + * check if provided profile is member of the group + */ + public function serviceIsFan ($iGroupProfileId, $iProfileId = false) + { + $oGroupProfile = BxDolProfile::getInstance($iGroupProfileId); + return $oGroupProfile !== false && $this->isFan($oGroupProfile->getContentId(), $iProfileId); + } + + /** + * check if provided profile is admin of the group + */ + public function serviceIsAdmin ($iGroupProfileId, $iProfileId = false) + { + if(!$iProfileId) + $iProfileId = bx_get_logged_profile_id(); + + $oGroupProfile = BxDolProfile::getInstance($iGroupProfileId); + if(!$oGroupProfile) + return false; + + $iGroupContentId = $oGroupProfile->getContentId(); + if(!$this->isFan($iGroupContentId, $iProfileId)) + return false; + + $aGroupContentInfo = $this->_oDb->getContentInfoById($iGroupContentId); + return $this->_oDb->isAdmin($iGroupProfileId, $iProfileId, $aGroupContentInfo); + } + + public function serviceGetAdminRole($iGroupProfileId, $iProfileId = false) + { + if(!$iProfileId) + $iProfileId = bx_get_logged_profile_id(); + + if(!$this->serviceIsAdmin($iGroupProfileId, $iProfileId)) + return 0; + + return $this->_oDb->getRole($iGroupProfileId, $iProfileId); + } + + /* + * Get context (group) advanced members who can perform the specified action. + * If 'Roles' are disabled for the context then all context admins are returned. + */ + public function serviceGetAdminsByAction($iGroupProfileId, $mixedAction) + { + if(!$this->_oConfig->isAdmins()) + return []; + + $aGroupContentInfo = $this->_oDb->getContentInfoByProfileId($iGroupProfileId); + if(empty($aGroupContentInfo) || !is_array($aGroupContentInfo)) + return []; + + $aAdmins = $this->_oDb->getAdmins($iGroupProfileId); + if(!$this->_oConfig->isRoles()) + return $aAdmins; + + if(!is_array($mixedAction)) + $mixedAction = [$mixedAction]; + + $aResult = []; + foreach($mixedAction as $sAction) + foreach($aAdmins as $iAdminProfileId) + if(!in_array($iAdminProfileId, $aResult) && $this->isAllowedActionByRole($sAction, $aGroupContentInfo, $iGroupProfileId, $iAdminProfileId)) + $aResult[] = $iAdminProfileId; + + return $aResult; + } + + public function serviceGetAdminsToManageContent($iGroupProfileId) + { + return $this->serviceGetAdminsByAction($iGroupProfileId, [ + BX_BASE_MOD_GROUPS_ACTION_EDIT_CONTENT, + BX_BASE_MOD_GROUPS_ACTION_DELETE_CONTENT + ]); + } + + /** + * Delete profile from fans and admins tables + * @param $iProfileId profile id + */ + public function serviceDeleteProfileFromFansAndAdmins ($iProfileId) + { + $CNF = &$this->_oConfig->CNF; + + $this->_oDb->deleteAdminsByProfileId($iProfileId); + + if (isset($CNF['OBJECT_CONNECTIONS']) && ($oConnection = BxDolConnection::getObjectInstance($CNF['OBJECT_CONNECTIONS']))) + $oConnection->onDeleteInitiatorAndContent($iProfileId); + } + + /** + * Reset group's author for particular group + * @param $iContentId group id + * @parem $iAuthorId new author profile ID + * @return false of error, or number of updated records on success + */ + public function serviceReassignEntityAuthor ($iContentId, $iAuthorId = 0) + { + $aContentInfo = $this->_oDb->getContentInfoById((int)$iContentId); + if (!$aContentInfo) + return false; + + if (empty($iAuthorId)) { + $oGroupProfile = BxDolProfile::getInstanceByContentAndType($iContentId, $this->getName()); + if (!$oGroupProfile) + return false; + + $aAdmins = $this->_oDb->getAdmins($oGroupProfile->id()); + if($aAdmins) + $iAuthorId = array_pop($aAdmins); + } + + return $this->_oDb->updateAuthorById($iContentId, $iAuthorId); + } + + /** + * Entry actions and social sharing block + */ + public function serviceEntityAllActions ($mixedContent = false, $aParams = array()) + { + $CNF = &$this->_oConfig->CNF; + + if(!empty($mixedContent)) { + if(!is_array($mixedContent)) + $mixedContent = array((int)$mixedContent, (method_exists($this->_oDb, 'getContentInfoById')) ? $this->_oDb->getContentInfoById((int)$mixedContent) : array()); + } + else { + $mixedContent = $this->_getContent(); + if($mixedContent === false) + return false; + } + + list($iContentId, $aContentInfo) = $mixedContent; + + if(!empty($CNF['FIELD_PICTURE']) && !empty($aContentInfo[$CNF['FIELD_PICTURE']])) + $aParams = array_merge(array( + 'entry_thumb' => (int)$aContentInfo[$CNF['FIELD_PICTURE']] + ), $aParams); + + return parent::serviceEntityAllActions ($mixedContent, $aParams); + } + + /** + * Reset group's author when author profile is deleted + * @param $iProfileId author profile id + * @param $iAuthorId new author profile id + * @return number of changed items + */ + public function serviceReassignEntitiesByAuthor ($iProfileId, $iAuthorId = 0) + { + $a = $this->_oDb->getEntriesByAuthor((int)$iProfileId); + if (!$a) + return 0; + + $iCount = 0; + foreach ($a as $aContentInfo) + $iCount += ('' == $this->serviceReassignEntityAuthor($aContentInfo[$this->_oConfig->CNF['FIELD_ID']], $iAuthorId) ? 1 : 0); + + return $iCount; + } + + public function servicePrepareFields ($aFieldsProfile) + { + $CNF = &$this->_oConfig->CNF; + + $aFieldsProfile[$CNF['FIELD_NAME']] = $aFieldsProfile['name']; + $aFieldsProfile[$CNF['FIELD_TEXT']] = isset($aFieldsProfile['description']) ? $aFieldsProfile['description'] : ''; + unset($aFieldsProfile['name']); + unset($aFieldsProfile['description']); + return $aFieldsProfile; + } + + public function serviceOnRemoveConnection ($iGroupProfileId, $iInitiatorId) + { + $CNF = &$this->_oConfig->CNF; + + list ($iProfileId, $iGroupProfileId, $oGroupProfile) = $this->_prepareProfileAndGroupProfile($iGroupProfileId, $iInitiatorId); + if (!$oGroupProfile) + return false; + + $this->_oDb->fromAdmins($iGroupProfileId, $iProfileId); + + if ($oConn = BxDolConnection::getObjectInstance('sys_profiles_subscriptions')) + return $oConn->removeConnection($iProfileId, $iGroupProfileId); + + return false; + } + + public function serviceAddMutualConnection ($iGroupProfileId, $iInitiatorId, $bSendInviteOnly = false) + { + $CNF = &$this->_oConfig->CNF; + + list ($iProfileId, $iGroupProfileId, $oGroupProfile) = $this->_prepareProfileAndGroupProfile($iGroupProfileId, $iInitiatorId); + if (!$oGroupProfile) + return false; + + if (!($aContentInfo = $this->_oDb->getContentInfoById((int)BxDolProfile::getInstance($iGroupProfileId)->getContentId()))) + return false; + + if (!isset($CNF['OBJECT_CONNECTIONS']) || !($oConnection = BxDolConnection::getObjectInstance($CNF['OBJECT_CONNECTIONS']))) + return false; + + $sEntryTitle = $aContentInfo[$CNF['FIELD_NAME']]; + $sEntryUrl = bx_absolute_url(BxDolPermalinks::getInstance()->permalink('page.php?i=' . $CNF['URI_VIEW_ENTRY'] . '&id=' . $aContentInfo[$CNF['FIELD_ID']])); + + // send invitation to the group + $sModule = $this->getName(); + if ($bSendInviteOnly && !$oConnection->isConnected((int)$iInitiatorId, $oGroupProfile->id()) && !$oConnection->isConnected($oGroupProfile->id(), (int)$iInitiatorId) && bx_get_logged_profile_id() != $iProfileId) { + /** + * @hooks + * @hookdef hook-bx_base_groups-join_invitation '{module_name}', 'join_invitation' - hook before adding (sending) new join to context invitation + * - $unit_name - module name + * - $action - equals `join_invitation` + * - $object_id - context id + * - $sender_id - context profile id + * - $extra_params - array of additional params with the following array keys: + * - `content` - [array] context info array as key&value pairs + * - `entry_title` - [string] context title + * - `entry_url` - [string] context URL + * - `group_profile` - [int] context profile id + * - `profile` - [int] profile id who was invited + * - `notification_subobject_id` - [int] profile id who was invited + * - `object_author_id` - [int] context profile id + * @hook @ref hook-bx_base_groups-join_invitation + */ + bx_alert($sModule, 'join_invitation', $aContentInfo[$CNF['FIELD_ID']], $iGroupProfileId, [ + 'content' => $aContentInfo, + 'entry_title' => $sEntryTitle, + 'entry_url' => $sEntryUrl, + 'group_profile' => $iGroupProfileId, + 'profile' => $iProfileId, + 'notification_subobject_id' => $iProfileId, + 'object_author_id' => $iGroupProfileId + ]); + + /** + * 'Invitation Received' alert for Notifications module. + * Note. It's essential to use Recipient ($iInitiatorId) in 'object_author_id' parameter. + * In this case notification will be received by Recipient profile. + */ + /** + * @hooks + * @hookdef hook-bx_base_groups-join_invitation_notif '{module_name}', 'join_invitation_notif' - hook before adding new join to context invitation. Is needed for Notifications module. + * - $unit_name - module name + * - $action - equals `join_invitation_notif` + * - $object_id - context id + * - $sender_id - context profile id + * - $extra_params - array of additional params with the following array keys: + * - `object_author_id` - [int] profile id who was invited + * - `privacy_view` - [int] or [string] privacy for view context action, @see BxDolPrivacy + * @hook @ref hook-bx_base_groups-join_invitation_notif + */ + bx_alert($sModule, 'join_invitation_notif', $aContentInfo[$CNF['FIELD_ID']], $iGroupProfileId, [ + 'object_author_id' => $iInitiatorId, + 'privacy_view' => isset($aContentInfo[$CNF['FIELD_ALLOW_VIEW_TO']]) ? $aContentInfo[$CNF['FIELD_ALLOW_VIEW_TO']] : 3, + ]); + } + // send notification to group's admins that new connection is pending confirmation + elseif (!$bSendInviteOnly && $oConnection->isConnected((int)$iInitiatorId, $oGroupProfile->id()) && !$oConnection->isConnected($oGroupProfile->id(), (int)$iInitiatorId) && $aContentInfo['join_confirmation']) { + /** + * @hooks + * @hookdef hook-bx_base_groups-join_request '{module_name}', 'join_request' - hook before adding new join to context request + * - $unit_name - module name + * - $action - equals `join_request` + * - $object_id - context id + * - $sender_id - context profile id + * - $extra_params - array of additional params with the following array keys: + * - `object_author_id` - [int] context profile id + * - `performer_id` - [int] profile id who wants to join + * - `content` - [array] context info array as key&value pairs + * - `entry_title` - [string] context title + * - `entry_url` - [string] context URL + * - `group_profile` - [int] context profile id + * - `profile` - [int] profile id who wants to join + * @hook @ref hook-bx_base_groups-join_request + */ + bx_alert($this->getName(), 'join_request', $aContentInfo[$CNF['FIELD_ID']], $iGroupProfileId, [ + 'object_author_id' => $iGroupProfileId, + 'performer_id' => $iProfileId, + + 'content' => $aContentInfo, + 'entry_title' => $sEntryTitle, + 'entry_url' => $sEntryUrl, + + 'group_profile' => $iGroupProfileId, + 'profile' => $iProfileId + ]); + } + // send notification that join request was accepted + else if (!$bSendInviteOnly && $oConnection->isConnected((int)$iInitiatorId, $oGroupProfile->id(), true) && $oGroupProfile->getModule() != $this->getName() && bx_get_logged_profile_id() != $iProfileId) { + /** + * @hooks + * @hookdef hook-bx_base_groups-join_request_accepted '{module_name}', 'join_request_accepted' - hook before accepting join to context request + * It's equivalent to @ref hook-bx_base_groups-join_request + * @hook @ref hook-bx_base_groups-join_request_accepted + */ + bx_alert($this->getName(), 'join_request_accepted', $aContentInfo[$CNF['FIELD_ID']], $iGroupProfileId, [ + 'object_author_id' => $iGroupProfileId, + 'performer_id' => $iProfileId, + + 'content' => $aContentInfo, + 'entry_title' => $sEntryTitle, + 'entry_url' => $sEntryUrl, + + 'group_profile' => $iGroupProfileId, + 'profile' => $iProfileId + ]); + } + + // new fan was added + if ($oConnection->isConnected($oGroupProfile->id(), (int)$iInitiatorId, true)) { + // follow group on join + if (BxDolService::call($oGroupProfile->getModule(), 'act_as_profile')){ + $this->addFollower($oGroupProfile->id(), (int)$iInitiatorId); + } + else{ + $this->addFollower((int)$iInitiatorId, $oGroupProfile->id()); + } + + /** + * @hooks + * @hookdef hook-bx_base_groups-fan_added '{module_name}', 'fan_added' - hook before adding (registering) new context member + * It's equivalent to @ref hook-bx_base_groups-join_request + * @hook @ref hook-bx_base_groups-fan_added + */ + bx_alert($this->getName(), 'fan_added', $aContentInfo[$CNF['FIELD_ID']], $iGroupProfileId, [ + 'object_author_id' => $iGroupProfileId, + 'performer_id' => $iProfileId, + + 'content' => $aContentInfo, + 'entry_title' => $sEntryTitle, + 'entry_url' => $sEntryUrl, + + 'group_profile' => $iGroupProfileId, + 'profile' => $iProfileId, + ]); + + $this->doAudit($iGroupProfileId, $iInitiatorId, '_sys_audit_action_group_join_request_accepted'); + + return false; + } + + // don't automatically add connection (mutual) if group requires manual join confirmation + if ($bSendInviteOnly || $aContentInfo['join_confirmation']) + return false; + + // check if connection already exists + if ($oConnection->isConnected($oGroupProfile->id(), (int)$iInitiatorId, true) || $oConnection->isConnected($oGroupProfile->id(), (int)$iInitiatorId)) + return false; + + if (!$oConnection->addConnection($oGroupProfile->id(), (int)$iInitiatorId)) + return false; + + return true; + } + + public function serviceFansTable () + { + $CNF = &$this->_oConfig->CNF; + + $oGrid = BxDolGrid::getObjectInstance($CNF['OBJECT_GRID_CONNECTIONS']); + if(!$oGrid) + return false; + + if($this->_bIsApi){ + return [ + bx_api_get_block('grid', $oGrid->getCodeAPI()) + ]; + } + + return $oGrid->getCode(); + } + + public function serviceInvitesTable () + { + $CNF = &$this->_oConfig->CNF; + + if(!isset($CNF['OBJECT_GRID_INVITES'])) + return false; + + $oGrid = BxDolGrid::getObjectInstance($CNF['OBJECT_GRID_INVITES']); + if(!$oGrid) + return false; + + if($this->_bIsApi) + return [ + bx_api_get_block('grid', $oGrid->getCodeAPI()) + ]; + + return $oGrid->getCode(); + } + + public function serviceBansTable () + { + $CNF = &$this->_oConfig->CNF; + + if(!isset($CNF['OBJECT_GRID_BANS'])) + return false; + + $oGrid = BxDolGrid::getObjectInstance($CNF['OBJECT_GRID_BANS']); + if(!$oGrid) + return false; + + if($this->_bIsApi) + return [ + bx_api_get_block('grid', $oGrid->getCodeAPI()) + ]; + + return $oGrid->getCode(); + } + + public function serviceFans ($iContentId = 0, $bAsArray = false) + { + $CNF = &$this->_oConfig->CNF; + + if (!$iContentId) + $iContentId = bx_process_input(bx_get('id'), BX_DATA_INT); + + if (!$iContentId) + return false; + + $aContentInfo = $this->_oDb->getContentInfoById($iContentId); + if (!$aContentInfo) + return false; + + if (!($oGroupProfile = BxDolProfile::getInstanceByContentAndType($iContentId, $this->getName()))) + return false; + + if(!$bAsArray) { + bx_import('BxDolConnection'); + $mixedResult = $this->serviceBrowseConnectionsQuick ($oGroupProfile->id(), $CNF['OBJECT_CONNECTIONS'], BX_CONNECTIONS_CONTENT_TYPE_CONTENT, true); + if (!$mixedResult) + return MsgBox(_t('_sys_txt_empty')); + } + else + $mixedResult = BxDolConnection::getObjectInstance($CNF['OBJECT_CONNECTIONS'])->getConnectedContent($oGroupProfile->id(), true); + + return $mixedResult; + } + + public function serviceFansWithoutAdmins ($iContentId = 0, $bAsArray = false) + { + if (!$iContentId) + $iContentId = bx_process_input(bx_get('id'), BX_DATA_INT); + if (!$iContentId) + return false; + + $aContentInfo = $this->_oDb->getContentInfoById($iContentId); + if (!$aContentInfo) + return false; + + if (!($oGroupProfile = BxDolProfile::getInstanceByContentAndType($iContentId, $this->getName()))) + return false; + + $CNF = &$this->_oConfig->CNF; + + $aFans = BxDolConnection::getObjectInstance($CNF['OBJECT_CONNECTIONS'])->getConnectedContent($oGroupProfile->id(), true); + if(empty($aFans) || !is_array($aFans)) + return false; + + $aAdmins = $this->_oDb->getAdmins($oGroupProfile->id()); + if(!empty($aAdmins) && is_array($aAdmins)) + $aFans = array_diff($aFans, $aAdmins); + + $iStart = (int)bx_get('start'); + $iLimit = !empty($CNF['PARAM_NUM_CONNECTIONS_QUICK']) ? getParam($CNF['PARAM_NUM_CONNECTIONS_QUICK']) : 4; + if(!$iLimit) + $iLimit = 4; + + return $this->_serviceBrowseQuick($aFans, $iStart, $iLimit); + } + + public function serviceAdmins ($iContentId = 0) + { + $CNF = &$this->_oConfig->CNF; + + if(!$iContentId) + $iContentId = bx_process_input(bx_get('id'), BX_DATA_INT); + if(!$iContentId) + return false; + + $oGroupProfile = BxDolProfile::getInstanceByContentAndType($iContentId, $this->getName()); + if(!$oGroupProfile) + return false; + + $iStart = (int)bx_get('start'); + $iLimit = !empty($CNF['PARAM_NUM_CONNECTIONS_QUICK']) ? getParam($CNF['PARAM_NUM_CONNECTIONS_QUICK']) : 4; + if(!$iLimit) + $iLimit = 4; + + $aProfiles = $this->_oDb->getAdmins($oGroupProfile->id(), $iStart, $iLimit+1); + if(empty($aProfiles) || !is_array($aProfiles)) + return false; + + return $this->_serviceBrowseQuick($aProfiles, $iStart, $iLimit); + } + + public function serviceMembersByRole ($iContentId = 0, $iRole = BX_BASE_MOD_GROUPS_ROLE_COMMON) + { + $CNF = &$this->_oConfig->CNF; + + if(!$iContentId) + $iContentId = bx_process_input(bx_get('id'), BX_DATA_INT); + if(!$iContentId) + return false; + + $oGroupProfile = BxDolProfile::getInstanceByContentAndType($iContentId, $this->getName()); + if(!$oGroupProfile) + return false; + + $iStart = (int)bx_get('start'); + $iLimit = !empty($CNF['PARAM_NUM_CONNECTIONS_QUICK']) ? getParam($CNF['PARAM_NUM_CONNECTIONS_QUICK']) : 4; + if(!$iLimit) + $iLimit = 4; + + $aProfiles = $this->_oDb->getRoles([ + 'type' => 'fan_pids_by_group_pid', + 'group_profile_id' => $oGroupProfile->id(), + 'role' => $iRole, + 'start' => $iStart, + 'limit' => $iLimit + 1 + ]); + + if(empty($aProfiles) || !is_array($aProfiles)) + return false; + + return $this->_serviceBrowseQuick($aProfiles, $iStart, $iLimit); + } + + public function serviceBrowseJoinedEntries ($iProfileId = 0, $bDisplayEmptyMsg = false) + { + if (!$iProfileId) + $iProfileId = bx_process_input(bx_get('profile_id'), BX_DATA_INT); + if (!$iProfileId) + return ''; + + return $this->_serviceBrowse ('joined_entries', array('joined_profile' => $iProfileId), BX_DB_PADDING_DEF, $bDisplayEmptyMsg); + } + + public function serviceBrowseFollowedEntries ($iProfileId = 0, $bDisplayEmptyMsg = false) + { + if (!$iProfileId) + $iProfileId = bx_process_input(bx_get('profile_id'), BX_DATA_INT); + if (!$iProfileId) + return ''; + + return $this->_serviceBrowse ('followed_entries', array('followed_profile' => $iProfileId), BX_DB_PADDING_DEF, $bDisplayEmptyMsg); + } + + public function serviceBrowseCreatedEntries ($iProfileId = 0, $bDisplayEmptyMsg = false) + { + if (!$iProfileId) + $iProfileId = bx_process_input(bx_get('profile_id'), BX_DATA_INT); + if (!$iProfileId) + return ''; + + return $this->_serviceBrowse ('created_entries', array('author' => $iProfileId), BX_DB_PADDING_DEF, $bDisplayEmptyMsg); + } + + public function serviceBrowseRecommendationsFans ($iProfileId = 0, $aParams = []) + { + $CNF = &$this->_oConfig->CNF; + + if($this->_bIsApi) + $aParams = bx_api_get_browse_params($aParams, true); + + if(!$iProfileId) + $iProfileId = bx_get_logged_profile_id(); + if(!$iProfileId) + return ''; + + $aParams = array_merge([ + 'empty_message' => false, + 'start' => 0, + 'per_page' => 0 + ], $aParams); + + if(($iStartGet = bx_get('start')) !== false) + $aParams['start'] = (int)$iStartGet; + + if(($iPerPageGet = bx_get('per_page')) !== false) + $aParams['per_page'] = (int)$iPerPageGet; + + $oRecommendation = BxDolRecommendation::getObjectInstance($CNF['OBJECT_RECOMMENDATIONS_FANS']); + if(!$oRecommendation) + return false; + + if($this->_bIsApi) { + $aData = $oRecommendation->getCodeAPI($iProfileId, $aParams); + $aData = array_merge($aData, [ + 'module' => 'system', + 'unit' => 'mixed', + 'request_url' => '/api.php?r=bx_groups/browse_recommendations_fans¶ms[]=' . $iProfileId . '¶ms[]=' + ]); + + return [bx_api_get_block('browse', $aData)]; + } + + $sCode = $oRecommendation->getCode($iProfileId, $aParams); + if(!$sCode && $aParams['empty_message']) + $sCode = MsgBox(_t(!empty($aParams['empty_message_text']) ? $aParams['empty_message_text'] : '_Empty')); + + return $sCode; + } + + public function serviceBrowseMembers ($iProfileId = 0, $aParams = []) + { + $CNF = &$this->_oConfig->CNF; + + if(!$iProfileId) + $iProfileId = bx_process_input(bx_get('profile_id'), BX_DATA_INT); + if(!$iProfileId) + return ''; + + $oGroupProfile = BxDolProfile::getInstance($iProfileId); + if(!($oGroupProfile)) + return ''; + + return bx_srv('system', 'browse_members', [$oGroupProfile->id(), $CNF['OBJECT_CONNECTIONS'], $aParams], 'TemplServiceProfiles'); + } + + public function serviceEntityEditQuestionnaire($iProfileId = 0) + { + $CNF = &$this->_oConfig->CNF; + + if(!$iProfileId) + $iProfileId = bx_process_input(bx_get('profile_id'), BX_DATA_INT); + if(!$iProfileId) + return ''; + + $aProfileInfo = BxDolProfileQuery::getInstance()->getInfoById($iProfileId); + if(empty($aProfileInfo) || !is_array($aProfileInfo)) + return ''; + + $aContentInfo = $this->_oDb->getContentInfoById($aProfileInfo['content_id']); + if(empty($aContentInfo) || !is_array($aContentInfo)) + return ''; + + if($this->checkAllowedEdit($aContentInfo) !== CHECK_ACTION_RESULT_ALLOWED) + return MsgBox(_t('_Access denied')); + + $oGrid = BxDolGrid::getObjectInstance($CNF['OBJECT_GRID_QUESTIONS_MANAGE']); + if(!$oGrid) + return ''; + + if($this->_bIsApi){ + return [ + bx_api_get_block('grid', $oGrid->getCodeAPI()) + ]; + + } + + return $oGrid->getCode(); + } + + public function serviceEntityPricing($iProfileId = 0) + { + $CNF = &$this->_oConfig->CNF; + + if(!$iProfileId) + $iProfileId = bx_process_input(bx_get('profile_id'), BX_DATA_INT); + if(!$iProfileId) + return ''; + + if(!$this->_oConfig->isPaidJoin()) + return ''; + + $oPayments = BxDolPayments::getInstance(); + if(!$oPayments->isActive()) + return MsgBox(_t('_sys_payments_err_no_payments')); + + if($this->checkAllowedUsePaidJoin() !== CHECK_ACTION_RESULT_ALLOWED) + return MsgBox(_t('_Access denied')); + + if($this->checkAllowedManageAdmins($iProfileId) !== CHECK_ACTION_RESULT_ALLOWED) + return MsgBox(_t('_Access denied')); + + $oGrid = BxDolGrid::getObjectInstance($CNF['OBJECT_GRID_PRICES_MANAGE']); + if(!$oGrid) + return ''; + + $sNote = ''; + if(!$oPayments->isAcceptingPayments($this->_iProfileId)) + $sNote = MsgBox(_t('_sys_payments_err_not_accept_payments', $oPayments->getDetailsUrl())); + + return $sNote . $oGrid->getCode(); + } + + public function serviceEntityJoin($iProfileId = 0) + { + $CNF = &$this->_oConfig->CNF; + + if(!$iProfileId) + $iProfileId = bx_process_input(bx_get('profile_id'), BX_DATA_INT); + if(!$iProfileId) + return ''; + + if(!$this->_oConfig->isPaidJoin()) + return ''; + + $oGrid = BxDolGrid::getObjectInstance($CNF['OBJECT_GRID_PRICES_VIEW']); + if(!$oGrid) + return ''; + + return $oGrid->getCode(); + } + + public function serviceEntityInvite ($iContentId = 0, $bErrorMsg = true) + { + $CNF = &$this->_oConfig->CNF; + + if(!isset($CNF['OBJECT_FORM_ENTRY_DISPLAY_INVITE'])) + return false; + + return $this->_serviceEntityForm ('inviteForm', $iContentId, false, false, $bErrorMsg); + } + + /** + * Entry social sharing block + */ + public function serviceEntitySocialSharing ($mixedContent = false, $aParams = array()) + { + if(!empty($mixedContent)) { + if(!is_array($mixedContent)) + $mixedContent = array((int)$mixedContent, array()); + } + else { + $mixedContent = $this->_getContent(); + if($mixedContent === false) + return false; + } + + list($iContentId, $aContentInfo) = $mixedContent; + + $oGroupProfile = BxDolProfile::getInstanceByContentAndType((int)$iContentId, $this->getName()); + if(!$oGroupProfile) + return false; + + return parent::serviceEntitySocialSharing(array($iContentId, $aContentInfo), array( + 'title' => $oGroupProfile->getDisplayName() + )); + } + + public function serviceIsPricingAvaliable($iProfileId) + { + if(!$this->_oConfig->isPaidJoin()) + return false; + + if($this->checkAllowedUsePaidJoin() !== CHECK_ACTION_RESULT_ALLOWED) + return false; + + if($this->checkAllowedManageAdmins($iProfileId) !== CHECK_ACTION_RESULT_ALLOWED) + return false; + + return true; + } + + public function serviceIsPaidJoinAvaliable($iGroupProfileId, $iProfileId = 0) + { + return $this->isPaidJoinByProfileForProfile($iGroupProfileId, $iProfileId); + } + + public function serviceIsPaidJoinAvaliableByContent($iGroupContentId, $iProfileId = 0) + { + $oGroupProfile = BxDolProfile::getInstanceByContentAndType($iGroupContentId, $this->getName()); + if(!$oGroupProfile) + return false; + + return $this->isPaidJoinByProfileForProfile($oGroupProfile->id(), $iProfileId); + } + + public function serviceIsFreeJoinAvaliable($iGroupProfileId, $iProfileId = 0) + { + return !$this->isPaidJoinByProfileForProfile($iGroupProfileId, $iProfileId); + } + + public function serviceIsFreeJoinAvaliableByContent($iGroupContentId, $iProfileId = 0) + { + $oGroupProfile = BxDolProfile::getInstanceByContentAndType($iGroupContentId, $this->getName()); + if(!$oGroupProfile) + return false; + + return !$this->isPaidJoinByProfileForProfile($oGroupProfile->id(), $iProfileId); + } + + /** + * Is Paid Join enabled in the group and whether a profile can use it. + * + * @param type $iGroupProfileId - Group profile ID. + * @param type $iProfileId - Profile ID of the user who wants to join. + * @return boolean + */ + public function isPaidJoinByProfileForProfile($iGroupProfileId, $iProfileId = 0) + { + $CNF = &$this->_oConfig->CNF; + + if(empty($iProfileId)) + $iProfileId = $this->_iProfileId; + + if(BxDolConnection::getObjectInstance($CNF['OBJECT_CONNECTIONS'])->isConnected($iProfileId, $iGroupProfileId)) + return false; + + return $this->isPaidJoinByProfile($iGroupProfileId); + } + + /** + * Is Paid Join enabled as is and whether a group has pricing plans added. + * + * @param type $iGroupProfileId - Group profile ID. + * @return boolean + */ + public function isPaidJoinByProfile($iGroupProfileId) + { + if(!$this->_oConfig->isPaidJoin()) + return false; + + $aPrices = $this->_oDb->getPrices(array('type' => 'by_profile_id', 'profile_id' => $iGroupProfileId)); + if(empty($aPrices) || !is_array($aPrices)) + return false; + + return true; + } + + /** + * Integration with Payments. + */ + public function serviceGetPaymentData() + { + return $this->_aModule; + } + + public function serviceGetCartItem($mixedItemId) + { + $CNF = &$this->_oConfig->CNF; + + if(!$mixedItemId) + return array(); + + if(is_numeric($mixedItemId)) + $aItem = $this->_oDb->getPrices(array('type' => 'by_id', 'value' => (int)$mixedItemId)); + else + $aItem = $this->_oDb->getPrices(array('type' => 'by_name', 'value' => $mixedItemId)); + + if(empty($aItem) || !is_array($aItem)) + return array(); + + if(!$this->isPaidJoinByProfile($aItem['profile_id'])) + return array(); + + $oGroupProfile = BxDolProfile::getInstance($aItem['profile_id']); + if(!$oGroupProfile) + return array(); + + $aGroupProfile = $this->_oDb->getContentInfoById($oGroupProfile->getContentId()); + + $aRoles = BxDolFormQuery::getDataItems($CNF['OBJECT_PRE_LIST_ROLES']); + + $sTitle = ''; + if(!empty($aItem['period']) && !empty($aItem['period_unit'])) + $sTitle = _t($CNF['T']['txt_cart_item_title'], $oGroupProfile->getDisplayName(), $aRoles[$aItem['role_id']], $aItem['period'], $aItem['period_unit']); + else + $sTitle = _t($CNF['T']['txt_cart_item_title_lifetime'], $oGroupProfile->getDisplayName(), $aRoles[$aItem['role_id']]); + + return array ( + 'id' => $aItem['id'], + 'author_id' => $aGroupProfile[$CNF['FIELD_AUTHOR']], + 'name' => $aItem['name'], + 'title' => $sTitle, + 'description' => '', + 'url' => $oGroupProfile->getUrl(), + 'price_single' => $aItem['price'], + 'price_recurring' => $aItem['price'], + 'period_recurring' => $aItem['period'], + 'period_unit_recurring' => $aItem['period_unit'], + 'trial_recurring' => 0 + ); + } + + public function serviceGetCartItems($iSellerId) + { + $CNF = &$this->_oConfig->CNF; + + if(empty($iSellerId)) + return array(); + + $sModule = $this->getName(); + $aRoles = BxDolFormQuery::getDataItems($CNF['OBJECT_PRE_LIST_ROLES']); + + $aGroups = $this->_oDb->getEntriesBy(array('type' => 'author', 'author' => $iSellerId)); + + $aResult = array(); + foreach($aGroups as $aGroup) { + $oGroupProfile = BxDolProfile::getInstanceByContentAndType($aGroup[$CNF['FIELD_ID']], $sModule); + if(!$oGroupProfile) + continue; + + $aPrices = $this->_oDb->getPrices(array('type' => 'by_profile_id', 'profile_id' => $oGroupProfile->id())); + if(empty($aPrices) || !is_array($aPrices)) + continue; + + $sTitle = $oGroupProfile->getDisplayName(); + $sUrl = $oGroupProfile->getUrl(); + + foreach($aPrices as $aPrice) + $aResult[] = array( + 'id' => $aPrice['id'], + 'author_id' => $iSellerId, + 'name' => $aPrice['name'], + 'title' => _t($CNF['T']['txt_cart_item_title'], $sTitle, $aRoles[$aPrice['role_id']], $aPrice['period'], $aPrice['period_unit']), + 'description' => '', + 'url' => $sUrl, + 'price_single' => $aPrice['price'], + 'price_recurring' => $aPrice['price'], + 'period_recurring' => $aPrice['period'], + 'period_unit_recurring' => $aPrice['period_unit'] + ); + } + + return $aResult; + } + + public function serviceRegisterCartItem($iClientId, $iSellerId, $iItemId, $iItemCount, $sOrder, $sLicense) + { + return $this->_serviceRegisterItem($iClientId, $iSellerId, $iItemId, $iItemCount, $sOrder); + } + + public function serviceRegisterSubscriptionItem($iClientId, $iSellerId, $iItemId, $iItemCount, $sOrder, $sLicense) + { + return $this->_serviceRegisterItem($iClientId, $iSellerId, $iItemId, $iItemCount, $sOrder); + } + + public function serviceReregisterCartItem($iClientId, $iSellerId, $iItemIdOld, $iItemIdNew, $sOrder) + { + return $this->_serviceReregisterItem($iClientId, $iSellerId, $iItemIdOld, $iItemIdNew, $sOrder); + } + + public function serviceReregisterSubscriptionItem($iClientId, $iSellerId, $iItemIdOld, $iItemIdNew, $sOrder) + { + return $this->_serviceReregisterItem($iClientId, $iSellerId, $iItemIdOld, $iItemIdNew, $sOrder); + } + + public function serviceUnregisterCartItem($iClientId, $iSellerId, $iItemId, $iItemCount, $sOrder, $sLicense) + { + return $this->_serviceUnregisterItem($iClientId, $iSellerId, $iItemId, $iItemCount, $sOrder); + } + + public function serviceUnregisterSubscriptionItem($iClientId, $iSellerId, $iItemId, $iItemCount, $sOrder, $sLicense) + { + return $this->_serviceUnregisterItem($iClientId, $iSellerId, $iItemId, $iItemCount, $sOrder); + } + + public function serviceCancelSubscriptionItem($iClientId, $iSellerId, $iItemId, $iItemCount, $sOrder) + { + return true; + } + + protected function _serviceRegisterItem($iClientId, $iSellerId, $iItemId, $iItemCount, $sOrder) + { + $CNF = &$this->_oConfig->CNF; + + $aItem = $this->serviceGetCartItem($iItemId); + if(empty($aItem) || !is_array($aItem)) + return array(); + + $aItemInfo = $this->_oDb->getPrices(array('type' => 'by_id', 'value' => $iItemId)); + + $mixedPeriod = false; + if((int)$aItemInfo['period'] != 0) + $mixedPeriod = array( + 'period' => (int)$aItemInfo['period'], + 'period_unit' => $aItemInfo['period_unit'], + 'period_reserve' => $CNF['PARAM_RECURRING_RESERVE'] + ); + + if(!$this->setRole($aItemInfo['profile_id'], $iClientId, $aItemInfo['role_id'], $mixedPeriod, $sOrder)) + return array(); + + return $aItem; + } + + protected function _serviceReregisterItem($iClientId, $iSellerId, $iItemIdOld, $iItemIdNew, $sOrder) + { + $aItem = $this->serviceGetCartItem($iItemIdNew); + if(empty($aItem) || !is_array($aItem)) + return array(); + + $aItemInfoOld = $this->_oDb->getPrices(array('type' => 'by_id', 'value' => $iItemIdOld)); + if(empty($aItemInfoOld) || !is_array($aItemInfoOld)) + return array(); + + $aItemInfoNew = $this->_oDb->getPrices(array('type' => 'by_id', 'value' => $iItemIdNew)); + if(empty($aItemInfoNew) || !is_array($aItemInfoNew)) + return array(); + + if(!$this->unsetRole($aItemInfoOld['profile_id'], $iClientId)) + return array(); + + $aResult = $this->_serviceRegisterItem($iClientId, $iSellerId, $iItemIdNew, 1, $sOrder); + if(empty($aResult) || !is_array($aResult)) + return array(); + + return $aItem; + } + + protected function _serviceUnregisterItem($iClientId, $iSellerId, $iItemId, $iItemCount, $sOrder) + { + $aItemInfo = $this->_oDb->getPrices(array('type' => 'by_id', 'value' => $iItemId)); + if(empty($aItemInfo) || !is_array($aItemInfo)) + return false; + + return $this->unsetRole($aItemInfo['profile_id'], $iClientId); + } + + public function serviceGetQuestionnaire($sSource, $sObject, $sAction, $iContentProfileId) + { + $CNF = &$this->_oConfig->CNF; + $sMsg = _t('_sys_txt_not_found'); + + $aContentInfo = $this->_oDb->getContentInfoByProfileId($iContentProfileId); + if(empty($aContentInfo) || !is_array($aContentInfo)) + return $this->_bIsApi ? [bx_api_get_msg($sMsg)] : ['code' => 1, 'msg' => $sMsg]; + + $oForm = null; + if(($oConnection = BxDolConnection::getObjectInstance($sObject)) !== false) { + $oForm = $oConnection->getQuestionnaireForm($sAction, $iContentProfileId, ['request' => [ + 's' => $sSource, + ]]); + + if($oForm === false) + return $this->_bIsApi ? [bx_api_get_msg($sMsg)] : ['code' => 3, 'msg' => $sMsg]; + } + else + return $this->_bIsApi ? [bx_api_get_msg($sMsg)] : ['code' => 2, 'msg' => $sMsg]; + + $oForm->initChecker(); + if($oForm->isSubmittedAndValid()) { + $iProfileId = bx_get_logged_profile_id(); + + $aQuestions = $this->_oDb->getQuestions(['sample' => 'content_pid', 'content_pid' => $iContentProfileId]); + foreach($aQuestions as $aQuestion) + $this->_oDb->insertAnswer((int)$aQuestion['id'], $iProfileId, $oForm->getCleanValue('question_' . $aQuestion['id'])); + + return $this->_bIsApi ? [] : ['code' => 0, 'o' => $sObject, 'a' => $sAction, 'cpi' => $iContentProfileId, 'ci' => $aContentInfo[$CNF['FIELD_ID']], 'eval' => $this->_oConfig->getJsObject($sSource) . '.connActionPerformed(oData)']; + } + + if($this->_bIsApi) + return [bx_api_get_block('form', $oForm->getCodeAPI(), ['ext' => [ + 'name' => $this->_oModule->getName(), + 'request' => ['url' => $oForm->aFormAttrs['action'], 'immutable' => true]] + ])]; + + bx_import('BxTemplFunctions'); + $sContent = BxTemplFunctions::getInstance()->popupBox($this->_oConfig->getHtmlIds('popup_questionnaire'), _t($CNF['T']['popup_title_questionnaire']), $this->_oTemplate->parseHtmlByName('popup_qnr_questionnaire.html', [ + 'form_id' => $oForm->getId(), + 'form' => $oForm->getCode(true), + ])); + + return ['popup' => ['html' => $sContent, 'options' => ['closeOnOuterClick' => false]]]; + } + + /** + * Data for Notifications module + */ + public function serviceGetNotificationsData() + { + $sModule = $this->_aModule['name']; + + $aSettingsTypes = ['follow_member', 'follow_context']; + if($this->serviceActAsProfile()) + $aSettingsTypes = ['personal', 'follow_member']; + + return [ + 'handlers' => [ + ['group' => $sModule . '_vote', 'type' => 'insert', 'alert_unit' => $sModule, 'alert_action' => 'doVote', 'module_name' => $sModule, 'module_method' => 'get_notifications_vote', 'module_class' => 'Module'], + ['group' => $sModule . '_vote', 'type' => 'delete', 'alert_unit' => $sModule, 'alert_action' => 'undoVote'], + + ['group' => $sModule . '_score_up', 'type' => 'insert', 'alert_unit' => $sModule, 'alert_action' => 'doVoteUp', 'module_name' => $sModule, 'module_method' => 'get_notifications_score_up', 'module_class' => 'Module'], + + ['group' => $sModule . '_score_down', 'type' => 'insert', 'alert_unit' => $sModule, 'alert_action' => 'doVoteDown', 'module_name' => $sModule, 'module_method' => 'get_notifications_score_down', 'module_class' => 'Module'], + + ['group' => $sModule . '_fan_added', 'type' => 'insert', 'alert_unit' => $sModule, 'alert_action' => 'fan_added', 'module_name' => $sModule, 'module_method' => 'get_notifications_fan_added', 'module_class' => 'Module'], + + ['group' => $sModule . '_join_invitation', 'type' => 'insert', 'alert_unit' => $sModule, 'alert_action' => 'join_invitation_notif', 'module_name' => $sModule, 'module_method' => 'get_notifications_join_invitation', 'module_class' => 'Module'], + + ['group' => $sModule . '_join_request', 'type' => 'insert', 'alert_unit' => $sModule, 'alert_action' => 'join_request', 'module_name' => $sModule, 'module_method' => 'get_notifications_join_request', 'module_class' => 'Module', 'module_event_privacy' => $this->_oConfig->CNF['OBJECT_PRIVACY_VIEW_NOTIFICATION_EVENT']], + + ['group' => $sModule . '_timeline_post_common', 'type' => 'insert', 'alert_unit' => $sModule, 'alert_action' => 'timeline_post_common', 'module_name' => $sModule, 'module_method' => 'get_notifications_timeline_post_common', 'module_class' => 'Module'], + + //--- Moderation related: For 'admins'. + ['group' => $sModule . '_object_pending_approval', 'type' => 'insert', 'alert_unit' => $sModule, 'alert_action' => 'pending_approval', 'module_name' => $sModule, 'module_method' => 'get_notifications_post_pending_approval', 'module_class' => 'Module'], + ], + 'settings' => [ + ['group' => 'vote', 'unit' => $sModule, 'action' => 'doVote', 'types' => $aSettingsTypes], + + ['group' => 'score_up', 'unit' => $sModule, 'action' => 'doVoteUp', 'types' => $aSettingsTypes], + + ['group' => 'score_down', 'unit' => $sModule, 'action' => 'doVoteDown', 'types' => $aSettingsTypes], + + ['group' => 'fan', 'unit' => $sModule, 'action' => 'fan_added', 'types' => $aSettingsTypes], + + ['group' => 'invite', 'unit' => $sModule, 'action' => 'join_invitation_notif', 'types' => ['personal']], + + ['group' => 'join', 'unit' => $sModule, 'action' => 'join_request', 'types' => $aSettingsTypes], + + ['group' => 'timeline_post', 'unit' => $sModule, 'action' => 'timeline_post_common', 'types' => $aSettingsTypes], + + //--- Moderation related: For 'admins'. + ['group' => 'action_required', 'unit' => $sModule, 'action' => 'pending_approval', 'types' => ['personal']], + ], + 'alerts' => [ + ['unit' => $sModule, 'action' => 'doVote'], + ['unit' => $sModule, 'action' => 'undoVote'], + + ['unit' => $sModule, 'action' => 'doVoteUp'], + ['unit' => $sModule, 'action' => 'doVoteDown'], + + ['unit' => $sModule, 'action' => 'fan_added'], + + ['unit' => $sModule, 'action' => 'join_invitation_notif'], + + ['unit' => $sModule, 'action' => 'join_request'], + + ['unit' => $sModule, 'action' => 'timeline_post_common'], + + //--- Moderation related: For 'admins'. + ['unit' => $sModule, 'action' => 'pending_approval'], + ] + ]; + } + + public function serviceGetNotificationsInsertData($oAlert, $aHandler, $aDataItems) + { + if($oAlert->sAction != 'join_invitation_notif' || empty($aDataItems) || !is_array($aDataItems)) + return $aDataItems; + + foreach($aDataItems as $iIndex => $aDataItem) + $aDataItems[$iIndex]['object_privacy_view'] = BX_DOL_PG_ALL; + + return $aDataItems; + } + + /** + * Notification about new invitation to join the group + */ + public function serviceGetNotificationsJoinInvitation($aEvent) + { + $CNF = &$this->_oConfig->CNF; + + $iContentId = (int)$aEvent['object_id']; + $oGroupProfile = BxDolProfile::getInstanceByContentAndType((int)$iContentId, $this->getName()); + if(!$oGroupProfile) + return array(); + + $aContentInfo = $this->_oDb->getContentInfoById($iContentId); + if(empty($aContentInfo) || !is_array($aContentInfo)) + return array(); + + /* + * It's essential that 'object_owner_id' contains invited member profile id. + */ + $oProfile = BxDolProfile::getInstance((int)$aEvent['object_owner_id']); + if(!$oProfile) + return array(); + + /* + * Note. Group Profile URL is used for both Entry and Subentry URLs, + * because Subentry URL has higher display priority and notification + * should be linked to Group Profile (Group Profile -> Members tab) + * instead of Personal Profile of invited member. + */ + $sEntryUrl = bx_absolute_url(str_replace(BX_DOL_URL_ROOT, '', $oGroupProfile->getUrl()), '{bx_url_root}'); + + return array( + 'entry_sample' => $CNF['T']['txt_sample_single'], + 'entry_url' => $sEntryUrl, + 'entry_caption' => $oGroupProfile->getDisplayName(), + 'subentry_sample' => $oProfile->getDisplayName(), + 'subentry_url' => $sEntryUrl, + 'lang_key' => $this->_oConfig->CNF['T']['txt_ntfs_join_invitation'] + ); + } + + /** + * Notification about new member requst in the group + */ + public function serviceGetNotificationsJoinRequest($aEvent) + { + return $this->_serviceGetNotification($aEvent, 'join_request', $this->_oConfig->CNF['T']['txt_ntfs_join_request']); + } + + /** + * Notification about new member in the group + */ + public function serviceGetNotificationsFanAdded($aEvent) + { + return $this->_serviceGetNotification($aEvent, 'fan_added', $this->_oConfig->CNF['T']['txt_ntfs_fan_added']); + } + + protected function _serviceGetNotification($aEvent, $sType, $sLangKey) + { + $CNF = &$this->_oConfig->CNF; + + $iContentId = (int)$aEvent['object_id']; + $oGroupProfile = BxDolProfile::getInstanceByContentAndType((int)$iContentId, $this->getName()); + if(!$oGroupProfile) + return array(); + + $aContentInfo = $this->_oDb->getContentInfoById($iContentId); + if(empty($aContentInfo) || !is_array($aContentInfo)) + return array(); + + $oProfile = BxDolProfile::getInstance((int)$aEvent['subobject_id']); + if(!$oProfile) + return array(); + + $iGroupProfileId = $oGroupProfile->id(); + + /* + * Note. Group Profile URL is used for both Entry and Subentry URLs, + * because Subentry URL has higher display priority and notification + * should be linked to Group Profile (Group Profile -> Members tab or Manage page) + * instead of Personal Profile of a member, who performed an action. + */ + if($sType == 'join_request' && !empty($CNF['URL_ENTRY_MANAGE'])) + $sEntryUrl = bx_absolute_url(BxDolPermalinks::getInstance()->permalink($CNF['URL_ENTRY_MANAGE'], [ + 'profile_id' => $iGroupProfileId + ]), '{bx_url_root}'); + else if(!empty($CNF['URL_ENTRY_FANS'])) + $sEntryUrl = bx_absolute_url(BxDolPermalinks::getInstance()->permalink($CNF['URL_ENTRY_FANS'], [ + 'profile_id' => $iGroupProfileId + ]), '{bx_url_root}'); + else + $sEntryUrl = bx_absolute_url(str_replace(BX_DOL_URL_ROOT, '', $oGroupProfile->getUrl()), '{bx_url_root}'); + + return [ + 'entry_sample' => $CNF['T']['txt_sample_single'], + 'entry_url' => $sEntryUrl, + 'entry_caption' => $oGroupProfile->getDisplayName(), + 'entry_author' => $iGroupProfileId, + 'subentry_sample' => $oProfile->getDisplayName(), + 'subentry_url' => $sEntryUrl, + 'lang_key' => $sLangKey + ]; + } + + /** + * Data for Timeline module + */ + public function serviceGetTimelineData() + { + $aResult = BxBaseModGeneralModule::serviceGetTimelineData(); + + $sModule = $this->_aModule['name']; + $aResult['handlers'] = array_merge($aResult['handlers'], [ + ['group' => $sModule . '_object', 'type' => 'update', 'alert_unit' => $sModule, 'alert_action' => 'context_cover_changed'], + ['group' => $sModule . '_object', 'type' => 'update', 'alert_unit' => $sModule, 'alert_action' => 'context_cover_deleted'] + ]); + $aResult['alerts'] = array_merge($aResult['alerts'], [ + ['unit' => $sModule, 'action' => 'context_cover_changed'], + ['unit' => $sModule, 'action' => 'context_cover_deleted'] + ]); + + return $aResult; + } + + /** + * Entry post for Timeline module + */ + public function serviceGetTimelinePost($aEvent, $aBrowseParams = array()) + { + $CNF = &$this->_oConfig->CNF; + + $a = parent::serviceGetTimelinePost($aEvent, $aBrowseParams); + if($a === false) + return false; + + $oGroupProfile = BxDolProfile::getInstanceByContentAndType($aEvent['object_id'], $this->getName()); + $a['content']['url'] = $oGroupProfile->getUrl(); + $a['content']['title'] = $oGroupProfile->getDisplayName(); + + $oConnection = BxDolConnection::getObjectInstance($CNF['OBJECT_CONNECTIONS']); + if($oConnection) + $a['content']['members'] = $oConnection->getConnectedInitiatorsCount($oGroupProfile->id(), true); + + if(isset($aEvent['object_privacy_view'])) + $a['content']['visibility'] = $aEvent['object_privacy_view']; + + if(isset($CNF['FIELD_PUBLISHED'])) { + $aContentInfo = $this->_oDb->getContentInfoById($aEvent['object_id']); + if($aContentInfo[$CNF['FIELD_PUBLISHED']] > $a['date']) + $a['date'] = $aContentInfo[$CNF['FIELD_PUBLISHED']]; + } + + return $a; + } + + + // ====== PERMISSION METHODS + /** + * @return CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. + */ + public function checkAllowedUsePaidJoin($isPerformAction = false) + { + // check ACL + $aCheck = checkActionModule($this->_iProfileId, 'use paid join', $this->getName(), $isPerformAction); + if($aCheck[CHECK_ACTION_RESULT] !== CHECK_ACTION_RESULT_ALLOWED) + return $aCheck[CHECK_ACTION_MESSAGE]; + + return CHECK_ACTION_RESULT_ALLOWED; + } + + /** + * @return CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. + */ + public function checkAllowedView ($aDataEntry, $isPerformAction = false) + { + return $this->serviceCheckAllowedViewForProfile ($aDataEntry, $isPerformAction); + } + + public function serviceCheckAllowedViewForProfile ($aDataEntry, $isPerformAction = false, $iProfileId = false) + { + $CNF = &$this->_oConfig->CNF; + + $iGroupContentId = (int)$aDataEntry[$CNF['FIELD_ID']]; + + $bInvited = false; + if(!empty($CNF['TABLE_INVITES'])) { + $iGroupProfileId = BxDolProfile::getInstanceByContentAndType($iGroupContentId, $this->getName())->id(); + + if(($sKey = bx_get('key')) !== false) { + $mixedInvited = $this->isInvited($sKey, $iGroupProfileId); + if($mixedInvited === true) + $bInvited = true; + } + else { + $mixedInvited = $this->isInvitedByProfileId($iProfileId ? $iProfileId : bx_get_logged_profile_id(), $iGroupProfileId); + if($mixedInvited === true) + $bInvited = true; + } + } + + if ($this->isFan($iGroupContentId, $iProfileId) || $bInvited) + return CHECK_ACTION_RESULT_ALLOWED; + + return parent::serviceCheckAllowedViewForProfile ($aDataEntry, $isPerformAction, $iProfileId); + } + + /** + * @return CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. + */ + public function checkAllowedCompose(&$aDataEntry, $isPerformAction = false) + { + if(!$this->isFan($aDataEntry[$this->_oConfig->CNF['FIELD_ID']])) + return _t('_sys_txt_access_denied'); + + return parent::checkAllowedCompose ($aDataEntry, $isPerformAction); + } + + /** + * @return CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. + */ + public function checkAllowedFanAdd(&$aDataEntry, $isPerformAction = false) + { + $mixedResult = $this->_modGroupsCheckAllowedFanAdd($aDataEntry, $isPerformAction); + + /** + * @hooks + * @hookdef hook-system-check_allowed_fan_add 'system', 'check_allowed_fan_add' - hook to override the result of checking whether 'fan add' to context action is allowed or not to currently logged in user + * - $unit_name - equals `system` + * - $action - equals `check_allowed_fan_add` + * - $object_id - not used + * - $sender_id - not used + * - $extra_params - array of additional params with the following array keys: + * - `module` - [string] module name + * - `content_info` - [array] context info array as key&value pairs + * - `profile_id` - [int] currently logged in profile id to be checked the availability of the action to + * - `override_result` - [string] or [int] by ref, check action result, can be overridden in hook processing. Return string with an error if action isn't allowed or CHECK_ACTION_RESULT_ALLOWED, @see BxDolAcl + * @hook @ref hook-system-check_allowed_fan_add + */ + bx_alert('system', 'check_allowed_fan_add', 0, 0, [ + 'module' => $this->getName(), + 'content_info' => $aDataEntry, + 'profile_id' => bx_get_logged_profile_id(), + 'override_result' => &$mixedResult + ]); + + return $mixedResult; + } + + public function _modGroupsCheckAllowedFanAdd (&$aDataEntry, $isPerformAction = false) + { + if ($this->isFan($aDataEntry[$this->_oConfig->CNF['FIELD_ID']]) || !isLogged()) + return _t('_sys_txt_access_denied'); + + return $this->_checkAllowedConnect ($aDataEntry, $isPerformAction, $this->_oConfig->CNF['OBJECT_CONNECTIONS'], false, false); + } + + /** + * @return CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. + */ + public function checkAllowedFanRemove (&$aDataEntry, $isPerformAction = false) + { + if (CHECK_ACTION_RESULT_ALLOWED === $this->_checkAllowedConnect ($aDataEntry, $isPerformAction, $this->_oConfig->CNF['OBJECT_CONNECTIONS'], false, true, true)) + return CHECK_ACTION_RESULT_ALLOWED; + return $this->_checkAllowedConnect ($aDataEntry, $isPerformAction, $this->_oConfig->CNF['OBJECT_CONNECTIONS'], false, true, false); + } + + protected function _checkAllowedActionByFan($sAction, $aDataEntry, $iProfileId = 0) + { + $CNF = &$this->_oConfig->CNF; + + $bRoles = $this->_oConfig->isRoles(); + if(empty($iProfileId)) + $iProfileId = bx_get_logged_profile_id(); + + $oGroupProfile = BxDolProfile::getInstanceByContentAndType($aDataEntry[$CNF['FIELD_ID']], $this->getName()); + if(!$oGroupProfile) + return $sAction == BX_BASE_MOD_GROUPS_ACTION_DELETE ? CHECK_ACTION_RESULT_ALLOWED : _t('_sys_txt_not_found'); + + $iGroupProfileId = $oGroupProfile->id(); + + if(!$bRoles && $this->_oDb->isAdmin($iGroupProfileId, $iProfileId, $aDataEntry)) + return CHECK_ACTION_RESULT_ALLOWED; + + if($bRoles && $this->isAllowedActionByRole($sAction, $aDataEntry, $iGroupProfileId, $iProfileId)) + return CHECK_ACTION_RESULT_ALLOWED; + + return _t('_sys_txt_access_denied'); + } + + public function isAllowedActionByRole($mAction, $aDataEntry, $iGroupProfileId, $iProfileId) + { + $iProfileRole = $this->_oDb->getRole($iGroupProfileId, $iProfileId); + + if (is_array($mAction)) { + $sAction = $mAction['action']; + $sActionModule = $mAction['module']; + } else { + $sAction = $mAction; + $sActionModule = $this->getName(); + } + + $bResult = false; + if($iProfileId) + $bResult = $this->isAllowedModuleActionByRole($sActionModule, $sAction, $iProfileRole); + + // in case neither of the profile's roles are having permissions set explicitly then fallback to an old way + if ($bResult === NULL) { + $bResult = false; + if($this->isFanByGroupProfileId($iGroupProfileId)) { + switch ($sAction) { + case BX_BASE_MOD_GROUPS_ACTION_DELETE: + case BX_BASE_MOD_GROUPS_ACTION_EDIT: + case BX_BASE_MOD_GROUPS_ACTION_CHANGE_COVER: + case BX_BASE_MOD_GROUPS_ACTION_MANAGE_ROLES: + if($this->isRole($iProfileRole, BX_BASE_MOD_GROUPS_ROLE_ADMINISTRATOR)) + $bResult = true; + break; + + case BX_BASE_MOD_GROUPS_ACTION_MANAGE_FANS: + case BX_BASE_MOD_GROUPS_ACTION_INVITE: + case BX_BASE_MOD_GROUPS_ACTION_EDIT_CONTENT: + case BX_BASE_MOD_GROUPS_ACTION_DELETE_CONTENT: + case BX_BASE_MOD_GROUPS_ACTION_TIMELINE_POST_PIN: + if($this->isRole($iProfileRole, BX_BASE_MOD_GROUPS_ROLE_ADMINISTRATOR) || $this->isRole($iProfileRole, BX_BASE_MOD_GROUPS_ROLE_MODERATOR)) + $bResult = true; + break; + + default: + $bResult = true; + } + } + } + + /** + * @hooks + * @hookdef hook-system-check_allowed_action_by_role 'system', 'check_allowed_action_by_role' - hook to override the result of checking whether an action is allowed or not to context member by his role in the context + * - $unit_name - equals `system` + * - $action - equals `check_allowed_action_by_role` + * - $object_id - not used + * - $sender_id - not used + * - $extra_params - array of additional params with the following array keys: + * - `module` - [string] module name + * - `multi_roles` - [boolean] whether multi roles are enabled in context or not + * - `action` - [string] action to be checked + * - `action_module` - [string] module name which the action belongs to + * - `content_profile_id` - [int] context profile id + * - `content_info` - [array] context info array as key&value pairs + * - `profile_id` - [int] profile id to be checked the availability of the action to + * - `profile_role` - [int] profile role in the context + * - `override_result` - [boolean] by ref, check action result, can be overridden in hook processing. + * @hook @ref hook-system-check_allowed_action_by_role + */ + bx_alert('system', 'check_allowed_action_by_role', 0, 0, [ + 'module' => $this->getName(), + 'multi_roles' => $this->_oConfig->isMultiRoles(), + 'action' => $sAction, + 'action_module' => $sActionModule, + 'content_profile_id' => $iGroupProfileId, + 'content_info' => $aDataEntry, + 'profile_id' => $iProfileId, + 'profile_role' => $iProfileRole, + 'override_result' => &$bResult + ]); + + return $bResult; + } + + public function isAllowedModuleActionByRole($sModule, $sAction, $iProfileRole) + { + static $aRoles; + + if (!$aRoles && isset($this->_oConfig->CNF['OBJECT_PRE_LIST_ROLES']) && !empty($this->_oConfig->CNF['OBJECT_PRE_LIST_ROLES'])) + $aRoles = BxBaseFormView::getDataItems($this->_oConfig->CNF['OBJECT_PRE_LIST_ROLES'], true, BX_DATA_VALUES_ALL); + + if ($aRoles) { + foreach ($aRoles as $iRole => $aRoleData) { + if ($iRole == 0 && $iProfileRole == 0 || $iRole > 0 && $this->isRole($iProfileRole, $iRole)) { + $mPermissions = isset($aRoles[$iRole]) && isset($aRoles[$iRole]['Data']) && !empty($aRoles[$iRole]['Data']) ? unserialize($aRoles[$iRole]['Data']) : false; + if ($mPermissions && isset($mPermissions[$sModule])) { + return isset($mPermissions[$sModule][$sAction]) && $mPermissions[$sModule][$sAction]; + } + } + } + } + + return NULL; + } + + public function isAllowedModuleActionByProfile($iContentId, $sPostModule, $sAction, $iProfileId = 0) { + if (!$iProfileId) $iProfileId = bx_get_logged_profile_id(); + + if ($iProfileId && $this->isFan($iContentId, $iProfileId)) { + $sModuleName = $this->getName(); + $oGroupProfile = BxDolProfile::getInstanceByContentAndType($iContentId, $sModuleName); + $aDataEntry = $this->_oDb->getContentInfoById($iContentId); + $bResult = $this->isAllowedActionByRole(['action' => $sAction, 'module' => $sPostModule], $aDataEntry, $oGroupProfile->id(), $iProfileId); + + if ($bResult === true) return CHECK_ACTION_RESULT_ALLOWED; + if ($bResult === false) return _t('_sys_txt_access_denied'); + } + + return NULL; //undefined, because the profile is either not a fan or his role is not having permissions defined. So process the default way then. + } + + public function isRole($iProfileRole, $iRole) + { + if(!$this->_oConfig->isMultiRoles()) + return $iProfileRole == $iRole; + else + return $iProfileRole & (1 << ($iRole - 1)); + } + + public function serviceIsRole($iProfileRole, $iRole) + { + return $this->isRole($iProfileRole, $iRole); + } + + public function checkAllowedManageFans($mixedDataEntry, $isPerformAction = false) + { + $aDataEntry = array(); + if(!is_array($mixedDataEntry)) { + $oGroupProfile = BxDolProfile::getInstance((int)$mixedDataEntry); + if($oGroupProfile && $this->getName() == $oGroupProfile->getModule()) + $aDataEntry = $this->_oDb->getContentInfoById($oGroupProfile->getContentId()); + } + else + $aDataEntry = $mixedDataEntry; + + if($this->_checkAllowedActionByFan(BX_BASE_MOD_GROUPS_ACTION_MANAGE_FANS, $aDataEntry) === CHECK_ACTION_RESULT_ALLOWED) + return CHECK_ACTION_RESULT_ALLOWED; + + return parent::checkAllowedEdit($aDataEntry, $isPerformAction); + } + + public function checkAllowedManageAdmins($mixedDataEntry, $isPerformAction = false) + { + $aDataEntry = array(); + if(!is_array($mixedDataEntry)) { + $oGroupProfile = BxDolProfile::getInstance((int)$mixedDataEntry); + if($oGroupProfile && $this->getName() == $oGroupProfile->getModule()) + $aDataEntry = $this->_oDb->getContentInfoById($oGroupProfile->getContentId()); + } + else + $aDataEntry = $mixedDataEntry; + + if($this->_checkAllowedActionByFan(BX_BASE_MOD_GROUPS_ACTION_MANAGE_ROLES, $aDataEntry) === CHECK_ACTION_RESULT_ALLOWED) + return CHECK_ACTION_RESULT_ALLOWED; + + return parent::checkAllowedEdit($aDataEntry, $isPerformAction); + } + + public function checkAllowedEdit($aDataEntry, $isPerformAction = false) + { + if($this->_checkAllowedActionByFan(BX_BASE_MOD_GROUPS_ACTION_EDIT, $aDataEntry) === CHECK_ACTION_RESULT_ALLOWED) + return CHECK_ACTION_RESULT_ALLOWED; + + return parent::checkAllowedEdit($aDataEntry, $isPerformAction); + } + + public function checkAllowedInvite($aDataEntry, $isPerformAction = false) + { + if($this->_checkAllowedActionByFan(BX_BASE_MOD_GROUPS_ACTION_INVITE, $aDataEntry) === CHECK_ACTION_RESULT_ALLOWED) + return CHECK_ACTION_RESULT_ALLOWED; + + return parent::checkAllowedEdit($aDataEntry, $isPerformAction); + } + + public function checkAllowedChangeCover($aDataEntry, $isPerformAction = false) + { + if($this->_checkAllowedActionByFan(BX_BASE_MOD_GROUPS_ACTION_CHANGE_COVER, $aDataEntry) === CHECK_ACTION_RESULT_ALLOWED) + return CHECK_ACTION_RESULT_ALLOWED; + + return parent::checkAllowedChangeCover($aDataEntry, $isPerformAction); + } + + public function checkAllowedDelete(&$aDataEntry, $isPerformAction = false) + { + if($this->_checkAllowedActionByFan(BX_BASE_MOD_GROUPS_ACTION_DELETE, $aDataEntry) === CHECK_ACTION_RESULT_ALLOWED) + return CHECK_ACTION_RESULT_ALLOWED; + + return parent::checkAllowedDelete($aDataEntry, $isPerformAction); + } + + public function checkAllowedJoin(&$aDataEntry, $isPerformAction = false) + { + if (bx_get('key')){ + $sKey = bx_get('key'); + $oGroupProfile = BxDolProfile::getInstanceByContentAndType($aDataEntry[$this->_oConfig->CNF['FIELD_ID']], $this->getName()); + $aData = $this->_oDb->getInviteByKey($sKey, $oGroupProfile->id()); + if (isset($aData['invited_profile_id']) && $aData['invited_profile_id'] == bx_get_logged_profile_id()){ + return CHECK_ACTION_RESULT_ALLOWED; + } + } + return _t('_sys_txt_access_denied'); + } + + public function checkAllowedSubscribeAdd(&$aDataEntry, $isPerformAction = false) + { + $mixedResult = $this->_modGroupsCheckAllowedSubscribeAdd($aDataEntry, $isPerformAction); + + /** + * @hooks + * @hookdef hook-system-check_allowed_subscribe_add 'system', 'check_allowed_subscribe_add' - hook to override the result of checking whether currently logged in user can subscribe (follow) the context or not + * - $unit_name - equals `system` + * - $action - equals `check_allowed_subscribe_add` + * - $object_id - not used + * - $sender_id - not used + * - $extra_params - array of additional params with the following array keys: + * - `module` - [string] module name + * - `content_info` - [array] context info array as key&value pairs + * - `profile_id` - [int] currently logged in profile id to be checked the availability of the action to + * - `override_result` - [string] or [int] by ref, check action result, can be overridden in hook processing. Return string with an error if action isn't allowed or CHECK_ACTION_RESULT_ALLOWED, @see BxDolAcl + * @hook @ref hook-system-check_allowed_subscribe_add + */ + bx_alert('system', 'check_allowed_subscribe_add', 0, 0, [ + 'module' => $this->getName(), + 'content_info' => $aDataEntry, + 'profile_id' => bx_get_logged_profile_id(), + 'override_result' => &$mixedResult + ]); + + return $mixedResult; + } + + /** + * Note. Is mainly needed for internal usage. Access level is 'public' to allow outer calls from alerts. + */ + public function _modGroupsCheckAllowedSubscribeAdd(&$aDataEntry, $isPerformAction = false) + { + $CNF = &$this->_oConfig->CNF; + + if(!$this->isFan($aDataEntry[$CNF['FIELD_ID']]) && (!isset($CNF['PARAM_SBS_WO_JOIN']) || getParam($CNF['PARAM_SBS_WO_JOIN']) != 'on')) + return _t('_sys_txt_access_denied'); + + return parent::_modProfileCheckAllowedSubscribeAdd($aDataEntry, $isPerformAction); + } + + /** + * @deprecated since version 11.0.3 and can be removed in the next version. + */ + public function _checkAllowedSubscribeAdd (&$aDataEntry, $isPerformAction = false) + { + return parent::checkAllowedSubscribeAdd ($aDataEntry, $isPerformAction); + } + + public function doAudit($iGroupProfileId, $iFanId, $sAction) + { + $oProfile = BxDolProfile::getInstance($iFanId); + + $iContentId = $oProfile->getContentId(); + $sModule = $oProfile->getModule(); + $oModule = BxDolModule::getInstance($sModule); + if (BxDolRequest::serviceExists($sModule, 'act_as_profile') && BxDolService::call($sModule, 'act_as_profile') && $oModule->_oConfig){ + $CNF = $oModule->_oConfig->CNF; + + $aContentInfo = BxDolRequest::serviceExists($sModule, 'get_all') ? BxDolService::call($sModule, 'get_all', array(array('type' => 'id', 'id' => $iContentId))) : array(); + + $AuditParams = array( + 'content_title' => (isset($CNF['FIELD_TITLE']) && isset($aContentInfo[$CNF['FIELD_TITLE']])) ? $aContentInfo[$CNF['FIELD_TITLE']] : '', + 'context_profile_id' => $iGroupProfileId, + 'context_profile_title' => BxDolProfile::getInstance($iGroupProfileId)->getDisplayName() + ); + + bx_audit( + $iContentId, + $sModule, + $sAction, + $AuditParams + ); + } + } + + protected function _checkAllowedConnect (&$aDataEntry, $isPerformAction, $sObjConnection, $isMutual, $isInvertResult, $isSwap = false) + { + $sResult = $this->checkAllowedView($aDataEntry); + + $oPrivacy = BxDolPrivacy::getObjectInstance($this->_oConfig->CNF['OBJECT_PRIVACY_VIEW']); + + // if profile view isn't allowed but visibility is in partially visible groups + // then display buttons to connect (befriend, join) to profile, + // if other conditions (in parent::_checkAllowedConnect) are met as well + if (CHECK_ACTION_RESULT_ALLOWED !== $sResult && !in_array($aDataEntry[$this->_oConfig->CNF['FIELD_ALLOW_VIEW_TO']], array_merge($oPrivacy->getPartiallyVisiblePrivacyGroups(), array('s')))) + return $sResult; + + return parent::_checkAllowedConnect ($aDataEntry, $isPerformAction, $sObjConnection, $isMutual, $isInvertResult, $isSwap); + } + + + // ====== COMMON METHODS + public function onUpdateImage($iContentId, $sFiledName, $sFiledValue, $iProfileId = 0) + { + $CNF = &$this->_oConfig->CNF; + + $aContentInfo = $this->_oDb->getContentInfoById($iContentId); + + $aField2Method = [ + $CNF['FIELD_PICTURE'] => 'picture', + $CNF['FIELD_COVER'] => 'cover', + ]; + + if(!empty($aField2Method[$sFiledName])) + /** + * @hooks + * @hookdef hook-bx_base_groups-context_picture_changed '{module_name}', 'context_picture_changed' - hook after context picture was changed + * - $unit_name - module name + * - $action - equals `context_picture_changed` + * - $object_id - context id + * - $sender_id - profile id who performed the action + * - $extra_params - array of additional params with the following array keys: + * - `status` - [string] context status + * - `status_admin` - [string] context admin status + * - `privacy_view` - [int] or [string] privacy for view context action, @see BxDolPrivacy + * - `cf` - [int] context's audience filter value + * @hook @ref hook-bx_base_groups-context_picture_changed + */ + /** + * @hooks + * @hookdef hook-bx_base_groups-context_cover_changed '{module_name}', 'context_cover_changed' - hook after context cover was changed + * It's equivalent to @ref hook-bx_base_groups-context_picture_changed + * @hook @ref hook-bx_base_groups-context_cover_changed + */ + bx_alert($this->getName(), 'context_' . $aField2Method[$sFiledName] . '_changed', $iContentId, $iProfileId, $this->_alertParams($aContentInfo)); + } + + protected function _alertParams($aContentInfo) + { + $aParams = parent::_alertParams($aContentInfo); + + $CNF = &$this->_oConfig->CNF; + + if(!empty($CNF['FIELD_CF']) && isset($aContentInfo[$CNF['FIELD_CF']])) + $aParams['cf'] = $aContentInfo[$CNF['FIELD_CF']]; + + return $aParams; + } + + public function alertAfterAdd($aContentInfo) + { + $CNF = &$this->_oConfig->CNF; + + $iId = (int)$aContentInfo[$CNF['FIELD_ID']]; + $iAuthorId = (int)$aContentInfo[$CNF['FIELD_AUTHOR']]; + + $sAction = 'added'; + if(isset($CNF['FIELD_STATUS_ADMIN']) && isset($aContentInfo[$CNF['FIELD_STATUS_ADMIN']]) && $aContentInfo[$CNF['FIELD_STATUS_ADMIN']] == BX_BASE_MOD_GENERAL_STATUS_PENDING) + $sAction = 'deferred'; + + $sModule = $this->getName(); + $aParams = $this->_alertParams($aContentInfo); + /** + * @hooks + * @hookdef hook-system-prepare_alert_params 'system', 'prepare_alert_params' - hook to override alert (hook) params + * - $unit_name - equals `system` + * - $action - equals `prepare_alert_params` + * - $object_id - not used + * - $sender_id - not used + * - $extra_params - array of additional params with the following array keys: + * - `unit` - [string] unit name + * - `action` - [string] by ref, action, can be overridden in hook processing + * - `object_id` - [int] by ref, object id, can be overridden in hook processing + * - `sender_id` - [int] by ref, action performer profile id, can be overridden in hook processing + * - `extras` - [array] by ref, extra params array as key&value pairs, can be overridden in hook processing + * @hook @ref hook-system-prepare_alert_params + */ + bx_alert('system', 'prepare_alert_params', 0, 0, [ + 'unit'=> $sModule, + 'action' => &$sAction, + 'object_id' => &$iId, + 'sender_id' => &$iAuthorId, + 'extras' => &$aParams + ]); + /** + * @hooks + * @hookdef hook-bx_base_groups-added '{module_name}', 'added' - hook after context was added (published) + * - $unit_name - module name + * - $action - equals `added` + * - $object_id - context id + * - $sender_id - not used + * - $extra_params - array of additional params with the following array keys: + * - `status` - [string] context status + * - `status_admin` - [string] context admin status + * - `privacy_view` - [int] or [string] privacy for view context action, @see BxDolPrivacy + * - `cf` - [int] context's audience filter value + * @hook @ref hook-bx_base_groups-added + */ + /** + * @hooks + * @hookdef hook-bx_base_groups-deferred '{module_name}', 'deferred' - hook after context was added with pending approval status + * It's equivalent to @ref hook-bx_base_groups-added + * @hook @ref hook-bx_base_groups-deferred + */ + bx_alert($sModule, $sAction, $iId, false, $aParams); + + $this->_processModerationNotifications($aContentInfo); + } + + public function addFollower ($iProfileId1, $iProfileId2) + { + $oConnectionFollow = BxDolConnection::getObjectInstance('sys_profiles_subscriptions'); + if($oConnectionFollow && !$oConnectionFollow->isConnected($iProfileId1, $iProfileId2)){ + $oConnectionFollow->addConnection($iProfileId1, $iProfileId2); + return true; + } + return false; + } + + public function isFan ($iContentId, $iProfileId = false) + { + $CNF = &$this->_oConfig->CNF; + + $oGroupProfile = BxDolProfile::getInstanceByContentAndType($iContentId, $this->getName()); + if($oGroupProfile && isset($CNF['OBJECT_CONNECTIONS'])) + return ($oConnection = BxDolConnection::getObjectInstance($CNF['OBJECT_CONNECTIONS'])) && $oConnection->isConnected($iProfileId ? $iProfileId : bx_get_logged_profile_id(), $oGroupProfile->id(), true); + + return false; + } + + public function isFanByGroupProfileId ($iGroupProfileId, $iProfileId = false) + { + $CNF = &$this->_oConfig->CNF; + + $oGroupProfile = BxDolProfile::getInstance($iGroupProfileId); + if($oGroupProfile && isset($CNF['OBJECT_CONNECTIONS'])) + return ($oConnection = BxDolConnection::getObjectInstance($CNF['OBJECT_CONNECTIONS'])) && $oConnection->isConnected($iProfileId ? $iProfileId : bx_get_logged_profile_id(), $oGroupProfile->id(), true); + + return false; + } + + public function isInvited ($sKey, $iGroupProfileId) + { + $CNF = &$this->_oConfig->CNF; + $aData = $this->_oDb->getInviteByKey($sKey, $iGroupProfileId); + if (!isset($aData['invited_profile_id'])) + return _t($CNF['T']['txt_invitation_popup_error_invitation_absent']); + + if ($aData['invited_profile_id'] != bx_get_logged_profile_id()) + return _t($CNF['T']['txt_invitation_popup_error_wrong_user']); + + return true; + } + + public function isInvitedByProfileId ($iProfileId, $iGroupProfileId) + { + $CNF = &$this->_oConfig->CNF; + + $aData = $this->_oDb->getInviteByInvited($iProfileId, $iGroupProfileId); + if (!isset($aData['invited_profile_id'])) + return _t($CNF['T']['txt_invitation_popup_error_invitation_absent']); + + if ($aData['invited_profile_id'] != bx_get_logged_profile_id()) + return _t($CNF['T']['txt_invitation_popup_error_wrong_user']); + + return true; + } + + public function serviceIsInvited($iGroupProfileId, $iProfileId = false, $sKey = '') + { + if(!$iProfileId) + $iProfileId = bx_get_logged_profile_id(); + + if(empty($sKey) && ($sKey = bx_get('key')) !== false) + $sKey = bx_process_input($sKey); + + $mixedInvited = false; + if(!empty($sKey)) + $mixedInvited = $this->isInvited($sKey, $iGroupProfileId); + else if($iProfileId !== false) + $mixedInvited = $this->isInvitedByProfileId($iProfileId, $iGroupProfileId); + + return $mixedInvited === true; + } + + public function serviceIsNotInvited($iGroupProfileId, $iProfileId = false, $sKey = '') + { + return !$this->serviceIsInvited($iGroupProfileId, $iProfileId, $sKey); + } + + public function serviceGetInvitedKey($iGroupProfileId, $iProfileId = false) + { + $sKey = ''; + if(($sKey = bx_get('key')) !== false) + $sKey = bx_process_input($sKey); + + if(!$sKey) { + if(!$iProfileId) + $iProfileId = bx_get_logged_profile_id(); + + if($iProfileId !== false) { + $aInvite = $this->_oDb->getInviteByInvited($iProfileId, $iGroupProfileId); + if(!empty($aInvite) && is_array($aInvite)) + $sKey = $aInvite['key']; + } + } + + return $sKey; + } + + public function getRole($iGroupProfileId, $iFanProfileId) + { + if(!$this->isFanByGroupProfileId($iGroupProfileId, $iFanProfileId)) + return false; + + return $this->_oDb->getRole($iGroupProfileId, $iFanProfileId); + } + + public function setRole($iGroupProfileId, $iFanProfileId, $mixedRole, $mixedPeriod = false, $sOrder = '') + { + $CNF = &$this->_oConfig->CNF; + + if(!isset($CNF['OBJECT_CONNECTIONS'])) + return false; + + $oConnection = BxDolConnection::getObjectInstance($CNF['OBJECT_CONNECTIONS']); + $oGroupProfile = BxDolProfile::getInstance($iGroupProfileId); + if(!$oConnection || !$oGroupProfile) + return false; + + if(!$oConnection->isConnected($iFanProfileId, $iGroupProfileId, true) && !$oConnection->addConnection($iFanProfileId, $iGroupProfileId)) + return false; + + if(!$this->_oDb->setRole($iGroupProfileId, $iFanProfileId, $mixedRole, $mixedPeriod, $sOrder)) + return false; + + $this->onSetRole($iGroupProfileId, $iFanProfileId, $mixedRole); + + return true; + } + + public function onSetRole($iGroupProfileId, $iFanProfileId, $mixedRole) + { + $CNF = &$this->_oConfig->CNF; + + $iProfileId = bx_get_logged_profile_id(); + $oGroupProfile = BxDolProfile::getInstance($iGroupProfileId); + $aGroupProfileInfo = $this->_oDb->getContentInfoById((int)$oGroupProfile->getContentId()); + $aRoles = BxDolFormQuery::getDataItems($CNF['OBJECT_PRE_LIST_ROLES']); + + // notify about admin status + if(!empty($CNF['EMAIL_FAN_SET_ROLE']) && $iFanProfileId != $iProfileId) { + $aSetRoles = is_array($mixedRole) ? $mixedRole : [$mixedRole]; + $aRolesNames = []; + foreach ($aSetRoles as $iRole) + $aRolesNames[] = $aRoles[(int)$iRole]; + + sendMailTemplate($CNF['EMAIL_FAN_SET_ROLE'], 0, $iFanProfileId, array( + 'EntryUrl' => $oGroupProfile->getUrl(), + 'EntryTitle' => $oGroupProfile->getDisplayName(), + 'Role' => implode(', ', $aRolesNames), + ), BX_EMAIL_NOTIFY); + } + + /** + * @hooks + * @hookdef hook-bx_base_groups-set_role '{module_name}', 'set_role' - hook after 'set role' action was applied to context member + * - $unit_name - module name + * - $action - equals `set_role` + * - $object_id - context id + * - $sender_id - context profile id + * - $extra_params - array of additional params with the following array keys: + * - `object_author_id` - [int] context profile id + * - `performer_id` - [int] performer profile id + * - `fan_id` - [int] context member profile id + * - `content` - [array] context info array as key&value pairs + * - `role` - [int] or [array] role or an array of roles to be set + * - `group_profile` - [int] context profile id + * - `profile` - [int] performer profile id + * @hook @ref hook-bx_base_groups-set_role + */ + bx_alert($this->getName(), 'set_role', $aGroupProfileInfo[$CNF['FIELD_ID']], $iGroupProfileId, array( + 'object_author_id' => $iGroupProfileId, + 'performer_id' => $iProfileId, + 'fan_id' => $iFanProfileId, + + 'content' => $aGroupProfileInfo, + 'role' => $mixedRole, + + 'group_profile' => $iGroupProfileId, + 'profile' => $iProfileId + )); + + $this->doAudit($iGroupProfileId, $iFanProfileId, '_sys_audit_action_group_role_changed'); + } + + public function unsetRole($iGroupProfileId, $iFanProfileId) + { + $CNF = &$this->_oConfig->CNF; + + if(!isset($CNF['OBJECT_CONNECTIONS'])) + return false; + + $oConnection = BxDolConnection::getObjectInstance($CNF['OBJECT_CONNECTIONS']); + $oGroupProfile = BxDolProfile::getInstance($iGroupProfileId); + if(!$oConnection || !$oGroupProfile) + return false; + + if($oConnection->isConnected($iFanProfileId, $iGroupProfileId, true) && !$oConnection->removeConnection($iFanProfileId, $iGroupProfileId)) + return false; + + $iRole = $this->_oDb->getRole($iGroupProfileId, $iFanProfileId); + + if(!$this->_oDb->unsetRole($iGroupProfileId, $iFanProfileId)) + return false; + + $this->onUnsetRole($iGroupProfileId, $iFanProfileId, $iRole); + + return true; + } + + public function onUnsetRole($iGroupProfileId, $iFanProfileId, $iRole) + { + $CNF = &$this->_oConfig->CNF; + + $iProfileId = bx_get_logged_profile_id(); + $oGroupProfile = BxDolProfile::getInstance($iGroupProfileId); + $aGroupProfileInfo = $this->_oDb->getContentInfoById((int)$oGroupProfile->getContentId()); + + /** + * @hooks + * @hookdef hook-bx_base_groups-set_role '{module_name}', 'set_role' - hook after 'set role' action was applied to context member + * - $unit_name - module name + * - $action - equals `set_role` + * - $object_id - context id + * - $sender_id - context profile id + * - $extra_params - array of additional params with the following array keys: + * - `object_author_id` - [int] context profile id + * - `performer_id` - [int] performer profile id + * - `fan_id` - [int] context member profile id + * - `content` - [array] context info array as key&value pairs + * - `role` - [int] or [array] role or an array of roles to be set + * - `group_profile` - [int] context profile id + * - `profile` - [int] performer profile id + * @hook @ref hook-bx_base_groups-set_role + */ + bx_alert($this->getName(), 'set_role', $aGroupProfileInfo[$CNF['FIELD_ID']], $iGroupProfileId, array( + 'object_author_id' => $iGroupProfileId, + 'performer_id' => $iProfileId, + 'fan_id' => $iFanProfileId, + + 'content' => $aGroupProfileInfo, + 'role' => $iRole, + + 'group_profile' => $iGroupProfileId, + 'profile' => $iProfileId + )); + + $this->doAudit($iGroupProfileId, $iFanProfileId, '_sys_audit_action_group_role_changed'); + } + + public function getGroupsByFan($iProfileId, $mixedRole = false) + { + $CNF = &$this->_oConfig->CNF; + + if(!isset($CNF['OBJECT_CONNECTIONS'])) + return false; + + if($mixedRole === false) + $mixedRole = BX_BASE_MOD_GROUPS_ROLE_COMMON; + + if(!is_array($mixedRole)) + $mixedRole = [$mixedRole]; + + $aResult = []; + foreach($mixedRole as $iRole) { + switch($iRole) { + case BX_BASE_MOD_GROUPS_ROLE_COMMON: + $aIds = BxDolConnection::getObjectInstance($CNF['OBJECT_CONNECTIONS'])->getConnectedContent($iProfileId); + break; + + default: + $aIds = $this->_oDb->getRoles([ + 'type' => 'group_pids_by_fan_id', + 'fan_id' => $iProfileId, + 'role' => $iRole + ]); + } + + $aResult = array_merge($aResult, $aIds); + } + + return $aResult; + } + + public function getMenuItemTitleByConnection($sConnection, $sAction, $iContentProfileId, $iInitiatorProfileId = 0) + { + $CNF = $this->_oConfig->getCNF(); + + $aResult = parent::getMenuItemTitleByConnection($sConnection, $sAction, $iContentProfileId, $iInitiatorProfileId); + if(!empty($aResult)) + return $aResult; + + $oConnection = BxDolConnection::getObjectInstance($sConnection); + if(!$oConnection) + return false; + + if(!$iInitiatorProfileId) + $iInitiatorProfileId = bx_get_logged_profile_id(); + + $aResult = []; + if($oConnection->isConnectedNotMutual($iInitiatorProfileId, $iContentProfileId)) + $aResult = [ + 'add' => _t(!empty($CNF['T']['menu_item_title_sm_join_requested']) ? $CNF['T']['menu_item_title_sm_join_requested'] : '_sys_menu_item_title_sm_join_requested'), + 'remove' => _t(!empty($CNF['T']['menu_item_title_sm_leave_cancel']) ? $CNF['T']['menu_item_title_sm_leave_cancel'] : '_sys_menu_item_title_sm_leave_cancel'), + ]; + else if($oConnection->isConnectedNotMutual($iContentProfileId, $iInitiatorProfileId)) + $aResult = [ + 'add' => _t(!empty($CNF['T']['menu_item_title_sm_join_confirm']) ? $CNF['T']['menu_item_title_sm_join_confirm'] : '_sys_menu_item_title_sm_join_confirm'), + 'remove' => _t(!empty($CNF['T']['menu_item_title_sm_leave_reject']) ? $CNF['T']['menu_item_title_sm_leave_reject'] : '_sys_menu_item_title_sm_leave_reject'), + ]; + else if($oConnection->isConnected($iInitiatorProfileId, $iContentProfileId, true)) + $aResult = [ + 'add' => '', + 'remove' => _t(!empty($CNF['T']['menu_item_title_sm_leave']) ? $CNF['T']['menu_item_title_sm_leave'] : '_sys_menu_item_title_sm_leave'), + ]; + else + $aResult = [ + 'add' => _t(!empty($CNF['T']['menu_item_title_sm_join']) ? $CNF['T']['menu_item_title_sm_join'] : '_sys_menu_item_title_sm_join'), + 'remove' => '', + ]; + + return !empty($sAction) && isset($aResult[$sAction]) ? $aResult[$sAction] : $aResult; + } + + protected function _getImagesForTimelinePost($aEvent, $aContentInfo, $sUrl, $aBrowseParams = array()) + { + $CNF = &$this->_oConfig->CNF; + + $iImageId = 0; + $sImageMd = $sImageXl = ''; + if(isset($CNF['FIELD_COVER']) && !empty($aContentInfo[$CNF['FIELD_COVER']])) { + $iImageId = (int)$aContentInfo[$CNF['FIELD_COVER']]; + $sImageMd = $this->_oConfig->getImageUrl($iImageId, ['OBJECT_IMAGES_TRANSCODER_GALLERY']); + $sImageXl = $this->_oConfig->getImageUrl($iImageId, ['OBJECT_IMAGES_TRANSCODER_COVER']); + } + + if($sImageXl == '' && isset($CNF['FIELD_PICTURE']) && !empty($aContentInfo[$CNF['FIELD_PICTURE']])) { + $iImageId = (int)$aContentInfo[$CNF['FIELD_PICTURE']]; + $sImageMd = $this->_oConfig->getImageUrl($iImageId, ['OBJECT_IMAGES_TRANSCODER_GALLERY']); + $sImageXl = $this->_oConfig->getImageUrl($iImageId, ['OBJECT_IMAGES_TRANSCODER_COVER']); + } + + if(empty($sImageXl)) + return []; + + $aImage = [ + 'id' => $iImageId, + 'url' => $sUrl, + 'src' => $sImageXl, + 'src_orig' => $sImageXl + ]; + + if(!empty($sImageMd)) + $aImage['src_medium'] = $sImageMd; + + return [ + $aImage + ]; + } + + protected function _prepareProfileAndGroupProfile($iGroupProfileId, $iInitiatorId) + { + if (!($oGroupProfile = BxDolProfile::getInstance($iGroupProfileId))) + return array(0, 0, null); + + if ($oGroupProfile->getModule() == $this->getName()) { + $iProfileId = $iInitiatorId; + $iGroupProfileId = $oGroupProfile->id(); + } else { + $iProfileId = $oGroupProfile->id(); + $iGroupProfileId = $iInitiatorId; + } + + return array($iProfileId, $iGroupProfileId, $oGroupProfile); + } +} + +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/groups/classes/BxBaseModGroupsPageEntry.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/groups/classes/BxBaseModGroupsPageEntry.php new file mode 100644 index 0000000000..4bd3ab23d1 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/groups/classes/BxBaseModGroupsPageEntry.php @@ -0,0 +1,156 @@ +<?php defined('BX_DOL') or die('hack attempt'); +/** + * Copyright (c) UNA, Inc - https://una.io + * MIT License - https://opensource.org/licenses/MIT + * + * @defgroup BaseGroups Base classes for groups modules + * @ingroup UnaModules + * + * @{ + */ + +/** + * Profile create/edit/delete pages. + */ +class BxBaseModGroupsPageEntry extends BxBaseModProfilePageEntry +{ + public function __construct($aObject, $oTemplate = false) + { + parent::__construct($aObject, $oTemplate); + + $CNF = &$this->_oModule->_oConfig->CNF; + + $this->_sCoverClass = 'bx-base-group-cover-wrapper ' . $this->_oModule->getName() . '_cover'; + + $bLoggedOwner = isset($this->_aContentInfo[$CNF['FIELD_AUTHOR']]) && $this->_aContentInfo[$CNF['FIELD_AUTHOR']] == bx_get_logged_profile_id(); + $bLoggedModerator = $this->_oModule->checkAllowedEditAnyEntry() === CHECK_ACTION_RESULT_ALLOWED; + + if(!empty($CNF['FIELD_CF']) && isset($this->_aContentInfo[$CNF['FIELD_CF']])) { + $oCf = BxDolContentFilter::getInstance(); + if($oCf->isEnabled() && !$oCf->isAllowed($this->_aContentInfo[$CNF['FIELD_CF']])) { + $this->setPageCover(false); + return; + } + } + + $aInformers = array (); + $oInformer = BxDolInformer::getInstance($this->_oTemplate); + if($oInformer && ($bLoggedOwner || $bLoggedModerator)) { + $sStatus = isset($CNF['FIELD_STATUS']) && isset($this->_aContentInfo[$CNF['FIELD_STATUS']]) ? $this->_aContentInfo[$CNF['FIELD_STATUS']] : ''; + $sStatusAdmin = isset($CNF['FIELD_STATUS_ADMIN']) && isset($this->_aContentInfo[$CNF['FIELD_STATUS_ADMIN']]) ? $this->_aContentInfo[$CNF['FIELD_STATUS_ADMIN']] : ''; + + //--- Display 'approving' informer. + if(!empty($sStatusAdmin) && $sStatusAdmin != BX_BASE_MOD_GENERAL_STATUS_ACTIVE) { + if(!empty($CNF['INFORMERS']['approving']) && isset($CNF['INFORMERS']['approving']['map'][$sStatusAdmin])) { + $aInformer = $CNF['INFORMERS']['approving']; + $aInformers[] = ['name' => $aInformer['name'], 'msg' => _t($aInformer['map'][$sStatusAdmin]['msg']), 'type' => $aInformer['map'][$sStatusAdmin]['type']]; + } + } + + //--- Display 'scheduled' informer if an item wasn't published yet. + if(isset($CNF['FIELD_PUBLISHED'])) { + if(!empty($CNF['INFORMERS']['scheduled']) && isset($CNF['INFORMERS']['scheduled']['map'][$sStatus])) { + $this->addMarkers(array( + 'date_publish_uf' => bx_time_js((int)$this->_aContentInfo[$CNF['FIELD_PUBLISHED']], BX_FORMAT_DATE, true) + )); + + $aInformer = $CNF['INFORMERS']['scheduled']; + $aInformers[] = array ('name' => $aInformer['name'], 'msg' => _t($aInformer['map'][$sStatus]['msg']), 'type' => $aInformer['map'][$sStatus]['type']); + } + } + + if($aInformers) + foreach($aInformers as $aInformer) + $oInformer->add($aInformer['name'], $this->_replaceMarkers($aInformer['msg']), $aInformer['type']); + } + } + + protected function _getInvitationCode($aParams = []) + { + $CNF = &$this->_oModule->_oConfig->CNF; + + if(empty($CNF['TABLE_INVITES']) || !$this->_oProfile) + return ''; + + $iProfileId = bx_get_logged_profile_id(); + $iGroupProfileId = $this->_oProfile->id(); + if(!$this->_oModule->serviceIsInvited($iGroupProfileId, $iProfileId)) + return ''; + + $sId = $this->_oModule->getName() . '_popup_invite'; + $sKey = $this->_oModule->serviceGetInvitedKey($iGroupProfileId, $iProfileId); + + $sCode = $this->_oModule->_oTemplate->getJsCode('invite_popup', array( + 'sPopupId' => $sId, + 'sKey' => $sKey, + 'sAcceptUrl' => bx_absolute_url(BxDolPermalinks::getInstance()->permalink('page.php?i=' . $CNF['URI_VIEW_ENTRY'] . '&id=' . $this->_aProfileInfo['content_id'])), + 'sDeclineUrl' => BX_DOL_URL_ROOT, + 'iGroupProfileId' => $this->_oProfile->id(), + )); + + if(!isset($aParams['use_invitation_popup']) || $aParams['use_invitation_popup'] === true) + $sCode .= BxTemplFunctions::getInstance()->popupBox($sId, _t($CNF['T']['txt_invitation_popup_title']), $this->_oModule->_oTemplate->parseHtmlByName('popup_invite.html', array( + 'popup_id' => $sId, + 'text' => _t($CNF['T']['txt_invitation_popup_text']), + 'button_accept' => _t($CNF['T']['txt_invitation_popup_accept_button']), + 'button_decline' => _t($CNF['T']['txt_invitation_popup_decline_button']), + )), true); + + $this->_oTemplate->addJs([ + 'modules/base/groups/js/|invite_popup.js', + 'invite_popup.js' + ]); + return $sCode; + } + + public function getCode () + { + return $this->_getInvitationCode() . parent::getCode(); + } + + protected function _isAvailablePage($a) + { + if(!$this->_aContentInfo || !$this->_oModule->isEntryActive($this->_aContentInfo)) + return false; + + return parent::_isAvailablePage($a); + } + + protected function _isVisiblePage ($a) + { + + $CNF = &$this->_oModule->_oConfig->CNF; + + if(!$this->_aContentInfo) + return false; + + if(($mixedAllowView = $this->_oModule->checkAllowedView($this->_aContentInfo)) !== CHECK_ACTION_RESULT_ALLOWED) { + $bPartiallyVisible = false; + if(!empty($CNF['OBJECT_PRIVACY_VIEW']) && ($oPrivacy = BxDolPrivacy::getObjectInstance($CNF['OBJECT_PRIVACY_VIEW'])) !== false) + $bPartiallyVisible = $oPrivacy->isPartiallyVisible($this->_aContentInfo[$CNF['FIELD_ALLOW_VIEW_TO']]); + /* + * If partially visible, replace current page with different set of blocks. + */ + + $bJoinPage = isset($CNF['OBJECT_PAGE_JOINED_ENTRY']) && $this->_sObject === $CNF['OBJECT_PAGE_JOINED_ENTRY']; + if($bPartiallyVisible && ($this->_sObject === $CNF['OBJECT_PAGE_VIEW_ENTRY'] || $bJoinPage)) { + $sPage = $bJoinPage ? $CNF['OBJECT_PAGE_JOINED_ENTRY'] : $CNF['OBJECT_PAGE_VIEW_ENTRY_CLOSED']; + $aObject = BxDolPageQuery::getPageObject($sPage); + $this->_sObject = $aObject['object']; + $this->_aObject = $aObject; + $this->_oQuery = new BxDolPageQuery($this->_aObject); + } + else + return $mixedAllowView; + } + + if(!BxDolPage::_isVisiblePage($a)) + return false; + + $this->_oModule->checkAllowedView($this->_aContentInfo, true); + + return true; + } +} + +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/groups/classes/BxBaseModGroupsTemplate.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/groups/classes/BxBaseModGroupsTemplate.php new file mode 100644 index 0000000000..4f9d844320 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/groups/classes/BxBaseModGroupsTemplate.php @@ -0,0 +1,146 @@ +<?php defined('BX_DOL') or die('hack attempt'); +/** + * Copyright (c) UNA, Inc - https://una.io + * MIT License - https://opensource.org/licenses/MIT + * + * @defgroup BaseGroups Base classes for groups modules + * @ingroup UnaModules + * + * @{ + */ + +/* + * Groups module representation. + */ +class BxBaseModGroupsTemplate extends BxBaseModProfileTemplate +{ + protected $_iUnitCharsSummary; + + protected $_sUnitClassWoCover; + + function __construct(&$oConfig, &$oDb) + { + parent::__construct($oConfig, $oDb); + + $this->_bLetterAvatar = false; + $this->_iUnitCharsSummary = 50; + + $this->_sUnitClassWoCover = $this->_sUnitClass; //--- Save default 'Unit' class (from BxBaseModProfileTemplate) as 'Unit W\O Cover' class here. + $this->_sUnitClassWithCover .= ' bx-base-groups-unit-with-cover'; + $this->_sUnitClass = $this->_sUnitClassWithCover; + $this->_sUnitClassWoInfo .= ' bx-base-groups-unit-wo-info'; + $this->_sUnitClassWoInfoShowCase .= ' bx-base-groups-unit-wo-info bx-base-groups-unit-wo-info-showcase'; + $this->_sUnitClassShowCase .= ' bx-base-groups-unit-with-cover bx-base-groups-unit-showcase'; + } + + public function addLocationBase() + { + parent::addLocationBase(); + + $this->addLocation('mod_groups', BX_DIRECTORY_PATH_MODULES . 'base' . DIRECTORY_SEPARATOR . 'groups' . DIRECTORY_SEPARATOR, BX_DOL_URL_MODULES . 'base/groups/'); + } + + function unitVars ($aData, $isCheckPrivateContent = true, $mixedTemplate = false, $aParams = array()) + { + $aVars = parent::unitVars ($aData, $isCheckPrivateContent, $mixedTemplate, $aParams); + + $CNF = &$this->_oConfig->CNF; + + $oProfile = BxDolProfile::getInstance($aData[$CNF['FIELD_AUTHOR']]); + if (!$oProfile) + $oProfile = BxDolProfileUndefined::getInstance(); + + $aVars['title'] = (boolean)$aVars['public'] ? bx_process_output($aData[$CNF['FIELD_NAME']]) : _t($CNF['T']['txt_private_group']); + $aVars['description'] = ''; + if(!empty($CNF['FIELD_TEXT']) && !empty($aData[$CNF['FIELD_TEXT']]) && (boolean)$aVars['public']) + $aVars['description'] = strmaxtextlen(strip_tags($aData[$CNF['FIELD_TEXT']]), $this->_iUnitCharsSummary); + + $aVars['author'] = $oProfile->getDisplayName(); + $aVars['author_url'] = $oProfile->getUrl(); + $aVars['author_icon'] = $oProfile->getIcon(); + $aVars['author_thumb'] = $oProfile->getThumb(); + $aVars['author_avatar'] = $oProfile->getAvatar(); + + return $aVars; + } + + public function getPopupSetRole($aRoles, $iProfileId, $iProfileRole) + { + $sJsObject = $this->_oConfig->getJsObject('main'); + $sHtmlIdPrefix = str_replace('_', '-', $this->_oConfig->getName()) . '-role'; + + $aTmplVarsRoles = array(); + foreach($aRoles as $iRole => $sRole) + $aTmplVarsRoles[] = array( + 'id' => $sHtmlIdPrefix . '-' . $iRole, + 'value' => $iRole, + 'onclick' => $sJsObject . '.onClickSetRoleMulti(this, ' . $iProfileId . ', ' . $iRole . ')', + 'title' => $sRole, + 'bx_if:show_checked' => array( + 'condition' => $iRole != 0 && $iProfileRole & (1 << ($iRole - 1)), + 'content' => array() + ) + ); + + return $this->parseHtmlByName('set_role_popup.html', array( + 'bx_repeat:roles' => $aTmplVarsRoles + )); + } + + public function getPopupQuestionnaire($iContentId, $iProfileId) + { + $aAnswers = $this->_oModule->_oDb->getQuestions(['sample' => 'answers', 'content_id' => $iContentId, 'profile_id' => $iProfileId]); + if(empty($aAnswers) || !is_array($aAnswers)) + return $this->_bIsApi ? [] : ''; + + $aTmplVarsAnswers = []; + foreach($aAnswers as $aAnswer) + $aTmplVarsAnswers[] = [ + 'question' => $aAnswer['question'], + 'answer' => $aAnswer['answer'], + ]; + + if($this->_bIsApi) + return $aTmplVarsAnswers; + + return $this->parseHtmlByName('popup_qnr_answers.html', ['bx_repeat:answers' => $aTmplVarsAnswers]); + } + + protected function _getUnitClass($aData, $sTemplateName = 'unit.html') + { + $CNF = &$this->_oConfig->CNF; + + $sResult = ''; + + switch($sTemplateName) { + case 'unit_wo_cover.html': + $sResult = $this->_sUnitClassWoCover; + break; + + default: + $sResult = parent::_getUnitClass($aData, $sTemplateName); + } + + return $sResult . ' ' . str_replace('_', '-', $this->_oConfig->getName()) . '-unit-' . $aData[$CNF['FIELD_ID']]; + } + + protected function _getUnitSize($aData, $sTemplateName = 'unit.html') + { + $sResult = ''; + + switch($sTemplateName) { + case 'unit.html': + case 'unit_with_cover.html': + $sResult = 'ava'; + break; + + default: + $sResult = $this->_sUnitSizeDefault; + break; + } + + return $sResult; + } +} + +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/profile/classes/BxBaseModProfileMenuViewActionsAll.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/profile/classes/BxBaseModProfileMenuViewActionsAll.php new file mode 100644 index 0000000000..700e6fb7da --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/profile/classes/BxBaseModProfileMenuViewActionsAll.php @@ -0,0 +1,210 @@ +<?php defined('BX_DOL') or die('hack attempt'); +/** + * Copyright (c) UNA, Inc - https://una.io + * MIT License - https://opensource.org/licenses/MIT + * + * @defgroup BaseProfile Base classes for profile modules + * @ingroup UnaModules + * + * @{ + */ + +/** + * View entry all actions menu + */ +class BxBaseModProfileMenuViewActionsAll extends BxBaseModGeneralMenuViewActions +{ + protected $_oProfile; + protected $_aProfileInfo; + + protected $_aConnectionToFunctionCheck; + + public function __construct($aObject, $oTemplate = false) + { + parent::__construct($aObject, $oTemplate); + + $this->_aConnectionToFunctionCheck = $this->_oModule->_oConfig->getConnectionToFunctionCheck(); + + if(empty($this->_iContentId) && bx_get('profile_id') !== false) + $this->setContentId(BxDolProfile::getInstance(bx_process_input(bx_get('profile_id'), BX_DATA_INT))->getContentId()); + } + + public function setContentId($iContentId) + { + parent::setContentId($iContentId); + + $this->_oProfile = BxDolProfile::getInstanceByContentAndType($this->_iContentId, $this->_sModule); + if(!$this->_oProfile) + return; + + $this->_aProfileInfo = $this->_oProfile->getInfo(); + + $this->addMarkers($this->_aProfileInfo); + $this->addMarkers(array( + 'profile_id' => $this->_oProfile->id() + )); + } + + protected function getMenuItemTitleByConnection($sConnection, $sAction, $iContentProfile, $iInitiatorProfile) + { + return ''; + } + + protected function _getMenuItemConnectionApi($sConnection, $sAction, &$aItem) + { + if(!isLogged() || (isset($this->_aConnectionToFunctionCheck[$sConnection]) && $this->_oModule->{$this->_aConnectionToFunctionCheck[$sConnection][$sAction]}($this->_aContentInfo) !== CHECK_ACTION_RESULT_ALLOWED)) + return false; + + $iInitiatorProfile = bx_get_logged_profile_id(); + $iContentProfile = $this->_oProfile->id(); + $sTitle = $this->_oModule->getMenuItemTitleByConnection($sConnection, $sAction, $iContentProfile, $iInitiatorProfile); + + if(empty($sTitle)) + $sTitle = $this->getMenuItemTitleByConnection($sConnection, $sAction, $iContentProfile, $iInitiatorProfile); + if(empty($sTitle)) + return false; + + return [ + 'id' => $aItem['id'], + 'name' => $aItem['name'], + 'title' => $sTitle, + 'display_type' => 'element', + 'data' => [ + 'type' => 'connections', + 'o' => $sConnection, + 'a' => $sAction, + 'iid' => $iInitiatorProfile, + 'cid' => $iContentProfile, + 'title' => $sTitle, + 'primary' => !empty($aItem['primary']), + ] + ]; + } + + protected function _getMenuItemProfileFriendAdd($aItem) + { + if($this->_bIsApi) + return $this->_getMenuItemConnectionApi('sys_profiles_friends', 'add', $aItem); + + return $this->_getMenuItemByNameActions($aItem); + } + + protected function _getMenuItemProfileFriendRemove($aItem) + { + if($this->_bIsApi) + return $this->_getMenuItemConnectionApi('sys_profiles_friends', 'remove', $aItem); + + return $this->_getMenuItemByNameActions($aItem); + } + + protected function _getMenuItemProfileRelationAdd($aItem) + { + return $this->_getMenuItemByNameActions($aItem); + } + + protected function _getMenuItemProfileRelationRemove($aItem) + { + return $this->_getMenuItemByNameActions($aItem); + } + + protected function _getMenuItemProfileSubscribeAdd($aItem) + { + if($this->_bIsApi) + return $this->_getMenuItemConnectionApi('sys_profiles_subscriptions', 'add', $aItem); + + return $this->_getMenuItemByNameActions($aItem); + } + + protected function _getMenuItemProfileSubscribeRemove($aItem) + { + if($this->_bIsApi) + return $this->_getMenuItemConnectionApi('sys_profiles_subscriptions', 'remove', $aItem); + + return $this->_getMenuItemByNameActions($aItem); + } + + protected function _getMenuItemProfileSetAclLevel($aItem) + { + $aItem = $this->_getMenuItemByNameActions($aItem); + if (!$this->_bIsApi) + return $aItem; + + $aItem['display_type'] = 'callback'; + $oAcl = BxDolAcl::getInstance(); + $aAclLevels = $oAcl->getMembershipsBy(array('type' => 'all_active_not_automatic_pair')); + $aValues = []; + + $aProfileAclLevel = $oAcl->getMemberMembershipInfo($this->_oProfile->id()); + + foreach ($aAclLevels as $k => $s){ + $aValues[] = ['value' => $k, 'label' => _t($s)]; + } + $aItem['content_type'] = 'memberships'; + $aItem['data'] = ['values' => $aValues, 'profile_id' => $this->_oProfile->id(), 'value' => $aProfileAclLevel['id']]; + return $aItem; + } + + protected function _getMenuItemView($aItem, $aParams = array()) + { + return parent::_getMenuItemView($aItem, array_merge($aParams, [ + 'object_options' => ['show_counter' => false] + ])); + } + + protected function _getMenuItemComment($aItem, $aParams = array()) + { + return parent::_getMenuItemComment($aItem, array_merge($aParams, [ + 'object_options' => ['show_counter' => false] + ])); + } + + protected function _getMenuItemVote($aItem, $aParams = array()) + { + return parent::_getMenuItemVote($aItem, array_merge($aParams, [ + 'object_options' => ['show_counter' => false] + ])); + } + + protected function _getMenuItemReaction($aItem, $aParams = array()) + { + return parent::_getMenuItemReaction($aItem, array_merge($aParams, [ + 'object_options' => ['show_counter' => false] + ])); + } + + protected function _getMenuItemScore($aItem, $aParams = array()) + { + return parent::_getMenuItemScore($aItem, array_merge($aParams, [ + 'object_options' => ['show_counter' => false] + ])); + } + + protected function _getMenuItemMessenger($aItem, $aParams = array()) + { + $aItem = BxTemplMenu::_getMenuItem($aItem); + if($aItem === false) + return false; + + if(!$this->_bIsApi) + return $this->_getMenuItemDefault($aItem); + + $sModule = 'bx_messenger'; + $sMethod = 'find_convo'; + if(!bx_is_srv($sModule, $sMethod)) + return false; + + return [ + 'id' => $aItem['id'], + 'name' => $aItem['name'], + 'title' => $aItem['title'], + 'display_type' => 'callback', + 'data' => [ + 'request_url' => $sModule . '/get_convo_url/Services¶ms[]=' . json_encode(['recipient' => $this->_oProfile->id()]), + 'on_callback' => 'redirect' + ], + 'primary' => $aItem['primary'], + ]; + } +} + +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/profile/classes/BxBaseModProfileModule.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/profile/classes/BxBaseModProfileModule.php new file mode 100644 index 0000000000..17620ded7e --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/profile/classes/BxBaseModProfileModule.php @@ -0,0 +1,2506 @@ +<?php defined('BX_DOL') or die('hack attempt'); +/** + * Copyright (c) UNA, Inc - https://una.io + * MIT License - https://opensource.org/licenses/MIT + * + * @defgroup BaseProfile Base classes for profile modules + * @ingroup UnaModules + * + * @{ + */ + +define('BX_DOL_PROFILE_REDIRECT_PROFILE', 'profile'); +define('BX_DOL_PROFILE_REDIRECT_LAST', 'last'); +define('BX_DOL_PROFILE_REDIRECT_CUSTOM', 'custom'); +define('BX_DOL_PROFILE_REDIRECT_HOMEPAGE', 'homepage'); + +define('BX_DOL_PROFILE_ACTIVATE_ALWAYS', 'on'); +define('BX_DOL_PROFILE_ACTIVATE_NEVER', 'off'); +define('BX_DOL_PROFILE_ACTIVATE_ADD', 'add'); +define('BX_DOL_PROFILE_ACTIVATE_EDIT', 'edit'); + +/** + * Base class for profile modules. + */ +class BxBaseModProfileModule extends BxBaseModGeneralModule implements iBxDolContentInfoService, iBxDolProfileService +{ + protected $_iAccountId; + + function __construct(&$aModule) + { + parent::__construct($aModule); + + $CNF = &$this->_oConfig->CNF; + + if(!empty($CNF['FIELD_ALLOW_POST_TO'])) + $this->_aSearchableNamesExcept[] = $CNF['FIELD_ALLOW_POST_TO']; + + if(!empty($CNF['FIELD_ALLOW_CONTACT_TO'])) + $this->_aSearchableNamesExcept[] = $CNF['FIELD_ALLOW_CONTACT_TO']; + + $this->_iAccountId = getLoggedId(); + } + + public function actionDeleteProfileImg($iFileId, $iContentId, $sFieldPicture) + { + $aResult = array(); + $CNF = &$this->_oConfig->CNF; + + $oSrorage = BxDolStorage::getObjectInstance($CNF['OBJECT_STORAGE']); + if (!($aFile = $oSrorage->getFile((int)$iFileId)) || !($aContentInfo = $this->_oDb->getContentInfoById($iContentId)) || $aContentInfo[$sFieldPicture] != (int)$iFileId) + $aResult = array('error' => 1, 'msg' => _t('_sys_storage_err_file_not_found')); + + $oAccountProfile = BxDolProfile::getInstanceAccountProfile(); + if ($oAccountProfile) + $iAccountProfileId = $oAccountProfile->id(); + + if ((!$aResult && !isLogged()) || (!$aResult && $aFile['profile_id'] != $iAccountProfileId && !$this->_isModerator())) + $aResult = array('error' => 2, 'msg' => _t('_Access denied')); + + $oForm = BxDolForm::getObjectInstance($CNF['OBJECT_FORM_ENTRY'], $CNF['OBJECT_FORM_ENTRY_DISPLAY_ADD'], $this->_oTemplate); + + if (!$aResult && !$oForm->_deleteFile($iContentId, $sFieldPicture, (int)$iFileId, true)) + $aResult = array('error' => 3, 'msg' => _t('_Failed')); + elseif (!$aResult) + $aResult = array('error' => 0, 'msg' => ''); + + header('Content-Type: application/json; charset=utf-8'); + echo json_encode($aResult); + } + + public function actionProfileCalendarData() + { + $iProfileId = (int)bx_get('profile_id'); + $aEntries = array(); + $BxDolModuleQuery = BxDolModuleQuery::getInstance(); + $aModules = $BxDolModuleQuery->getModulesBy(array('type' => 'modules', 'active' => 1)); + foreach($aModules as $aModule){ + $sModuleName = $aModule['name']; + $oModule = BxDolModule::getInstance($sModuleName); + if($oModule instanceof iBxDolCalendarService){ + if(BxDolRequest::serviceExists($sModuleName, 'get_calendar_entries')){ + $aEntries2 = BxDolService::call($sModuleName, 'get_calendar_entries', array($iProfileId)); + $aEntries = array_merge($aEntries, $aEntries2); + } + } + } + + header('Content-Type: application/json; charset=utf-8'); + echo json_encode($aEntries); + } + + public function actionEmbed($iContentId, $sUnitTemplate = '', $sAddCode = '') + { + return parent::actionEmbed($iContentId, 'unit_with_cover.html'); + } + + // ====== SERVICE METHODS + + public function serviceGetSafeServices() + { + $a = parent::serviceGetSafeServices(); + return array_merge($a, array ( + 'ProfileUnitSafe' => '', + 'ProfileUrl' => '', + 'EntityCreate' => '', + 'BrowseRecommended' => '', + 'BrowseRecentProfiles' => '', + 'BrowseActiveProfiles' => '', + 'BrowseTopProfiles' => '', + 'BrowseOnlineProfiles' => '', + 'BrowseConnections' => '', + 'BrowseConnectionsEverywhere' => '', + 'BrowseByAcl' => '', + )); + } + + public function serviceGetOptionsRedirectAfterAdd() + { + $CNF = &$this->_oConfig->CNF; + + $aResult = array(); + $aChoices = array(BX_DOL_PROFILE_REDIRECT_PROFILE, BX_DOL_PROFILE_REDIRECT_LAST, BX_DOL_PROFILE_REDIRECT_CUSTOM, BX_DOL_PROFILE_REDIRECT_HOMEPAGE); + foreach($aChoices as $sChoice) + $aResult[] = array('key' => $sChoice, 'value' => _t($CNF['T']['option_redirect_aadd_' . $sChoice])); + + return $aResult; + } + + public function serviceGetOptionsActivation() + { + $CNF = &$this->_oConfig->CNF; + + $aResult = array(); + $aChoices = array(BX_DOL_PROFILE_ACTIVATE_ALWAYS, BX_DOL_PROFILE_ACTIVATE_NEVER, BX_DOL_PROFILE_ACTIVATE_ADD, BX_DOL_PROFILE_ACTIVATE_EDIT); + foreach($aChoices as $sChoice) + $aResult[] = array('key' => $sChoice, 'value' => _t($CNF['T']['option_activation_' . $sChoice])); + + return $aResult; + } + + public function serviceGetThumb ($iContentId, $sTranscoder = '') + { + $CNF = &$this->_oConfig->CNF; + + if(bx_is_api()){ + $aContentInfo = $this->_oDb->getContentInfoById($iContentId); + return bx_api_get_image($CNF['OBJECT_STORAGE'], $aContentInfo[$CNF['FIELD_PICTURE']]); + } + + if(empty($sTranscoder) && !empty($CNF['OBJECT_IMAGES_TRANSCODER_THUMB'])) + $sTranscoder = $CNF['OBJECT_IMAGES_TRANSCODER_THUMB']; + + $mixedResult = $this->_getFieldValueThumb('FIELD_PICTURE', $iContentId, $sTranscoder); + return $mixedResult !== false ? $mixedResult : ''; + } + + public function serviceGetCover ($iContentId, $sTranscoder = '') + { + $CNF = &$this->_oConfig->CNF; + + if(bx_is_api()){ + $aContentInfo = $this->_oDb->getContentInfoById($iContentId); + $aTmp = bx_api_get_image($CNF['OBJECT_STORAGE'], $aContentInfo[$CNF['FIELD_COVER']]); + if (!$aTmp){ + return ['storage' => $CNF['OBJECT_STORAGE']]; + } + return $aTmp; + } + + if(empty($sTranscoder) && !empty($CNF['OBJECT_IMAGES_TRANSCODER_COVER'])) + $sTranscoder = $CNF['OBJECT_IMAGES_TRANSCODER_COVER']; + + $mixedResult = $this->_getFieldValueThumb('FIELD_COVER', $iContentId, $sTranscoder); + return $mixedResult !== false ? $mixedResult : ''; + } + + public function serviceGetSearchResultUnit ($iContentId, $sUnitTemplate = '') + { + if(empty($sUnitTemplate)) + $sUnitTemplate = 'unit_with_cover.html'; + + return parent::serviceGetSearchResultUnit($iContentId, $sUnitTemplate); + } + + public function serviceGetSearchableFieldsExtended($aInputsAdd = array()) + { + $CNF = &$this->_oConfig->CNF; + + $aResult = parent::serviceGetSearchableFieldsExtended($aInputsAdd); + if(!$this->serviceActAsProfile()) + return $aResult; + + if(!in_array('online', $this->_aSearchableNamesExcept)) + $aResult['online'] = array( + 'type' => 'checkbox', + 'caption' => $CNF['T']['form_field_online'], + 'info' => '', + 'value' => '1', + 'values' => '', + 'pass' => '' + ); + + if(!empty($CNF['FIELD_PICTURE']) && !in_array($CNF['FIELD_PICTURE'], $this->_aSearchableNamesExcept)) + $aResult[$CNF['FIELD_PICTURE']] = array( + 'type' => 'checkbox', + 'caption' => $CNF['T']['form_field_picture'], + 'info' => '', + 'value' => '1', + 'values' => '', + 'pass' => '', + 'search_operator' => '>=' + ); + + return $aResult; + } + + + /** + * @page service Service Calls + * @section bx_base_profile Base Profile + * @subsection bx_base_profile-general General + * @subsubsection bx_base_profile-entity_calendar entity_calendar + * + * @code bx_srv('bx_persons', 'entity_calendar', [...]); @endcode + * + * Get calendar block + * @param $iContentId content ID + * + * @see BxBaseModProfileModule::serviceEntityCalendar + */ + /** + * @ref bx_base_profile-entity_calendar "entity_calendar" + */ + public function serviceEntityCalendar($iContentId = 0, $sTemplate = 'calendar.html') + { + $iContentId = $this->_getContent($iContentId, false); + $oProfile = BxDolProfile::getInstanceByContentAndType($iContentId, $this->_oConfig->getName()); + if($oProfile){ + $o = new BxTemplCalendar(array( + 'eventSources' => array ( + bx_append_url_params(BX_DOL_URL_ROOT . $this->_oConfig->getBaseUri() . 'profile_calendar_data', array('profile_id' => $oProfile->id())), + ), + ), $this->_oTemplate); + return $o->display($sTemplate); + } + return ''; + } + + public function servicePrivateProfileMsg() + { + $sMessage = ''; + + $mixedContent = $this->_getContent(); + if($mixedContent) { + list($iContentId, $aContentInfo) = $mixedContent; + $sMessage = $this->checkAllowedView($aContentInfo); + } + else + $sMessage = MsgBox(_t('_sys_access_denied_to_private_content')); + + return !$this->_bIsApi ? $sMessage : [bx_api_get_msg($sMessage, ['ext' => ['msg_type' => 'result']])]; + } + + public function serviceGetContentInfoById($iContentId) + { + return $this->_oDb->getContentInfoById((int)$iContentId); + } + + public function serviceGetContentInfoByProfileId($iProfileId) + { + return $this->_oDb->getContentInfoByProfileId((int)$iProfileId); + } + + public function serviceGetMenuAddonManageTools() + { + $CNF = &$this->_oConfig->CNF; + + $iNumTotal = $this->_oDb->getEntriesNumByParams(); + + $iNum1 = $this->_oDb->getEntriesNumByParams([ + [ + 'key' => 'status', + 'table' => 'sys_profiles', + 'value' => BX_PROFILE_STATUS_PENDING, + 'operator' => '=' + ] + ]); + + $iNum2 = 0; + if (isset($CNF['OBJECT_REPORTS'])){ + $iNum2 = $this->_oDb->getEntriesNumByParams([ + [ + 'key' => 'reports', + 'value' => '0', + 'operator' => '>' + ] + ]); + } + + return array('counter1_value' => $iNum1, 'counter2_value' => $iNum2, 'counter3_value' => $iNumTotal, 'counter1_caption' => _t('_sys_menu_dashboard_manage_tools_addon_counter1_caption_profile_default')); + } + + public function serviceGetMenuAddonManageToolsProfileStats($iProfileId = 0) + { + if(!$iProfileId) + $iProfileId = bx_get_logged_profile_id(); + + $aAccountInfo = BxDolProfileQuery::getInstance()->getAccountInfoByProfileId($iProfileId); + if(empty($aAccountInfo) || !is_array($aAccountInfo)) + return 0; + + bx_import('SearchResult', $this->_aModule); + $sClass = $this->_aModule['class_prefix'] . 'SearchResult'; + $o = new $sClass(); + $o->fillFilters([ + 'account_id' => $aAccountInfo['id'], + 'perofileStatus' => '' + ]); + $o->unsetPaginate(); + + return $o->getNum(); + } + + public function serviceGetMenuAddonFavoritesProfileStats() + { + bx_import('SearchResult', $this->_aModule); + $sClass = $this->_aModule['class_prefix'] . 'SearchResult'; + $o = new $sClass('favorite', array('user' => bx_get_logged_profile_id())); + $o->unsetPaginate(); + + return $o->getNum(); + } + + public function serviceGetSubmenuObject () + { + return $this->_oConfig->CNF['OBJECT_MENU_SUBMENU_VIEW_ENTRY']; + } + + public function serviceGetMenuSetNameForMenuTrigger ($sMenuTriggerName) + { + $CNF = &$this->_oConfig->CNF; + + if (isset($CNF['TRIGGER_MENU_PROFILE_VIEW_SUBMENU']) && $CNF['TRIGGER_MENU_PROFILE_VIEW_SUBMENU'] == $sMenuTriggerName) + return $CNF['OBJECT_MENU_SUBMENU_VIEW_ENTRY']; + elseif (isset($CNF['TRIGGER_MENU_PROFILE_SNIPPET_META']) && $CNF['TRIGGER_MENU_PROFILE_SNIPPET_META'] == $sMenuTriggerName) + return $CNF['OBJECT_MENU_SNIPPET_META']; + else if (isset($CNF['TRIGGER_MENU_PROFILE_VIEW_ACTIONS']) && $CNF['TRIGGER_MENU_PROFILE_VIEW_ACTIONS'] == $sMenuTriggerName) { + if(empty($CNF['OBJECT_MENU_ACTIONS_VIEW_ENTRY_ALL'])) + return $CNF['OBJECT_MENU_ACTIONS_VIEW_ENTRY']; + else + return array($CNF['OBJECT_MENU_ACTIONS_VIEW_ENTRY'], $CNF['OBJECT_MENU_ACTIONS_VIEW_ENTRY_ALL']); + } + + return ''; + } + + public function serviceGetSnippetMenuVars($iProfileId, $bPublic = null, $aParams = []) + { + return $this->_oTemplate->getSnippetMenuVars($iProfileId, $bPublic, $aParams); + } + + public function serviceGetPageObjectForPageTrigger ($sPageTriggerName) + { + if (isset($this->_oConfig->CNF['TRIGGER_PAGE_VIEW_ENTRY']) && $this->_oConfig->CNF['TRIGGER_PAGE_VIEW_ENTRY'] == $sPageTriggerName) + return $this->_oConfig->CNF['OBJECT_PAGE_VIEW_ENTRY']; + + return ''; + } + + public function serviceProfilesSearch ($sTerm, $iLimit) + { + $aRet = array(); + + $a = $this->_oDb->searchByTerm($sTerm, $iLimit); + foreach ($a as $r) { + $oProfile = BxDolProfile::getInstance($r['profile_id']); + + if (bx_is_api()) { + $aData = $oProfile->getUnitAPI(0, ['template' => 'unit_wo_info']); + $aRet[] = $aData['author_data']; + } + else{ + $aRet[] = array ( + 'label' => $this->serviceProfileName($r['content_id']), + 'value' => $r['profile_id'], + 'url' => $oProfile->getUrl(), + 'thumb' => $oProfile->getThumb(), + 'unit' => $oProfile->getUnit(0, ['template' => ['name' => 'unit_wo_info', 'size' => 'icon']]) + ); + } + } + + return $aRet; + } + + /** + * @page service Service Calls + * @section bx_base_profile Base Profile + * @subsection bx_base_profile-general General + * @subsubsection bx_base_profile-profile_unit_safe profile_unit_safe + * + * @code bx_srv('bx_persons', 'profile_unit_safe', [...]); @endcode + * + * Get profile unit + * @param $iContentId content ID + * + * @see BxBaseModProfileModule::serviceProfileUnitSafe + */ + /** + * @ref bx_base_profile-profile_unit_safe "profile_unit_safe" + */ + public function serviceProfileUnitSafe ($iContentId, $aParams = array()) + { + unset($aParams['check_private_content']); + return $this->serviceProfileUnit ($iContentId, $aParams); + } + + public function serviceProfileUnit ($iContentId, $aParams = []) + { + $mixedContent = $this->_getContent($iContentId); + if($mixedContent === false) + return false; + + list($iContentId, $aContentInfo) = $mixedContent; + + $bCheckPrivateContent = isset($aParams['check_private_content']) ? (bool)$aParams['check_private_content'] : true; + + $aUnitTemplate = ['name' => 'unit.html', 'size' => false, 'vars' => []]; + if(!empty($aParams['template'])) { + $mixedTemplate = $aParams['template']; + unset($aParams['template']); + + if(is_string($mixedTemplate)) + $aUnitTemplate['name'] = $mixedTemplate . '.html'; + else if(is_array($mixedTemplate)) { + if(!empty($mixedTemplate['name'])) + $aUnitTemplate['name'] = $mixedTemplate['name'] . '.html'; + + if(!empty($mixedTemplate['size'])) + $aUnitTemplate['size'] = $mixedTemplate['size']; + + if(!empty($mixedTemplate['vars'])) + $aUnitTemplate['vars'] = $mixedTemplate['vars']; + } + } + + $aUnitParams = []; + if(!empty($aParams)) + $aUnitParams = $aParams; + + return $this->_oTemplate->unit($aContentInfo, $bCheckPrivateContent, array_values($aUnitTemplate), $aUnitParams); + } + + public function serviceProfileUnitApi ($iContentId, $aParams = []) + { + $mixedContent = $this->_getContent($iContentId); + if($mixedContent === false) + return false; + + list($iContentId, $aContentInfo) = $mixedContent; + + return $this->_oTemplate->unitAPI($aContentInfo, $aParams); + } + + public function serviceHasImage ($iContentId) + { + $CNF = &$this->_oConfig->CNF; + + $mixedContent = $this->_getContent($iContentId, 'getContentInfoById'); + if($mixedContent === false) + return false; + + list($iContentId, $aContentInfo) = $mixedContent; + + return !empty($aContentInfo[$CNF['FIELD_PICTURE']]); + } + + public function serviceProfilePicture ($iContentId) + { + return $this->_serviceTemplateFunc('urlPicture', $iContentId); + } + + public function serviceProfileAvatar ($iContentId) + { + return $this->_serviceTemplateFunc('urlAvatar', $iContentId); + } + + public function serviceProfileAvatarBig ($iContentId) + { + return $this->_serviceTemplateFunc('urlAvatarBig', $iContentId); + } + + public function serviceProfileCover ($iContentId) + { + return $this->_serviceTemplateFunc('urlCover', $iContentId); + } + + public function serviceProfileUnitCover ($iContentId) + { + return $this->_serviceTemplateFunc('urlCoverUnit', $iContentId); + } + + public function serviceProfileEditUrl ($iContentId) + { + return bx_absolute_url(BxDolPermalinks::getInstance()->permalink('page.php?i=' . $this->_oConfig->CNF['URI_EDIT_ENTRY'] . '&id=' . $iContentId)); + } + + public function serviceProfileThumb ($iContentId) + { + return $this->_serviceTemplateFunc('urlThumb', $iContentId); + } + + public function serviceProfileIcon ($iContentId) + { + return $this->_serviceTemplateFunc('urlIcon', $iContentId); + } + + public function serviceProfileName ($iContentId) + { + if (!$iContentId) + return false; + $aContentInfo = $this->_oDb->getContentInfoById($iContentId); + if (!$aContentInfo) + return false; + + $sDisplayName = $this->getProfileName($aContentInfo); + + /** + * @hooks + * @hookdef hook-bx_base_profile-profile_name '{module_name}', 'profile_name' - hook to override profile display name + * - $unit_name - module name + * - $action - equals `profile_name` + * - $object_id - profile id + * - $sender_id - not used + * - $extra_params - array of additional params with the following array keys: + * - `info` - [array] profile info array as key&value pairs + * - `display_name` - [string] by ref, profile display name, can be overridden in hook processing + * @hook @ref hook-bx_base_profile-profile_name + */ + bx_alert($this->getName(), 'profile_name', $aContentInfo['profile_id'], 0, [ + 'info' => $aContentInfo, + 'display_name' => &$sDisplayName + ]); + + return $sDisplayName; + } + + public function serviceProfileSettings ($iContentId) + { + if (!$iContentId) + return false; + $aContentInfo = $this->_oDb->getContentInfoById($iContentId); + if (!$aContentInfo) + return false; + + if (isset($aContentInfo['settings'])) + return json_decode($aContentInfo['settings']); + } + + public function serviceProfileSettingsSet ($iContentId, $oValue) + { + $CNF = $this->_oConfig->CNF; + $this->_oDb->updateEntriesBy(['settings' => json_encode($oValue)], [$CNF['FIELD_ID'] => $iContentId]); + } + + public function serviceProfileCreateUrl ($bAbsolute = true) + { + $CNF = $this->_oConfig->CNF; + if(empty($CNF['URL_CREATE'])) + return false; + + return $bAbsolute ? bx_absolute_url(BxDolPermalinks::getInstance()->permalink($CNF['URL_CREATE'])) : $CNF['URL_CREATE']; + } + + /** + * @page service Service Calls + * @section bx_base_profile Base Profile + * @subsection bx_base_profile-general General + * @subsubsection bx_base_profile-profile_url profile_url + * + * @code bx_srv('bx_persons', 'profile_url', [...]); @endcode + * + * Get profile URL + * @param $iContentId content ID + * + * @see BxBaseModProfileModule::serviceProfileUrl + */ + /** + * @ref bx_base_profile-profile_url "profile_url" + */ + public function serviceProfileUrl ($iContentId) + { + if (!$iContentId) + return false; + $aContentInfo = $this->_oDb->getContentInfoById($iContentId); + if (!$aContentInfo) + return false; + $CNF = $this->_oConfig->CNF; + return bx_absolute_url(BxDolPermalinks::getInstance()->permalink('page.php?i=' . $CNF['URI_VIEW_ENTRY'] . '&id=' . $aContentInfo[$CNF['FIELD_ID']])); + } + + /** + * @see iBxDolProfileService::serviceGetSpaceTitle + */ + public function serviceGetSpaceTitle() + { + return _t('_sys_ps_space_title_friend'); + } + + /** + * @see iBxDolProfileService::serviceGetParticipatingProfiles + */ + public function serviceGetParticipatingProfiles($iProfileId, $aConnectionObjects = false) + { + if (false === $aConnectionObjects) + $aConnectionObjects = array('sys_profiles_friends'); + + $a = array(); + foreach ($aConnectionObjects as $sConnectionObject) { + if (!($o = BxDolConnection::getObjectInstance($sConnectionObject))) + continue; + + if (BX_CONNECTIONS_TYPE_MUTUAL == $o->getType()) + $a = array_merge($a, $o->getConnectedContentByType($iProfileId, $this->getName(), true)); + else + $a = array_merge($a, $o->getConnectedContentByType($iProfileId, $this->getName())); + } + $aRet = array_unique($a); + + // the check for an ability to post in profile has been moved to BxDolPrivacy because we need to have an extended check + // with an ability to check for extended roles taking into account the type of content which is going be posted/edited + // so now this service returns just a fans, not filtered by an ability to post into an entry's context + /*foreach ($a as $iConnectedProfileId) { + if (!($oConnectedProfile = BxDolProfile::getInstance($iConnectedProfileId))) + continue; + + if (CHECK_ACTION_RESULT_ALLOWED === bx_srv($oConnectedProfile->getModule(), 'check_allowed_post_in_profile', array($oConnectedProfile->getContentId(), $iProfileId))) + $aRet[] = $iConnectedProfileId; + }*/ + + /** + * @hooks + * @hookdef hook-system-get_participating_profiles 'system', 'get_participating_profiles' - hook to override context participants list + * - $unit_name - equals `system` + * - $action - equals `get_participating_profiles` + * - $object_id - context profile id + * - $sender_id - not used + * - $extra_params - array of additional params with the following array keys: + * - `module` - [string] module name + * - `profiles` - [array] by ref, a list of participating profiles ids, can be overridden in hook processing + * @hook @ref hook-system-get_participating_profiles + */ + bx_alert('system', 'get_participating_profiles', $iProfileId, false, [ + 'module' => $this->_oConfig->getName(), + 'profiles' => &$aRet + ]); + + return $aRet; + } + + /** + * Prepare fields from some universal set of fields to fields in particular profile module. + * By default only 'name' and 'description' fields are supported. + * After fields convertion it can be used in @see BxBaseModGeneralModule::serviceEntityAdd + * @param $aFieldsProfile fields in soem universal format. + * @return array which is ready to use for particular module + */ + public function servicePrepareFields ($aFieldsProfile) + { + /** + * @hooks + * @hookdef hook-bx_base_profile-prepare_fields '{module_name}', 'prepare_fields' - hook to override prepared profile fields + * - $unit_name - module name + * - $action - equals `prepare_fields` + * - $object_id - not used + * - $sender_id - not used + * - $extra_params - array of additional params with the following array keys: + * - `fields_orig` - [array] original fields array as key&value pairs + * - `fields_result` - [array] by ref, resulting fields array as key&value pairs, can be overridden in hook processing + * @hook @ref hook-bx_base_profile-prepare_fields + */ + bx_alert($this->getName(), 'prepare_fields', 0, 0, [ + 'fields_orig' => $aFieldsProfile, + 'fields_result' => &$aFieldsProfile + ]); + + return $aFieldsProfile; + } + + protected function _servicePrepareFields ($aFieldsProfile, $aFieldsDefault, $aMap) + { + $aFieldsOrig = $aFieldsProfile; + + bx_import('BxDolPrivacy'); + $aFieldsDefault2 = array( + 'allow_view_to' => BX_DOL_PG_ALL, + 'allow_contact_to' => BX_DOL_PG_ALL, + 'allow_post_to' => BX_DOL_PG_FRIENDS, + ); + $aFieldsProfile = array_merge($aFieldsDefault2, $aFieldsDefault, $aFieldsProfile); + + foreach ($aMap as $k => $v) { + if (isset($aFieldsProfile[$v])) + $aFieldsProfile[$k] = $aFieldsProfile[$v]; + if ($k != $v && !isset($aMap[$v])) + unset($aFieldsProfile[$v]); + } + + /** + * @hooks + * @hookdef hook-bx_base_profile-prepare_fields '{module_name}', 'prepare_fields' - hook to override prepared profile fields + * - $unit_name - module name + * - $action - equals `prepare_fields` + * - $object_id - not used + * - $sender_id - not used + * - $extra_params - array of additional params with the following array keys: + * - `fields_orig` - [array] original fields array as key&value pairs + * - `fields_result` - [array] by ref, resulting fields array as key&value pairs, can be overridden in hook processing + * @hook @ref hook-bx_base_profile-prepare_fields + */ + bx_alert($this->getName(), 'prepare_fields', 0, 0, [ + 'fields_orig' => $aFieldsOrig, + 'fields_result' => &$aFieldsProfile + ]); + + return $aFieldsProfile; + } + + public function serviceFormsHelper () + { + return parent::serviceFormsHelper (); + } + + /** + * @page service Service Calls + * @section bx_base_profile Base Profile + * @subsection bx_base_profile-forms Forms + * @subsubsection bx_base_profile-entity_create entity_create + * + * @code bx_srv('bx_persons', 'entity_create', [...]); @endcode + * + * Get profile creation form + * @param $sDisplay optional form display name + * + * @see BxBaseModProfileModule::serviceEntityCreate + */ + /** + * @ref bx_base_profile-entity_create "entity_create" + */ + public function serviceEntityCreate ($sDisplay = false) + { + BxDolInformer::getInstance($this->_oTemplate)->setEnabled(false); + + return parent::serviceEntityCreate ($sDisplay); + } + + public function serviceActAsProfile () + { + return true; + } + + /** + * @page service Service Calls + * @section bx_base_profile Base Profile + * @subsection bx_base_profile-browse Browse + * @subsubsection bx_base_profile-browse_recommended browse_recommended + * + * @code bx_srv('bx_persons', 'browse_recommended', [...]); @endcode + * + * Browse recommended profiles + * @param $sUnitView optional, unit view, for example - showcase + * @param $bEmptyMessage optional, display or not "empty" message when there is no content + * @param $bAjaxPaginate optional, use AJAX paginate or not + * + * @see BxBaseModProfileModule::serviceBrowseRecommended + */ + /** + * @ref bx_base_profile-browse_recommended "browse_recommended" + */ + public function serviceBrowseRecommended ($sUnitView = false, $bEmptyMessage = false, $bAjaxPaginate = true) + { + if (!isLogged()) + return ''; + return $this->_serviceBrowse ('recommended', $sUnitView ? array('unit_view' => $sUnitView) : false, BX_DB_PADDING_DEF, $bEmptyMessage, $bAjaxPaginate); + } + + /** + * @page service Service Calls + * @section bx_base_profile Base Profile + * @subsection bx_base_profile-browse Browse + * @subsubsection bx_base_profile-browse_recent_profiles browse_recent_profiles + * + * @code bx_srv('bx_persons', 'browse_recent_profiles', [...]); @endcode + * + * Browse recently joined profiles + * @param $bEmptyMessage optional, display or not "empty" message when there is no content + * @param $bAjaxPaginate optional, use AJAX paginate or not + * + * @see BxBaseModProfileModule::serviceBrowseRecentProfiles + */ + /** + * @ref bx_base_profile-browse_recent_profiles "browse_recent_profiles" + */ + public function serviceBrowseRecentProfiles ($bDisplayEmptyMsg = false, $bAjaxPaginate = true, $sUnitView = false) + { + return $this->_serviceBrowse ('recent', $sUnitView ? array('unit_view' => $sUnitView) : false, BX_DB_PADDING_DEF, $bDisplayEmptyMsg, $bAjaxPaginate); + } + + /** + * @page service Service Calls + * @section bx_base_profile Base Profile + * @subsection bx_base_profile-browse Browse + * @subsubsection bx_base_profile-browse_active_profiles browse_active_profiles + * + * @code bx_srv('bx_persons', 'browse_active_profiles', [...]); @endcode + * + * Browse recently active profiles + * @param $bEmptyMessage optional, display or not "empty" message when there is no content + * @param $bAjaxPaginate optional, use AJAX paginate or not + * + * @see BxBaseModProfileModule::serviceBrowseActiveProfiles + */ + /** + * @ref bx_base_profile-browse_active_profiles "browse_active_profiles" + */ + public function serviceBrowseActiveProfiles ($sUnitView = false, $bEmptyMessage = false, $bAjaxPaginate = false) + { + return $this->_serviceBrowse ('active', $sUnitView ? array('unit_view' => $sUnitView) : false, BX_DB_PADDING_DEF, $bEmptyMessage, $bAjaxPaginate); + } + + /** + * @page service Service Calls + * @section bx_base_profile Base Profile + * @subsection bx_base_profile-browse Browse + * @subsubsection bx_base_profile-browse_familiar_profiles browse_familiar_profiles + * + * @code bx_srv('bx_persons', 'browse_familiar_profiles', [...]); @endcode + * + * Browse profiles you might be familiar with. By default using 'Profile Friends' connection. + * @param $bEmptyMessage optional, display or not "empty" message when there is no content + * @param $bAjaxPaginate optional, use AJAX paginate or not + * + * @see BxBaseModProfileModule::serviceBrowseFamiliarProfiles + */ + /** + * @ref bx_base_profile-browse_familiar_profiles "browse_familiar_profiles" + */ + public function serviceBrowseFamiliarProfiles ($sConnection = '', $sUnitView = false, $bEmptyMessage = false, $bAjaxPaginate = false) + { + $aParams = [ + 'object' => 'sys_profiles_friends', + 'profile' => bx_get_logged_profile_id(), + ]; + + if(!empty($sConnection)) { + if(is_string($sConnection)) + $aParams['object'] = $sConnection; + else if(is_array($sConnection)) + $aParams = array_merge($aParams, $sConnection); + } + + if($sUnitView) + $aParams['unit_view'] = $sUnitView; + + return $this->_serviceBrowse ('familiar', $aParams, BX_DB_PADDING_DEF, $bEmptyMessage, $bAjaxPaginate); + } + + /** + * @page service Service Calls + * @section bx_base_profile Base Profile + * @subsection bx_base_profile-browse Browse + * @subsubsection bx_base_profile-browse_top_profiles browse_top_profiles + * + * @code bx_srv('bx_persons', 'browse_top_profiles', [...]); @endcode + * + * Browse top profiles + * @param $bEmptyMessage optional, display or not "empty" message when there is no content + * @param $bAjaxPaginate optional, use AJAX paginate or not + * + * @see BxBaseModProfileModule::serviceBrowseTopProfiles + */ + /** + * @ref bx_base_profile-browse_top_profiles "browse_top_profiles" + */ + public function serviceBrowseTopProfiles ($bDisplayEmptyMsg = false, $bAjaxPaginate = false) + { + return $this->_serviceBrowse ('top', false, BX_DB_PADDING_DEF, $bDisplayEmptyMsg, $bAjaxPaginate); + } + + /** + * @page service Service Calls + * @section bx_base_profile Base Profile + * @subsection bx_base_profile-browse Browse + * @subsubsection bx_base_profile-browse_online_profiles browse_online_profiles + * + * @code bx_srv('bx_persons', 'browse_online_profiles', [...]); @endcode + * + * Browse online profiles + * @param $bEmptyMessage optional, display or not "empty" message when there is no content + * @param $bAjaxPaginate optional, use AJAX paginate or not + * + * @see BxBaseModProfileModule::serviceBrowseOnlineProfiles + */ + /** + * @ref bx_base_profile-browse_online_profiles "browse_online_profiles" + */ + public function serviceBrowseOnlineProfiles ($bDisplayEmptyMsg = false, $bAjaxPaginate = false) + { + return $this->_serviceBrowse ('online', false, BX_DB_PADDING_DEF, $bDisplayEmptyMsg, $bAjaxPaginate); + } + + public function serviceBrowseConnections ($iProfileId, $sObjectConnections = 'sys_profiles_friends', $sConnectionsType = 'content', $iMutual = false, $iDesignBox = BX_DB_PADDING_DEF, $iProfileId2 = 0) + { + return $this->_serviceBrowse ( + 'connections', [ + 'object' => $sObjectConnections, + 'type' => $sConnectionsType, + 'mutual' => $iMutual, + 'profile' => (int)$iProfileId, + 'profile2' => (int)$iProfileId2 + ], $iDesignBox + ); + } + + public function serviceBrowseRelationsQuick ($iProfileId, $sObjectConnections = 'sys_profiles_friends', $sConnectionsType = 'content', $iMutual = false, $iProfileId2 = 0) + { + // get connections object + $oConnection = BxDolConnection::getObjectInstance($sObjectConnections); + if (!$oConnection) + return ''; + + // set some vars + $iStart = (int)bx_get('start'); + $iLimit = empty($this->_oConfig->CNF['PARAM_NUM_CONNECTIONS_QUICK']) ? 4 : getParam($this->_oConfig->CNF['PARAM_NUM_CONNECTIONS_QUICK']); + if (!$iLimit) + $iLimit = 4; + + // get connections array + bx_import('BxDolConnection'); + $aConnections = $oConnection->getConnectionsAsArrayExt($sConnectionsType, $iProfileId, $iProfileId2, $iMutual, $iStart, $iLimit + 1, BX_CONNECTIONS_ORDER_ADDED_DESC); + if(empty($aConnections) || !is_array($aConnections)) + return ''; + + $aResult = array(); + foreach($aConnections as $iProfile => $aConnection) + $aResult[] = array( + 'id' => $iProfile, + 'info' => array( + 'addon' => $oConnection->getRelationTranslation($aConnection['relation']) + ) + ); + + return $this->_serviceBrowseQuick($aResult, $iStart, $iLimit); + } + + public function serviceBrowseConnectionsQuick ($iProfileId, $sObjectConnections = 'sys_profiles_friends', $sConnectionsType = 'content', $iMutual = false, $iProfileId2 = 0) + { + // get connections object + $oConnection = BxDolConnection::getObjectInstance($sObjectConnections); + if (!$oConnection) + return ''; + + // set some vars + $iLimit = empty($this->_oConfig->CNF['PARAM_NUM_CONNECTIONS_QUICK']) ? 4 : getParam($this->_oConfig->CNF['PARAM_NUM_CONNECTIONS_QUICK']); + if (!$iLimit) + $iLimit = 4; + $iStart = (int)bx_get('start'); + + // get connections array + bx_import('BxDolConnection'); + $a = $oConnection->getConnectionsAsArray ($sConnectionsType, $iProfileId, $iProfileId2, $iMutual, (int)bx_get('start'), $iLimit + 1, BX_CONNECTIONS_ORDER_ADDED_DESC); + if (!$a) + return ''; + + return $this->_serviceBrowseQuick($a, $iStart, $iLimit); + } + + public function serviceBrowseConnectionsByType ($aParamsCnn, $aParamsBrs = array()) + { + $sAll = 'all'; + + $aParamsCnn['object'] = !empty($aParamsCnn['object']) ? $aParamsCnn['object'] : 'sys_profiles_friends'; + $aParamsCnn['type'] = !empty($aParamsCnn['type']) ? $aParamsCnn['type'] : 'content'; + $aParamsCnn['profile_id2'] = !empty($aParamsCnn['profile_id2']) ? (int)$aParamsCnn['profile_id2'] : 0; + $aParamsCnn['mutual'] = isset($aParamsCnn['mutual']) ? $aParamsCnn['mutual'] : false; + + $oConnection = BxDolConnection::getObjectInstance($aParamsCnn['object']); + if(!$oConnection) + return ''; + + $aSQLParts = $oConnection->getConnectionsAsSQLParts ($aParamsCnn['type'], 'sys_profiles', 'id', $aParamsCnn['profile_id'], $aParamsCnn['profile_id2'], $aParamsCnn['mutual']); + + $sType = !empty($aParamsBrs['type']) ? $aParamsBrs['type'] : $sAll; + if(bx_get('type') !== false) + $sType = bx_process_input(bx_get('type')); + + $iStart = (int)bx_get('start'); + + $iLimitDefault = 4; + $iLimit = !empty($this->_oConfig->CNF['PARAM_NUM_CONNECTIONS_QUICK']) ? getParam($this->_oConfig->CNF['PARAM_NUM_CONNECTIONS_QUICK']) : $iLimitDefault; + if(!empty($aParamsBrs['per_page'])) + $iLimit = (int)$aParamsBrs['per_page']; + if(!$iLimit) + $iLimit = $iLimitDefault; + + $aProfiles = BxDolProfileQuery::getInstance()->getConnectedProfilesByType($aSQLParts, ($sType != $sAll ? $sType : ''), $iStart, $iLimit + 1); + + $mixedMenu = ''; + if(!isset($aParamsBrs['filter_menu']) || $aParamsBrs['filter_menu'] === true) { + $aModules = array( + array('name' => $sAll) + ); + $aModules = array_merge($aModules, BxDolModuleQuery::getInstance()->getModulesBy(array('type' => 'modules', 'active' => 1))); + + $aMenuItems = array(); + foreach($aModules as $aModule) + if($aModule['name'] == $sAll || BxDolRequest::serviceExists($aModule['name'], 'act_as_profile')) + $aMenuItems[] = array( + 'id' => $aModule['name'], + 'name' => $aModule['name'], + 'class' => '', + 'link' => 'javascript:void(0)', + 'onclick' => "return !loadDynamicBlockAutoPaginate(this, " . $iStart . ", " . $iLimit . ", " . bx_js_string(json_encode(array('type' => $aModule['name']))) . ");", + 'target' => '_self', + 'title' => _t('_' . $aModule['name']), + 'active' => 1 + ); + + if(!empty($aMenuItems)) { + $mixedMenu = new BxTemplMenu(array('template' => 'menu_vertical.html', 'menu_id'=> $this->_oConfig->getName() . '-connections-by-type', 'menu_items' => $aMenuItems)); + $mixedMenu->setSelected('', $sType); + } + } + + return array( + 'menu' => $mixedMenu, + 'content' => $this->_serviceBrowseQuick(array_keys($aProfiles), $iStart, $iLimit, array('type' => $sType)) + ); + } + + /** + * @page service Service Calls + * @section bx_base_profile Base Profile + * @subsection bx_base_profile-browse Browse + * @subsubsection bx_base_profile-browse_by_acl browse_by_acl + * + * @code bx_srv('bx_persons', 'browse_by_acl', [...]); @endcode + * + * Browse profiles by membership(ACL) level + * @param $mixedLevelId membership level, or array of membership levels + * @param $iDesignBox optional, design box identifier + * + * @see BxBaseModProfileModule::serviceBrowseByAcl + */ + /** + * @ref bx_base_profile-browse_by_acl "browse_by_acl" + */ + public function serviceBrowseByAcl ($mixedLevelId, $iDesignBox = BX_DB_PADDING_DEF) + { + return $this->_serviceBrowse ( + 'acl', + array( + 'level' => $mixedLevelId, + ), + $iDesignBox, + true + ); + } + + public function serviceEntityEditCover ($iContentId = 0) + { + return $this->_serviceEntityForm ('editDataForm', $iContentId, $this->_oConfig->CNF['OBJECT_FORM_ENTRY_DISPLAY_EDIT_COVER']); + } + + /** + * @page service Service Calls + * @section bx_base_profile Base Profile + * @subsection bx_base_profile-page_blocks Page Blocks + * @subsubsection bx_base_profile-entity_cover entity_cover + * + * @code bx_srv('bx_persons', 'entity_cover', [...]); @endcode + * + * Get cover + * @param $iContentId content ID + * + * @see BxBaseModProfileModule::serviceEntityCover + */ + /** + * @ref bx_base_general-entity_cover "entity_cover" + */ + public function serviceEntityCover ($iContentId = 0, $aParams = []) + { + $mixedContent = $this->_getContent($iContentId); + if($mixedContent === false) + return false; + + list($iContentId, $aContentInfo) = $mixedContent; + + if($this->_bIsApi) { + $CNF = &$this->_oConfig->CNF; + + $aContentInfo['cover'] = $this->serviceGetCover($iContentId); + $aContentInfo['image'] = $this->serviceGetThumb($iContentId); + + $sKey = 'OBJECT_MENU_VIEW_ENTRY_META'; + if(!empty($CNF[$sKey]) && ($oMetaMenu = BxTemplMenu::getObjectInstance($CNF[$sKey])) !== false) + $aContentInfo['meta_menu'] = $oMetaMenu->getCodeAPI(); + + $sKey = 'OBJECT_MENU_ACTIONS_VIEW_ENTRY_ALL'; + if(!empty($CNF[$sKey]) && ($oActionMenu = BxTemplMenu::getObjectInstance($CNF[$sKey])) !== false) + $aContentInfo['actions_menu'] = $oActionMenu->getCodeAPI(); + + if(($oMenuManage = BxDolMenu::getObjectInstance('sys_site_manage')) !== false) { + if(!empty($CNF['FIELD_ID'])) + $oMenuManage->setContentId($aContentInfo[$CNF['FIELD_ID']]); + + $aObjectManage = []; + if(!empty($CNF['OBJECT_MENU_MANAGE_VIEW_ENTRY'])) + $aObjectManage = [$CNF['OBJECT_MENU_MANAGE_VIEW_ENTRY']]; + else if(!empty($CNF['OBJECT_MENU_ACTIONS_VIEW_ENTRY_MORE'])) + $aObjectManage = [$CNF['OBJECT_MENU_ACTIONS_VIEW_ENTRY_MORE'], true]; + + call_user_func_array([$oMenuManage, 'setObjectManage'], $aObjectManage); + + $aMenuManage = $oMenuManage->getCodeAPI(); + if(!empty($aMenuManage) && is_array($aMenuManage)) { + if(isset($aContentInfo['actions_menu']) && is_array($aContentInfo['actions_menu'])) + $aContentInfo['actions_menu']['items'] = array_merge($aContentInfo['actions_menu']['items'], $aMenuManage['items']); + else + $aContentInfo['actions_menu'] = $aMenuManage; + } + } + + if(($oProfile = BxDolProfile::getInstanceByContentAndType($iContentId, $this->getName())) !== false); + $aContentInfo['profile'] = BxDolProfile::getData($oProfile, [ + 'get_avatar' => 'getAvatarBig', + 'with_info' => false + ]); + + return [bx_api_get_block('entity_cover', $aContentInfo)]; + } + + return $this->_oTemplate->getBlockCover($aContentInfo, $aParams); + } + + /** + * Entry comments + */ + public function serviceEntityCommentsByProfile ($iProfileId) + { + $CNF = &$this->_oConfig->CNF; + if(empty($CNF['OBJECT_COMMENTS'])) + return ''; + + $oProfile = BxDolProfile::getInstance($iProfileId); + if(!$oProfile) + return ''; + + return $this->_entityComments($CNF['OBJECT_COMMENTS'], $oProfile->getContentId()); + } + + /** + * Entry social sharing block + */ + public function serviceEntitySocialSharing ($mixedContent = false, $aParams = array()) + { + if(!empty($mixedContent)) { + if(!is_array($mixedContent)) + $mixedContent = array((int)$mixedContent, array()); + } + else { + $mixedContent = $this->_getContent(); + if($mixedContent === false) + return false; + } + + list($iContentId, $aContentInfo) = $mixedContent; + + return parent::serviceEntitySocialSharing(array($iContentId, $aContentInfo), array( + 'id_thumb' => !empty($CNF['FIELD_PICTURE']) && !empty($aContentInfo[$CNF['FIELD_PICTURE']]) ? $aContentInfo[$CNF['FIELD_PICTURE']] : 0, + )); + } + + public function serviceProfileMembership ($iContentId = 0) + { + $mixedContent = $this->_getContent($iContentId); + if($mixedContent === false) + return false; + + list($iContentId, $aContentInfo) = $mixedContent; + + return BxDolAcl::getInstance()->getProfileMembership($aContentInfo['profile_id']); + } + + public function serviceProfileFriends ($iContentId = 0) + { + $mixedContent = $this->_getContent($iContentId); + if($mixedContent === false) + return false; + + list($iContentId, $aContentInfo) = $mixedContent; + + bx_import('BxDolConnection'); + $s = $this->serviceBrowseConnectionsQuick ($aContentInfo['profile_id'], 'sys_profiles_friends', BX_CONNECTIONS_CONTENT_TYPE_CONTENT, true); + if (!$s) + return MsgBox(_t('_sys_txt_empty')); + + return $s; + } + + public function serviceProfileFriendsMutual ($iContentId = 0) + { + $mixedContent = $this->_getContent($iContentId); + if($mixedContent === false) + return false; + + list($iContentId, $aContentInfo) = $mixedContent; + + $iViewer = bx_get_logged_profile_id(); + $iOwner = (int)$aContentInfo['profile_id']; + if($iViewer == $iOwner) + return false; + + bx_import('BxDolConnection'); + $s = $this->serviceBrowseConnectionsQuick ($iOwner, 'sys_profiles_friends', BX_CONNECTIONS_CONTENT_TYPE_COMMON, true, $iViewer); + if(!$s) + return MsgBox(_t('_sys_txt_empty')); + + return $s; + } + + public function serviceProfileSubscriptions ($iContentId = 0, $aParams = array()) + { + $mixedContent = $this->_getContent($iContentId); + if($mixedContent === false) + return false; + + list($iContentId, $aContentInfo) = $mixedContent; + + bx_import('BxDolConnection'); + $aResult = $this->serviceBrowseConnectionsByType(array( + 'profile_id' => $aContentInfo['profile_id'], + 'object' => 'sys_profiles_subscriptions', + 'type' => BX_CONNECTIONS_CONTENT_TYPE_CONTENT + ), array( + 'type' => isset($aParams['type']) ? $aParams['type'] : '', + 'filter_menu' => isset($aParams['filter_menu']) ? $aParams['filter_menu'] : true, + )); + if(empty($aResult['content'])) + $aResult['content'] = MsgBox(_t('_sys_txt_empty')); + + return $aResult; + } + + public function serviceProfileSubscribedMe ($iContentId = 0) + { + $mixedContent = $this->_getContent($iContentId); + if($mixedContent === false) + return false; + + list($iContentId, $aContentInfo) = $mixedContent; + + bx_import('BxDolConnection'); + $s = $this->serviceBrowseConnectionsQuick ($aContentInfo['profile_id'], 'sys_profiles_subscriptions', BX_CONNECTIONS_CONTENT_TYPE_INITIATORS); + if (!$s) + return MsgBox(_t('_sys_txt_empty')); + + return $s; + } + + public function serviceProfileRelations ($iContentId = 0, $aParams = array()) + { + if(!BxDolRelation::isEnabled()) + return false; + + $mixedContent = $this->_getContent($iContentId); + if($mixedContent === false) + return false; + + list($iContentId, $aContentInfo) = $mixedContent; + + bx_import('BxDolConnection'); + $s = $this->serviceBrowseRelationsQuick ($aContentInfo['profile_id'], 'sys_profiles_relations', BX_CONNECTIONS_CONTENT_TYPE_CONTENT, 1); + if (!$s) + return MsgBox(_t('_sys_txt_empty')); + + return $s; + } + + public function serviceProfileRelatedMe ($iContentId = 0) + { + if(!BxDolRelation::isEnabled()) + return false; + + $mixedContent = $this->_getContent($iContentId); + if($mixedContent === false) + return false; + + list($iContentId, $aContentInfo) = $mixedContent; + + bx_import('BxDolConnection'); + $s = $this->serviceBrowseRelationsQuick ($aContentInfo['profile_id'], 'sys_profiles_relations', BX_CONNECTIONS_CONTENT_TYPE_INITIATORS, 1); + if (!$s) + return MsgBox(_t('_sys_txt_empty')); + + return $s; + } + + /** + * check enabled profile activation letter + */ + public function serviceIsEnableProfileActivationLetter() + { + $CNF = &$this->_oConfig->CNF; + return isset($CNF['PARAM_ENABLE_ACTIVATION_LETTER']) ? (bool)getParam($CNF['PARAM_ENABLE_ACTIVATION_LETTER']) : true; + } + + public function serviceIsEnableRelations() + { + if(!BxDolRelation::isEnabled()) + return false; + + $sModule = $this->_oConfig->getName(); + $oRelations = BxDolConnection::getObjectInstance('sys_profiles_relations'); + return $oRelations->isRelationAvailableWithProfile($sModule) || $oRelations->isRelationAvailableFromProfile($sModule); + } + + /** + * For internal usage only. + */ + public function serviceDeleteEntityService ($iContentId, $bDeleteWithContent = false) + { + return parent::serviceDeleteEntity ($iContentId, 'deleteDataService'); + } + + /** + * Data for Notifications module + */ + public function serviceGetNotificationsData() + { + $a = parent::serviceGetNotificationsData(); + + $sModule = $this->_aModule['name']; + + $a['handlers'][] = array('group' => $sModule . '_timeline_post_common', 'type' => 'insert', 'alert_unit' => $sModule, 'alert_action' => 'timeline_post_common', 'module_name' => $sModule, 'module_method' => 'get_notifications_timeline_post_common', 'module_class' => 'Module'); + + $a['settings'][] = array('group' => 'timeline_post', 'unit' => $sModule, 'action' => 'timeline_post_common', 'types' => array('follow_member')); + + $a['alerts'][] = array('unit' => $sModule, 'action' => 'timeline_post_common'); + + return $a; + } + + public function serviceGetNotificationsPost($aEvent) + { + $aResult = parent::serviceGetNotificationsVote($aEvent); + if(empty($aResult) || !is_array($aResult) || !$this->serviceActAsProfile()) + return $aResult; + + $oProfile = BxDolProfile::getInstanceByContentAndType((int)$aEvent['object_id'], $this->_oConfig->getName()); + if($oProfile !== false) + $aResult['entry_author'] = $oProfile->id(); + + return $aResult; + } + + public function serviceGetNotificationsVote($aEvent) + { + $aResult = parent::serviceGetNotificationsVote($aEvent); + if(empty($aResult) || !is_array($aResult) || !$this->serviceActAsProfile()) + return $aResult; + + $oProfile = BxDolProfile::getInstanceByContentAndType((int)$aEvent['object_id'], $this->_oConfig->getName()); + if($oProfile !== false) + $aResult['entry_author'] = $oProfile->id(); + + return $aResult; + } + + /** + * Notification about new member requst in the group + */ + public function serviceGetNotificationsTimelinePostCommon($aEvent) + { + $CNF = &$this->_oConfig->CNF; + + $iContentId = (int)$aEvent['object_id']; + $oGroupProfile = BxDolProfile::getInstanceByContentAndType((int)$iContentId, $this->getName()); + if(!$oGroupProfile) + return []; + + $aContentInfo = $this->_oDb->getContentInfoById($iContentId); + if(empty($aContentInfo) || !is_array($aContentInfo)) + return []; + + $aSubcontentInfo = BxDolService::call('bx_timeline', 'get_info', array((int)$aEvent['subobject_id'], false)); + if(empty($aSubcontentInfo) || !is_array($aSubcontentInfo)) + return []; + + $sEntrySummary = isset($aContentInfo[$CNF['FIELD_TEXT']]) ? $aContentInfo[$CNF['FIELD_TEXT']] : ''; + + $sSubentryUrl = bx_absolute_url(str_replace(BX_DOL_URL_ROOT, '', BxDolService::call('bx_timeline', 'get_link', array((int)$aEvent['subobject_id']))), '{bx_url_root}'); + $sSubentrySample = $aSubcontentInfo['title']; + if(empty($sSubentrySample)) + $sSubentrySample = strmaxtextlen($aSubcontentInfo['description'], 20, '...'); + $sSubentrySummary = $aSubcontentInfo['description']; + + return [ + 'entry_sample' => $CNF['T']['txt_sample_single'], + 'entry_url' => bx_absolute_url(str_replace(BX_DOL_URL_ROOT, '', $oGroupProfile->getUrl()), '{bx_url_root}'), + 'entry_caption' => $oGroupProfile->getDisplayName(), + 'entry_summary' => $sEntrySummary, + 'entry_author' => $oGroupProfile->id(), + 'subentry_sample' => $sSubentrySample, + 'subentry_url' => $sSubentryUrl, + 'subentry_summary' => $sSubentrySummary, + 'lang_key' => $CNF['T']['txt_ntfs_timeline_post_common'], + ]; + } + + /** + * Data for Timeline module + */ + public function serviceGetTimelineData() + { + $CNF = &$this->_oConfig->CNF; + $sModule = $this->_aModule['name']; + + $aAlerts = array(); + $aHandlers = array(); + if(!empty($CNF['FIELD_PICTURE'])) { + $aAlerts = array_merge($aAlerts, array( + array('unit' => $sModule, 'action' => 'profile_picture_changed'), + array('unit' => $sModule, 'action' => 'profile_picture_deleted') + )); + $aHandlers = array_merge($aHandlers, array( + array('group' => $sModule . '_profile_picture', 'type' => 'insert', 'alert_unit' => $sModule, 'alert_action' => 'profile_picture_changed', 'module_name' => $sModule, 'module_method' => 'get_timeline_profile_picture', 'module_class' => 'Module', 'groupable' => 0, 'group_by' => ''), + array('group' => $sModule . '_profile_picture', 'type' => 'delete', 'alert_unit' => $sModule, 'alert_action' => 'profile_picture_deleted') + )); + } + + if(!empty($CNF['FIELD_COVER'])) { + $aAlerts = array_merge($aAlerts, array( + array('unit' => $sModule, 'action' => 'profile_cover_changed'), + array('unit' => $sModule, 'action' => 'profile_cover_deleted') + )); + $aHandlers = array_merge($aHandlers, array( + array('group' => $sModule . '_profile_cover', 'type' => 'insert', 'alert_unit' => $sModule, 'alert_action' => 'profile_cover_changed', 'module_name' => $sModule, 'module_method' => 'get_timeline_profile_cover', 'module_class' => 'Module', 'groupable' => 0, 'group_by' => ''), + array('group' => $sModule . '_profile_cover', 'type' => 'delete', 'alert_unit' => $sModule, 'alert_action' => 'profile_cover_deleted') + )); + } + + $aResult = array(); + if(!empty($aAlerts) && !empty($aHandlers)) + $aResult = array( + 'handlers' => $aHandlers, + 'alerts' => $aAlerts + ); + + return $aResult; + } + + /** + * Entry post for Timeline module + */ + public function serviceGetTimelineProfilePicture($aEvent, $aBrowseParams = []) + { + $aResult = $this->_serviceGetTimelineProfileImage($aEvent, $aBrowseParams, [ + 'stg' => 'OBJECT_STORAGE', + 'trans' => ['OBJECT_IMAGES_TRANSCODER_GALLERY', 'OBJECT_IMAGES_TRANSCODER_AVATAR'], + 'trans_orig' => ['OBJECT_IMAGES_TRANSCODER_PICTURE', 'OBJECT_IMAGES_TRANSCODER_GALLERY'], + 'txt_ss' => 'txt_sample_pp_single', + 'txt_sswa' => 'txt_sample_pp_single_with_article', + 'txt_sa' => 'txt_sample_pi_action', + 'txt_sau' => 'txt_sample_pi_action_user' + ]); + + if($aResult !== false) + $aResult['allowed_view'] = ['module' => $this->_oConfig->getName(), 'method' => 'get_timeline_profile_picture_allowed_view']; + + return $aResult; + } + + public function serviceGetTimelineProfilePictureAllowedView($aEvent) + { + return $this->_serviceGetTimelineProfileImageAllowedView($aEvent); + } + + public function serviceGetTimelineProfileCover($aEvent, $aBrowseParams = []) + { + $aResult = $this->_serviceGetTimelineProfileImage($aEvent, $aBrowseParams, [ + 'stg' => 'OBJECT_STORAGE_COVER', + 'trans' => ['OBJECT_IMAGES_TRANSCODER_GALLERY', 'OBJECT_IMAGES_TRANSCODER_COVER_THUMB'], + 'trans_orig' => ['OBJECT_IMAGES_TRANSCODER_COVER', 'OBJECT_IMAGES_TRANSCODER_GALLERY'], + 'txt_ss' => 'txt_sample_pc_single', + 'txt_sswa' => 'txt_sample_pc_single_with_article', + 'txt_sa' => 'txt_sample_pi_action', + 'txt_sau' => 'txt_sample_pi_action_user' + ]); + + if($aResult !== false) + $aResult['allowed_view'] = ['module' => $this->_oConfig->getName(), 'method' => 'get_timeline_profile_cover_allowed_view']; + + return $aResult; + } + + public function serviceGetTimelineProfileCoverAllowedView($aEvent) + { + return $this->_serviceGetTimelineProfileImageAllowedView($aEvent); + } + + public function serviceGetMenuItemTitleByConnection($sConnection, $sAction, $iContentProfileId, $iInitiatorProfileId = 0) + { + return $this->getMenuItemTitleByConnection($sConnection, $sAction, $iContentProfileId, $iInitiatorProfileId); + } + + + // ====== PERMISSION METHODS + /** + * @see iBxDolProfileService::serviceCheckAllowedProfileView + */ + public function serviceCheckAllowedProfileView($iContentId) + { + return $this->serviceCheckAllowedWithContent('View', $iContentId); + } + + /** + * @see iBxDolProfileService::serviceCheckAllowedProfileContact + */ + public function serviceCheckAllowedProfileContact($iContentId) + { + return $this->serviceCheckAllowedWithContent('Contact', $iContentId); + } + + /** + * @see iBxDolProfileService::serviceCheckAllowedPostInProfile + */ + public function serviceCheckAllowedPostInProfile($iContentId, $sPostModule = '') + { + $CNF = &$this->_oConfig->CNF; + + if(!empty($CNF['FIELD_ALLOW_VIEW_TO']) && getParam('sys_treat_cxt_in_cxt_as_cnt') == 'on') { + $aContentInfo = $this->_oDb->getContentInfoById($iContentId); + if($aContentInfo && isset($aContentInfo[$CNF['FIELD_ALLOW_VIEW_TO']]) && (int)$aContentInfo[$CNF['FIELD_ALLOW_VIEW_TO']] < 0) + return _t('_sys_txt_access_denied'); + } + + // for groups based profiles we do have a Role permissions which have a higher priority than the site-wide permissions. + if (method_exists($this, 'isAllowedModuleActionByProfile')) { + $bResult = $this->isAllowedModuleActionByProfile($iContentId, $sPostModule, 'post'); + // if a profile is having a role and a role is having permissions set then it overrides the site-wide setting. + if ($bResult !== NULL) return $bResult; + } + + return $this->serviceCheckAllowedWithContent('Post', $iContentId); + } + + /** + * @see iBxDolProfileService::serviceCheckAllowedModuleActionInProfile + */ + public function serviceCheckAllowedModuleActionInProfile($iContentId, $sPostModule, $sActionName) + { + if (method_exists($this, 'isAllowedModuleActionByProfile')) { + $bResult = $this->isAllowedModuleActionByProfile($iContentId, $sPostModule, $sActionName); + if ($bResult !== NULL) return $bResult; + } + + return _t('_Access denied'); + } + + /** + * @see iBxDolProfileService::serviceCheckSpacePrivacy + */ + public function serviceCheckSpacePrivacy($iContentId) + { + return $this->serviceCheckAllowedProfileView($iContentId); + } + + /** + * Check if the profile can be viewed. + * + * NOTE. This service should be used if it's needed to pass some specific values in + * $isPerformAction and $iProfileId parameters, otherwise it's recommended to use + * BxBaseModProfileModule::serviceCheckAllowedProfileView service method or + * BxDolProfile::checkAllowedProfileView method. + * + * @param type $aDataEntry - entry which the action will be performed for + * @param type $isPerformAction - perform or just check the action + * @param type $iProfileId - performer's profile ID + * @return integer - one of CHECK_ACTION_RESULT_XXX constants. + */ + public function serviceCheckAllowedViewForProfile ($aDataEntry, $isPerformAction = false, $iProfileId = false) + { + if (!$iProfileId) + $iProfileId = $this->_iProfileId; + + if(empty($aDataEntry) || !is_array($aDataEntry)) + return _t('_sys_txt_not_found'); + + $oProfile = BxDolProfile::getInstanceByContentAndType($aDataEntry[$this->_oConfig->CNF['FIELD_ID']], $this->getName()); + if ($oProfile && $oProfile->id() == $iProfileId) + return CHECK_ACTION_RESULT_ALLOWED; + + return parent::serviceCheckAllowedViewForProfile ($aDataEntry, $isPerformAction, $iProfileId); + } + + /** + * Check if posting (comment, post in Timeline) is available. + * + * NOTE. This service should be used if it's needed to pass some specific values in + * $isPerformAction and $iProfileId parameters, otherwise it's recommended to use + * BxBaseModProfileModule::serviceCheckAllowedPostInProfile service method or + * BxDolProfile::checkAllowedPostInProfile method. + * + * @param type $aDataEntry - entry which the action will be performed for + * @param type $isPerformAction - perform or just check the action + * @param type $iProfileId - performer's profile ID + * @return integer - one of CHECK_ACTION_RESULT_XXX constants. + */ + public function serviceCheckAllowedPostForProfile ($aDataEntry, $isPerformAction = false, $iProfileId = false) + { + $CNF = &$this->_oConfig->CNF; + + if(!$iProfileId) + $iProfileId = $this->_iProfileId; + + // check is view allowed + if(($mixedResult = $this->serviceCheckAllowedViewForProfile($aDataEntry, $isPerformAction, $iProfileId)) !== CHECK_ACTION_RESULT_ALLOWED) + return $mixedResult; + + // moderator and owner always have access + $oProfile = BxDolProfile::getInstanceByContentAndType($aDataEntry[$CNF['FIELD_ID']], $this->getName()); + if(($oProfile && $oProfile->id() == $iProfileId) || $this->_isModerator($isPerformAction)) + return CHECK_ACTION_RESULT_ALLOWED; + + // check privacy + if(!empty($CNF['OBJECT_PRIVACY_POST'])) { + $oPrivacy = BxDolPrivacy::getObjectInstance($CNF['OBJECT_PRIVACY_POST']); + if($oPrivacy && !$oPrivacy->check($aDataEntry[$CNF['FIELD_ID']], $iProfileId)) + return _t('_sys_access_denied_to_private_content'); + } + + // check alert to allow custom checks + $mixedResult = null; + + /** + * @hooks + * @hookdef hook-system-check_allowed_post 'system', 'check_allowed_post' - hook to override the result of checking whether 'post' action is allowed or not to specified profile + * It's equivalent to @ref hook-system-check_allowed_view + * @hook @ref hook-system-check_allowed_post + */ + bx_alert('system', 'check_allowed_post', 0, 0, [ + 'module' => $this->getName(), + 'content_info' => $aDataEntry, + 'profile_id' => $iProfileId, + 'override_result' => &$mixedResult + ]); + if($mixedResult !== null) + return $mixedResult; + + return CHECK_ACTION_RESULT_ALLOWED; + } + + /** + * Check if profile can be contacted. + * + * NOTE. This service should be used if it's needed to pass some specific values in + * $isPerformAction and $iProfileId parameters, otherwise it's recommended to use + * BxBaseModProfileModule::serviceCheckAllowedProfileContact service method or + * BxDolProfile::checkAllowedProfileContact method. + * + * @param type $aDataEntry - entry which the action will be performed for + * @param type $isPerformAction - perform or just check the action + * @param type $iProfileId - performer's profile ID + * @return integer - one of CHECK_ACTION_RESULT_XXX constants. + */ + public function serviceCheckAllowedContactForProfile ($aDataEntry, $isPerformAction = false, $iProfileId = false) + { + $mixedResult = $this->_serviceCheckAllowedContactForProfile($aDataEntry, $isPerformAction, $iProfileId); + + /** + * @hooks + * @hookdef hook-system-check_allowed_contact 'system', 'check_allowed_contact' - hook to override the result of checking whether 'contact' action is allowed or not to specified profile + * It's equivalent to @ref hook-system-check_allowed_view + * @hook @ref hook-system-check_allowed_contact + */ + bx_alert('system', 'check_allowed_contact', 0, 0, [ + 'module' => $this->getName(), + 'content_info' => $aDataEntry, + 'profile_id' => $iProfileId, + 'override_result' => &$mixedResult + ]); + + return $mixedResult; + } + + public function serviceSetViewProfileCover($oPage, $aProfileInfo) + { + $this->_oTemplate->setCover($oPage,$aProfileInfo); + } + + /** + * Returns list of members by mode with limited number of records for React Jot + * @param string $sMode + * @param int $iStart + * @param int $iPerPage + * @return mixed + */ + public function serviceGetMembers($sMode = 'active', $iStart = 0, $iPerPage = 10){ + bx_import('SearchResult', $this->_aModule); + $sClass = $this->_aModule['class_prefix'] . 'SearchResult'; + $o = new $sClass($sMode); + + $o -> aCurrent['paginate'] = array('perPage' => $iPerPage, 'forceStart' => $iStart); + return $o -> getSearchData(); + } + + /** + * @return CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. So make sure to make strict(===) checking. + */ + public function checkAllowedAdd ($isPerformAction = false) + { + if($this->serviceActAsProfile() && ($oAccount = BxDolAccount::getInstance()) !== false && $oAccount->isProfilesLimitReached()) + return _t('_sys_txt_access_denied'); + + return parent::checkAllowedAdd ($isPerformAction); + } + + /** + * @return CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. So make sure to make strict(===) checking. + */ + public function checkAllowedView ($aDataEntry, $isPerformAction = false) + { + return $this->serviceCheckAllowedViewForProfile ($aDataEntry, $isPerformAction); + } + + /** + * @return CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. + */ + public function checkAllowedViewProfileImage ($aDataEntry, $isPerformAction = false) + { + $CNF = &$this->_oConfig->CNF; + + // check privacy + if (empty($CNF['OBJECT_PRIVACY_VIEW']) || isAdmin() || CHECK_ACTION_RESULT_ALLOWED === $this->checkAllowedEditAnyEntry()) + return CHECK_ACTION_RESULT_ALLOWED; + + $oPrivacy = BxDolPrivacy::getObjectInstance($CNF['OBJECT_PRIVACY_VIEW']); + if ($oPrivacy && !$oPrivacy->check($aDataEntry[$CNF['FIELD_ID']]) && !$oPrivacy->isPartiallyVisible($aDataEntry[$CNF['FIELD_ALLOW_VIEW_TO']])) + return _t('_sys_access_denied_to_private_content'); + + return CHECK_ACTION_RESULT_ALLOWED; + } + + /** + * @return CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. + */ + public function checkAllowedViewCoverImage ($aDataEntry, $isPerformAction = false) + { + return $this->checkAllowedViewProfileImage($aDataEntry); + } + + /** + * @return CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. + */ + public function checkAllowedPost ($aDataEntry, $isPerformAction = false) + { + return $this->serviceCheckAllowedPostForProfile ($aDataEntry, $isPerformAction); + } + + /** + * @return CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. + */ + public function checkAllowedContact ($aDataEntry, $isPerformAction = false) + { + return $this->serviceCheckAllowedContactForProfile ($aDataEntry, $isPerformAction); + } + + /** + * @return CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. + */ + public function checkAllowedEdit ($aDataEntry, $isPerformAction = false) + { + if(empty($aDataEntry) || !is_array($aDataEntry)) + return _t('_sys_txt_not_found'); + + // moderator always has access + if ($this->_isModerator($isPerformAction)) + return CHECK_ACTION_RESULT_ALLOWED; + + // owner (checked by account instead of author!) always have access + $oProfile = BxDolProfile::getInstanceByContentAndType($aDataEntry[$this->_oConfig->CNF['FIELD_ID']], $this->_aModule['name']); + if (!$oProfile) + return _t('_sys_txt_error_occured'); + + if ($oProfile->id() == $this->_iProfileId || $oProfile->getAccountId() == $this->_iAccountId) + return CHECK_ACTION_RESULT_ALLOWED; + + return _t('_sys_txt_access_denied'); + } + + /** + * Check if user can change cover image + */ + public function checkAllowedChangeCover ($aDataEntry, $isPerformAction = false) + { + // moderator always has access + if ($this->_isModerator($isPerformAction)) + return CHECK_ACTION_RESULT_ALLOWED; + + // owner (checked by account instead of author!) always have access + $oProfile = BxDolProfile::getInstanceByContentAndType($aDataEntry[$this->_oConfig->CNF['FIELD_ID']], $this->_aModule['name']); + if (!$oProfile) + return _t('_sys_txt_error_occured'); + + if ($oProfile->id() == $this->_iProfileId || $oProfile->getAccountId() == $this->_iAccountId) + return CHECK_ACTION_RESULT_ALLOWED; + + return _t('_sys_txt_access_denied'); + } + + /** + * @return CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. + */ + public function checkAllowedDelete (&$aDataEntry, $isPerformAction = false) + { + // moderator always has access + if ($this->_isModerator($isPerformAction)) + return CHECK_ACTION_RESULT_ALLOWED; + + // owner (checked by account instead of author!) always have access + $aCheck = checkActionModule($this->_iProfileId, 'delete entry', $this->getName(), $isPerformAction); + + $oProfile = BxDolProfile::getInstanceByContentAndType($aDataEntry[$this->_oConfig->CNF['FIELD_ID']], $this->_aModule['name'], $isPerformAction); + if (!$oProfile) + return _t('_sys_txt_error_occured'); + + if (($oProfile->id() == $this->_iProfileId || $oProfile->getAccountId() == $this->_iAccountId) && $aCheck[CHECK_ACTION_RESULT] === CHECK_ACTION_RESULT_ALLOWED) + return CHECK_ACTION_RESULT_ALLOWED; + + return _t('_sys_txt_access_denied'); + } + + /** + * @return CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. + */ + public function checkAllowedViewMoreMenu (&$aDataEntry, $isPerformAction = false) + { + $oMenu = BxTemplMenu::getObjectInstance($this->_oConfig->CNF['OBJECT_MENU_ACTIONS_VIEW_ENTRY_MORE']); + if (!$oMenu || !$oMenu->getCode()) + return _t('_sys_txt_access_denied'); + return CHECK_ACTION_RESULT_ALLOWED; + } + + /** + * Compose differs from Contact. For example, a user should NOT be able to start conversation (compose) + * with himself but he should be able to view conversation page where he is one of the participants. + * + * @return CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. + */ + public function checkAllowedCompose(&$aDataEntry, $isPerformAction = false) + { + $CNF = &$this->_oConfig->CNF; + + $oProfile = BxDolProfile::getInstanceByContentAndType($aDataEntry[$CNF['FIELD_ID']], $this->getName()); + if($oProfile && $oProfile->id() == $this->_iProfileId) + return _t('_sys_txt_access_denied'); + + return $this->checkAllowedContact($aDataEntry, $isPerformAction); + } + + /** + * @return CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. + */ + public function checkAllowedFriendAdd (&$aDataEntry, $isPerformAction = false) + { + return $this->_checkAllowedConnect ($aDataEntry, $isPerformAction, ['sys_profiles_friends', 'checkAllowedAddConnection'], false, false); + } + + /** + * @return CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. + */ + public function checkAllowedFriendRemove (&$aDataEntry, $isPerformAction = false) + { + if (CHECK_ACTION_RESULT_ALLOWED === $this->_checkAllowedConnect ($aDataEntry, $isPerformAction, ['sys_profiles_friends', 'checkAllowedRemoveConnection'], false, true, true)) + return CHECK_ACTION_RESULT_ALLOWED; + + return $this->_checkAllowedConnect ($aDataEntry, $isPerformAction, ['sys_profiles_friends', 'checkAllowedRemoveConnection'], false, true, false); + } + + /** + * @return CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. + */ + public function checkAllowedRelationAdd (&$aDataEntry, $isPerformAction = false) + { + $sResult = _t('_sys_txt_access_denied'); + if(!BxDolRelation::isEnabled()) + return $sResult; + + if(($sMsg = $this->checkAllowedView($aDataEntry)) !== CHECK_ACTION_RESULT_ALLOWED) + return $sMsg; + + return $this->_checkAllowedConnect ($aDataEntry, $isPerformAction, 'sys_profiles_relations', false, false); + } + + /** + * @return CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. + */ + public function checkAllowedRelationRemove (&$aDataEntry, $isPerformAction = false) + { + $sResult = _t('_sys_txt_access_denied'); + if(!BxDolRelation::isEnabled()) + return $sResult; + + return $this->_checkAllowedConnect ($aDataEntry, $isPerformAction, 'sys_profiles_relations', false, true); + } + + public function checkAllowedRelationsView (&$aDataEntry, $isPerformAction = false) + { + $sResult = _t('_sys_txt_access_denied'); + if(!BxDolRelation::isEnabled()) + return $sResult; + + $sModule = $this->_oConfig->getName(); + $oRelations = BxDolConnection::getObjectInstance('sys_profiles_relations'); + if(!$oRelations->isRelationAvailableWithProfile($sModule) && !$oRelations->isRelationAvailableFromProfile($sModule)) + return $sResult; + + if(empty($aDataEntry) || !is_array($aDataEntry)) + return $sResult; + + return CHECK_ACTION_RESULT_ALLOWED; + } + + /** + * @return CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. + */ + public function checkAllowedSubscribeAdd(&$aDataEntry, $isPerformAction = false) + { + $mixedResult = $this->_modProfileCheckAllowedSubscribeAdd($aDataEntry, $isPerformAction); + + /** + * @hooks + * @hookdef hook-system-check_allowed_subscribe_add 'system', 'check_allowed_subscribe_add' - hook to override the result of checking whether 'subscribe' action is allowed or not to currently logged in user + * It's equivalent to @ref hook-system-check_allowed_view + * @hook @ref hook-system-check_allowed_subscribe_add + */ + bx_alert('system', 'check_allowed_subscribe_add', 0, 0, [ + 'module' => $this->getName(), + 'content_info' => $aDataEntry, + 'profile_id' => bx_get_logged_profile_id(), + 'override_result' => &$mixedResult + ]); + + return $mixedResult; + } + + /** + * Note. Is mainly needed for internal usage. Access level is 'public' to allow outer calls from alerts. + */ + public function _modProfileCheckAllowedSubscribeAdd(&$aDataEntry, $isPerformAction = false) + { + if(($sMsg = $this->checkAllowedView($aDataEntry)) !== CHECK_ACTION_RESULT_ALLOWED) + return $sMsg; + + return $this->_checkAllowedConnect($aDataEntry, $isPerformAction, 'sys_profiles_subscriptions', false, false); + } + + /** + * @return CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. + */ + public function checkAllowedSubscribeRemove (&$aDataEntry, $isPerformAction = false) + { + return $this->_checkAllowedConnect ($aDataEntry, $isPerformAction, 'sys_profiles_subscriptions', false, true); + } + + public function checkAllowedSubscriptionsView (&$aDataEntry, $isPerformAction = false) + { + $CNF = &$this->_oConfig->CNF; + + $sResult = _t('_sys_txt_access_denied'); + if(empty($aDataEntry) || !is_array($aDataEntry)) + return $sResult; + + $oProfile = BxDolProfile::getInstanceByContentAndType($aDataEntry[$CNF['FIELD_ID']], $this->_aModule['name']); + if(!$oProfile || ($oProfile->id() != $this->_iProfileId && $this->_oDb->getParam($CNF['PARAM_PUBLIC_SBSN']) != 'on' && $this->_oDb->getParam($CNF['PARAM_PUBLIC_SBSD']) != 'on')) + return $sResult; + + return CHECK_ACTION_RESULT_ALLOWED; + } + + public function checkMyself($iContentId) + { + $iLogged = (int)bx_get_logged_profile_id(); + if(empty($iLogged)) + return false; + + $oProfile = BxDolProfile::getInstanceByContentAndType((int)$iContentId, $this->_oConfig->getName()); + if(!$oProfile) + return false; + + return $oProfile->id() == $iLogged; + } + + public function isAllowDeleteOrDisable($iActorProfileId, $iTargetProfileId) + { + if (BxDolAcl::getInstance()->isMemberLevelInSet(array(MEMBERSHIP_ID_MODERATOR), $iActorProfileId) && BxDolAcl::getInstance()->isMemberLevelInSet(array(MEMBERSHIP_ID_MODERATOR, MEMBERSHIP_ID_ADMINISTRATOR), $iTargetProfileId)) + return false; + + return true; + } + + public function getProfileObject($iContentId) + { + $oProfile = BxDolProfile::getInstanceByContentAndType((int)$iContentId, $this->_oConfig->getName()); + if (!$oProfile) + $oProfile = BxDolProfileUndefined::getInstance(); + + return $oProfile; + } + + protected function _serviceCheckAllowedContactForProfile($aDataEntry, $isPerformAction = false, $iProfileId = false) + { + $CNF = &$this->_oConfig->CNF; + + if(!$iProfileId) + $iProfileId = $this->_iProfileId; + + /* + * allow to 'contact myself'. It's needed to allow a user to view conversation page + * where he is one of the participants. + */ + $oProfile = BxDolProfile::getInstanceByContentAndType($aDataEntry[$CNF['FIELD_ID']], $this->getName()); + if($oProfile && $oProfile->id() == $iProfileId) + return CHECK_ACTION_RESULT_ALLOWED; + + // moderator always has access + if($this->_isModeratorForProfile($isPerformAction, $iProfileId)) + return CHECK_ACTION_RESULT_ALLOWED; + + // check privacy + if(!empty($CNF['OBJECT_PRIVACY_CONTACT'])) { + $oPrivacy = BxDolPrivacy::getObjectInstance($CNF['OBJECT_PRIVACY_CONTACT']); + if($oPrivacy && !$oPrivacy->check($aDataEntry[$CNF['FIELD_ID']], $iProfileId)) + return _t('_sys_access_denied_to_private_content'); + } + + return CHECK_ACTION_RESULT_ALLOWED; + } + + // ====== COMMON METHODS + public function onUpdateImage($iContentId, $sFiledName, $sFiledValue, $iProfileId = 0) + { + $CNF = &$this->_oConfig->CNF; + + $sModule = $this->getName(); + + if(!$iProfileId && ($oProfile = BxDolProfile::getInstanceByContentAndType($iContentId, $sModule)) !== false) + $iProfileId = $oProfile->id(); + + $aField2Method = [ + $CNF['FIELD_PICTURE'] => 'picture', + $CNF['FIELD_COVER'] => 'cover', + ]; + + if(!empty($aField2Method[$sFiledName])) + /** + * @hooks + * @hookdef hook-bx_base_profile-profile_picture_changed '{module_name}', 'profile_picture_changed' - hook after profile picture was changed + * - $unit_name - module name + * - $action - equals `profile_picture_changed` + * - $object_id - image id + * - $sender_id - profile id who performed the action + * - $extra_params - array of additional params with the following array keys: + * - `object_author_id` - [int] profile id + * - `content` - [int] profile content id + * - `field` - [string] field name + * @hook @ref hook-bx_base_profile-profile_picture_changed + */ + /** + * @hooks + * @hookdef hook-bx_base_profile-profile_cover_changed '{module_name}', 'profile_cover_changed' - hook after profile cover was changed + * It's equivalent to @ref hook-bx_base_profile-profile_picture_changed + * @hook @ref hook-bx_base_profile-profile_cover_changed + */ + bx_alert($sModule, 'profile_' . $aField2Method[$sFiledName] . '_changed', $sFiledValue, $iProfileId, [ + 'object_author_id' => $iProfileId, + 'content' => $iContentId, + 'field' => $sFiledName + ]); + } + + protected function _alertParams($aContentInfo) + { + $aParams = parent::_alertParams($aContentInfo); + + $CNF = &$this->_oConfig->CNF; + + if(!empty($CNF['FIELD_STATUS']) && isset($aContentInfo[$CNF['FIELD_STATUS']])) + $aParams['status'] = $aContentInfo[$CNF['FIELD_STATUS']]; + + if(!empty($CNF['FIELD_STATUS_ADMIN']) && isset($aContentInfo[$CNF['FIELD_STATUS_ADMIN']])) + $aParams['status_admin'] = $aContentInfo[$CNF['FIELD_STATUS_ADMIN']]; + + if(!empty($CNF['FIELD_ALLOW_VIEW_TO']) && isset($aContentInfo[$CNF['FIELD_ALLOW_VIEW_TO']])) + $aParams['privacy_view'] = $aContentInfo[$CNF['FIELD_ALLOW_VIEW_TO']]; + + return $aParams; + } + + public function alertAfterAdd($aContentInfo) + { + $CNF = &$this->_oConfig->CNF; + + $iContentId = (int)$aContentInfo[$CNF['FIELD_ID']]; + + $aParams = $this->_alertParams($aContentInfo); + + /** + * @hooks + * @hookdef hook-bx_base_profile-added '{module_name}', 'added' - hook after profile was added + * - $unit_name - module name + * - $action - equals `added` + * - $object_id - profile content id + * - $sender_id - not used + * - $extra_params - array of additional params with the following array keys: + * - `status` - [string] context status + * - `status_admin` - [string] context admin status + * - `privacy_view` - [int] or [string] privacy for view context action, @see BxDolPrivacy + * @hook @ref hook-bx_base_profile-added + */ + bx_alert($this->getName(), 'added', $iContentId, false, $aParams); + } + + public function alertAfterEdit($aContentInfo) + { + $CNF = &$this->_oConfig->CNF; + + $sModule = $this->getName(); + $iContentId = (int)$aContentInfo[$CNF['FIELD_ID']]; + + $aParams = $this->_alertParams($aContentInfo); + /** + * @hooks + * @hookdef hook-bx_base_profile-edited '{module_name}', 'edited' - hook after profile was changed + * It's equivalent to @ref hook-bx_base_profile-added + * @hook @ref hook-bx_base_profile-edited + */ + bx_alert($sModule, 'edited', $iContentId, false, $aParams); + + $oProfile = BxDolProfile::getInstanceByContentAndType($iContentId, $sModule); + + /** + * @hooks + * @hookdef hook-profile-edit 'profile', 'edit' - hook after profile was changed + * - $unit_name - equals `profile` + * - $action - equals `edit` + * - $object_id - profile id + * - $sender_id - not used + * - $extra_params - array of additional params with the following array keys: + * - `content` - [int] profile content id + * - `module` - [string] module name + * @hook @ref hook-profile-added + */ + bx_alert('profile', 'edit', $oProfile->id(), 0, [ + 'content' => $iContentId, + 'module' => $sModule + ]); + } + + public function getProfileByCurrentUrl () + { + $iProfileId = bx_process_input(bx_get('profile_id'), BX_DATA_INT); + + if ($iProfileId) + return BxDolProfile::getInstance($iProfileId); + + $iContentId = bx_process_input(bx_get('id'), BX_DATA_INT); + if ($iContentId) + return BxDolProfile::getInstanceByContentAndType($iContentId, $this->getName()); + + return false; + } + + public function getEntryImageData($aContentInfo, $sField = 'FIELD_PICTURE', $aTranscoders = array()) + { + return parent::getEntryImageData($aContentInfo, $sField, $aTranscoders); + } + + public function getProfileName ($aContentInfo) + { + return bx_process_output($aContentInfo[$this->_oConfig->CNF['FIELD_NAME']]); + } + + public function getMenuItemTitleByConnection($sConnection, $sAction, $iContentProfileId, $iInitiatorProfileId = 0) + { + $oConnection = BxDolConnection::getObjectInstance($sConnection); + if(!$oConnection) + return false; + + if(!$iInitiatorProfileId) + $iInitiatorProfileId = bx_get_logged_profile_id(); + + $aResult = []; + switch($sConnection) { + case 'sys_profiles_friends': + $aResult = $this->_getMenuItemTitleProfilesFriends($sAction, $iContentProfileId, $iInitiatorProfileId, $oConnection); + break; + + case 'sys_profiles_subscriptions': + $aResult = $this->_getMenuItemTitleProfilesSubscriptions($sAction, $iContentProfileId, $iInitiatorProfileId, $oConnection); + break; + } + + return $aResult; + } + + protected function _getMenuItemTitleProfilesFriends($sAction, $iContentProfileId, $iInitiatorProfileId, &$oConnection) + { + $CNF = $this->_oConfig->getCNF(); + + $aResult = []; + if($oConnection->isConnectedNotMutual($iInitiatorProfileId, $iContentProfileId)) + $aResult = [ + 'add' => _t(!empty($CNF['T']['menu_item_title_befriend_sent']) ? $CNF['T']['menu_item_title_befriend_sent'] : '_sys_menu_item_title_sm_befriend_sent'), + 'remove' => _t(!empty($CNF['T']['menu_item_title_unfriend_cancel']) ? $CNF['T']['menu_item_title_unfriend_cancel'] : '_sys_menu_item_title_sm_unfriend_cancel'), + ]; + else if($oConnection->isConnectedNotMutual($iContentProfileId, $iInitiatorProfileId)) + $aResult = [ + 'add' => _t(!empty($CNF['T']['menu_item_title_befriend_confirm']) ? $CNF['T']['menu_item_title_befriend_confirm'] : '_sys_menu_item_title_sm_befriend_confirm'), + 'remove' => _t(!empty($CNF['T']['menu_item_title_unfriend_reject']) ? $CNF['T']['menu_item_title_unfriend_reject'] : '_sys_menu_item_title_sm_unfriend_reject'), + ]; + else if($oConnection->isConnected($iInitiatorProfileId, $iContentProfileId, true)) + $aResult = [ + 'add' => '', + 'remove' => _t(!empty($CNF['T']['menu_item_title_unfriend']) ? $CNF['T']['menu_item_title_unfriend'] : '_sys_menu_item_title_sm_unfriend'), + ]; + else + $aResult = [ + 'add' => _t(!empty($CNF['T']['menu_item_title_befriend']) ? $CNF['T']['menu_item_title_befriend'] : '_sys_menu_item_title_sm_befriend'), + 'remove' => '', + ]; + + return !empty($sAction) && isset($aResult[$sAction]) ? $aResult[$sAction] : $aResult; + } + + protected function _getMenuItemTitleProfilesSubscriptions($sAction, $iContentProfileId, $iInitiatorProfileId, &$oConnection) + { + $CNF = $this->_oConfig->getCNF(); + + $aResult = []; + if($oConnection->isConnected($iInitiatorProfileId, $iContentProfileId)) + $aResult = [ + 'add' => '', + 'remove' => _t(!empty($CNF['T']['menu_item_title_unsubscribe']) ? $CNF['T']['menu_item_title_unsubscribe'] : '_sys_menu_item_title_sm_unsubscribe'), + ]; + else + $aResult = [ + 'add' => _t(!empty($CNF['T']['menu_item_title_subscribe']) ? $CNF['T']['menu_item_title_subscribe'] : '_sys_menu_item_title_sm_subscribe'), + 'remove' => '', + ]; + + return !empty($sAction) && !empty($aResult[$sAction]) ? $aResult[$sAction] : $aResult; + } + + public function decodeDataAPI($aData, $aParams = []) + { + $CNF = $this->_oConfig->CNF; + + $sModule = $this->getName(); + $iId = (int)$aData[$CNF['FIELD_ID']]; + $oProfile = BxDolProfile::getInstanceByContentAndType($iId, $sModule); + + $aResult = [ + 'id' => $iId, + 'module' => $sModule, + 'module_title' => _t($CNF['T']['txt_sample_single']), + 'added' => $aData[$CNF['FIELD_ADDED']], + 'author' => $aData[$CNF['FIELD_AUTHOR']], + 'author_data' => $oProfile !== false ? BxDolProfile::getData($oProfile->id()) : '', + 'title' => $aData[$CNF['FIELD_TITLE']], + $CNF['FIELD_TITLE'] => $aData[$CNF['FIELD_TITLE']], + 'url' => bx_api_get_relative_url($this->serviceGetLink($iId)), + 'image' => $this->serviceGetThumb($iId), + 'cover' => $this->serviceGetCover($iId), + ]; + + if(isset($aParams['template']) && $aParams['template'] == 'unit_wo_info') + return $aResult; + + if(isset($aParams['extended']) && $aParams['extended'] === true) + $aResult['text'] = $aData[$CNF['FIELD_TEXT']]; + + if(getParam('sys_api_conn_in_prof_units') == 'on' && $oProfile !== false) { + $iProfileId = $oProfile->id(); + $aResult['title'] = $oProfile->getDisplayName(); + if(($oConnection = BxDolConnection::getObjectInstance('sys_profiles_friends')) !== false && isset($CNF['URI_VIEW_FRIENDS'])) { + $aResult['friends_count'] = $oConnection->getConnectedContentCount($iProfileId, true); + $aResult['friends_list'] = $oConnection->getConnectedListAPI($iProfileId, true, BX_CONNECTIONS_CONTENT_TYPE_CONTENT); + if(isLogged()) { + $iLoggedId = bx_get_logged_profile_id(); + $aResult['mutual_friends_count'] = $oConnection->getCommonContentCount($iProfileId, $iLoggedId, true); + $aResult['mutual_friends_list'] = $oConnection->getCommonListAPI($iProfileId, $iLoggedId, true); + } + } + + if(($oConnection = BxDolConnection::getObjectInstance('sys_profiles_subscriptions')) !== false){ + $aResult['followers_count'] = $oConnection->getConnectedInitiatorsCount($iProfileId); + $aResult['followers_list'] = $oConnection->getConnectedListAPI($iProfileId, false, BX_CONNECTIONS_CONTENT_TYPE_INITIATORS); + } + } + + $sKey = 'OBJECT_MENU_SNIPPET_META'; + if(!empty($CNF[$sKey]) && ($oMetaMenu = BxDolMenu::getObjectInstance($CNF[$sKey], $this->_oTemplate)) !== false) { + $oPrivacy = BxDolPrivacy::getObjectInstance($CNF['OBJECT_PRIVACY_VIEW']); + $bPublic = !$oPrivacy || $oPrivacy->check($iId) || $oPrivacy->isPartiallyVisible($aData[$CNF['FIELD_ALLOW_VIEW_TO']]); + + $oMetaMenu->setContentId($iId); + $oMetaMenu->setContentPublic($bPublic); + if(isset($aParams['context'])) + $oMetaMenu->setContext($aParams['context']); + + $aResult['meta'] = $oMetaMenu->getCodeAPI(); + } + + return $aResult; + } + + + // ====== PROTECTED METHODS + protected function _checkAllowedConnect (&$aDataEntry, $isPerformAction, $mixedConnection, $isMutual, $isInvertResult, $isSwap = false) + { + if (!$this->_iProfileId) + return _t('_sys_txt_access_denied'); + + $CNF = &$this->_oConfig->CNF; + + $oProfile = BxDolProfile::getInstanceByContentAndType($aDataEntry[$CNF['FIELD_ID']], $this->_aModule['name']); + if (!$oProfile || $oProfile->id() == $this->_iProfileId) + return _t('_sys_txt_access_denied'); + + $sConnObject = ''; + $sConnMethod = 'checkAllowedConnect'; + if(is_array($mixedConnection)) + list($sConnObject, $sConnMethod) = $mixedConnection; + else + $sConnObject = $mixedConnection; + + return BxDolConnection::getObjectInstance($sConnObject)->$sConnMethod($this->_iProfileId, $oProfile->id(), $isPerformAction, $isMutual, $isInvertResult, $isSwap); + } + + protected function _buildRssParams($sMode, $aArgs) + { + $aParams = array (); + $sMode = bx_process_input($sMode); + switch ($sMode) { + case 'connections': + $aParams = array( + 'object' => isset($aArgs[0]) ? $aArgs[0] : '', + 'type' => isset($aArgs[1]) ? $aArgs[1] : '', + 'profile' => isset($aArgs[2]) ? (int)$aArgs[2] : 0, + 'mutual' => isset($aArgs[3]) ? (int)$aArgs[3] : 0, + 'profile2' => isset($aArgs[4]) ? (int)$aArgs[4] : 0, + ); + break; + } + + return $aParams; + } + + protected function _serviceGetTimelineProfileImage($aEvent, $aBrowseParams, $aBuildParams) + { + $CNF = &$this->_oConfig->CNF; + + $aFileInfo = BxDolStorage::getObjectInstance($CNF[$aBuildParams['stg']])->getFile((int)$aEvent['object_id']); + if(empty($aFileInfo) || !is_array($aFileInfo)) + return false; + + $aEventContent = unserialize($aEvent['content']); + if(!is_array($aEventContent) || empty($aEventContent['content'])) + return false; + + $aContentInfo = $this->_oDb->getContentInfoById($aEventContent['content']); + if(empty($aContentInfo) || !is_array($aContentInfo)) + return false; + + $oProfile = BxDolProfile::getInstanceMagic($aContentInfo['profile_id']); + if (!$oProfile->isActive()) + return false; + + $sUserName = $oProfile->getDisplayName(); + + $sSample = isset($CNF['T'][$aBuildParams['txt_sswa']]) ? $CNF['T'][$aBuildParams['txt_sswa']] : $CNF['T'][$aBuildParams['txt_ss']]; + + //--- Title & Description + $sTitle = !empty($aContentInfo[$CNF['FIELD_TITLE']]) ? $aContentInfo[$CNF['FIELD_TITLE']] : ''; + if(empty($sTitle) && !empty($aContentInfo[$CNF['FIELD_TEXT']])) + $sTitle = $aContentInfo[$CNF['FIELD_TEXT']]; + + $sDescription = _t($CNF['T'][$aBuildParams['txt_sau']], $sUserName, _t($sSample)); + + return array( + 'owner_id' => $aEvent['owner_id'], + 'object_owner_id' => $aContentInfo['profile_id'], + 'icon' => !empty($CNF['ICON']) ? $CNF['ICON'] : '', + 'sample' => $sSample, + 'sample_wo_article' => $CNF['T'][$aBuildParams['txt_ss']], + 'sample_action' => isset($CNF['T'][$aBuildParams['txt_sa']]) ? $CNF['T'][$aBuildParams['txt_sa']] : '', + 'url' => bx_absolute_url(BxDolPermalinks::getInstance()->permalink('page.php?i=' . $CNF['URI_VIEW_ENTRY'] . '&id=' . $aContentInfo[$CNF['FIELD_ID']])), + 'content' => $this->_getContentForTimelineProfileImage($aEvent, $aBrowseParams, $aBuildParams, $aContentInfo, $aFileInfo), //a string to display or array to parse default template before displaying. + 'date' => $aContentInfo[$CNF['FIELD_ADDED']], + 'views' => '', + 'votes' => '', + 'scores' => '', + 'reports' => '', + 'comments' => '', + 'title' => $sTitle, //may be empty. + 'description' => $sDescription //may be empty. + ); + } + + protected function _serviceGetTimelineProfileImageAllowedView($aEvent) + { + $sError = _t('_sys_access_denied_to_private_content'); + + if(empty($aEvent['content']) || !is_array($aEvent['content']) || empty($aEvent['content']['id'])) + return $sError; + + $aContentInfo = $this->_oDb->getContentInfoById($aEvent['content']['id']); + if(empty($aContentInfo) || !is_array($aContentInfo)) + return $sError; + + return $this->serviceCheckAllowedViewForProfile($aContentInfo); + } + + protected function _getContentForTimelineProfileImage($aEvent, $aBrowseParams, $aBuildParams, $aContentInfo, $aFileInfo) + { + $CNF = &$this->_oConfig->CNF; + + $sUrl = bx_absolute_url(BxDolPermalinks::getInstance()->permalink('page.php?i=' . $CNF['URI_VIEW_ENTRY'] . '&id=' . $aContentInfo[$CNF['FIELD_ID']])); + + //--- Image(s) + $sImage = $this->_oConfig->getImageUrl($aFileInfo['id'], $aBuildParams['trans']); + $sImageOrig = $this->_oConfig->getImageUrl($aFileInfo['id'], $aBuildParams['trans_orig']); + if(!empty($sImage)) { + if(empty($sImageOrig)) + $sImageOrig = $sImage; + + $a = ['id' => $aFileInfo['id'], 'url' => $sUrl, 'src' => $sImage]; + if(CHECK_ACTION_RESULT_ALLOWED === $this->checkAllowedView($aContentInfo)) { + $a['src_orig'] = $sImageOrig; + + $sCnfKey = 'OBJECT_IMAGES_TRANSCODER_GALLERY'; + if(!empty($CNF[$sCnfKey]) && ($sSrcMedium = $this->_oConfig->getImageUrl($aFileInfo['id'], [$sCnfKey])) != '') + $a['src_medium'] = $sSrcMedium; + } + $aImages = [$a]; + } + + return array( + 'sample' => isset($CNF['T'][$aBuildParams['txt_sswa']]) ? $CNF['T'][$aBuildParams['txt_sswa']] : $CNF['T'][$aBuildParams['txt_ss']], + 'sample_wo_article' => $CNF['T'][$aBuildParams['txt_ss']], + 'sample_action' => isset($CNF['T'][$aBuildParams['txt_sa']]) ? $CNF['T'][$aBuildParams['txt_sa']] : '', + 'id' => $aContentInfo[$CNF['FIELD_ID']], + 'url' => $sUrl, + 'title' => '', + 'text' => '', + 'images' => $aImages, + 'videos' => array() + ); + } + + protected function _entityComments($sObject, $iId = 0) + { + if(!$iId) + $iId = bx_process_input(bx_get('id'), BX_DATA_INT); + + if(!$iId) + $iId = bx_process_input(bx_get('profile_id'), BX_DATA_INT); + + if(!$iId) + return false; + + $oCmts = BxDolCmts::getObjectInstance($sObject, $iId); + if(!$oCmts || !$oCmts->isEnabled()) + return false; + + if (bx_is_api()) + return [bx_srv('system', 'get_data_api', [['module' => $sObject, 'object_id' => $iId]], 'TemplCmtsServices')]; + + return $oCmts->getCommentsBlock(array(), array('in_designbox' => false)); + } + + protected function _getContent($iContentId = 0, $sFuncGetContent = 'getContentInfoById') + { + if(!$iContentId && bx_get('id') === false && bx_get('profile_id') !== false) { + $oProfile = BxDolProfile::getInstance((int)bx_get('profile_id')); + if($oProfile) + $iContentId = $oProfile->getContentId(); + } + + return parent::_getContent($iContentId, $sFuncGetContent); + } +} + +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/profile/template/search_extended_results.html b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/profile/template/search_extended_results.html new file mode 100644 index 0000000000..76a2ff9f14 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/profile/template/search_extended_results.html @@ -0,0 +1,7 @@ +<div class="bx-search-result-block __class__"> + <div class="bx-search-result-sorting bx-def-margin-sec-bottom bx-clearfix">__sort__</div> + <div class="bx-search-result-content bx-base-pofile-units-wrapper bx-def-margin-sec-lefttopright-neg bx-def-margin-sec-bottom-neg bx-clearfix">__code__</div> + <bx_if:show_paginate> + <div class="bx-search-result-paginate bx-def-margin-top">__paginate__</div> + </bx_if:show_paginate> +</div> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/text/classes/BxBaseModTextConfig.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/text/classes/BxBaseModTextConfig.php new file mode 100644 index 0000000000..3d81a7eed8 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/text/classes/BxBaseModTextConfig.php @@ -0,0 +1,142 @@ +<?php defined('BX_DOL') or die('hack attempt'); +/** + * Copyright (c) UNA, Inc - https://una.io + * MIT License - https://opensource.org/licenses/MIT + * + * @defgroup BaseText Base classes for text modules + * @ingroup UnaModules + * + * @{ + */ + +bx_import('BxDolInformer'); + +class BxBaseModTextConfig extends BxBaseModGeneralConfig +{ + /** + * Determine whether Timeline post will use common content (header image + text) + * or content received from attachments (header image + text + images + videos + polls). + * By default the first variant is used. + * Note. The variable can be removed in future, when all Text Based modules + * implement 'attachments' related parameters. + */ + protected $_bAttachmentsInTimeline; + + protected $_aPregPatterns; + + function __construct($aModule) + { + parent::__construct($aModule); + + $this->CNF = array( + // modules icon + 'ICON_POLLS_ANSWERS' => 'vote-yea', + 'ICON_POLLS_RESULTS' => 'poll-h', + + // database tables + 'TABLE_POLLS' => $aModule['db_prefix'] . 'polls', + 'TABLE_POLLS_ANSWERS' => $aModule['db_prefix'] . 'polls_answers', + 'TABLE_POLLS_ANSWERS_VOTES' => $aModule['db_prefix'] . 'polls_answers_votes', + 'TABLE_POLLS_ANSWERS_VOTES_TRACK' => $aModule['db_prefix'] . 'polls_answers_votes_track', + + 'TABLE_LINKS' => $aModule['db_prefix'] . 'links', + 'TABLE_LINKS2CONTENT' => $aModule['db_prefix'] . 'links2content', + + // database fields + 'FIELD_POLL_ID' => 'id', + 'FIELD_POLL_AUTHOR_ID' => 'author_id', + 'FIELD_POLL_CONTENT_ID' => 'content_id', + 'FIELD_POLL_TEXT' => 'text', + 'FIELD_POLL_ANSWERS' => 'answers', + + 'FIELD_ATTACH_LINK_CONTENT_ID' => 'content_id', + 'FIELD_ATTACH_LINK_URL' => 'url', + 'FIELD_ATTACH_LINK_CONTROLS' => 'controls', + + // some params + 'PARAM_POLL_ENABLED' => true, + 'PARAM_POLL_HIDDEN_RESULTS' => false, + 'PARAM_POLL_ANONYMOUS_VOTING' => true, + 'PARAM_MULTICAT_ENABLED' => false, + 'PARAM_LINKS_ENABLED' => false, + 'PARAM_LINKS_LIMIT' => 'sys_attach_links_max', + + // objects + 'OBJECT_VOTES_POLL_ANSWERS' => $this->_sName . '_poll_answers', + 'OBJECT_FORM_ATTACH_LINK' => $this->_sName . '_attach_link', + 'OBJECT_FORM_ATTACH_LINK_DISPLAY_ADD' => $this->_sName . '_attach_link_add', + + + // styles + 'STYLES_POLLS_EMBED_CLASS' => 'body.bx-page-iframe.bx-def-color-bg-page', + 'STYLES_POLLS_EMBED_CONTENT' => array( + 'background-color' => '#ffffff' + ), + ); + + $sPrefix = str_replace('_', '-', $this->_sName); + $this->_aPrefixes = [ + 'style' => $sPrefix, + ]; + + $this->_aJsClasses = array( + 'poll' => $this->_sClassPrefix . 'Polls', + 'links' => $this->_sClassPrefix . 'Links', + 'categories' => $this->_sClassPrefix . 'Categories' + ); + + $this->_aJsObjects = array( + 'poll' => 'o' . $this->_sClassPrefix . 'Polls', + 'links' => 'o' . $this->_sClassPrefix . 'Links', + 'categories' => 'o' . $this->_sClassPrefix . 'Categories' + ); + + $this->_aHtmlIds = array( + 'add_poll_popup' => $sPrefix . '-add-poll-popup', + 'add_poll_form_field' => $sPrefix . '-add-poll-form-field', + 'polls_showcase' => $sPrefix . '-polls-showcase-', + 'poll' => $sPrefix . '-poll-', + 'poll_content' => $sPrefix . '-poll-content-', + 'poll_view_menu' => $sPrefix . '-poll-view-menu', + 'poll_view_link_answers' => $sPrefix . '-poll-view-answers-', + 'poll_view_link_results' => $sPrefix . '-poll-view-results-', + + 'attach_link_popup' => $sPrefix . '-attach-link-popup', + 'attach_link_form_field' => $sPrefix . '-attach-link-form-field-', + 'attach_link_item' => $sPrefix . '-attach-link-item-', + ); + + $this->_aPregPatterns = array( + "meta_title" => "/<title>(.*)<\/title>/", + "meta_description" => "/<meta[\s]+[^>]*?name[\s]?=[\s\"\']+description[\s\"\']+content[\s]?=[\s\"\']+(.*?)[\"\']+.*?>/", + "url" => "/(([A-Za-z]{3,9}:(?:\/\/)?)(?:[\-;:&=\+\$,\w]+@)?[A-Za-z0-9\.\-]+|(?:www\.|[\-;:&=\+\$,\w]+@)[A-Za-z0-9\.\-]+)((?:\/[\+~%#\/\.\w\-_!\(\)]*)?\??(?:[\-\+=&;%@\.\w_]*)#?(?:[\.\!\/\\\w]*))?/" + ); + + $this->_bAttachmentsInTimeline = false; + } + + public function isAttachLinks() + { + return !empty($this->CNF['TABLE_LINKS']) && $this->CNF['PARAM_LINKS_ENABLED'] == true; + } + + public function isAttachmentsInTimeline() + { + return $this->_bAttachmentsInTimeline; + } + + public function getPregPattern($sType) + { + return $this->_aPregPatterns[$sType]; + } + + public function getHtmlIds($sKey = '') + { + if(empty($sKey)) + return $this->_aHtmlIds; + + return isset($this->_aHtmlIds[$sKey]) ? $this->_aHtmlIds[$sKey] : ''; + } +} + +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/text/classes/BxBaseModTextModule.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/text/classes/BxBaseModTextModule.php new file mode 100644 index 0000000000..b2cc79d154 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/text/classes/BxBaseModTextModule.php @@ -0,0 +1,1075 @@ +<?php defined('BX_DOL') or die('hack attempt'); +/** + * Copyright (c) UNA, Inc - https://una.io + * MIT License - https://opensource.org/licenses/MIT + * + * @defgroup BaseText Base classes for text modules + * @ingroup UnaModules + * + * @{ + */ + +define('BX_BASE_MOD_TEXT_STATUS_ACTIVE', 'active'); +define('BX_BASE_MOD_TEXT_STATUS_HIDDEN', 'hidden'); +define('BX_BASE_MOD_TEXT_STATUS_AWAITING', 'awaiting'); +/** + * Saved for backward compatibility. + * Can be removed in future releases of UNA 13. + */ +define('BX_BASE_MOD_TEXT_STATUS_PENDING', 'pending'); + +/** + * Base module class for text based modules + */ +class BxBaseModTextModule extends BxBaseModGeneralModule implements iBxDolContentInfoService +{ + function __construct(&$aModule) + { + parent::__construct($aModule); + } + + + // ====== ACTIONS METHODS + + public function actionEmbedPoll($iPollId = 0) + { + if(empty($iPollId) && bx_get('poll_id') !== false) + $iPollId = (int)bx_get('poll_id'); + + $aParams = bx_get_with_prefix('param'); + array_walk($aParams, function(&$sValue) { + $sValue = bx_process_input($sValue); + }); + + $this->_oTemplate->embedPollItem($iPollId, $aParams); + } + + public function actionEmbedPolls($iId = 0) + { + list($iContentId, $aContentInfo) = $this->_getContent($iId); + if($iContentId === false) + return; + + $aParams = bx_get_with_prefix('param'); + array_walk($aParams, function(&$sValue) { + $sValue = bx_process_input($sValue); + }); + + $this->_oTemplate->embedPollItems($aContentInfo, $aParams); + } + + public function actionGetPoll() + { + $iPollId = (int)bx_get('poll_id'); + $sView = bx_process_input(bx_get('view')); + + $sMethod = 'serviceGetBlockPoll' . bx_gen_method_name($sView); + if(!method_exists($this, $sMethod)) + return echoJson(array()); + + $aBlock = $this->$sMethod($iPollId, true); + if(empty($aBlock) || !is_array($aBlock)) + return echoJson(array()); + + return echoJson(array( + 'content' => $aBlock['content'] + )); + } + public function actionDeletePoll() + { + $CNF = &$this->_oConfig->CNF; + + $iId = bx_process_input(bx_get('id'), BX_DATA_INT); + if(empty($iId)) + return echoJson(array()); + + $aResult = array(); + if($this->_oDb->deletePolls(array($CNF['FIELD_POLL_ID'] => $iId))) + $aResult = array('code' => 0); + else + $aResult = array('code' => 1, 'message' => _t($CNF['txt_err_cannot_perform_action'])); + + echoJson($aResult); + } + + public function actionGetPollForm() + { + echo $this->_oTemplate->getPollForm(); + } + + public function actionSubmitPollForm() + { + echoJson($this->getPollForm()); + } + + public function actionFileEmbedVideo($iFileId) + { + $this->_oTemplate->embedVideo($iFileId); + } + + public function actionFileEmbedSound($iFileId) + { + $this->_oTemplate->embedSound($iFileId); + } + + + // ====== SERVICE METHODS + + public function serviceGetSafeServices() + { + $a = parent::serviceGetSafeServices(); + return array_merge($a, array ( + 'GetBlockPollAnswers' => '', + 'GetBlockPollResults' => '', + 'GetMenuAddonManageToolsProfileStats' => '', + 'BrowsePublic' => '', + 'BrowsePopular' => '', + 'BrowseTop' => '', + 'BrowseUpdated' => '', + 'BrowseAuthor' => '', + 'CategoriesMultiListContext' => '' + )); + } + + public function serviceManageTools($sType = 'common') + { + $this->_oTemplate->addJs(['modules/base/text/js/|manage_tools.js']); + + return parent::serviceManageTools($sType); + } + + /** + * @page service Service Calls + * @section bx_base_text Base Text + * @subsection bx_base_general-page_blocks Page Blocks + * @subsubsection bx_base_general-categories_multi_list_context categories_multi_list_context + * + * @code bx_srv('bx_posts', 'categories_multi_list_context', [...]); @endcode + * + * Display multi-categorories block with number of posts in each category for current context + * @param $bDisplayEmptyCats display empty categories + * + * @see BxBaseModGeneralModule::serviceCategoriesMultiListContext + */ + /** + * @ref bx_base_general-categories_multi_list_context "categories_multi_list_context" + */ + public function serviceCategoriesMultiListContext($iProfileId = 0, $bDisplayEmptyCats = true) + { + if ($iProfileId == 0) + $iProfileId = bx_process_input(bx_get('profile_id'), BX_DATA_INT); + + $oCategories = BxDolCategories::getInstance(); + $aCats = $oCategories->getData([ + 'type' => 'by_module&context_with_num', + 'module' => $this->getName(), + 'context_id' => $iProfileId + ] + ); + $aVars = array('bx_repeat:cats' => array()); + foreach ($aCats as $oCat) { + $sValue = $oCat['value']; + $iNum = $oCat['num']; + + $aVars['bx_repeat:cats'][] = array( + 'url' => $oCategories->getUrl($this->getName(), $sValue, '&context_id=' . $iProfileId), + 'name' => _t($sValue), + 'value' => $sValue, + 'num' => $iNum, + ); + } + + if (!$aVars['bx_repeat:cats']) + return ''; + + return $this->_oTemplate->parseHtmlByName('category_list_multi.html', $aVars); + } + + /** + * @page service Service Calls + * @section bx_base_text Base Text + * @subsection bx_base_text-polls Polls Blocks + * @subsubsection bx_base_text-get_block_poll_answers get_block_poll_answers + * + * @code bx_srv('bx_posts', 'get_block_poll_answers', [...]); @endcode + * + * Get block with poll answers + * @param $iPollId poll ID + * + * @see BxBaseModTextModule::serviceGetBlockPollAnswers + */ + /** + * @ref bx_base_text-get_block_poll_answers "get_block_poll_answers" + */ + public function serviceGetBlockPollAnswers($iPollId, $bForceDisplay = false) + { + if(!$iPollId) + return false; + + if(!$bForceDisplay && $this->isPollPerformed($iPollId)) + return $this->serviceGetBlockPollResults($iPollId); + + return $this->_serviceTemplateFunc('entryPollAnswers', $iPollId, 'getPollInfoById'); + } + + /** + * @page service Service Calls + * @section bx_base_text Base Text + * @subsection bx_base_text-polls Polls Blocks + * @subsubsection bx_base_text-get_block_poll_results get_block_poll_results + * + * @code bx_srv('bx_posts', 'get_block_poll_results', [...]); @endcode + * + * Get block with poll results + * @param $iPollId poll ID + * + * @see BxBaseModTextModule::serviceGetBlockPollResults + */ + /** + * @ref bx_base_text-get_block_poll_results "get_block_poll_results" + */ + public function serviceGetBlockPollResults($iPollId) + { + return $this->_serviceTemplateFunc('entryPollResults', $iPollId, 'getPollInfoById'); + } + + /** + * Display media EXIF information. + * @param $iMediaId media ID, if it's omitted then it's taken from 'id' GET variable. + * @return HTML string with EXIF info. On error empty string is returned. + */ + public function serviceMediaExif ($iMediaId = 0) + { + $CNF = &$this->_oConfig->CNF; + return $this->_serviceTemplateFunc ('mediaExif', $iMediaId, $CNF['FUNCTION_FOR_GET_ITEM_INFO']); + } + + public function serviceGetThumb ($iContentId, $sTranscoder = '') + { + $CNF = &$this->_oConfig->CNF; + if(bx_is_api()){ + $aContentInfo = $this->_oDb->getContentInfoById($iContentId); + if (isset($CNF['FIELD_THUMB'])) + return bx_api_get_image($CNF['OBJECT_STORAGE'], $aContentInfo[$CNF['FIELD_THUMB']]); + } + + if(empty($sTranscoder) && !empty($CNF['OBJECT_IMAGES_TRANSCODER_GALLERY'])) + $sTranscoder = $CNF['OBJECT_IMAGES_TRANSCODER_GALLERY']; + + $mixedResult = $this->_getFieldValueThumb('FIELD_THUMB', $iContentId, $sTranscoder); + return $mixedResult !== false ? $mixedResult : ''; + } + + public function serviceGetMenuAddonManageTools() + { + $CNF = &$this->_oConfig->CNF; + + $iNumTotal = $this->_oDb->getEntriesNumByParams(); + + $iNum1 = $this->_oDb->getEntriesNumByParams([ + [ + 'key' => $CNF['FIELD_STATUS'], + 'value' => 'hidden', + 'operator' => '=' + ] + ]); + + $iNum2 = 0; + if (isset($CNF['OBJECT_REPORTS'])){ + $iNum2 = $this->_oDb->getEntriesNumByParams([ + [ + 'key' => 'reports', + 'value' => '0', + 'operator' => '>' + ] + ]); + } + return array('counter1_value' => $iNum1, 'counter2_value' => $iNum2, 'counter3_value' => $iNumTotal ); + } + + /** + * @page service Service Calls + * @section bx_base_text Base Text + * @subsection bx_base_text-other Other + * @subsubsection bx_base_text-get_menu_addon_manage_tools_profile_stats get_menu_addon_manage_tools_profile_stats + * + * @code bx_srv('bx_posts', 'get_menu_addon_manage_tools_profile_stats', []); @endcode + * + * Get number of posts for currently logged in user + * + * @see BxBaseModTextModule::serviceGetMenuAddonManageToolsProfileStats + */ + /** + * @ref bx_base_text-get_menu_addon_manage_tools_profile_stats "get_menu_addon_manage_tools_profile_stats" + */ + public function serviceGetMenuAddonManageToolsProfileStats($iProfileId = 0) + { + if(!$iProfileId) + $iProfileId = bx_get_logged_profile_id(); + + bx_import('SearchResult', $this->_aModule); + $sClass = $this->_aModule['class_prefix'] . 'SearchResult'; + $o = new $sClass(); + $o->fillFilters([ + 'author' => $iProfileId + ]); + $o->unsetPaginate(); + + return $o->getNum(); + } + + /** + * @page service Service Calls + * @section bx_base_text Base Text + * @subsection bx_base_text-browse Browse + * @subsubsection bx_base_text-browse_public browse_public + * + * @code bx_srv('bx_posts', 'browse_public', [...]); @endcode + * + * Display public posts + * @param $sUnitView unit view, such as: full, extended, gallery, showcase + * @param $bEmptyMessage display or not "empty" message when there is no content + * @param $bAjaxPaginate use AJAX paginate or not + * + * @see BxBaseModTextModule::serviceBrowsePublic + */ + /** + * @ref bx_base_text-browse_public "browse_public" + */ + public function serviceBrowsePublic ($sUnitView = false, $bEmptyMessage = true, $bAjaxPaginate = true) + { + return $this->_serviceBrowse ('public', $sUnitView ? array('unit_view' => $sUnitView) : false, BX_DB_PADDING_DEF, $bEmptyMessage, $bAjaxPaginate); + } + + /** + * @page service Service Calls + * @section bx_base_text Base Text + * @subsection bx_base_text-browse Browse + * @subsubsection bx_base_text-browse_popular browse_popular + * + * @code bx_srv('bx_posts', 'browse_popular', [...]); @endcode + * + * Display popular posts + * @param $sUnitView unit view, such as: full, extended, gallery, showcase + * @param $bEmptyMessage display or not "empty" message when there is no content + * @param $bAjaxPaginate use AJAX paginate or not + * + * @see BxBaseModTextModule::serviceBrowsePopular + */ + /** + * @ref bx_base_text-browse_popular "browse_popular" + */ + public function serviceBrowsePopular ($sUnitView = false, $bEmptyMessage = true, $bAjaxPaginate = true) + { + return $this->_serviceBrowse ('popular', $sUnitView ? array('unit_view' => $sUnitView) : false, BX_DB_PADDING_DEF, $bEmptyMessage, $bAjaxPaginate); + } + + /** + * @page service Service Calls + * @section bx_base_text Base Text + * @subsection bx_base_text-browse Browse + * @subsubsection bx_base_text-browse_top browse_top + * + * @code bx_srv('bx_posts', 'browse_top', [...]); @endcode + * + * Display top posts + * @param $sUnitView unit view, such as: full, extended, gallery, showcase + * @param $bEmptyMessage display or not "empty" message when there is no content + * @param $bAjaxPaginate use AJAX paginate or not + * + * @see BxBaseModTextModule::serviceBrowseTop + */ + /** + * @ref bx_base_text-browse_top "browse_top" + */ + public function serviceBrowseTop ($sUnitView = false, $bEmptyMessage = true, $bAjaxPaginate = true) + { + return $this->_serviceBrowse ('top', $sUnitView ? array('unit_view' => $sUnitView) : false, BX_DB_PADDING_DEF, $bEmptyMessage, $bAjaxPaginate); + } + + /** + * @page service Service Calls + * @section bx_base_text Base Text + * @subsection bx_base_text-browse Browse + * @subsubsection bx_base_text-browse_updated browse_updated + * + * @code bx_srv('bx_posts', 'browse_updated', [...]); @endcode + * + * Display recently updated posts + * @param $sUnitView unit view, such as: full, extended, gallery, showcase + * @param $bEmptyMessage display or not "empty" message when there is no content + * @param $bAjaxPaginate use AJAX paginate or not + * + * @see BxBaseModTextModule::serviceBrowseUpdated + */ + /** + * @ref bx_base_text-browse_updated "browse_updated" + */ + public function serviceBrowseUpdated ($sUnitView = false, $bEmptyMessage = true, $bAjaxPaginate = true) + { + return $this->_serviceBrowse ('updated', $sUnitView ? array('unit_view' => $sUnitView) : false, BX_DB_PADDING_DEF, $bEmptyMessage, $bAjaxPaginate); + } + + /** + * @page service Service Calls + * @section bx_base_text Base Text + * @subsection bx_base_text-browse Browse + * @subsubsection bx_base_text-browse_author browse_author + * + * @code bx_srv('bx_posts', 'browse_author', [...]); @endcode + * + * Display posts of specified author + * @param $iProfileId profile ID + * @param $aParams additional params, see BxBaseModGeneralModule::serviceBrowse + * + * @see BxBaseModTextModule::serviceBrowseAuthor + */ + /** + * @ref bx_base_text-browse_author "browse_author" + */ + public function serviceBrowseAuthor ($iProfileId = 0, $aParams = array()) + { + return $this->_serviceBrowseWithParam ('author', 'profile_id', $iProfileId, $aParams); + } + + /** + * @page service Service Calls + * @section bx_base_text Base Text + * @subsection bx_base_text-page_blocks Page Blocks + * @subsubsection bx_base_text-entity_author entity_author + * + * @code bx_srv('bx_posts', 'entity_author', [...]); @endcode + * + * Display author block for the specified post + * @param $iContentId content ID + * + * @see BxBaseModTextModule::serviceEntityAuthor + */ + /** + * @ref bx_base_text-entity_author "entity_author" + */ + public function serviceEntityAuthor ($iContentId = 0) + { + return $this->_serviceTemplateFunc ('entryAuthor', $iContentId); + } + + /** + * @page service Service Calls + * @section bx_base_text Base Text + * @subsection bx_base_text-page_blocks Page Blocks + * @subsubsection bx_base_text-entity_polls entity_polls + * + * @code bx_srv('bx_posts', 'entity_polls', [...]); @endcode + * + * Display polls for the specified post + * @param $iContentId content ID + * + * @see BxBaseModTextModule::serviceEntityPolls + */ + /** + * @ref bx_base_text-entity_polls "entity_polls" + */ + public function serviceEntityPolls ($iContentId = 0) + { + return $this->_serviceTemplateFunc ('entryPolls', $iContentId); + } + + /** + * @page service Service Calls + * @section bx_base_text Base Text + * @subsection bx_base_text-page_blocks Page Blocks + * @subsubsection bx_base_text-entity_breadcrumb entity_breadcrumb + * + * @code bx_srv('bx_forum', 'entity_breadcrumb', [...]); @endcode + * + * Display breadcrumb for the specified post + * @param $iContentId content ID + * + * @see BxBaseModTextModule::serviceEntityBreadcrumb + */ + /** + * @ref bx_base_text-entity_breadcrumb "entity_breadcrumb" + */ + public function serviceEntityBreadcrumb ($iContentId = 0) + { + return $this->_serviceTemplateFunc ('entryBreadcrumb', $iContentId); + } + + /** + * Delete all content by profile + * @param $iProfileId profile id + * @return number of deleted items + */ + public function serviceDeleteEntitiesByAuthor ($iProfileId) + { + $a = $this->_oDb->getEntriesByAuthor((int)$iProfileId); + if (!$a) + return 0; + + $iCount = 0; + foreach ($a as $aContentInfo) + $iCount += ('' == $this->serviceDeleteEntity($aContentInfo[$this->_oConfig->CNF['FIELD_ID']]) ? 1 : 0); + + return $iCount; + } + + + // ====== PERMISSION METHODS + + /** + * @return CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. So make sure to make strict(===) checking. + */ + public function checkAllowedSetThumb ($iContentId = 0) + { + // check ACL + $aCheck = checkActionModule($this->_iProfileId, 'set thumb', $this->getName(), false); + if ($aCheck[CHECK_ACTION_RESULT] !== CHECK_ACTION_RESULT_ALLOWED) + return $aCheck[CHECK_ACTION_MESSAGE]; + return CHECK_ACTION_RESULT_ALLOWED; + } + + public function isAllowedApprove($mixedContent, $isPerformAction = false) + { + return $this->checkAllowedApprove($mixedContent, $isPerformAction) === CHECK_ACTION_RESULT_ALLOWED; + } + + public function checkAllowedApprove($mixedContent, $isPerformAction = false) + { + $CNF = &$this->_oConfig->CNF; + + $sTxtError = '_sys_txt_access_denied'; + $iProfileId = bx_get_logged_profile_id(); + + if(!is_array($mixedContent)) + $mixedContent = $this->_oDb->getContentInfoById((int)$mixedContent); + + if(empty($mixedContent) || !is_array($mixedContent)) + return _t($sTxtError); + + if(!isset($CNF['FIELD_STATUS_ADMIN']) || $mixedContent[$CNF['FIELD_STATUS_ADMIN']] != BX_BASE_MOD_GENERAL_STATUS_PENDING) + return _t($sTxtError); + + if($this->_isModerator()) + return CHECK_ACTION_RESULT_ALLOWED; + + if(!empty($CNF['FIELD_ALLOW_VIEW_TO']) && (int)$mixedContent[$CNF['FIELD_ALLOW_VIEW_TO']] < 0) { + $iContextProfileId = abs((int)$mixedContent[$CNF['FIELD_ALLOW_VIEW_TO']]); + $oContextProfile = BxDolProfile::getInstance($iContextProfileId); + + $aAdmins = bx_srv($oContextProfile->getModule(), 'get_admins_to_manage_content', [$iContextProfileId]); + if(!empty($aAdmins) && in_array($iProfileId, $aAdmins)) + return CHECK_ACTION_RESULT_ALLOWED; + } + + return _t($sTxtError); + } + + public function isPollPerformed($iObjectId, $iAuthorId = 0, $iAuthorIp = 0) + { + if(empty($iAuthorId)) { + $iAuthorId = bx_get_logged_profile_id(); + $iAuthorIp = bx_get_ip_hash(getVisitorIP()); + } + + return $this->_oDb->isPollPerformed($iObjectId, $iAuthorId, $iAuthorIp); + } + + + // ====== COMMON METHODS + public function deleteAttachLinks($iId) + { + if(!$this->_oConfig->isAttachLinks()) + return; + + $CNF = &$this->_oConfig->CNF; + + $aLinks = $this->_oDb->getLinks($iId); + if(empty($aLinks) || !is_array($aLinks)) + return; + + $oStorage = BxDolStorage::getObjectInstance($CNF['OBJECT_STORAGE_PHOTOS']); + foreach($aLinks as $aLink) + if(!empty($aLink['media_id'])) + $oStorage->deleteFile($aLink['media_id']); + + $this->_oDb->deleteLinks($iId); + } + + public function deleteAttachLinksUnused($iProfileId) + { + if(!$this->_oConfig->isAttachLinks()) + return; + + $CNF = &$this->_oConfig->CNF; + + $aLinks = $this->_oDb->getUnusedLinks($iProfileId); + if(empty($aLinks) || !is_array($aLinks)) + return; + + $oStorage = BxDolStorage::getObjectInstance($CNF['OBJECT_STORAGE_PHOTOS']); + foreach($aLinks as $aLink) + if(!empty($aLink['media_id'])) + $oStorage->deleteFile($aLink['media_id']); + + $this->_oDb->deleteUnusedLinks($iProfileId); + } + + public function onApprove($mixedContent) + { + $CNF = &$this->_oConfig->CNF; + + if(!is_array($mixedContent)) + $mixedContent = $this->_oDb->getContentInfoById((int)$mixedContent); + + $this->alertAfterApprove($mixedContent); + + $this->onPublished($mixedContent[$CNF['FIELD_ID']]); + } + + public function alertAfterAdd($aContentInfo) + { + $CNF = &$this->_oConfig->CNF; + + $iId = (int)$aContentInfo[$CNF['FIELD_ID']]; + $iAuthorId = (int)$aContentInfo[$CNF['FIELD_AUTHOR']]; + + $sAction = 'added'; + if(isset($CNF['FIELD_STATUS']) && isset($aContentInfo[$CNF['FIELD_STATUS']]) && $aContentInfo[$CNF['FIELD_STATUS']] == BX_BASE_MOD_TEXT_STATUS_AWAITING) + $sAction = 'deferred'; + else if(isset($CNF['FIELD_STATUS_ADMIN']) && isset($aContentInfo[$CNF['FIELD_STATUS_ADMIN']]) && $aContentInfo[$CNF['FIELD_STATUS_ADMIN']] == BX_BASE_MOD_GENERAL_STATUS_PENDING) + $sAction = 'deferred'; + + $aParams = $this->_alertParamsAdd($aContentInfo); + + /** + * @hooks + * @hookdef hook-system-prepare_alert_params 'system', 'prepare_alert_params' - hook to override alert (hook) params + * - $unit_name - equals `system` + * - $action - equals `prepare_alert_params` + * - $object_id - not used + * - $sender_id - not used + * - $extra_params - array of additional params with the following array keys: + * - `unit` - [string] unit name + * - `action` - [string] by ref, action, can be overridden in hook processing + * - `object_id` - [int] by ref, object id, can be overridden in hook processing + * - `sender_id` - [int] by ref, action performer profile id, can be overridden in hook processing + * - `extras` - [array] by ref, extra params array as key&value pairs, can be overridden in hook processing + * @hook @ref hook-system-prepare_alert_params + */ + bx_alert('system', 'prepare_alert_params', 0, 0, [ + 'unit'=> $this->getName(), + 'action' => &$sAction, + 'object_id' => &$iId, + 'sender_id' => &$iAuthorId, + 'extras' => &$aParams + ]); + + /** + * @hooks + * @hookdef hook-bx_base_text-added '{module_name}', 'added' - hook after content was added (published) + * - $unit_name - module name + * - $action - equals `added` + * - $object_id - content id + * - $sender_id - content author profile id + * - $extra_params - array of additional params with the following array keys: + * - `status` - [string] content status + * - `status_admin` - [string] content admin status + * - `privacy_view` - [int] or [string] privacy for view content action, @see BxDolPrivacy + * - `cf` - [int] content's audience filter value + * @hook @ref hook-bx_base_text-added + */ + /** + * @hooks + * @hookdef hook-bx_base_text-deferred '{module_name}', 'deferred' - hook after content was added with pending approval status + * It's equivalent to @ref hook-bx_base_text-added + * @hook @ref hook-bx_base_text-deferred + */ + bx_alert($this->getName(), $sAction, $iId, $iAuthorId, $aParams); + + $this->_processModerationNotifications($aContentInfo); + } + + public function alertAfterEdit($aContentInfo) + { + $CNF = &$this->_oConfig->CNF; + + $iId = (int)$aContentInfo[$CNF['FIELD_ID']]; + + $aParams = $this->_alertParamsEdit($aContentInfo); + + /** + * @hooks + * @hookdef hook-bx_base_text-edited '{module_name}', 'edited' - hook after content was changed + * It's equivalent to @ref hook-bx_base_text-added + * @hook @ref hook-bx_base_text-edited + */ + bx_alert($this->getName(), 'edited', $iId, false, $aParams); + } + + /** + * Get array of params to be passed in Add/Edit Alert. + */ + protected function _alertParams($aContentInfo) + { + $aParams = parent::_alertParams($aContentInfo); + + $CNF = &$this->_oConfig->CNF; + + if(!empty($CNF['FIELD_STATUS']) && isset($aContentInfo[$CNF['FIELD_STATUS']])) + $aParams['status'] = $aContentInfo[$CNF['FIELD_STATUS']]; + + if(!empty($CNF['FIELD_STATUS_ADMIN']) && isset($aContentInfo[$CNF['FIELD_STATUS_ADMIN']])) + $aParams['status_admin'] = $aContentInfo[$CNF['FIELD_STATUS_ADMIN']]; + + if(!empty($CNF['FIELD_ALLOW_VIEW_TO']) && isset($aContentInfo[$CNF['FIELD_ALLOW_VIEW_TO']])) + $aParams['privacy_view'] = $aContentInfo[$CNF['FIELD_ALLOW_VIEW_TO']]; + + if(!empty($CNF['FIELD_CF']) && isset($aContentInfo[$CNF['FIELD_CF']])) + $aParams['cf'] = $aContentInfo[$CNF['FIELD_CF']]; + + return $aParams; + } + + protected function _alertParamsAdd($aContentInfo) + { + $aParams = $this->_alertParams($aContentInfo); + + $CNF = &$this->_oConfig->CNF; + + if(!empty($CNF['OBJECT_METATAGS'])) + $aParams['timeline_group'] = $this->_getAlertParamTimelineGroup($aContentInfo); + + return $aParams; + } + + protected function _alertParamsEdit($aContentInfo) + { + $aParams = $this->_alertParams($aContentInfo); + + $CNF = &$this->_oConfig->CNF; + + if(!empty($CNF['OBJECT_METATAGS'])) + $aParams['timeline_group'] = $this->_getAlertParamTimelineGroup($aContentInfo); + + return $aParams; + } + + protected function _getAlertParamTimelineGroup($aContentInfo) + { + $CNF = &$this->_oConfig->CNF; + + return [ + 'by' => $this->getName() . '_' . abs((int)$aContentInfo[$CNF['FIELD_AUTHOR']]) . '_' . (int)$aContentInfo[$CNF['FIELD_ID']], + 'field' => 'owner_id' + ]; + } + + public function getPollForm() + { + $CNF = &$this->_oConfig->CNF; + + if(empty($CNF['OBJECT_FORM_POLL'])) + return array('code' => 1, 'message' => '_sys_txt_error_occured'); + + $iProfileId = bx_get_logged_profile_id(); + + $oForm = BxDolForm::getObjectInstance($CNF['OBJECT_FORM_POLL'], $CNF['OBJECT_FORM_POLL_DISPLAY_ADD'], $this->_oTemplate); + $oForm->aFormAttrs['action'] = BX_DOL_URL_ROOT . $this->_oConfig->getBaseUri() . 'submit_poll_form/'; + + $oForm->initChecker(); + if($oForm->isSubmittedAndValid()) { + $iId = $oForm->insert(); + if($iId) + return array('code' => 0, 'id' => $iId, 'item' => $this->_oTemplate->getPollItem($iId, $iProfileId, array( + 'manage' => true + ))); + else + return array('code' => 2, 'message' => '_sys_txt_error_entry_creation'); + } + + return array('form' => $oForm->getCode(), 'form_id' => $oForm->id); + } + + public function getEntryImageData($aContentInfo, $sField = 'FIELD_THUMB', $aTranscoders = array()) + { + $CNF = &$this->_oConfig->CNF; + + $mResult = parent::getEntryImageData($aContentInfo, $sField, $aTranscoders); + if ($mResult === false && isset($CNF['PARAM_USE_GALERY_AS_COVER']) && getParam($CNF['PARAM_USE_GALERY_AS_COVER']) == 'on'){ + if(!empty($CNF['OBJECT_STORAGE_PHOTOS']) && !empty($CNF['OBJECT_IMAGES_TRANSCODER_PREVIEW_PHOTOS'])){ + $sStorage = $CNF['OBJECT_STORAGE_PHOTOS']; + $oStorage = BxDolStorage::getObjectInstance($sStorage); + $aGhostFiles = $oStorage->getGhosts ($this->serviceGetContentOwnerProfileId($aContentInfo[$CNF['FIELD_ID']]), $aContentInfo[$CNF['FIELD_ID']]); + if ($aGhostFiles){ + foreach ($aGhostFiles as $k => $a) { + return array('id' => $a['id'], 'transcoder' => $CNF['OBJECT_IMAGES_TRANSCODER_PREVIEW_PHOTOS']); + } + } + + } + } + + return $mResult; + } + + public function decodeDataAPI($aData, $aParams = []) + { + $CNF = &$this->_oConfig->CNF; + + $sModule = $this->getName(); + $iId = (int)$aData[$CNF['FIELD_ID']]; + + $sSummary = ''; + if(!empty($CNF['PARAM_CHARS_SUMMARY_PLAIN'])) { + $sSummary = $this->_oTemplate->getText($aData); + $sSummary = BxTemplFunctions::getInstance()->getStringWithLimitedLength(strip_tags($sSummary), (int)getParam($CNF['PARAM_CHARS_SUMMARY_PLAIN'])); + } + + $aResult = [ + 'id' => $iId, + 'module' => $sModule, + 'module_title' => _t($CNF['T']['txt_sample_single']), + 'added' => $aData[$CNF['FIELD_ADDED']], + 'author' => $aData[$CNF['FIELD_AUTHOR']], + 'author_data' => !empty($aData[$CNF['FIELD_AUTHOR']]) ? BxDolProfile::getData($aData[$CNF['FIELD_AUTHOR']]) : '', + 'title' => $aData[$CNF['FIELD_TITLE']], + 'url' => bx_api_get_relative_url($this->serviceGetLink($iId)), + 'image' => $this->serviceGetThumb($iId), + 'summary_plain' => $sSummary + ]; + + if(isset($aParams['extended']) && $aParams['extended'] === true) + $aResult['text'] = $aData[$CNF['FIELD_TEXT']]; + + if(!empty($CNF['OBJECT_MENU_SNIPPET_META']) && ($oMetaMenu = BxDolMenu::getObjectInstance($CNF['OBJECT_MENU_SNIPPET_META'], $this->_oTemplate)) !== false) { + $oMetaMenu->setContentId($iId); + + $aResult['meta'] = $oMetaMenu->getCodeAPI(); + } + + return $aResult; + } + + + // ====== PROTECTED METHODS + + protected function _getImagesForTimelinePost($aEvent, $aContentInfo, $sUrl, $aBrowseParams = array()) + { + $CNF = &$this->_oConfig->CNF; + $aResults = parent::_getImagesForTimelinePost($aEvent, $aContentInfo, $sUrl, $aBrowseParams); + + if (bx_is_api()) + return $aResults; + + if (count($aResults) == 0 && isset($CNF['PARAM_USE_GALERY_AS_COVER']) && getParam($CNF['PARAM_USE_GALERY_AS_COVER']) == 'on'){ + $aResults = $this->_getImagesForTimelinePostAttachInner($aEvent, $aContentInfo, $sUrl, $aBrowseParams); + if (count($aResults) > 1){ + $aResults = array_slice($aResults, 0, 1); + } + } + return $aResults; + } + + protected function _getImagesForTimelinePostAttach($aEvent, $aContentInfo, $sUrl, $aBrowseParams = array()) + { + $CNF = &$this->_oConfig->CNF; + $aTmp = parent::_getImagesForTimelinePost($aEvent, $aContentInfo, $sUrl, $aBrowseParams); + $aResults = $this->_getImagesForTimelinePostAttachInner($aEvent, $aContentInfo, $sUrl, $aBrowseParams); + + if (bx_is_api()) + return $aResults; + + if (count($aTmp) == 0 && count($aResults) > 0 && isset($CNF['PARAM_USE_GALERY_AS_COVER']) && getParam($CNF['PARAM_USE_GALERY_AS_COVER']) == 'on'){ + $aResults = array_slice($aResults, 1); + } + return $aResults; + } + + protected function _getImagesForTimelinePostAttachInner($aEvent, $aContentInfo, $sUrl, $aBrowseParams = array()) + { + $CNF = &$this->_oConfig->CNF; + + $aResults = parent::_getImagesForTimelinePostAttach($aEvent, $aContentInfo, $sUrl, $aBrowseParams); + + if(!$this->_oConfig->isAttachmentsInTimeline() || empty($CNF['OBJECT_STORAGE_PHOTOS']) || empty($CNF['OBJECT_IMAGES_TRANSCODER_GALLERY_PHOTOS'])) + return $aResults; + + $iContentId = (int)$aContentInfo[$CNF['FIELD_ID']]; + $oStorage = BxDolStorage::getObjectInstance($CNF['OBJECT_STORAGE_PHOTOS']); + + $aGhostFiles = $oStorage->getGhosts($this->serviceGetContentOwnerProfileId($iContentId), $iContentId); + if(!$aGhostFiles) + return []; + + $oTranscoderSm = false; + if(!empty($CNF['OBJECT_IMAGES_TRANSCODER_MINIATURE_PHOTOS'])) + $oTranscoderSm = BxDolTranscoderImage::getObjectInstance($CNF['OBJECT_IMAGES_TRANSCODER_MINIATURE_PHOTOS']); + + $oTranscoderMd = BxDolTranscoderImage::getObjectInstance($CNF['OBJECT_IMAGES_TRANSCODER_GALLERY_PHOTOS']); + + $oTranscoderXl = false; + if(!empty($CNF['OBJECT_IMAGES_TRANSCODER_VIEW_PHOTOS'])) + $oTranscoderXl = BxDolTranscoderImage::getObjectInstance($CNF['OBJECT_IMAGES_TRANSCODER_VIEW_PHOTOS']); + + foreach($aGhostFiles as $k => $a) { + $sPhotoSrcMd = $oTranscoderMd->getFileUrl($a['id']); + if(empty($sPhotoSrcMd)) + continue; + + $sPhotoSrcSm = $oTranscoderSm !== false ? $oTranscoderSm->getFileUrl($a['id']) : ''; + if(!$sPhotoSrcSm) + $sPhotoSrcSm = $sPhotoSrcMd; + + $sPhotoSrcXl = $oTranscoderXl !== false ? $oTranscoderXl->getFileUrl($a['id']) : $oStorage->getFileUrlById($a['id']); + if(!$sPhotoSrcXl) + $sPhotoSrcXl = $sPhotoSrcMd; + + if (bx_is_api()){ + $aResults[] = bx_api_get_image($CNF['OBJECT_STORAGE_PHOTOS'], (int)$a['id']); + } + else{ + $aResults[] = [ + 'id' => $a['id'], + 'src' => $sPhotoSrcMd, + 'src_small' => $sPhotoSrcSm, + 'src_medium' => $sPhotoSrcMd, + 'src_orig' => $sPhotoSrcXl, + ]; + } + } + return $aResults; + } + + protected function _getVideosForTimelinePostAttach($aEvent, $aContentInfo, $sUrl, $aBrowseParams = array()) + { + $CNF = &$this->_oConfig->CNF; + + $aResults = parent::_getVideosForTimelinePostAttach($aEvent, $aContentInfo, $sUrl, $aBrowseParams); + if(!$this->_oConfig->isAttachmentsInTimeline() || empty($CNF['OBJECT_STORAGE_VIDEOS']) || empty($CNF['OBJECT_VIDEOS_TRANSCODERS'])) + return $aResults; + + $iContentId = (int)$aContentInfo[$CNF['FIELD_ID']]; + $oStorage = BxDolStorage::getObjectInstance($CNF['OBJECT_STORAGE_VIDEOS']); + + $aGhostFiles = $oStorage->getGhosts($this->serviceGetContentOwnerProfileId($iContentId), $iContentId); + if(!$aGhostFiles) + return array(); + + $oTcPoster = BxDolTranscoderVideo::getObjectInstance($CNF['OBJECT_VIDEOS_TRANSCODERS']['poster']); + $oTcMp4 = BxDolTranscoderVideo::getObjectInstance($CNF['OBJECT_VIDEOS_TRANSCODERS']['mp4']); + $oTcMp4Hd = BxDolTranscoderVideo::getObjectInstance($CNF['OBJECT_VIDEOS_TRANSCODERS']['mp4_hd']); + if(!$oTcPoster || !$oTcMp4 || !$oTcMp4Hd) + return array(); + + $aResults = array(); + foreach ($aGhostFiles as $k => $a) { + $sVideoUrl = $oStorage->getFileUrlById($a['id']); + $aVideoFile = $oStorage->getFile($a['id']); + + $sVideoUrlHd = ''; + if (!empty($aVideoFile['dimensions']) && $oTcMp4Hd->isProcessHD($aVideoFile['dimensions'])) + $sVideoUrlHd = $oTcMp4Hd->getFileUrl($a['id']); + + $aResults[$a['id']] = array( + 'id' => $a['id'], + 'src_poster' => $oTcPoster->getFileUrl($a['id']), + 'src_mp4' => $oTcMp4->getFileUrl($a['id']), + 'src_mp4_hd' => $sVideoUrlHd, + ); + } + + return $aResults; + } + + protected function _getFilesForTimelinePostAttach($aEvent, $aContentInfo, $sUrl, $aBrowseParams = array()) + { + $CNF = &$this->_oConfig->CNF; + + $aResults = parent::_getFilesForTimelinePostAttach($aEvent, $aContentInfo, $sUrl, $aBrowseParams); + if(!$this->_oConfig->isAttachmentsInTimeline() || empty($CNF['OBJECT_STORAGE_FILES'])) + return $aResults; + + $iContentId = (int)$aContentInfo[$CNF['FIELD_ID']]; + $oStorage = BxDolStorage::getObjectInstance($CNF['OBJECT_STORAGE_FILES']); + + $aGhostFiles = $oStorage->getGhosts($this->serviceGetContentOwnerProfileId($iContentId), $iContentId); + if(!$aGhostFiles) + return array(); + + $oTranscoder = null; + if(!empty($CNF['OBJECT_IMAGES_TRANSCODER_GALLERY_FILES'])) + $oTranscoder = BxDolTranscoderImage::getObjectInstance($CNF['OBJECT_IMAGES_TRANSCODER_GALLERY_FILES']); + + foreach ($aGhostFiles as $k => $a) { + $bImage = in_array($a['ext'], array('jpg', 'jpeg', 'png', 'gif')); + + $sPhotoSrc = ''; + if($bImage && $oTranscoder) + $sPhotoSrc = $oTranscoder->getFileUrl($a['id']); + + if(empty($sPhotoSrc) && $oStorage) + $sPhotoSrc = $this->_oTemplate->getIconUrl($oStorage->getIconNameByFileName($a['file_name'])); + + $sUrl = $oStorage->getFileUrlById($a['id']); + + $aResults[] = array( + 'id' => $a['id'], + 'src' => $sPhotoSrc, + 'src_medium' => $sPhotoSrc, + 'src_orig' => $bImage ? $sUrl : '', + 'url' => !$bImage ? $sUrl : '' + ); + } + + return $aResults; + } + + protected function _getContentForTimelinePost($aEvent, $aContentInfo, $aBrowseParams = array()) + { + $aResult = parent::_getContentForTimelinePost($aEvent, $aContentInfo, $aBrowseParams); + if(!$this->_oConfig->isAttachmentsInTimeline()) + return $aResult; + + $CNF = &$this->_oConfig->CNF; + + $bDynamic = isset($aBrowseParams['dynamic_mode']) && (bool)$aBrowseParams['dynamic_mode'] === true; + if(!empty($CNF['PARAM_POLL_ENABLED']) && $CNF['PARAM_POLL_ENABLED'] == true) + $aPolls = $this->_oDb->getPolls(array('type' => 'content_id', 'content_id' => (int)$aContentInfo[$CNF['FIELD_ID']])); + if(!empty($aPolls) && is_array($aPolls)) { + $sInclude = $this->_oTemplate->addCss(array('polls.css'), $bDynamic); + + $aResult['raw'] = ($bDynamic ? $sInclude : '') . $this->_oTemplate->parseHtmlByName('poll_items_embed.html', array( + 'embed_url' => BX_DOL_URL_ROOT . bx_append_url_params($this->_oConfig->getBaseUri() . 'embed_polls/', array( + 'id' => (int)$aContentInfo[$CNF['FIELD_ID']], + 'param_switch_menu' => 0, + 'param_showcase' => 1 + )) + )); +/* + if((!empty($aResult['videos']) && is_array($aResult['videos'])) || (!empty($aResult['videos_attach']) && is_array($aResult['videos_attach']))) + $aResult['_cache'] = false; + */ + } + return $aResult; + } + + protected function _buildRssParams($sMode, $aArgs) + { + $aParams = array (); + $sMode = bx_process_input($sMode); + switch ($sMode) { + case 'author': + $aParams = array('author' => isset($aArgs[0]) ? (int)$aArgs[0] : ''); + break; + } + + return $aParams; + } + + public function serviceIsAllowedPostInContext() + { + return true; + } +} + +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/text/classes/BxBaseModTextSearchResult.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/text/classes/BxBaseModTextSearchResult.php new file mode 100644 index 0000000000..ff2a626846 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/text/classes/BxBaseModTextSearchResult.php @@ -0,0 +1,256 @@ +<?php defined('BX_DOL') or die('hack attempt'); +/** + * Copyright (c) UNA, Inc - https://una.io + * MIT License - https://opensource.org/licenses/MIT + * + * @defgroup BaseText Base classes for text modules + * @ingroup UnaModules + * + * @{ + */ + +class BxBaseModTextSearchResult extends BxBaseModGeneralSearchResult +{ + protected $sUnitViewParamName = 'unit_view'; + + function __construct($sMode = '', $aParams = array()) + { + parent::__construct($sMode, $aParams); + $this->aUnitViews = array('extended' => 'unit.html', 'gallery' => 'unit_gallery.html', 'full' => 'unit_full.html', 'showcase' => 'unit_showcase.html'); + if (!empty($aParams['unit_views'])) + $this->aUnitViews = $aParams['unit_views']; + if (!empty($aParams['unit_view'])) + $this->sUnitViewDefault = $aParams['unit_view']; + $this->aGetParams = array($this->sUnitViewParamName); + $this->sUnitTemplate = $this->aUnitViews[$this->sUnitViewDefault]; + if (isset($this->aUnitViews[bx_get($this->sUnitViewParamName)])) + $this->sUnitTemplate = $this->aUnitViews[bx_get($this->sUnitViewParamName)]; + $this->addContainerClass ('bx-def-margin-bottom-neg'); + if ('unit_gallery.html' == $this->sUnitTemplate){ + $this->removeContainerClass ('bx-def-margin-bottom-neg'); + $this->addContainerClass (array('bx-base-text-unit-gallery-wrapper', 'bx-def-margin-sec-neg')); + } + if ('unit_showcase.html' == $this->sUnitTemplate){ + $this->bShowcaseView = true; + } + } + + protected function checkRestrictionsForContext($sMode, $aParams, $oProfileAuthor){ + if(bx_get('context_id')){ + $aParams['context'] = bx_get('context_id'); + $oProfileAuthor = null; + $this->_updateCurrentForContext($sMode, $aParams, $oProfileAuthor); + } + } + + function getAlterOrder() + { + $CNF = &$this->oModule->_oConfig->CNF; + + $sTable = $this->aCurrent['table']; + + $aSql = array(); + switch ($this->aCurrent['sorting']) { + case 'last': + $aSql['order'] = ' ORDER BY `' . $sTable . '`.`' . $CNF['FIELD_ADDED'] . '` DESC'; + break; + + case 'updated': + $aSql['order'] = ' ORDER BY `' . $sTable . '`.`' . $CNF['FIELD_CHANGED'] . '` DESC'; + break; + + case 'featured': + $aSql['order'] = ' ORDER BY `' . $sTable . '`.`featured` DESC'; + break; + + case 'popular': + $aSql['order'] = ' ORDER BY `' . $sTable . '`.`' . $CNF['FIELD_VIEWS'] . '` DESC'; + break; + + case 'top': + $aSql['order'] = ''; + + $aPartsUp = $aPartsDown = array(0); + if(!empty($CNF['OBJECT_VOTES']) && ($oVote = BxDolVote::getObjectInstance($CNF['OBJECT_VOTES'], 0, false)) !== false && $oVote->isEnabled()) { + $aVote = $oVote->getSystemInfo(); + if(!empty($aVote['trigger_table']) && !empty($aVote['trigger_field_count'])) + $aPartsUp[] = '`' . $aVote['trigger_table'] . '`.`' . $aVote['trigger_field_count'] . '`'; + } + + if(!empty($CNF['OBJECT_REACTIONS']) && ($oReaction = BxDolVote::getObjectInstance($CNF['OBJECT_REACTIONS'], 0, false)) !== false && $oReaction->isEnabled()) { + $aReaction = $oReaction->getSystemInfo(); + if(!empty($aReaction['trigger_table']) && !empty($aReaction['trigger_field_count'])) + $aPartsUp[] = '`' . $aReaction['trigger_table'] . '`.`' . $aReaction['trigger_field_count'] . '`'; + } + + if(!empty($CNF['OBJECT_SCORES']) && ($oScore = BxDolScore::getObjectInstance($CNF['OBJECT_SCORES'], 0, false)) !== false && $oScore->isEnabled()) { + $aScore = $oScore->getSystemInfo(); + if(!empty($aScore['trigger_table']) && !empty($aScore['trigger_field_cup']) && !empty($aScore['trigger_field_cdown'])) { + $aPartsUp[] = '`' . $aScore['trigger_table'] . '`.`' . $aScore['trigger_field_cup'] . '`'; + $aPartsDown[] = '`' . $aScore['trigger_table'] . '`.`' . $aScore['trigger_field_cdown'] . '`'; + } + } + + if(empty($aPartsUp) && empty($aPartsDown)) + break; + + $aSql['order'] = ' ORDER BY ' . pow(10, 8) . ' * ((' . implode(' + ', $aPartsUp) . ') - (' . implode(' + ', $aPartsDown) . ')) / (UNIX_TIMESTAMP() - `' . $sTable . '`.`' . $CNF['FIELD_ADDED'] . '`) DESC'; + break; + } + + return $aSql; + } + + function getRssUnitImage (&$a, $sField) + { + $CNF = &$this->oModule->_oConfig->CNF; + + if(empty($sField) || empty($a[$sField]) || empty($CNF['OBJECT_IMAGES_TRANSCODER_GALLERY'])) + return ''; + + $oTranscoder = BxDolTranscoderImage::getObjectInstance($CNF['OBJECT_IMAGES_TRANSCODER_GALLERY']); + if(!$oTranscoder) + return ''; + + return $oTranscoder->getFileUrl($a[$sField]); + } + + protected function processReplaceableMarkers($oProfileAuthor) + { + if ($oProfileAuthor) { + $this->addMarkers($oProfileAuthor->getInfo()); // profile info is replaceable + $this->addMarkers(array('profile_id' => $oProfileAuthor->id())); // profile id is replaceable + $this->addMarkers(array('display_name' => $oProfileAuthor->getDisplayName())); // profile display name is replaceable + } + + $this->sBrowseUrl = $this->_replaceMarkers($this->sBrowseUrl); + $this->aCurrent['title'] = $this->_replaceMarkers($this->aCurrent['title']); + } + + protected function getCurrentOnclick($aAdditionalParams = array(), $bReplacePagesParams = true) + { + // always add UnitView as additional param + $sUnitView = bx_process_input(bx_get($this->sUnitViewParamName)); + if ($sUnitView && isset($this->aUnitViews[$sUnitView])) + $aAdditionalParams = array_merge(array($this->sUnitViewParamName => $sUnitView), $aAdditionalParams); + + return parent::getCurrentOnclick($aAdditionalParams, $bReplacePagesParams); + } + + protected function _updateCurrentForAuthor($sMode, $aParams, &$oProfileAuthor) + { + $CNF = &$this->oModule->_oConfig->CNF; + + $oProfileAuthor = BxDolProfile::getInstance((int)$aParams['author']); + if (!$oProfileAuthor) + return false; + + $iProfileAuthor = $oProfileAuthor->id(); + if (bx_get_logged_profile_id() == $iProfileAuthor || $this->oModule->_isModerator()) { + // for real owner and for moderators show anonymous posts + $this->aCurrent['restriction']['author']['operator'] = 'in'; + $this->aCurrent['restriction']['author']['value'] = array($iProfileAuthor, -$iProfileAuthor); + } + else { + $this->aCurrent['restriction']['author']['value'] = $iProfileAuthor; + } + + if(!empty($aParams['except'])) + $this->aCurrent['restriction']['except']['value'] = is_array($aParams['except']) ? $aParams['except'] : array($aParams['except']); + + if(!empty($aParams['per_page'])) + $this->aCurrent['paginate']['perPage'] = is_numeric($aParams['per_page']) ? (int)$aParams['per_page'] : (int)getParam($aParams['per_page']); + + $this->sBrowseUrl = 'page.php?i=' . $CNF['URI_AUTHOR_ENTRIES'] . '&profile_id={profile_id}'; + $this->aCurrent['title'] = _t($CNF['T']['txt_all_entries_by_author']); + $this->aCurrent['rss']['link'] = 'modules/?r=' . $this->oModule->_oConfig->getUri() . '/rss/' . $sMode . '/' . $iProfileAuthor; + + return true; + } + + protected function _updateCurrentForContext($sMode, $aParams, &$oProfileContext) + { + $CNF = &$this->oModule->_oConfig->CNF; + + if(empty($aParams['context'])) + return false; + + $oProfileContext = BxDolProfile::getInstance((int)$aParams['context']); + if(!$oProfileContext) + return false; + + $iProfileIdContext = $oProfileContext->id(); + $this->aCurrent['restriction']['context'] = array( + 'value' => -$iProfileIdContext, + 'field' => $CNF['FIELD_ALLOW_VIEW_TO'], + 'operator' => '=', + ); + + if(!empty($aParams['per_page'])) + $this->aCurrent['paginate']['perPage'] = is_numeric($aParams['per_page']) ? (int)$aParams['per_page'] : (int)getParam($aParams['per_page']); + + $this->sBrowseUrl = 'page.php?i=' . $CNF['URI_ENTRIES_BY_CONTEXT'] . '&profile_id={profile_id}'; + $this->aCurrent['title'] = _t($CNF['T']['txt_all_entries_by_context']); + $this->aCurrent['rss']['link'] = 'modules/?r=' . $this->oModule->_oConfig->getUri() . '/rss/' . $sMode . '/' . $iProfileIdContext; + + return true; + } + + protected function _updateCurrentForFavorite($sMode, $aParams, &$oProfileAuthor) + { + $CNF = &$this->oModule->_oConfig->CNF; + + $sSystem = ''; + $iListId = 0; + + if(!empty($aParams['system'])) { + $sSystem = $aParams['system']; + unset($aParams['system']); + } + + if(!empty($aParams['list_id'])) { + $iListId = $aParams['list_id']; + unset($aParams['list_id']); + } + + $oProfileAuthor = BxDolProfile::getInstance((int)$aParams['user']); + if(!$oProfileAuthor) + return false; + + $iProfileAuthor = $oProfileAuthor->id(); + $oFavorite = $this->oModule->getObjectFavorite($sSystem); + if(!$oFavorite->isPublic() && $iProfileAuthor != bx_get_logged_profile_id()) + return false; + + $aConditions = $oFavorite->getConditionsTrack($this->aCurrent['table'], 'id', $iProfileAuthor, $iListId); + if(!empty($aConditions) && is_array($aConditions)) { + if(empty($this->aCurrent['restriction']) || !is_array($this->aCurrent['restriction'])) + $this->aCurrent['restriction'] = array(); + $this->aCurrent['restriction'] = array_merge($this->aCurrent['restriction'], $aConditions['restriction']); + + if(empty($this->aCurrent['join']) || !is_array($this->aCurrent['join'])) + $this->aCurrent['join'] = array(); + $this->aCurrent['join'] = array_merge($this->aCurrent['join'], $aConditions['join']); + } + + $this->sBrowseUrl = 'page.php?i=' . $CNF['URI_AUTHOR_ENTRIES'] . '&profile_id={profile_id}'; + $this->aCurrent['title'] = _t($CNF['T']['txt_all_entries_by_author']); + $this->aCurrent['rss']['link'] = 'modules/?r=' . $this->oModule->_oConfig->getUri() . '/rss/' . $sMode . '/' . $iProfileAuthor; + + return true; + } + + function _getPseud () + { + return array( + 'id' => 'id', + 'title' => 'title', + 'text' => 'text', + 'added' => 'added', + 'author' => 'author', + 'photo' => 'photo', + ); + } +} + +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/text/classes/BxBaseModTextTemplate.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/text/classes/BxBaseModTextTemplate.php new file mode 100644 index 0000000000..9257ad9f64 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/text/classes/BxBaseModTextTemplate.php @@ -0,0 +1,1178 @@ +<?php defined('BX_DOL') or die('hack attempt'); +/** + * Copyright (c) UNA, Inc - https://una.io + * MIT License - https://opensource.org/licenses/MIT + * + * @defgroup BaseText Base classes for text modules + * @ingroup UnaModules + * + * @{ + */ + +/** + * Module representation. + */ +class BxBaseModTextTemplate extends BxBaseModGeneralTemplate +{ + protected $_sUnitClassShowCase; + + function __construct(&$oConfig, &$oDb) + { + parent::__construct($oConfig, $oDb); + + $this->_sUnitClassShowCase = 'bx-base-unit-showcase bx-base-text-unit-showcase bx-def-margin-sec-bottom'; + } + + public function addLocationBase() + { + parent::addLocationBase(); + + $this->addLocation('mod_text', BX_DIRECTORY_PATH_MODULES . 'base' . DIRECTORY_SEPARATOR . 'text' . DIRECTORY_SEPARATOR, BX_DOL_URL_MODULES . 'base/text/'); + } + + public function getJsCode($sType, $aParams = array(), $bWrap = true) + { + $CNF = &$this->getModule()->_oConfig->CNF; + + $aParams = array_merge(array( + 'aHtmlIds' => $this->_oConfig->getHtmlIds(), + 'sEditorId' => isset($CNF['FIELD_TEXT_ID']) ? $CNF['FIELD_TEXT_ID'] : '' + ), $aParams); + + return parent::getJsCode($sType, $aParams, $bWrap); + } + + function unit ($aData, $isCheckPrivateContent = true, $sTemplateName = 'unit.html', $aParams = array()) + { + if(!empty($aParams['template_name'])) + $sTemplateName = $aParams['template_name']; + else + $aParams['template_name'] = $sTemplateName; + + $sResult = $this->checkPrivacy ($aData, $isCheckPrivateContent, $this->getModule(), $sTemplateName); + if($sResult) + return $sResult; + + $aTemplateVars = $this->getUnit($aData, $aParams); + + /** + * @hooks + * @hookdef hook-bx_base_text-unit '{module_name}', 'unit' - hook to override content browsing unit + * - $unit_name - module name + * - $action - equals `unit` + * - $object_id - not used + * - $sender_id - not used + * - $extra_params - array of additional params with the following array keys: + * - `data` - [array] content info array as key&value pairs + * - `check_private_content` - [boolean] check if it's a provate content + * - `template` - [string] or [array] with template for content unit + * - `params` - [array] additional params array as key&value pairs + * - `tmpl_name` - [string] by ref, template name, can be overridden in hook processing + * - `tmpl_vars` - [array] by ref, template parsable variables as key&value pairs, can be overridden in hook processing + * @hook @ref hook-bx_base_text-unit + */ + bx_alert($this->getModule()->getName(), 'unit', 0, 0, [ + 'data' => $aData, + 'check_private_content' => $isCheckPrivateContent, + 'template' => $sTemplateName, + 'params' => $aParams, + 'tmpl_name' => &$sTemplateName, + 'tmpl_vars' => &$aTemplateVars + ]); + + return $this->parseHtmlByName($sTemplateName, $aTemplateVars); + } + + function entryAttachments ($aData, $aParams = array()) + { + $CNF = &$this->getModule()->_oConfig->CNF; + + $aStoragesKeys = array('OBJECT_STORAGE_PHOTOS', 'OBJECT_STORAGE_VIDEOS', 'OBJECT_STORAGE_SOUNDS', 'OBJECT_STORAGE_FILES'); + + $aStorages = array(); + foreach($aStoragesKeys as $sKey) + if(!empty($CNF[$sKey])) + $aStorages[] = $CNF[$sKey]; + + if(!empty($aStorages)) + return $this->entryAttachmentsByStorage($aStorages, $aData, array_merge($aParams, array('filter_field' => ''))); + + return parent::entryAttachments($aData, $aParams); + } + + function entryAuthor ($aData, $iProfileId = false, $sFuncAuthorDesc = 'getAuthorDesc', $sTemplateName = 'author.html', $sFuncAuthorAddon = 'getAuthorAddon') + { + $oModule = $this->getModule(); + $CNF = &$oModule->_oConfig->CNF; + + if (!$iProfileId) + $iProfileId = $aData[$CNF['FIELD_AUTHOR']]; + + if($this->_bIsApi) { + $sFldAdd = 'FIELD_ADDED'; + $sFldAvt = 'FIELD_ALLOW_VIEW_TO'; + + return [ + bx_api_get_block('entity_author', [ + 'author_data' => BxDolProfile::getData($iProfileId), + 'entry_date' => !empty($CNF[$sFldAdd]) && !empty($aData[$CNF[$sFldAdd]]) ? $aData[$CNF[$sFldAdd]] : '', + 'entry_context' => !empty($CNF[$sFldAvt]) && (int)$aData[$CNF[$sFldAvt]] < 0 ? BxDolProfile::getData(abs((int)$aData[$CNF[$sFldAvt]])) : '', + 'menu_manage' => $oModule->getEntryAllActions() + ]) + ]; + } + + $oProfile = BxDolProfile::getInstanceMagic($iProfileId); + $sName = $oProfile->getDisplayName(); + $sAddon = $sFuncAuthorAddon && is_a($oProfile, 'BxDolProfile') ? $this->$sFuncAuthorAddon($aData, $oProfile) : ''; + + return $this->parseHtmlByName($sTemplateName, [ + 'author_url' => $oProfile->getUrl(), + 'author_thumb_url' => $oProfile->getThumb(), + 'author_unit' => $oProfile->getUnit(0, ['template' => 'unit_wo_info']), + 'author_title' => $sName, + 'author_title_attr' => bx_html_attribute($sName), + 'author_desc' => $sFuncAuthorDesc ? $this->$sFuncAuthorDesc($aData, $oProfile) : '', + 'author_profile_desc' => $this->getAuthorProfileDesc($aData, $oProfile), + 'bx_if:addon' => [ + 'condition' => (bool)$sAddon, + 'content' => [ + 'content' => $sAddon, + ], + ], + ]); + } + + public function entryBreadcrumb($aContentInfo, $aTmplVarsItems = array()) + { + if(!empty($aTmplVarsItems) && is_array($aTmplVarsItems)) + return parent::entryBreadcrumb($aContentInfo, $aTmplVarsItems); + + $CNF = &$this->getModule()->_oConfig->CNF; + + $aTmplVarsItems = array(); + if(!empty($CNF['OBJECT_CATEGORY']) && !empty($CNF['FIELD_CATEGORY'])) { + $oCategory = BxDolCategory::getObjectInstance($CNF['OBJECT_CATEGORY']); + + $aParams = []; + if(isset($CNF['URL_CATEGORY'])) + $aParams['page'] = bx_append_url_params(BxDolPermalinks::getInstance()->permalink($CNF['URL_CATEGORY']), [ + 'category' => '{keyword}' + ], true, ['{keyword}']); + + $aTmplVarsItems[] = array( + 'url' => $oCategory->getCategoryUrl($aContentInfo[$CNF['FIELD_CATEGORY']], $aParams), + 'title' => $oCategory->getCategoryTitle($aContentInfo[$CNF['FIELD_CATEGORY']]) + ); + } + + $aTmplVarsItems[] = array( + 'url' => BxDolPermalinks::getInstance()->permalink('page.php?i=' . $CNF['URI_VIEW_ENTRY'] . '&id=' . $aContentInfo[$CNF['FIELD_ID']]), + 'title' => bx_process_output($aContentInfo[$CNF['FIELD_TITLE']]) + ); + + return parent::entryBreadcrumb($aContentInfo, $aTmplVarsItems); + } + + public function entryPolls($aData) + { + $CNF = &$this->getModule()->_oConfig->CNF; + + $aPolls = $this->_oDb->getPolls(array( + 'type' => 'content_id', + 'content_id' => $aData[$CNF['FIELD_ID']], + )); + if(empty($aPolls) || !is_array($aPolls)) + return; + + $iProfileId = bx_get_logged_profile_id(); + + $sPolls = ''; + foreach($aPolls as $aPoll) + $sPolls .= $this->getPollItem($aPoll, $iProfileId); + + if(empty($sPolls)) + return ''; + + $this->_addCssJs(); + return $this->getJsCode('poll') . $this->parseHtmlByName('poll_items.html', array( + 'polls' => $sPolls + )); + } + + public function entryPollAnswers($aPoll, $bDynamic = false) + { + $sContent = $this->_getPollAnswers($aPoll, $bDynamic); + if(empty($sContent)) + return ''; + + return array( + 'content' => $sContent, + 'menu' => $this->_getPollBlockMenu($aPoll, 'answers') + ); + } + + public function entryPollResults($aPoll, $bDynamic = false) + { + $sContent = $this->_getPollResults($aPoll, $bDynamic); + if(empty($sContent)) + return ''; + + return array( + 'content' => $sContent, + 'menu' => $this->_getPollBlockMenu($aPoll, 'results') + ); + } + + public function getPollForm() + { + $aForm = $this->getModule()->getPollForm(); + + return $this->parseHtmlByName('poll_form.html', array( + 'js_object' => $this->_oConfig->getJsObject('poll'), + 'form_id' => $aForm['form_id'], + 'form' => $aForm['form'], + )); + } + + public function getPollField($iContentId = 0, $iProfileId = 0) + { + if(empty($iProfileId)) + $iProfileId = bx_get_logged_profile_id(); + + $aPolls = array(); + if(!empty($iContentId)) + $aPolls = array_merge($aPolls, $this->_oDb->getPolls(array( + 'type' => 'content_id', + 'content_id' => $iContentId, + ))); + + $aPolls = array_merge($aPolls, $this->_oDb->getPolls(array( + 'type' => 'author_id', + 'author_id' => $iProfileId, + 'unused' => true + ))); + + $sPolls = ''; + foreach($aPolls as $aPoll) + $sPolls .= $this->getPollItem($aPoll, $iProfileId, array( + 'manage' => true + )); + + return $this->parseHtmlByName('poll_form_field.html', array( + 'html_id' => $this->_oConfig->getHtmlIds('add_poll_form_field'), + 'polls' => $sPolls + )); + } + + public function getPollItem($mixedPoll, $iProfileId = 0, $aParams = array()) + { + $oModule = $this->getModule(); + $CNF = &$oModule->_oConfig->CNF; + + $aPoll = is_array($mixedPoll) ? $mixedPoll : $this->_oDb->getPolls(array('type' => 'id', 'id' => (int)$mixedPoll)); + if(empty($aPoll) || !is_array($aPoll)) + return ''; + + $sJsObject = $this->_oConfig->getJsObject('poll'); + + $bDynamic = isset($aParams['dynamic']) && $aParams['dynamic'] === true; + $bManage = isset($aParams['manage']) && $aParams['manage'] === true; + $bSwitchMenu = isset($aParams['switch_menu']) ? (bool)$aParams['switch_menu'] : true; + $bForceDisplayAnswers = isset($aParams['force_display_answers']) && (bool)$aParams['force_display_answers'] === true; + + $iPollId = (int)$aPoll[$CNF['FIELD_POLL_ID']]; + $sPollView = !$bForceDisplayAnswers && $oModule->isPollPerformed($iPollId, $iProfileId) ? 'results' : 'answers'; + + $sMethod = '_getPoll' . ucfirst($sPollView); + if(!method_exists($this, $sMethod)) + return ''; + + $mixedMenu = ''; + if($bSwitchMenu) + $mixedMenu = $this->_getPollBlockMenu($aPoll, $sPollView, array('template' => 'menu_interactive.html')); + + return $this->parseHtmlByName('poll_item.html', array( + 'html_id' => $this->_oConfig->getHtmlIds('poll') . $iPollId, + 'bx_if:show_input_hidden' => array( + 'condition' => $bManage, + 'content' => array( + 'name' => $CNF['FIELD_POLL'], + 'id' => $iPollId + ) + ), + 'action_menu' => !empty($mixedMenu) ? $mixedMenu->getCode() : '', + 'bx_if:show_action_embed' => array( + 'condition' => $bManage, + 'content' => array( + 'js_object' => $sJsObject, + 'id' => $iPollId + ) + ), + 'bx_if:show_action_delete' => array( + 'condition' => $bManage, + 'content' => array( + 'js_object' => $sJsObject, + 'id' => $iPollId, + 'editor_id' => isset($CNF['FIELD_TEXT_ID']) ? $CNF['FIELD_TEXT_ID'] : '' + ) + ), + 'text' => bx_process_output($aPoll[$CNF['FIELD_POLL_TEXT']], BX_DATA_TEXT), + 'content' => $this->$sMethod($aPoll, $bDynamic) + )); + } + + public function embedPollItem($mixedPoll, $aParams = array()) + { + $CNF = &$this->getModule()->_oConfig->CNF; + + $sHeader = ''; + $sContent = $this->getPollItem($mixedPoll, 0, $aParams); + if(!empty($sContent)) { + $aPoll = is_array($mixedPoll) ? $mixedPoll : $this->_oDb->getPolls(array('type' => 'id', 'id' => (int)$mixedPoll)); + + $sHeader = strmaxtextlen($aPoll[$CNF['FIELD_POLL_TEXT']], 32, '...'); + $sContent = $this->getJsCode('poll') . $sContent; + } + + $this->_addCssJs(); + + $oTemplate = BxDolTemplate::getInstance(); + $oTemplate->addCssStyle($CNF['STYLES_POLLS_EMBED_CLASS'], $CNF['STYLES_POLLS_EMBED_CONTENT']); + $oTemplate->setPageNameIndex(BX_PAGE_EMBED); + $oTemplate->setPageHeader($sHeader); + $oTemplate->setPageContent('page_main_code', $sContent); + $oTemplate->getPageCode(); + exit; + } + + public function embedPollItems($mixedContentInfo, $aParams = array()) + { + $CNF = &$this->getModule()->_oConfig->CNF; + + $aContentInfo = is_array($mixedContentInfo) ? $mixedContentInfo : $this->_oDb->getContentInfoById((int)$mixedContentInfo); + if(empty($aContentInfo) || !is_array($aContentInfo)) + return; + + $iContentId = (int)$aContentInfo[$CNF['FIELD_ID']]; + + $aPolls = $this->_oDb->getPolls(array('type' => 'content_id', 'content_id' => $iContentId)); + if(empty($aPolls) || !is_array($aPolls)) + return; + + $iPolls = 0; + $sContent = ''; + foreach($aPolls as $aPoll) { + $sPoll = $this->getPollItem($aPoll, 0, $aParams); + if(empty($sPoll)) + continue; + + $sContent .= $sPoll; + $iPolls += 1; + } + + if(!empty($sContent) && isset($aParams['showcase']) && (bool)$aParams['showcase'] === true) { + $this->addJs(array('flickity/flickity.pkgd.min.js')); + $this->addCss(BX_DIRECTORY_PATH_PLUGINS_PUBLIC . 'flickity/|flickity.css'); + + $sContent = $this->parseHtmlByName('poll_items_showcase.html', array( + 'js_object' => $this->_oConfig->getJsObject('poll'), + 'html_id' => $this->_oConfig->getHtmlIds('polls_showcase') . $iContentId, + 'type' => $iPolls == 1 ? 'single' : 'multiple', + 'polls' => $sContent + )); + } + + $sHeader = ''; + if(!empty($sContent)) { + $sHeader = $iPolls == 1 ? array_shift($aPolls)[$CNF['FIELD_POLL_TEXT']] : _t('_polls_from', $aContentInfo[$CNF['FIELD_TITLE']]); + $sHeader = strmaxtextlen($sHeader, 32, '...'); + + $sContent = $this->getJsCode('poll') . $sContent; + } + + $this->_addCssJs(); + + $oTemplate = BxDolTemplate::getInstance(); + $oTemplate->addCssStyle($CNF['STYLES_POLLS_EMBED_CLASS'], $CNF['STYLES_POLLS_EMBED_CONTENT']); + $oTemplate->setPageNameIndex(BX_PAGE_EMBED); + $oTemplate->setPageHeader($sHeader); + $oTemplate->setPageContent('page_main_code', $sContent); + $oTemplate->getPageCode(); + exit; + } + + protected function _addCssJs() + { + $this->addJs(array( + 'modules/base/text/js/|polls.js', + 'polls.js' + )); + $this->addCss(array('polls.css')); + } + + protected function _getPollAnswers($aPoll, $bDynamic = false) + { + $CNF = &$this->getModule()->_oConfig->CNF; + + $aAnswers = $this->_oDb->getPollAnswers(array('type' => 'poll_id', 'poll_id' => $aPoll[$CNF['FIELD_POLL_ID']])); + if(empty($aAnswers) || !is_array($aAnswers)) + return ''; + + $aTmplVarsAnswers = array(); + foreach($aAnswers as $aAnswer) { + $oVotes = BxDolVote::getObjectInstance($CNF['OBJECT_VOTES_POLL_ANSWERS'], $aAnswer['id']); + + $aTmplVarsAnswers[] = array( + 'answer' => $oVotes->getElementBlock(array( + 'dynamic_mode' => $bDynamic + )) + ); + } + + return $this->parseHtmlByName('poll_item_answers.html', array( + 'html_id' => $this->_oConfig->getHtmlIds('poll_content') . $aPoll[$CNF['FIELD_POLL_ID']], + 'bx_repeat:answers' => $aTmplVarsAnswers + )); + } + + protected function _getPollResults($aPoll, $bDynamic = false) + { + $CNF = &$this->getModule()->_oConfig->CNF; + + $aAnswers = $this->_oDb->getPollAnswers(array('type' => 'poll_id', 'poll_id' => $aPoll[$CNF['FIELD_POLL_ID']])); + if(empty($aAnswers) || !is_array($aAnswers)) + return ''; + + $iTotal = 0; + foreach($aAnswers as $aAnswer) + $iTotal += $aAnswer['votes']; + + $aTmplVarsAnswers = array(); + foreach($aAnswers as $aAnswer) { + $oVotes = BxDolVote::getObjectInstance($CNF['OBJECT_VOTES_POLL_ANSWERS'], $aAnswer['id']); + $aVotesParams = array('show_counter_empty' => true, 'show_counter_in_brackets' => false, 'dynamic_mode' => $bDynamic); + + $fPercent = $iTotal > 0 ? 100 * (float)$aAnswer['votes']/$iTotal : 0; + $aTmplVarsAnswers[] = array( + 'title' => bx_process_output($aAnswer['title']), + 'width' => (int)round($fPercent) . '%', + 'votes' => $oVotes->getCounter($aVotesParams), + 'percent' => _t($CNF['T']['txt_poll_answer_vote_percent'], $iTotal > 0 ? round($fPercent, 2) : 0) + ); + } + + return $this->parseHtmlByName('poll_item_results.html', array( + 'html_id' => $this->_oConfig->getHtmlIds('poll_content') . $aPoll[$CNF['FIELD_POLL_ID']], + 'bx_repeat:answers' => $aTmplVarsAnswers, + )); + } + + protected function _getPollBlockMenu($aPoll, $sSelected = '', $aParams = array()) + { + $oModule = $this->getModule(); + $CNF = &$oModule->_oConfig->CNF; + + $sPostfix = '-' . time() . rand(0, PHP_INT_MAX); + $sJsObject = $this->_oConfig->getJsObject('poll'); + $iPollId = $aPoll[$CNF['FIELD_POLL_ID']]; + + $aViews = array( + 'answers' => true, + 'results' => $CNF['PARAM_POLL_HIDDEN_RESULTS'] === false || $oModule->isPollPerformed($iPollId) + ); + + $aMenu = array(); + foreach($aViews as $sView => $bActive) { + if(!$bActive) + continue; + + $sId = $this->_oConfig->getHtmlIds('poll_view_link_' . $sView) . $iPollId; + if(!empty($sSelected) && $sSelected == $sView) + $sSelected = $sId; + + $aMenu[] = array( + 'id' => $sId, + 'name' => $sId, + 'class' => '', + 'link' => 'javascript:void(0)', + 'onclick' => 'javascript:' . $sJsObject . '.changePollView(this, \'' . $sView . '\', ' . $iPollId . ')', + 'target' => '_self', + 'title_attr' => _t($CNF['T']['txt_poll_menu_view_' . $sView]), + 'title' => $this->parseIcon($CNF['ICON_POLLS_' . strtoupper($sView)]) + ); + } + + if(count($aMenu) <= 1) + return ''; + + $oMenu = new BxTemplMenuInteractive(array( + 'template' => !empty($aParams['template']) ? $aParams['template'] : 'menu_interactive_vertical.html', + 'menu_id' => $this->_oConfig->getHtmlIds('poll_view_menu') . $sPostfix, + 'menu_items' => $aMenu + )); + + if(!empty($sSelected)) + $oMenu->setSelected('', $sSelected); + + return $oMenu; + } + + public function getAttachLinkForm($iContentId = 0) + { + $sStylePrefix = $this->_oConfig->getPrefix('style'); + $sJsObject = $this->_oConfig->getJsObject('links'); + + $aForm = $this->getModule()->getFormAttachLink($iContentId); + + return $this->parseHtmlByName('attach_link_form.html', array( + 'style_prefix' => $sStylePrefix, + 'js_object' => $sJsObject, + 'form_id' => $aForm['form_id'], + 'form' => $aForm['form'], + )); + } + + public function getAttachLinkField($iUserId, $iContentId = 0) + { + $sStylePrefix = $this->_oConfig->getPrefix('style'); + + if(!$iContentId) + $aLinks = $this->_oDb->getUnusedLinks($iUserId); + else + $aLinks = $this->_oDb->getLinks($iContentId); + + $sLinks = ''; + foreach($aLinks as $aLink) + $sLinks .= $this->getAttachLinkItem($iUserId, $aLink); + + return $this->parseHtmlByName('attach_link_form_field.html', array( + 'html_id' => $this->_oConfig->getHtmlIds('attach_link_form_field') . $iContentId, + 'style_prefix' => $sStylePrefix, + 'links' => $sLinks + )); + } + + public function getAttachLinkItem($iUserId, $mixedLink) + { + $CNF = &$this->getModule()->_oConfig->CNF; + + $aLink = is_array($mixedLink) ? $mixedLink : $this->_oDb->getLinksBy(array('type' => 'id', 'id' => (int)$mixedLink, 'profile_id' => $iUserId)); + if(empty($aLink) || !is_array($aLink)) + return ''; + + $sLinkIdPrefix = $this->_oConfig->getHtmlIds('attach_link_item'); + $sStylePrefix = $this->_oConfig->getPrefix('style'); + $sClass = $sStylePrefix . '-al-item'; + $sJsObject = $this->_oConfig->getJsObject('links'); + + $oEmbed = BxDolEmbed::getObjectInstance(); + $bEmbed = $oEmbed !== false; + + $sThumbnail = ''; + $aLinkAttrs = array(); + if(!$bEmbed) { + $aLinkAttrs = array( + 'title' => bx_html_attribute($aLink['title']) + ); + if(!$this->_oConfig->isEqualUrls(BX_DOL_URL_ROOT, $aLink['url'])) { + $aLinkAttrs['target'] = '_blank'; + + if($this->_oDb->getParam('sys_add_nofollow') == 'on') + $aLinkAttrs['rel'] = 'nofollow'; + } + + if((int)$aLink['media_id'] != 0) + $sThumbnail = BxDolTranscoderImage::getObjectInstance($CNF['OBJECT_IMAGES_TRANSCODER_PREVIEW_PHOTOS'])->getFileUrl($aLink['media_id']); + } + else + $sClass .= ' embed'; + + return $this->parseHtmlByName('attach_link_item.html', array( + 'html_id' => $sLinkIdPrefix . $aLink['id'], + 'style_prefix' => $sStylePrefix, + 'class' => $sClass, + 'js_object' => $sJsObject, + 'id' => $aLink['id'], + 'bx_if:show_embed_outer' => array( + 'condition' => $bEmbed, + 'content' => array( + 'style_prefix' => $sStylePrefix, + 'embed' => $bEmbed ? $oEmbed->getLinkHTML($aLink['url'], $aLink['title'], 300) : '', + ) + ), + 'bx_if:show_embed_inner' => array( + 'condition' => !$bEmbed, + 'content' => array( + 'style_prefix' => $sStylePrefix, + 'bx_if:show_thumbnail' => array( + 'condition' => !empty($sThumbnail), + 'content' => array( + 'style_prefix' => $sStylePrefix, + 'thumbnail' => $sThumbnail + ) + ), + 'url' => $aLink['url'], + 'link' => $this->parseLink($aLink['url'], $aLink['title'], $aLinkAttrs) + ) + ), + )); + } + + public function getEventLinks($iContentId) + { + $CNF = &$this->getModule()->_oConfig->CNF; + + $aLinks = $this->_oDb->getLinks($iContentId); + if(empty($aLinks) || !is_array($aLinks)) + return array(); + + $oTranscoder = BxDolTranscoderImage::getObjectInstance($CNF['OBJECT_IMAGES_TRANSCODER_PREVIEW_PHOTOS']); + + $aResult = array(); + foreach($aLinks as $aLink) + $aResult[] = array( + 'url' => $aLink['url'], + 'title' => $aLink['title'], + 'text' => $aLink['text'], + 'thumbnail' => (int)$aLink['media_id'] != 0 ? $oTranscoder->getFileUrl($aLink['media_id']) : '' + ); + + return $aResult; + } + + public function getTmplVarsText($aData) + { + $CNF = &$this->getModule()->_oConfig->CNF; + $sStylePrefix = $this->_oConfig->getPrefix('style'); + + $aVars = parent::getTmplVarsText($aData); + + $aImageParams = $this->_getHeaderImageParams(); + $mixedImage = $this->_getHeaderImage($aData); + + $sImage = ''; + if($mixedImage !== false) { + if(!empty($mixedImage['object'])) + $o = BxDolStorage::getObjectInstance($mixedImage['object']); + else if(!empty($mixedImage['transcoder'])) + $o = BxDolTranscoder::getObjectInstance($mixedImage['transcoder']); + + if($o) + $sImage = $o->getFileUrlById($mixedImage['id']); + } + + if($this->_bIsApi) { + if($sImage) + $aVars['image'] = bx_api_get_image($aImageParams['storage'], $mixedImage['id']); + + return $aVars; + } + + $sAddClassPicture = ""; + $sAddCode = ""; + $oModule = $this->getModule(); + $bIsAllowEditPicture = CHECK_ACTION_RESULT_ALLOWED === $oModule->checkAllowedEdit($aData); + + if($aImageParams['field'] && $aImageParams['uploaders'] && $aImageParams['storage'] && $aImageParams['transcoder_cover']) { + /** + * @hooks + * @hookdef hook-system-image_editor 'system', 'image_editor' - hook to override content header image editor + * - $unit_name - equals `system` + * - $action - equals `image_editor` + * - $object_id - not used + * - $sender_id - not used + * - $extra_params - array of additional params with the following array keys: + * - `module` - [string] module name + * - `content_id` - [int] profile content id + * - `is_allow_edit` - [boolean] if edit action is allowed to current user + * - `image_type` - [string] image type equals to `header_image` + * - `image_url` - [string] image URL + * - `uploader` - [string] uploader name + * - `storage` - [string] storage name + * - `transcoder` - [string] transcoder name + * - `field` - [string] field name + * - `is_background` - [boolean] if image is used as background, always `false` + * - `add_class` - [string] by ref, class to add, can be overridden in hook processing + * - `add_code` - [array] by ref, code to add, can be overridden in hook processing + * @hook @ref hook-system-image_editor + */ + bx_alert('system', 'image_editor', 0, 0, [ + 'module' => $oModule->getName(), + 'content_id' => $aData[$CNF['FIELD_ID']], + 'is_allow_edit' => $bIsAllowEditPicture, + 'image_type' => 'header_image', + 'image_url' => $sImage, + 'uploader' => $aImageParams['uploaders'] && is_array($aImageParams['uploaders']) ? $aImageParams['uploaders'][0] : '', + 'storage' => $aImageParams['storage'], + 'transcoder' => $aImageParams['transcoder_cover'], + 'field' => $aImageParams['field'], + 'is_background' => false, + 'add_class' => &$sAddClassPicture, + 'add_code' => &$sAddCode + ]); + } + + $sImageTweak = ''; + $sUniqIdImage = genRndPwd (8, false); + if ($bIsAllowEditPicture && empty($sAddCode) && $aImageParams['field_position']){ + $sImageTweak = $this->_prepareImage($aData, $sUniqIdImage, $aImageParams['uploaders'], $aImageParams['storage'], $aImageParams['field'], true); + } + + + $aVars['content_description_before'] = ''; + $aVars['content_description_after'] = ''; + $aVars['bx_if:show_image'] = array( + 'condition' => !empty($sImage), + 'content' => array( + 'entry_image' => $sImage, + 'image_settings' => $aImageParams['field_position'] ? $this->_getImageSettings($aData[$aImageParams['field_position']]) : '', + 'add_class' => $sAddClassPicture, + 'img_class' => $sAddClassPicture != '' ? 'bx-media-editable-src' : '', + 'additional_code' => $sAddCode, + 'image_tweak' => $sImageTweak, + 'unique_id' => $sUniqIdImage, + ) + ); + + $aTmplVarsLinks = []; + + if(isset($CNF['FIELD_LINK'])){ + $aLinks = $this->getEventLinks($aData[$CNF['FIELD_ID']]); + + $sClass = $sStylePrefix . '-al-item'; + + $bAddNofollow = $this->_oDb->getParam('sys_add_nofollow') == 'on'; + + foreach($aLinks as $aLink) { + $sLink = ''; + + $oEmbed = BxDolEmbed::getObjectInstance(); + if ($oEmbed) { + $sLink = $this->parseHtmlByName('link_embed_provider.html', array( + 'style_prefix' => $sStylePrefix, + 'embed' => $oEmbed->getLinkHTML($aLink['url'], $aLink['title']), + )); + } + else { + $aLinkAttrs = array( + 'title' => $aLink['title'] + ); + if(!$this->_oConfig->isEqualUrls(BX_DOL_URL_ROOT, $aLink['url'])) { + $aLinkAttrs['target'] = '_blank'; + + if($bAddNofollow) + $aLinkAttrs['rel'] = 'nofollow'; + } + + $sLinkAttrs = ''; + foreach($aLinkAttrs as $sKey => $sValue) + $sLinkAttrs .= ' ' . $sKey . '="' . bx_html_attribute($sValue) . '"'; + + $sLink = $this->parseHtmlByName('link_embed_common.html', array( + 'bx_if:show_thumbnail' => [ + 'condition' => !empty($aLink['thumbnail']), + 'content' => [ + 'style_prefix' => $sStylePrefix, + 'thumbnail' => $aLink['thumbnail'], + 'link' => !empty($aLink['url']) ? $aLink['url'] : 'javascript:void(0)', + 'attrs' => $sLinkAttrs + ] + ], + 'link' => !empty($aLink['url']) ? $aLink['url'] : 'javascript:void(0)', + 'attrs' => $sLinkAttrs, + 'content' => $aLink['title'], + 'bx_if:show_text' => [ + 'condition' => !empty($aLink['text']), + 'content' => [ + 'style_prefix' => $sStylePrefix, + 'text' => $aLink['text'] + ] + ] + )); + } + + $aTmplVarsLinks[] = [ + 'style_prefix' => $sStylePrefix, + 'link' => $sLink + ]; + } + } + + $aVars['bx_if:show_links'] = [ + 'condition' => count($aTmplVarsLinks) > 0, + 'content' => [ + 'style_prefix' => $sStylePrefix, + 'bx_repeat:links' => $aTmplVarsLinks + ] + ]; + + if(!empty($CNF['OBJECT_REACTIONS']) && ($oReactions = BxDolVote::getObjectInstance($CNF['OBJECT_REACTIONS'], $aData[$CNF['FIELD_ID']])) !== false) + $aVars['content_description_after'] .= $oReactions->getCounter([ + 'show_counter' => true, + 'show_counter_empty' => false + ]); + + $this->addCss(array('cover.css')); + + return $aVars; + } + + function getAuthorDesc($aData, $oProfile) + { + $CNF = &$this->getModule()->_oConfig->CNF; + + $aItem = array( + 'bx_if:text' => array( + 'condition' => false, + 'content' => array( + 'content' => '' + ) + ), + 'bx_if:link' => array( + 'condition' => false, + 'content' => array( + 'link' => '', + 'content' => '' + ) + ) + ); + + $aTmplVarsItems = array(); + if(!empty($CNF['FIELD_ADDED']) && !empty($aData[$CNF['FIELD_ADDED']])) + $aTmplVarsItems[] = array_merge($aItem, array('bx_if:text' => array( + 'condition' => true, + 'content' => array( + 'content' => bx_time_js($aData[$CNF['FIELD_ADDED']], BX_FORMAT_DATE) + ) + ))); + + if(!empty($CNF['URI_AUTHOR_ENTRIES'])) + $aTmplVarsItems[] = array_merge($aItem, array('bx_if:link' => array( + 'condition' => true, + 'content' => array( + 'link' => BxDolPermalinks::getInstance()->permalink('page.php?i=' . $CNF['URI_AUTHOR_ENTRIES'] . '&profile_id=' . $oProfile->id()), + 'content' => _t($CNF['T']['txt_all_entries_by'], $this->getModule()->serviceGetMenuAddonManageToolsProfileStats($oProfile->id())) + ) + ))); + + return $this->parseHtmlByName('author_desc.html', array( + 'bx_repeat:items' => $aTmplVarsItems + )); + } + + function getAuthorProfileDesc ($aData, $oProfile) + { + $aSnippetMeta = $this->getProfileSnippetMenu($aData); + if(empty($aSnippetMeta) || !is_array($aSnippetMeta) || !isset($aSnippetMeta['meta'])) + return ''; + + return $aSnippetMeta['meta']; + } + + function getProfileSnippetMenu ($aData) + { + $CNF = &$this->getModule()->_oConfig->CNF; + if (!($oProfile = BxDolProfile::getInstance($aData[$CNF['FIELD_AUTHOR']]))) + return array(); + + return bx_srv($oProfile->getModule(), 'get_snippet_menu_vars', array($oProfile->id())); + } + + function getAuthorAddon ($aData, $oProfile) + { + return ''; + } + + protected function checkPrivacy ($aData, $isCheckPrivateContent, $oModule, $sTemplateName = '') + { + if ($isCheckPrivateContent && CHECK_ACTION_RESULT_ALLOWED !== ($sMsg = $oModule->checkAllowedView($aData))) { + $aVars = array ( + 'summary' => $sMsg, + ); + return $this->parseHtmlByName($sTemplateName ? str_replace('.html', '_private.html', $sTemplateName) : 'unit_private.html', $aVars); + } + + return ''; + } + + protected function getUnitThumbAndGallery ($aData) + { + $CNF = &BxDolModule::getInstance($this->MODULE)->_oConfig->CNF; + + $sPhotoThumb = ''; + $sPhotoGallery = ''; + if(!empty($CNF['FIELD_THUMB']) && !empty($aData[$CNF['FIELD_THUMB']])) { + + $oImagesTranscoder = BxDolTranscoderImage::getObjectInstance($CNF['OBJECT_IMAGES_TRANSCODER_PREVIEW']); + if ($oImagesTranscoder) + $sPhotoThumb = $oImagesTranscoder->getFileUrl($aData[$CNF['FIELD_THUMB']]); + + $oImagesTranscoder = BxDolTranscoderImage::getObjectInstance($CNF['OBJECT_IMAGES_TRANSCODER_GALLERY']); + if ($oImagesTranscoder) + $sPhotoGallery = $oImagesTranscoder->getFileUrl($aData[$CNF['FIELD_THUMB']]); + else + $sPhotoGallery = $sPhotoThumb; + } + + return array($sPhotoThumb, $sPhotoGallery); + } + + protected function getUnit ($aData, $aParams = array()) + { + $CNF = &$this->_oConfig->CNF; + $oModule = $this->getModule(); + + // get thumb url + list($sPhotoThumb, $sPhotoGallery) = $this->getUnitThumbAndGallery($aData); + + if ($sPhotoGallery == '' && isset($CNF['PARAM_USE_GALERY_AS_COVER']) && getParam($CNF['PARAM_USE_GALERY_AS_COVER']) == 'on'){ + if(!empty($CNF['OBJECT_STORAGE_PHOTOS'])){ + $sStorage = $CNF['OBJECT_STORAGE_PHOTOS']; + $oStorage = BxDolStorage::getObjectInstance($sStorage); + list($oTranscoder, $oTranscoderView) = $this->getAttachmentsImagesTranscoders($sStorage); + $aGhostFiles = $oStorage->getGhosts($oModule->serviceGetContentOwnerProfileId($aData[$CNF['FIELD_ID']]), $aData[$CNF['FIELD_ID']]); + if(!empty($aGhostFiles) && is_array($aGhostFiles)) { + $aGhostFile = array_shift($aGhostFiles); + + $sPhotoThumb = $oTranscoderView->getFileUrl($aGhostFile['id']); + $sPhotoGallery = $oTranscoder->getFileUrl($aGhostFile['id']); + } + } + } + + // get entry url + $sUrl = $this->_oConfig->getViewEntryUrl($aData[$CNF['FIELD_ID']]); + + $oProfile = BxDolProfile::getInstanceMagic($aData[$CNF['FIELD_AUTHOR']]); + + $sTitle = $this->getTitle($aData); + $sText = $this->getText($aData); + $sSummary = $this->getSummary($aData, $sTitle, $sText, $sUrl); + $sSummaryPlain = isset($CNF['PARAM_CHARS_SUMMARY_PLAIN']) && $CNF['PARAM_CHARS_SUMMARY_PLAIN'] ? BxTemplFunctions::getInstance()->getStringWithLimitedLength(strip_tags($sSummary), (int)getParam($CNF['PARAM_CHARS_SUMMARY_PLAIN'])) : ''; + + if(!empty($CNF['OBJECT_METATAGS'])) { + $oMetatags = BxDolMetatags::getObjectInstance($CNF['OBJECT_METATAGS']); + $sText = $oMetatags->metaParse($aData[$CNF['FIELD_ID']], $sText); + } + + $aTmplVarsMeta = []; + if(!empty($CNF['OBJECT_MENU_SNIPPET_META'])) { + $oMenuMeta = BxDolMenu::getObjectInstance($CNF['OBJECT_MENU_SNIPPET_META'], $this); + if($oMenuMeta) { + $oMenuMeta->setContentId($aData[$CNF['FIELD_ID']]); + if(isset($aParams['context'])) + $oMenuMeta->setContext($aParams['context']); + + $aTmplVarsMeta = [ + 'meta' => $oMenuMeta->getCode() + ]; + } + } + + $bBadgesSingle = isset($aParams['badges_single']) ? $aParams['badges_single'] : false; + $bBadgesCompact = isset($aParams['badges_compact']) ? $aParams['badges_compact'] : false; + + $sCoverData = isset($aData['thumb_data']) ? $aData['thumb_data'] : ''; + + $aTmplVars = array ( + 'class' => $this->_getUnitClass($aData,(isset($aParams['template_name']) ? $aParams['template_name'] : '')), + 'html_id' => $this->_getUnitHtmlId($aData,(isset($aParams['template_name']) ? $aParams['template_name'] : '')), + 'id' => $aData[$CNF['FIELD_ID']], + 'content_url' => $sUrl, + 'bx_if:show_onclick' => [ + 'condition' => false, + 'content' => [ + 'content_onclick' => '' + ] + ], + 'title' => $sTitle, + 'badges' => $oModule->serviceGetBadges($aData[$CNF['FIELD_ID']], $bBadgesSingle, $bBadgesCompact), + 'title_attr' => bx_html_attribute($sTitle), + 'summary' => $sSummary, + 'text' => $sText, + 'author' => $oProfile->getDisplayName(), + 'author_url' => $oProfile->getUrl(), + 'author_icon' => $oProfile->getIcon(), + 'author_thumb' => $oProfile->getThumb(), + 'author_avatar' => $oProfile->getAvatar(), + 'entry_posting_date' => bx_time_js($aData[$CNF['FIELD_ADDED']], BX_FORMAT_DATE), + 'module_name' => _t($CNF['T']['txt_sample_single']), + 'ts' => $aData[$CNF['FIELD_ADDED']], + 'bx_if:meta' => array( + 'condition' => !empty($aTmplVarsMeta), + 'content' => $aTmplVarsMeta + ), + 'bx_if:thumb' => array ( + 'condition' => $sPhotoThumb, + 'content' => array ( + 'title' => $sTitle, + 'summary_attr' => bx_html_attribute($sSummaryPlain), + 'content_url' => $sUrl, + 'bx_if:show_thumb_onclick' => [ + 'condition' => false, + 'content' => [ + 'content_onclick' => '' + ] + ], + 'thumb_url' => $sPhotoThumb ? $sPhotoThumb : '', + 'gallery_url' => $sPhotoGallery ? $sPhotoGallery : '', + 'image_settings' => $this->_getImageSettings($sCoverData), + 'strecher' => str_repeat(' ', 40), + ), + ), + 'bx_if:no_thumb' => array ( + 'condition' => !$sPhotoThumb, + 'content' => array ( + 'module_icon' => $CNF['ICON'], + 'content_url' => $sUrl, + 'bx_if:show_no_thumb_onclick' => [ + 'condition' => false, + 'content' => [ + 'content_onclick' => '' + ] + ], + 'summary_plain' => $sSummaryPlain, + 'strecher' => mb_strlen($sSummaryPlain) > 240 ? '' : str_repeat(' ', round((240 - mb_strlen($sSummaryPlain)) / 6)), + ), + ), + 'unit_content_before' => '', + 'unit_content_after' => '' + ); + + if(isset($aParams['template_vars']) && is_array($aParams['template_vars'])) + $aTmplVars = array_merge($aTmplVars, $aParams['template_vars']); + + // generate html + return $aTmplVars; + } + + protected function getAttachmentsImagesTranscoders ($sStorage = '') + { + $CNF = &$this->getModule()->_oConfig->CNF; + + $oTranscoder = null; + $oTranscoderView = null; + + if(isset($CNF['OBJECT_STORAGE_PHOTOS']) && $CNF['OBJECT_STORAGE_PHOTOS'] == $sStorage) { + if(!empty($CNF['OBJECT_IMAGES_TRANSCODER_PREVIEW_PHOTOS'])) + $oTranscoder = BxDolTranscoderImage::getObjectInstance($CNF['OBJECT_IMAGES_TRANSCODER_PREVIEW_PHOTOS']); + if(!empty($CNF['OBJECT_IMAGES_TRANSCODER_VIEW_PHOTOS'])) + $oTranscoderView = BxDolTranscoderImage::getObjectInstance($CNF['OBJECT_IMAGES_TRANSCODER_VIEW_PHOTOS']); + else if(!empty($CNF['OBJECT_IMAGES_TRANSCODER_GALLERY_PHOTOS'])) + $oTranscoderView = BxDolTranscoderImage::getObjectInstance($CNF['OBJECT_IMAGES_TRANSCODER_GALLERY_PHOTOS']); + } + else if(isset($CNF['OBJECT_STORAGE_FILES']) && $CNF['OBJECT_STORAGE_FILES'] == $sStorage) { + if(!empty($CNF['OBJECT_IMAGES_TRANSCODER_PREVIEW_FILES'])) + $oTranscoder = BxDolTranscoderImage::getObjectInstance($CNF['OBJECT_IMAGES_TRANSCODER_PREVIEW_FILES']); + if(!empty($CNF['OBJECT_IMAGES_TRANSCODER_GALLERY_FILES'])) + $oTranscoderView = BxDolTranscoderImage::getObjectInstance($CNF['OBJECT_IMAGES_TRANSCODER_GALLERY_FILES']); + } + else + list($oTranscoder, $oTranscoderView) = parent::getAttachmentsImagesTranscoders($sStorage); + + return array($oTranscoder, $oTranscoderView); + } + + protected function _getUnitName($aData, $sTemplateName = 'unit.html') + { + return trim(str_replace('.html', '', $sTemplateName)); + } + + protected function _getUnitClass($aData, $sTemplateName = 'unit.html') + { + $sResult = ''; + + switch($sTemplateName) { + case 'unit_showcase.html': + $sResult = $this->_sUnitClassShowCase; + break; + } + + return $sResult; + } + + protected function _getUnitHtmlId($aData, $sTemplateName = 'unit.html') + { + $CNF = &$this->_oConfig->CNF; + + return str_replace('_', '-', $this->MODULE . '_unit_' . $aData[$CNF['FIELD_ID']]); + } + + protected function _getHeaderImageParams() + { + $CNF = &$this->_oConfig->CNF; + + return [ + 'field' => isset($CNF['FIELD_THUMB']) ? $CNF['FIELD_THUMB'] : false, + 'field_position' => isset($CNF['FIELD_THUMB_POSITION']) ? $CNF['FIELD_THUMB_POSITION'] : false, + 'storage' => isset($CNF['OBJECT_STORAGE']) ? $CNF['OBJECT_STORAGE'] : false, + 'uploaders' => isset($CNF['OBJECT_UPLOADERS']) ? $CNF['OBJECT_UPLOADERS'] : false, + 'transcoder_cover' => isset($CNF['OBJECT_IMAGES_TRANSCODER_COVER']) ? $CNF['OBJECT_IMAGES_TRANSCODER_COVER'] : false, + ]; + } + + protected function _getHeaderImage($aData) + { + return $this->getModule()->getEntryImageData($aData); + } + + function mediaExif ($aMediaInfo, $iProfileId = false, $sFuncAuthorDesc = '', $sTemplateName = 'media-exif.html') + { + if (empty($aMediaInfo['exif'])) + return ''; + + $a = unserialize($aMediaInfo['exif']); + + $s = ''; + if (!empty($a['Make'])) { + $oModule = BxDolModule::getInstance($this->MODULE); + $CNF = &$oModule->_oConfig->CNF; + + $sCamera = BxDolMetatags::keywordsCameraModel($a); + if (!empty($CNF['OBJECT_METATAGS_MEDIA_CAMERA'])) { + $oMetatags = BxDolMetatags::getObjectInstance($CNF['OBJECT_METATAGS_MEDIA_CAMERA']); + if ($oMetatags->keywordsIsEnabled()) { + $sCamera = $oMetatags->keywordsParseOne($aMediaInfo['id'], $sCamera); + } + } + + if (!empty($sCamera)) + $s .= $this->parseHtmlByName('media-exif-value.html', array( + 'key' => _t($CNF['T']['txt_media_exif_camera']), + 'val' => $sCamera, + )); + } + + if (!empty($a['FocalLength'])) + $s .= $this->parseHtmlByName('media-exif-value.html', array( + 'key' => _t($CNF['T']['txt_media_exif_focal_length']), + 'val' => _t($CNF['T']['txt_media_exif_focal_length_value'], $a['FocalLength']), + )); + + if (!empty($a['COMPUTED']['ApertureFNumber'])) + $s .= $this->parseHtmlByName('media-exif-value.html', array( + 'key' => _t($CNF['T']['txt_media_exif_aperture']), + 'val' => $a['COMPUTED']['ApertureFNumber'], + )); + + if (!empty($a['ExposureTime'])) + $s .= $this->parseHtmlByName('media-exif-value.html', array( + 'key' => _t($CNF['T']['txt_media_exif_shutter_speed']), + 'val' => _t($CNF['T']['txt_media_exif_shutter_speed_value'], $a['ExposureTime']), + )); + + if (!empty($a['ISOSpeedRatings'])) + $s .= $this->parseHtmlByName('media-exif-value.html', array( + 'key' => _t($CNF['T']['txt_media_exif_iso']), + 'val' => $a['ISOSpeedRatings'], + )); + + if (empty($s)) + return ''; + + return $this->parseHtmlByName($sTemplateName, array('content' => $s)); + } +} + +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/text/js/links.js b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/text/js/links.js new file mode 100644 index 0000000000..3cbe76b7d3 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/text/js/links.js @@ -0,0 +1,258 @@ +/** + * Copyright (c) UNA, Inc - https://una.io + * MIT License - https://opensource.org/licenses/MIT + * + * @defgroup BaseText Base classes for text modules + * @ingroup UnaModules + * + * @{ + */ + +function BxBaseModTextLinks(oOptions) { + this._sActionsUri = oOptions.sActionUri; + this._sActionsUrl = oOptions.sActionUrl; + this._sObjName = oOptions.sObjName == undefined ? 'oBxBaseModTextLinks' : oOptions.sObjName; + this._iOwnerId = oOptions.iOwnerId == undefined ? 0 : oOptions.iOwnerId; + this._iContentId = oOptions.iContentId == undefined ? 0 : oOptions.iContentId; + this._sFormId = oOptions.sFormId == undefined ? 0 : oOptions.sFormId; + this._sEditorId = oOptions.sEditorId == undefined ? '' : oOptions.sEditorId; + this._aHtmlIds = oOptions.aHtmlIds == undefined ? {} : oOptions.aHtmlIds; + this._iLimitAttachLinks = oOptions.iLimitAttachLinks == undefined ? 0 : oOptions.iLimitAttachLinks; + this._sLimitAttachLinksErr = oOptions.sLimitAttachLinksErr == undefined ? '' : oOptions.sLimitAttachLinksErr; + this._oAttachedLinks = oOptions.oAttachedLinks == undefined ? {} : oOptions.oAttachedLinks; + + var $this = this; + + $(document).ready(function () { + $this.initFormPost($this._sFormId); + }); +} + +BxBaseModTextLinks.prototype.initFormPost = function(sFormId) +{ + var $this = this; + var oForm = $('#' + sFormId); + var oTextarea = oForm.find('textarea'); + + if (typeof window.glOnSpaceEnterInEditor === 'undefined') + window.glOnSpaceEnterInEditor = []; + + window.glOnSpaceEnterInEditor.push(function (sData, sSelector) { + if(!oTextarea.is(sSelector)) + return; + + $this.parseContent(oForm, sData, true); + }); + + var sContent = oTextarea.val(); + if(sContent && sContent.length > 0) + this.parseContent(oForm, sContent, false); + + if(this._bAutoAttach) { + if (typeof window.glOnInsertImageInEditor === 'undefined') + window.glOnInsertImageInEditor = []; + + window.glOnInsertImageInEditor.push(function (oFile, sSelector) { + + if(!oTextarea.is(sSelector)) + return false; + + const oFormData = new FormData(); + oFormData.append('file', oFile); + oFormData.append('u', $this._sAutoUploader); + oFormData.append('uid', $this._sAutoUploaderId); + + fetch($this._sActionsUrl + 'auto_attach_insertion/', {method: "POST", body: oFormData}) + .then(response => response.json()) + .then(result => { + processJsonData(result) + }); + return true; + }); + } +}; + +BxBaseModTextLinks.prototype.parseContent = function(oForm, sData, bPerformAttach) +{ + var oExp, aMatch = null; + + oExp = new RegExp(bx_get_regexp('tag'), "ig"); + sData = sData.replace(oExp, ''); + + oExp = new RegExp(bx_get_regexp('mention'), "ig"); + sData = sData.replace(oExp, ''); + + oExp = new RegExp(bx_get_regexp('url'), "ig"); + while(aMatch = oExp.exec(sData)) { + var sUrl = aMatch[0].replace(/^(\s|( ))+|(\s|( ))+$/gm,''); + if(!sUrl.length || this._oAttachedLinks[sUrl] != undefined || (this._iLimitAttachLinks != 0 && Object.keys(this._oAttachedLinks).length >= this._iLimitAttachLinks)) + continue; + + //--- Mark that 'attach link' process was started. + this._oAttachedLinks[sUrl] = 0; + + if(bPerformAttach) + this.addAttachLink(oForm, sUrl); + } +}; + +BxBaseModTextLinks.prototype.addAttachLink = function(oElement, sUrl) +{ + if(!sUrl || (this._iLimitAttachLinks != 0 && Object.keys(this._oAttachedLinks).length > this._iLimitAttachLinks)) + return; + + var $this = this; + var oData = this._getDefaultData(); + oData['url'] = sUrl; + oData['content_id'] = $this._iContentId; + + + jQuery.post ( + this._sActionsUrl + 'add_attach_link/', + oData, + function(oData) { + if(!oData.id || !oData.item || !$.trim(oData.item).length) + return; + + //--- Mark that 'attach link' process was finished. + $this._oAttachedLinks[sUrl] = oData.id; + + var iContentId = 0; + if(oData && oData.content_id != undefined) + iContentId = parseInt(oData.content_id); + + var oItem = $(oData.item).hide(); + $('#' + $this._aHtmlIds['attach_link_form_field'] + iContentId).prepend(oItem).find('#' + oItem.attr('id')).bx_anim('show', $this._sAnimationEffect, $this._sAnimationSpeed, function() { + $(this).bxProcessHtml(); + }); + }, + 'json' + ); +}; + +BxBaseModTextLinks.prototype.showAttachLink = function(oLink) +{ + if(this._iLimitAttachLinks != 0 && Object.keys(this._oAttachedLinks).length >= this._iLimitAttachLinks) { + bx_alert(this._sLimitAttachLinksErr); + return false; + } + + var oData = this._getDefaultData(); + oData['content_id'] = this._iContentId; + + $(window).dolPopupAjax({ + id: {value: this._aHtmlIds['attach_link_popup'], force: true}, + url: bx_append_url_params(this._sActionsUri + 'get_attach_link_form/', oData), + closeOnOuterClick: false, + removeOnClose: true + }); + + return false; +}; + +BxBaseModTextLinks.prototype.initFormAttachLink = function(sFormId) +{ + var $this = this; + var oForm = $('#' + sFormId); + + oForm.ajaxForm({ + dataType: "json", + clearForm: true, + beforeSubmit: function (formData, jqForm, options) { + window[$this._sObjName].beforeFormAttachLinkSubmit(oForm); + }, + success: function (oData) { + window[$this._sObjName].afterFormAttachLinkSubmit(oForm, oData); + } + }); +}; + +BxBaseModTextLinks.prototype.beforeFormAttachLinkSubmit = function(oForm) +{ + this.loadingInButton($(oForm).children().find(':submit'), true); +}; + +BxBaseModTextLinks.prototype.afterFormAttachLinkSubmit = function (oForm, oData) +{ + var $this = this; + var fContinue = function() { + if(oData && oData.item != undefined) { + $('#' + $this._aHtmlIds['attach_link_popup']).dolPopupHide({}); + + if(!$.trim(oData.item).length) + return; + + var iContentId = 0; + if(oData && oData.content_id != undefined) + iContentId = parseInt(oData.content_id); + + var oItem = $(oData.item).hide(); + $('#' + $this._aHtmlIds['attach_link_form_field'] + iContentId).prepend(oItem).find('#' + oItem.attr('id')).bx_anim('show', $this._sAnimationEffect, $this._sAnimationSpeed, function() { + $(this).bxProcessHtml(); + }); + + $this._oAttachedLinks[oData.url] = oData.id; + return; + } + + if(oData && oData.form != undefined && oData.form_id != undefined) { + $('#' + oData.form_id).replaceWith(oData.form); + $this.initFormAttachLink(oData.form_id); + + return; + } + }; + + this.loadingInButton($(oForm).find(':submit'), false); + + if(oData && oData.message != undefined) + bx_alert(oData.message, fContinue); + else + fContinue(); +}; + +BxBaseModTextLinks.prototype.deleteAttachLink = function(oLink, iId) +{ + var $this = this; + var oData = this._getDefaultData(); + oData['id'] = iId; + + var oAttachLink = $('#' + this._aHtmlIds['attach_link_item'] + iId); + bx_loading(oAttachLink, true); + + jQuery.post ( + this._sActionsUrl + 'delete_attach_link/', + oData, + function(oData) { + var fContinue = function() { + if(oData && oData.code != undefined && oData.code == 0) { + oAttachLink.bx_anim('hide', $this._sAnimationEffect, $this._sAnimationSpeed, function() { + $(this).remove; + }); + } + }; + + bx_loading(oAttachLink, false); + + if(oData && oData.message != undefined) + bx_alert(oData.message, fContinue); + else + fContinue(); + }, + 'json' + ); + + return false; +}; + +BxBaseModTextLinks.prototype._getDefaultData = function() { + var oDate = new Date(); + return jQuery.extend({}, this._oRequestParams, {_t:oDate.getTime()}); +}; + +BxBaseModTextLinks.prototype.loadingInButton = function(e, bShow) { + if($(e).length) + bx_loading_btn($(e), bShow); + else + bx_loading($('body'), bShow); +}; \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/text/template/entry-text.html b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/text/template/entry-text.html new file mode 100644 index 0000000000..782af0b744 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/text/template/entry-text.html @@ -0,0 +1,29 @@ +<div class="bx-content-description-before">__content_description_before__</div> +<div class="bx-content-description"> + <bx_if:show_image> + <div class="bx-base-text-entity-image mb-4 text-center __add_class__ relative flex justify-center items-center"> + <img class="rounded __img_class__ aspect-video object-cover bg-cover bx-image-edit-source-__unique_id__" style="background-image:url(__entry_image__); __image_settings__" src="<bx_icon_url:spacer.gif />"/> + __image_tweak__ + </div> + + __additional_code__ + </bx_if:show_image> + <div class="bx-base-text-entity-content bx-def-constraint-list bx-def-constraint-pre bx-def-constraint-object bx-def-constraint-iframe bx-def-constraint-img bx-def-vanilla-html"> + <div class="bx-base-text-title-bages"> + <h1>__entry_title__</h1> + <div class="bx-base-bages-container absolute flex -translate-y-5/4">__badges__</div> + </div> + <bx_if:show_entry_abstract> + <div class="bx-base-text-abstract mb-3 md:mb-4 lg:mb-6 text-gray-600 dark:text-gray-400 text-xl font-medium">__entry_abstract__</div> + </bx_if:show_entry_abstract> + <div class="bx-base-text-text">__entry_text__</div> + </div> + <bx_if:show_links> + <div class="__style_prefix__-item-links"> + <bx_repeat:links> + <div class="__style_prefix__-item-link mt-3 md:mt-4 lg:mt-6">__link__</div> + </bx_repeat:links> + </div> + </bx_if:show_links> +</div> +<div class="bx-content-description-after">__content_description_after__</div> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/text/template/unit_gallery.html b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/text/template/unit_gallery.html new file mode 100644 index 0000000000..97b178c32e --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/modules/base/text/template/unit_gallery.html @@ -0,0 +1,29 @@ +<div id="__html_id__" class="__class__ bx-base-text-unit bx-base-text-unit-gallery bx-def-gal-unit-size flex flex-col w-full p-2 box-border"> + <div class="bx-base-text-unit-cnt bx-def-box bx-def-box-round-corners bx-def-color-bg-box h-full"> + <div class="bx-base-text-unit-content-before">__unit_content_before__</div> + <bx_if:thumb> + <a href="__content_url__" <bx_if:show_thumb_onclick>onclick="javascript:__content_onclick__"</bx_if:show_thumb_onclick> title="__summary_attr__"> + <div class="shrink-0 m-1"> + <img class="bx-def-round-corners aspect-video object-cover bg-cover w-full" alt="__title__" style="background-image:url(__gallery_url__); __image_settings__" src="<bx_icon_url:spacer.gif />" /> + </div> + </a> + </bx_if:thumb> + <bx_if:no_thumb> + <div class="bx-def-gal-img-column shrink-0 m-1"> + <div class="bx-base-text-unit-no-thumb bx-def-round-corners flex flex-col items-center justify-center aspect-video p-4 bg-gradient-to-b from-red-400 to-red-500 box-border"></div> + </div> + </bx_if:no_thumb> + <div class="bx-base-text-unit-text flex flex-col flex-1 p-3 md:p-4 lg:p-6 pt-1 md:pt-2 lg:pt-3 box-border"> + <div class="bx-base-text-unit-badges pb-1 lg:pb-2">__badges__</div> + <div class="bx-base-text-unit-title flex-auto max-h-14"> + <div class="bx-base-tut-title truncate text-left"> + <a href="__content_url__" <bx_if:show_onclick>onclick="javascript:__content_onclick__"</bx_if:show_onclick> class="text-left">__title__</a> + </div> + </div> + <div class="bx-base-text-unit-info flex flex-auto flex-col justify-end text-sm text-gray-500 dark:text-gray-400"> + <bx_if:meta><div class="bx-base-general-unit-meta pt-2">__meta__</div></bx_if:meta> + </div> + </div> + <div class="bx-base-text-unit-content-after">__unit_content_after__</div> + </div> +</div> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/oembed.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/oembed.php new file mode 100644 index 0000000000..e8a41db64b --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/oembed.php @@ -0,0 +1,24 @@ +<?php +/** + * Copyright (c) UNA, Inc - https://una.io + * MIT License - https://opensource.org/licenses/MIT + * + * @defgroup UnaCore UNA Core + * @{ + */ + +require_once('./inc/header.inc.php'); +require_once(BX_DIRECTORY_PATH_INC . "design.inc.php"); + +if (getParam('sys_embed_default') != 'sys_oembed') + exit; + +$aLinks = bx_get('l'); + +bx_import('BxDolEmbed'); +if(($oEmbed = BxDolEmbed::getObjectInstance('sys_system')) !== false) { + if(bx_get('html')) + echo '<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;"" /><style>body, html {margin:0px} A{text-decoration:none; color:#222}</style><div style=" margin:0px auto; justify-content: center;" id="ifr">' . $oEmbed->getLinkHTML($aLinks) . '</div>'; + else + echoJson($oEmbed->parseLinks($aLinks)); +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/NOTES.md b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/NOTES.md new file mode 100644 index 0000000000..f44c79c85c --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/NOTES.md @@ -0,0 +1,86 @@ +# Testing notes + +**⚠️ WARNING**: Running all tests across all services takes _hours_. It is recommended that you use the SignedURLs test as a quick validation tool across multiple services, then test against the `$standardTests` suite overnight. + +## Against Amazon S3 proper + +This is the _canonical_ method for testing this library since Amazon S3 proper is the canonical provider of the S3 API (and not all of its quirks are fully documented, we might add). + +Copy `config.dist.php` to `config.php` and enter the connection information to your Amazon S3 or compatible service. + +## Against [LocalStack](https://localstack.cloud) + +This method is very useful for development. It is the most faithful implementation of S3, but it does have some minor quirks not present in the real thing as a result of it running inside a Docker container. + +Install LocalStack [per its documentation](https://docs.localstack.cloud/getting-started/installation/), or using its Docker Desktop Extension. + +You will also need to install [`awslocal`](https://github.com/localstack/awscli-local) like so: +```php +pip install awscli +pip install awscli-local +``` + +Start LocalStack e.g. `localstack start -d` or via the Docker Desktop Extension. + +Create a new bucket called `test` i.e. `awslocal s3 mb s3://test` + +The `config.dist.php` already has a configuration for LocalStack. Yes, the access and secret key can be any random string. + +## Against Wasabi + +Wasabi nominally supports v4 signatures, but their implementation is actually _non-canonical_, as they only read the date from the optional `x-amz-date` header, without falling back to the standard HTTP `Date` header. We have changed the behaviour of the library to always go through the X-Amz-Date header as a result. Hence, the need to test with Wasabi. + +The Wasabi configuration block looks like this: + +```php + 'wasabi-v4' => [ + 'access' => 'THE_ACCESS_KEY', + 'secret' => 'VERY_SECRET_MUCH_WOW', + 'region' => 'eu-central-2', + 'bucket' => 'bucketname', + 'signature' => 'v4', + 'dualstack' => false, + 'path_access' => true, + 'ssl' => true, + 'endpoint' => 's3.eu-central-2.wasabisys.com', + ], + 'wasabi-v2' => [ + 'access' => 'THE_ACCESS_KEY', + 'secret' => 'VERY_SECRET_MUCH_WOW', + 'region' => 'eu-central-2', + 'bucket' => 'bucketname', + 'signature' => 'v2', + 'dualstack' => false, + 'path_access' => true, + 'ssl' => true, + 'endpoint' => 's3.eu-central-2.wasabisys.com', + ], + +``` + +**❗Important**: The Endpoint and Region must match each other, and the region the bucket was crated in. In the example above, we have created a bucket in the `eu-central-2` region. If you use the wrong region and/or endpoint the tests _will_ fail! + +## Against Synology C2 + +Synology C2 is an S3-“compatible” storage service. It is not very “compatible” though, since they implemented Amazon's documentation of the v4 signatures instead of how the v4 signatures work in the real world (yeah, there's a very big difference). While Amazon S3 _in reality_ expects all dates to be formatted as per RFC1123, they document that they expect them to be formatted as per “ISO 8601”, and they give their _completely wrong_ interpretation of what the “ISO 8601” format is. Synology did not catch that discrepancy, and they only expect the wrongly formatted dates which is totally NOT what S3 itself expects. Luckily, most third party implementations expect either format because they've caught the discrepancy between documentation and reality, therefore making it possible for us to come up with a viable workaround. + +And that's why we need to test with C2 as well, folks. + +The C2 config block looks like this: + +```php + 'c2' => [ + 'access' => 'THE_ACCESS_KEY', + 'secret' => 'VERY_SECRET_MUCH_WOW', + 'region' => 'eu-002', + 'bucket' => 'bucketname', + 'signature' => 'v4', + 'dualstack' => false, + 'path_access' => false, + 'ssl' => true, + 'endpoint' => 'eu-002.s3.synologyc2.net', + ], + +``` + +The endpoint URL is given in the Synology C2 Object Manager, next to each bucket. Note the part before `.s3.`. This is the **region** you need to use with v4 signatures. They do not document this anywhere. \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/AbstractTest.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/AbstractTest.php new file mode 100644 index 0000000000..e3f77cce95 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/AbstractTest.php @@ -0,0 +1,242 @@ +<?php +/** + * Akeeba Engine + * + * @package akeebaengine + * @copyright Copyright (c)2006-2024 Nicholas K. Dionysopoulos / Akeeba Ltd + * @license GNU General Public License version 3, or later + */ + +namespace Akeeba\MiniTest\Test; + +use Akeeba\S3\Connector; +use RuntimeException; + +abstract class AbstractTest +{ + const TEN_KB = 10240; + + const HUNDRED_KB = 102400; + + const SIX_HUNDRED_KB = 614400; + + const ONE_MB = 1048576; + + const FIVE_MB = 5242880; + + const SIX_MB = 6291456; + + const TEN_MB = 10485760; + + const ELEVEN_MB = 11534336; + + const BLOCK_SIZE = 1048576; + + const FILE_HASHING_ALGORITHM = 'sha256'; + + public static function setup(Connector $s3, array $options): void + { + // Runs before any test + } + + public static function teardown(Connector $s3, array $options): void + { + // Runs after all tests are finished + } + + /** + * Creates a file with random data and returns its file path. + * + * The random data in the file repeats every $blockSize bytes when $reuseBlock is true. + * + * @param int $size Size in files + * + * @param int $blockSize + * @param bool $reuseBlock + * + * @return string The full path to the temporary file. + */ + protected static function createFile(int $size = AbstractTest::SIX_HUNDRED_KB, int $blockSize = self::BLOCK_SIZE, bool $reuseBlock = true) + { + $tempFilePath = tempnam(static::getTempFolder(), 'as3'); + + if ($tempFilePath === false) + { + throw new RuntimeException("Cannot create a temporary file."); + } + + $fp = @fopen($tempFilePath, 'w', false); + + if ($fp === false) + { + throw new RuntimeException("Cannot write to the temporary file."); + } + + $blockSize = static::BLOCK_SIZE; + $lastBlockSize = $size % $blockSize; + $wholeBlocks = (int) (($size - $lastBlockSize) / $blockSize); + $blockData = static::getRandomData(); + + for ($i = 0; $i < $wholeBlocks; $i++) + { + fwrite($fp, $blockData); + + if (!$reuseBlock) + { + $blockData = static::getRandomData($blockSize); + } + } + + if ($lastBlockSize > 0) + { + fwrite($fp, $blockData, $lastBlockSize); + } + + + fclose($fp); + + return $tempFilePath; + } + + /** + * Get a writeable temporary folder + * + * @return string + */ + protected static function getTempFolder(): string + { + $tempPath = sys_get_temp_dir(); + + if (!is_writable($tempPath)) + { + $tempPath = __DIR__ . '/tmp'; + + if (!is_dir($tempPath)) + { + @mkdir($tempPath, 0755, true); + } + } + + if (!is_writable($tempPath)) + { + throw new RuntimeException("Cannot get a writeable temporary path."); + } + + return $tempPath; + } + + /** + * Checks that two files are of equal length and contents + * + * @param string $referenceFilePath The known, reference file + * @param string $unknownFilePath The file we want to verify is the same as the reference file + * + * @return bool + */ + protected static function areFilesEqual(string $referenceFilePath, string $unknownFilePath): bool + { + if (!file_exists($referenceFilePath) || !file_exists($unknownFilePath)) + { + return false; + } + + if (!is_file($referenceFilePath) || !is_file($unknownFilePath)) + { + return false; + } + + if (!is_readable($referenceFilePath) || !is_readable($unknownFilePath)) + { + return false; + } + + if (@filesize($referenceFilePath) !== @filesize($unknownFilePath)) + { + return false; + } + + return hash_file(static::FILE_HASHING_ALGORITHM, $referenceFilePath) === hash_file(static::FILE_HASHING_ALGORITHM, $unknownFilePath); + } + + /** + * Checks that two strings are of equal length and contents + * + * @param string $referenceString The known, reference file + * @param string $unknownString The file we want to verify is the same as the reference file + * + * @return bool + */ + protected static function areStringsEqual(string $referenceString, string $unknownString): bool + { + return $referenceString === $unknownString; + } + + /** + * Returns random data of the specific size in bytes + * + * @param int $length How many bytes of random data to return + * + * @return string Your random data + */ + protected static function getRandomData(int $length = self::BLOCK_SIZE): string + { + $blockData = ''; + + if (substr(strtolower(PHP_OS), 0, 7) !== 'windows') + { + $fpRandom = @fopen('/dev/urandom', 'r'); + if ($fpRandom !== false) + { + $blockData = @fread($fpRandom, $length); + @fclose($fpRandom); + } + } + + if (empty($blockData) && function_exists('random_bytes')) + { + try + { + $blockData = random_bytes($length); + } + catch (\Exception $e) + { + $blockData = ''; + } + } + + if (empty($blockData) && function_exists('openssl_random_pseudo_bytes')) + { + $blockData = openssl_random_pseudo_bytes($length); + } + + if (empty($blockData) && function_exists('mcrypt_create_iv')) + { + $blockData = mcrypt_create_iv($length, MCRYPT_DEV_URANDOM); + + if (empty($blockData)) + { + $blockData = mcrypt_create_iv($length, MCRYPT_RAND); + } + } + + if (empty($blockData)) + { + for ($i = 0; $i < $length; $i++) + { + $blockData .= ord(mt_rand(0, 255)); + } + } + + return $blockData; + } + + protected static function assert(bool $condition, string $message): void + { + if ($condition) + { + return; + } + + throw new RuntimeException($message); + } +} \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/BigFiles.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/BigFiles.php new file mode 100644 index 0000000000..506e175875 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/BigFiles.php @@ -0,0 +1,217 @@ +<?php +/** + * Akeeba Engine + * + * @package akeebaengine + * @copyright Copyright (c)2006-2024 Nicholas K. Dionysopoulos / Akeeba Ltd + * @license GNU General Public License version 3, or later + */ + +namespace Akeeba\MiniTest\Test; + + +use Akeeba\S3\Connector; +use Akeeba\S3\Input; + +/** + * Upload, download and delete big files (over 1MB), without multipart uploads. Uses string or file sources. + * + * @package Akeeba\MiniTest\Test + */ +class BigFiles extends AbstractTest +{ + /** + * Should I download the file after uploading it to test for contents consistency? + * + * @var bool + */ + protected static $downloadAfter = true; + + /** + * Should I delete the uploaded file after the test case is done? + * + * @var bool + */ + protected static $deleteRemote = true; + + /** + * Should I use multipart (chunked) uploads? + * + * @var bool + */ + protected static $multipart = false; + + /** + * Chunk size for each multipart upload. Must be at least 5MB or the library overrides us. + * + * @var int + */ + protected static $uploadChunkSize = 5242880; + + /** + * Number of uploaded chunks. + * + * This is set by static::upload(). Zero for single part uploads, non-zero for multipart uploads. + * + * @var int + */ + protected static $numberOfChunks = 0; + + public static function upload5MBString(Connector $s3, array $options): bool + { + return static::upload($s3, $options, static::FIVE_MB, 'bigtest_5mb.dat'); + } + + public static function upload6MBString(Connector $s3, array $options): bool + { + return static::upload($s3, $options, static::SIX_MB, 'bigtest_6mb.dat'); + } + + public static function upload10MBString(Connector $s3, array $options): bool + { + return static::upload($s3, $options, static::TEN_MB, 'bigtest_10mb.dat'); + } + + public static function upload11MBString(Connector $s3, array $options): bool + { + return static::upload($s3, $options, static::ELEVEN_MB, 'bigtest_11mb.dat'); + } + + public static function upload5MBFile(Connector $s3, array $options): bool + { + return static::upload($s3, $options, static::FIVE_MB, 'bigtest_5mb.dat', false); + } + + public static function upload6MBFile(Connector $s3, array $options): bool + { + return static::upload($s3, $options, static::SIX_MB, 'bigtest_6mb.dat', false); + } + + public static function upload10MBFile(Connector $s3, array $options): bool + { + return static::upload($s3, $options, static::TEN_MB, 'bigtest_10mb.dat', false); + } + + public static function upload11MBFile(Connector $s3, array $options): bool + { + return static::upload($s3, $options, static::ELEVEN_MB, 'bigtest_11mb.dat', false); + } + + protected static function upload(Connector $s3, array $options, int $size, string $uri, bool $useString = true): bool + { + // Randomize the name. Required for archive buckets where you cannot overwrite data. + $dotPos = strrpos($uri, '.'); + $uri = substr($uri, 0, $dotPos) . '.' . hash('md5', microtime(false)) . substr($uri, $dotPos); + + static::$numberOfChunks = 0; + + if ($useString) + { + $sourceData = static::getRandomData($size); + $input = Input::createFromData($sourceData); + } + else + { + // Create a file with random data + $sourceFile = static::createFile($size); + $input = Input::createFromFile($sourceFile); + } + + // Upload the file. Throws exception if it fails. + $bucket = $options['bucket']; + + if (!static::$multipart) + { + $s3->putObject($input, $bucket, $uri); + } + else + { + // Get an upload session + $uploadSession = $s3->startMultipart($input, $bucket, $uri); + + // This array holds the etags of uploaded parts. Used by finalizeMultipart. + $eTags = []; + $partNumber = 1; + + while (true) + { + // We need to create a new input for each upload chunk + if ($useString) + { + $input = Input::createFromData($sourceData); + } + else + { + $input = Input::createFromFile($sourceFile); + } + + $input->setUploadID($uploadSession); + $input->setEtags($eTags); + $input->setPartNumber($partNumber); + + $etag = $s3->uploadMultipart($input, $bucket, $uri, [], static::$uploadChunkSize); + + // If the result was null we have no more file parts to process. + if (is_null($etag)) + { + break; + } + + // Append the etag to the etags array + $eTags[] = $etag; + + // Set the etags array in the Input object (required by finalizeMultipart) + $input->setEtags($eTags); + + $partNumber++; + } + + static::$numberOfChunks = count($eTags); + + // Finalize the multipart upload. Tells Amazon to construct the file from the uploaded parts. + $s3->finalizeMultipart($input, $bucket, $uri); + } + + // Tentatively accept that this method succeeded. + $result = true; + + // Should I download the file and compare its contents? + if (static::$downloadAfter) + { + if ($useString) + { + // Download the data. Throws exception if it fails. + $downloadedData = $s3->getObject($bucket, $uri); + + // Compare the file contents. + $result = static::areStringsEqual($sourceData, $downloadedData); + } + else + { + // Download the data. Throws exception if it fails. + $downloadedFile = tempnam(static::getTempFolder(), 'as3'); + $s3->getObject($bucket, $uri, $downloadedFile); + + // Compare the file contents. + $result = static::areFilesEqual($sourceFile, $downloadedFile); + + @unlink($downloadedFile); + } + } + + // Remove the local files + if (!$useString) + { + @unlink($sourceFile); + } + + // Should I delete the remotely stored file? + if (static::$deleteRemote) + { + // Delete the remote file. Throws exception if it fails. + $s3->deleteObject($bucket, $uri); + } + + return $result; + } +} \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/BucketLocation.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/BucketLocation.php new file mode 100644 index 0000000000..7055204545 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/BucketLocation.php @@ -0,0 +1,25 @@ +<?php +/** + * Akeeba Engine + * + * @package akeebaengine + * @copyright Copyright (c)2006-2024 Nicholas K. Dionysopoulos / Akeeba Ltd + * @license GNU General Public License version 3, or later + */ + +namespace Akeeba\MiniTest\Test; + + +use Akeeba\S3\Connector; + +class BucketLocation extends AbstractTest +{ + public static function getBucketLocation(Connector $s3, array $options): bool + { + $location = $s3->getBucketLocation($options['bucket']); + + static::assert($location === $options['region'], "Bucket ‘{$options['bucket']}′ reports being in region ‘{$location}′ instead of expected ‘{$options['region']}′"); + + return true; + } +} \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/BucketsList.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/BucketsList.php new file mode 100644 index 0000000000..ebd7d5eb36 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/BucketsList.php @@ -0,0 +1,52 @@ +<?php +/** + * Akeeba Engine + * + * @package akeebaengine + * @copyright Copyright (c)2006-2024 Nicholas K. Dionysopoulos / Akeeba Ltd + * @license GNU General Public License version 3, or later + */ + +namespace Akeeba\MiniTest\Test; + + +use Akeeba\S3\Connector; +use RuntimeException; + +class BucketsList extends AbstractTest +{ + public static function listBucketsDetailed(Connector $s3, array $options): bool + { + $buckets = $s3->listBuckets(true); + + static::assert(is_array($buckets), "Detailed buckets list is not an array"); + static::assert(isset($buckets['owner']), "Detailed buckets list does not list an owner"); + static::assert(isset($buckets['owner']['id']), "Detailed buckets list does not list an owner's id"); + static::assert(isset($buckets['owner']['name']), "Detailed buckets list does not list an owner's name"); + static::assert(isset($buckets['buckets']), "Detailed buckets list does not list any buckets"); + + foreach ($buckets['buckets'] as $bucketInfo) + { + static::assert(isset($bucketInfo['name']), "Bucket information does not list a name"); + static::assert(isset($bucketInfo['time']), "Bucket information does not list a created times"); + + if ($bucketInfo['name'] === $options['bucket']) + { + return true; + } + } + + throw new RuntimeException("Detailed buckets list does not include configured bucket ‘{$options['bucket']}′"); + } + + public static function listBucketsSimple(Connector $s3, array $options): bool + { + $buckets = $s3->listBuckets(false); + + static::assert(is_array($buckets), "Simple buckets list is not an array"); + static::assert(in_array($options['bucket'], $buckets), "Simple buckets list does not include configured bucket ‘{$options['bucket']}′"); + + return true; + } + +} \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/HeadObject.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/HeadObject.php new file mode 100644 index 0000000000..87f32ed7b8 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/HeadObject.php @@ -0,0 +1,67 @@ +<?php +/** + * Akeeba Engine + * + * @package akeebaengine + * @copyright Copyright (c)2006-2024 Nicholas K. Dionysopoulos / Akeeba Ltd + * @license GNU General Public License version 3, or later + */ + + +namespace Akeeba\MiniTest\Test; + + +use Akeeba\S3\Connector; +use Akeeba\S3\Exception\CannotDeleteFile; +use Akeeba\S3\Exception\CannotGetFile; +use Akeeba\S3\Input; + +class HeadObject extends AbstractTest +{ + public static function testExistingFile(Connector $s3, array $options): bool + { + $uri = 'head_test.dat'; + + // Randomize the name. Required for archive buckets where you cannot overwrite data. + $dotPos = strrpos($uri, '.'); + $uri = substr($uri, 0, $dotPos) . '.' . hash('md5', microtime(false)) . substr($uri, $dotPos); + + // Create a file with random data + $sourceFile = static::createFile(AbstractTest::TEN_KB); + + // Upload the file. Throws exception if it fails. + $bucket = $options['bucket']; + $input = Input::createFromFile($sourceFile); + + $s3->putObject($input, $bucket, $uri); + + $headers = $s3->headObject($bucket, $uri); + + static::assert(isset($headers['size']), 'The returned headers do not contain the object size'); + static::assert($headers['size'] == AbstractTest::TEN_KB, 'The returned size does not match'); + + // Remove the local files + @unlink($sourceFile); + + // Delete the remote file. Throws exception if it fails. + $s3->deleteObject($bucket, $uri); + + return true; + } + + public static function testMissingFile(Connector $s3, array $options): bool + { + $bucket = $options['bucket']; + + try + { + $headers = $s3->headObject($bucket, hash('md5', microtime(false)) . '_does_not_exist'); + } + catch (CannotGetFile $e) + { + return true; + } + + return false; + } +} \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/ListFiles.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/ListFiles.php new file mode 100644 index 0000000000..fc6ed23230 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/ListFiles.php @@ -0,0 +1,308 @@ +<?php +/** + * Akeeba Engine + * + * @package akeebaengine + * @copyright Copyright (c)2006-2024 Nicholas K. Dionysopoulos / Akeeba Ltd + * @license GNU General Public License version 3, or later + */ + +namespace Akeeba\MiniTest\Test; + + +use Akeeba\S3\Connector; +use Akeeba\S3\Exception\CannotPutFile; +use Akeeba\S3\Input; + +class ListFiles extends AbstractTest +{ + private static $paths = [ + 'listtest_one.dat', + 'listtest_two.dat', + 'listtest_three.dat', + 'list_deeper/test_one.dat', + 'list_deeper/test_two.dat', + 'list_deeper/test_three.dat', + 'list_deeper/listtest_four.dat', + 'list_deeper/listtest_five.dat', + 'list_deeper/listtest_six.dat', + 'list_deeper/spam.dat', + 'list_deeper/listtest_deeper/seven.dat', + 'list_deeper/listtest_deeper/eight.dat', + 'spam.dat', + ]; + + public static function setup(Connector $s3, array $options): void + { + $data = static::getRandomData(static::TEN_KB); + + foreach (static::$paths as $uri) + { + $input = Input::createFromData($data); + try + { + $s3->putObject($input, $options['bucket'], $uri); + } + catch (CannotPutFile $e) + { + // Expected for archival buckets + } + } + } + + public static function teardown(Connector $s3, array $options): void + { + foreach (static::$paths as $uri) + { + try + { + $s3->deleteObject($options['bucket'], $uri); + } + catch (\Exception $e) + { + // No problem if I can't delete the file + } + } + } + + public static function testGetAll(Connector $s3, array $options): bool + { + $listing = $s3->getBucket($options['bucket'], 'listtest_'); + + static::assert(is_array($listing), "The files listing must be an array"); + static::assert(count($listing) == 3, "I am expecting to see 3 files"); + + // Make sure I have the expected files + static::assert(array_key_exists('listtest_one.dat', $listing), "File listtest_one.dat not in listing"); + static::assert(array_key_exists('listtest_two.dat', $listing), "File listtest_two.dat not in listing"); + static::assert(array_key_exists('listtest_three.dat', $listing), "File listtest_three.dat not in listing"); + + // I must not see the files in subdirectories + static::assert(!array_key_exists('listtest_four.dat', $listing), "File listtest_four.dat in listing"); + static::assert(!array_key_exists('listtest_five.dat', $listing), "File listtest_five.dat in listing"); + static::assert(!array_key_exists('listtest_six.dat', $listing), "File listtest_six.dat in listing"); + + // I must not see the files not matching the prefix I gave + static::assert(!array_key_exists('spam.dat', $listing), "File spam.dat in listing"); + static::assert(!array_key_exists('ham.dat', $listing), "File ham.dat in listing"); + + foreach ($listing as $fileName => $info) + { + static::assert(isset($info['name']), "File entries must have a name"); + static::assert(isset($info['time']), "File entries must have a time"); + static::assert(isset($info['size']), "File entries must have a size"); + static::assert(isset($info['hash']), "File entries must have a hash"); + } + + return true; + } + + public static function testGetContinue(Connector $s3, array $options): bool + { + $listing = $s3->getBucket($options['bucket'], 'listtest_', null, 1); + + static::assert(is_array($listing), "The files listing must be an array"); + static::assert(count($listing) == 1, sprintf("I am expecting to see 1 file, %s seen", count($listing))); + + $files = array_keys($listing); + $continued = $s3->getBucket($options['bucket'], 'listtest_', array_shift($files)); + + static::assert(is_array($continued), "The continued files listing must be an array"); + static::assert(count($continued) == 2, sprintf("I am expecting to see 2 files, %s seen", count($continued))); + + $listing = array_merge($listing, $continued); + + // Make sure I have the expected files + static::assert(array_key_exists('listtest_one.dat', $listing), "File listtest_one.dat not in listing"); + static::assert(array_key_exists('listtest_two.dat', $listing), "File listtest_two.dat not in listing"); + static::assert(array_key_exists('listtest_three.dat', $listing), "File listtest_three.dat not in listing"); + + // I must not see the files in subdirectories + static::assert(!array_key_exists('listtest_four.dat', $listing), "File listtest_four.dat in listing"); + static::assert(!array_key_exists('listtest_five.dat', $listing), "File listtest_five.dat in listing"); + static::assert(!array_key_exists('listtest_six.dat', $listing), "File listtest_six.dat in listing"); + + // I must not see the files not matching the prefix I gave + static::assert(!array_key_exists('spam.dat', $listing), "File spam.dat in listing"); + static::assert(!array_key_exists('ham.dat', $listing), "File ham.dat in listing"); + + foreach ($listing as $fileName => $info) + { + static::assert(isset($info['name']), "File entries must have a name"); + static::assert(isset($info['time']), "File entries must have a time"); + static::assert(isset($info['size']), "File entries must have a size"); + static::assert(isset($info['hash']), "File entries must have a hash"); + } + + return true; + } + + public static function testGetSubdirectoryFiles(Connector $s3, array $options): bool + { + $listing = $s3->getBucket($options['bucket'], 'list_deeper/test_'); + + static::assert(is_array($listing), "The files listing must be an array"); + static::assert(count($listing) == 3, "I am expecting to see 3 files"); + + // Make sure I have the expected files + static::assert(array_key_exists('list_deeper/test_one.dat', $listing), "File test_one.dat not in listing"); + static::assert(array_key_exists('list_deeper/test_two.dat', $listing), "File test_two.dat not in listing"); + static::assert(array_key_exists('list_deeper/test_three.dat', $listing), "File test_three.dat not in listing"); + + // I must not see the files with different prefix + static::assert(!array_key_exists('list_deeper/listtest_four.dat', $listing), "File listtest_four.dat in listing"); + static::assert(!array_key_exists('list_deeper/listtest_five.dat', $listing), "File listtest_five.dat in listing"); + static::assert(!array_key_exists('list_deeper/listtest_six.dat', $listing), "File listtest_six.dat in listing"); + static::assert(!array_key_exists('list_deeper/spam.dat', $listing), "File spam.dat in listing"); + + // I must not see the files in subdirectories + static::assert(!array_key_exists('list_deeper/listtest_deeper/seven.dat', $listing), "File spam.dat in listing"); + static::assert(!array_key_exists('list_deeper/listtest_deeper/eight.dat', $listing), "File spam.dat in listing"); + + foreach ($listing as $fileName => $info) + { + static::assert(isset($info['name']), "File entries must have a name"); + static::assert(isset($info['time']), "File entries must have a time"); + static::assert(isset($info['size']), "File entries must have a size"); + static::assert(isset($info['hash']), "File entries must have a hash"); + } + + return true; + } + + public static function testGetSubdirectoryFilesWithContinue(Connector $s3, array $options): bool + { + $listing = $s3->getBucket($options['bucket'], 'list_deeper/test_', null, 1); + + static::assert(is_array($listing), "The files listing must be an array"); + static::assert(count($listing) == 1, sprintf("I am expecting to see 1 file, %s seen", count($listing))); + + $files = array_keys($listing); + $continued = $s3->getBucket($options['bucket'], 'list_deeper/test_', array_shift($files)); + + static::assert(is_array($continued), "The continued files listing must be an array"); + static::assert(count($continued) == 2, sprintf("I am expecting to see 2 files, %s seen", count($continued))); + + $listing = array_merge($listing, $continued); + + static::assert(is_array($listing), "The files listing must be an array"); + static::assert(count($listing) == 3, "I am expecting to see 3 files"); + + // Make sure I have the expected files + static::assert(array_key_exists('list_deeper/test_one.dat', $listing), "File test_one.dat not in listing"); + static::assert(array_key_exists('list_deeper/test_two.dat', $listing), "File test_two.dat not in listing"); + static::assert(array_key_exists('list_deeper/test_three.dat', $listing), "File test_three.dat not in listing"); + + // I must not see the files with different prefix + static::assert(!array_key_exists('list_deeper/listtest_four.dat', $listing), "File listtest_four.dat in listing"); + static::assert(!array_key_exists('list_deeper/listtest_five.dat', $listing), "File listtest_five.dat in listing"); + static::assert(!array_key_exists('list_deeper/listtest_six.dat', $listing), "File listtest_six.dat in listing"); + static::assert(!array_key_exists('list_deeper/spam.dat', $listing), "File spam.dat in listing"); + + // I must not see the files in subdirectories + static::assert(!array_key_exists('list_deeper/listtest_deeper/seven.dat', $listing), "File spam.dat in listing"); + static::assert(!array_key_exists('list_deeper/listtest_deeper/eight.dat', $listing), "File spam.dat in listing"); + + foreach ($listing as $fileName => $info) + { + static::assert(isset($info['name']), "File entries must have a name"); + static::assert(isset($info['time']), "File entries must have a time"); + static::assert(isset($info['size']), "File entries must have a size"); + static::assert(isset($info['hash']), "File entries must have a hash"); + } + + return true; + } + + public static function testListWithPrefixSharedWithFolder(Connector $s3, array $options): bool + { + /** + * The prefix list_deeper/listtest_ matches BOTH keys (files) and common prefixes (folders). + * + * Common prefixes have priority so the first request would return zero files. The Connector catches that + * internally and performs more requests until it has at least as many files as we requeted. + */ + $listing = $s3->getBucket($options['bucket'], 'list_deeper/listtest_', null, 1); + + static::assert(is_array($listing), "The files listing must be an array"); + static::assert(count($listing) == 1, sprintf("I am expecting to see 1 files, %s seen", count($listing))); + + $files = array_keys($listing); + $continued = $s3->getBucket($options['bucket'], 'list_deeper/listtest_', array_shift($files)); + + static::assert(is_array($continued), "The continued files listing must be an array"); + static::assert(count($continued) == 2, sprintf("I am expecting to see 2 files, %s seen", count($continued))); + + $listing = array_merge($listing, $continued); + + static::assert(is_array($listing), "The files listing must be an array"); + static::assert(count($listing) == 3, "I am expecting to see 3 files"); + + // Make sure I have the expected files + static::assert(array_key_exists('list_deeper/listtest_four.dat', $listing), "File listtest_four.dat not in listing"); + static::assert(array_key_exists('list_deeper/listtest_five.dat', $listing), "File listtest_five.dat not in listing"); + static::assert(array_key_exists('list_deeper/listtest_six.dat', $listing), "File listtest_six.dat not in listing"); + + + // I must not see the files with different prefix + static::assert(!array_key_exists('list_deeper/test_one.dat', $listing), "File test_one.dat in listing"); + static::assert(!array_key_exists('list_deeper/test_two.dat', $listing), "File test_two.dat in listing"); + static::assert(!array_key_exists('list_deeper/test_three.dat', $listing), "File test_three.dat in listing"); + static::assert(!array_key_exists('list_deeper/spam.dat', $listing), "File spam.dat in listing"); + + // I must not see the files in subdirectories + static::assert(!array_key_exists('list_deeper/listtest_deeper/seven.dat', $listing), "File spam.dat in listing"); + static::assert(!array_key_exists('list_deeper/listtest_deeper/eight.dat', $listing), "File spam.dat in listing"); + + foreach ($listing as $fileName => $info) + { + static::assert(isset($info['name']), "File entries must have a name"); + static::assert(isset($info['time']), "File entries must have a time"); + static::assert(isset($info['size']), "File entries must have a size"); + static::assert(isset($info['hash']), "File entries must have a hash"); + } + + return true; + } + + public static function testCommonPrefixes(Connector $s3, array $options): bool + { + $listing = $s3->getBucket($options['bucket'], 'list_deeper/listtest_', null, null, '/', true); + + static::assert(is_array($listing), "The files listing must be an array"); + static::assert(count($listing) == 4, sprintf("I am expecting to see 4 entries, %s entries seen.", count($listing))); + + // Make sure I have the expected files + static::assert(array_key_exists('list_deeper/listtest_four.dat', $listing), "File listtest_four.dat not in listing"); + static::assert(array_key_exists('list_deeper/listtest_five.dat', $listing), "File listtest_five.dat not in listing"); + static::assert(array_key_exists('list_deeper/listtest_six.dat', $listing), "File listtest_six.dat not in listing"); + static::assert(array_key_exists('list_deeper/listtest_deeper/', $listing), "Folder listtest_deeper not in listing"); + + // I must not see the files in subdirectories + static::assert(!array_key_exists('list_deeper/listtest_deeper/seven.dat', $listing), "File seven.dat in listing"); + static::assert(!array_key_exists('list_deeper/listtest_deeper/eight.dat', $listing), "File eight.dat in listing"); + + // I must not see the files with different prefix + static::assert(!array_key_exists('list_deeper/spam.dat', $listing), "File spam.dat in listing"); + static::assert(!array_key_exists('list_deeper/test_one.dat', $listing), "File test_one.dat not in listing"); + static::assert(!array_key_exists('list_deeper/test_two.dat', $listing), "File test_two.dat not in listing"); + static::assert(!array_key_exists('list_deeper/test_three.dat', $listing), "File test_three.dat not in listing"); + + foreach ($listing as $fileName => $info) + { + if (substr($fileName, -1) !== '/') + { + static::assert(isset($info['name']), "File entries must have a name"); + static::assert(isset($info['time']), "File entries must have a time"); + static::assert(isset($info['size']), "File entries must have a size"); + static::assert(isset($info['hash']), "File entries must have a hash"); + } + else + { + static::assert(isset($info['prefix']), "Folder entries must return a prefix"); + } + } + + return true; + } +} \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/ListThousandsOfFiles.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/ListThousandsOfFiles.php new file mode 100644 index 0000000000..8485a715f4 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/ListThousandsOfFiles.php @@ -0,0 +1,111 @@ +<?php +/** + * Akeeba Engine + * + * @package akeebaengine + * @copyright Copyright (c)2006-2024 Nicholas K. Dionysopoulos / Akeeba Ltd + * @license GNU General Public License version 3, or later + */ + +namespace Akeeba\MiniTest\Test; + +use Akeeba\S3\Connector; +use Akeeba\S3\Input; + +class ListThousandsOfFiles extends AbstractTest +{ + private const PATH_PREFIX = 'massive/'; + + public static function setup(Connector $s3, array $options): void + { + if (defined('CREATE_2100_FILES') && CREATE_2100_FILES === false) + { + return; + } + + $data = static::getRandomData(128); + + echo "\nPopulating with 2100 files\n"; + + for ($i = 1; $i <= 2100; $i++) + { + if ($i % 10 === 0) + { + echo "Uploading from $i...\n"; + } + + $uri = sprintf('%stest_%04u.dat', static::PATH_PREFIX, $i); + $input = Input::createFromData($data); + $s3->putObject($input, $options['bucket'], $uri); + } + } + + public static function testGetAll(Connector $s3, array $options): bool + { + $listing = $s3->getBucket($options['bucket'], static::PATH_PREFIX); + + static::assert(is_array($listing), "The files listing must be an array"); + static::assert(count($listing) === 2100, "I am expecting to see 2100 files"); + + for ($i = 1; $i <= 2100; $i++) + { + $key = sprintf('%stest_%04u.dat', static::PATH_PREFIX, $i); + + static::assert(array_key_exists($key, $listing), sprintf('Results should list object %s', $key)); + } + + return true; + } + + public static function testGetHundred(Connector $s3, array $options): bool + { + $listing = $s3->getBucket($options['bucket'], static::PATH_PREFIX, null, 100); + + static::assert(is_array($listing), "The files listing must be an array"); + static::assert(count($listing) === 100, "I am expecting to see 100 files"); + + for ($i = 1; $i <= 100; $i++) + { + $key = sprintf('%stest_%04u.dat', static::PATH_PREFIX, $i); + + static::assert(array_key_exists($key, $listing), sprintf('Results should list object %s', $key)); + } + + return true; + } + + public static function testGetElevenHundred(Connector $s3, array $options): bool + { + $listing = $s3->getBucket($options['bucket'], static::PATH_PREFIX, null, 1100); + + static::assert(is_array($listing), "The files listing must be an array"); + static::assert(count($listing) === 1100, "I am expecting to see 1100 files"); + + for ($i = 1; $i <= 1100; $i++) + { + $key = sprintf('%stest_%04u.dat', static::PATH_PREFIX, $i); + + static::assert(array_key_exists($key, $listing), sprintf('Results should list object %s', $key)); + } + + return true; + } + + public static function testGetLastHundred(Connector $s3, array $options): bool + { + $listing = $s3->getBucket($options['bucket'], static::PATH_PREFIX . 'test_20', null); + + static::assert(is_array($listing), "The files listing must be an array"); + static::assert(count($listing) === 100, "I am expecting to see 100 files"); + + for ($i = 2000; $i <= 2099; $i++) + { + $key = sprintf('%stest_%04u.dat', static::PATH_PREFIX, $i); + + static::assert(array_key_exists($key, $listing), sprintf('Results should list object %s', $key)); + } + + return true; + } + +} \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/Multipart.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/Multipart.php new file mode 100644 index 0000000000..fc244c6282 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/Multipart.php @@ -0,0 +1,103 @@ +<?php +/** + * Akeeba Engine + * + * @package akeebaengine + * @copyright Copyright (c)2006-2024 Nicholas K. Dionysopoulos / Akeeba Ltd + * @license GNU General Public License version 3, or later + */ + +namespace Akeeba\MiniTest\Test; + + +use Akeeba\S3\Connector; + +class Multipart extends BigFiles +{ + public static function setup(Connector $s3, array $options): void + { + static::$multipart = true; + + parent::setup($s3, $options); + } + + public static function upload5MBString(Connector $s3, array $options): bool + { + $result = parent::upload5MBString($s3, $options); + + $expectedChunks = 1; + static::assert(static::$numberOfChunks === $expectedChunks, sprintf("Expected %s chunks, upload complete in %s chunks", $expectedChunks, static::$numberOfChunks)); + + return $result; + } + + public static function upload6MBString(Connector $s3, array $options): bool + { + $result = parent::upload6MBString($s3, $options); + + $expectedChunks = 2; + static::assert(static::$numberOfChunks === $expectedChunks, sprintf("Expected %s chunks, upload complete in %s chunks", $expectedChunks, static::$numberOfChunks)); + + return $result; + } + + public static function upload10MBString(Connector $s3, array $options): bool + { + $result = parent::upload10MBString($s3, $options); + + $expectedChunks = 2; + static::assert(static::$numberOfChunks === $expectedChunks, sprintf("Expected %s chunks, upload complete in %s chunks", $expectedChunks, static::$numberOfChunks)); + + return $result; + } + + public static function upload11MBString(Connector $s3, array $options): bool + { + $result = parent::upload11MBString($s3, $options); + + $expectedChunks = 3; + static::assert(static::$numberOfChunks === $expectedChunks, sprintf("Expected %s chunks, upload complete in %s chunks", $expectedChunks, static::$numberOfChunks)); + + return $result; + } + + public static function upload5MBFile(Connector $s3, array $options): bool + { + $result = parent::upload5MBFile($s3, $options); + + $expectedChunks = 1; + static::assert(static::$numberOfChunks === $expectedChunks, sprintf("Expected %s chunks, upload complete in %s chunks", $expectedChunks, static::$numberOfChunks)); + + return $result; + } + + public static function upload6MBFile(Connector $s3, array $options): bool + { + $result = parent::upload6MBFile($s3, $options); + + $expectedChunks = 2; + static::assert(static::$numberOfChunks === $expectedChunks, sprintf("Expected %s chunks, upload complete in %s chunks", $expectedChunks, static::$numberOfChunks)); + + return $result; + } + + public static function upload10MBFile(Connector $s3, array $options): bool + { + $result = parent::upload10MBFile($s3, $options); + + $expectedChunks = 2; + static::assert(static::$numberOfChunks === $expectedChunks, sprintf("Expected %s chunks, upload complete in %s chunks", $expectedChunks, static::$numberOfChunks)); + + return $result; + } + + public static function upload11MBFile(Connector $s3, array $options): bool + { + $result = parent::upload11MBFile($s3, $options); + + $expectedChunks = 3; + static::assert(static::$numberOfChunks === $expectedChunks, sprintf("Expected %s chunks, upload complete in %s chunks", $expectedChunks, static::$numberOfChunks)); + + return $result; + } +} \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/SignedURLs.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/SignedURLs.php new file mode 100644 index 0000000000..2b2e1ba60a --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/SignedURLs.php @@ -0,0 +1,78 @@ +<?php +/** + * Akeeba Engine + * + * @package akeebaengine + * @copyright Copyright (c)2006-2024 Nicholas K. Dionysopoulos / Akeeba Ltd + * @license GNU General Public License version 3, or later + */ + +namespace Akeeba\MiniTest\Test; + + +use Akeeba\S3\Acl; +use Akeeba\S3\Connector; +use Akeeba\S3\Input; +use RuntimeException; + +class SignedURLs extends AbstractTest +{ + public static function signedURLPublicObject(Connector $s3, array $options): bool + { + return static::signedURL($s3, $options, Acl::ACL_PUBLIC_READ); + } + + public static function signedURLPublicObjectSpaces(Connector $s3, array $options): bool + { + return static::signedURL($s3, array_merge($options, [ + 'spaces' => true + ]), Acl::ACL_PUBLIC_READ); + } + + public static function signedURLPrivateObject(Connector $s3, array $options): bool + { + return static::signedURL($s3, $options, Acl::ACL_PRIVATE); + } + + public static function signedURLPrivateObjectSpaces(Connector $s3, array $options): bool + { + return static::signedURL($s3, array_merge($options, [ + 'spaces' => true + ]), Acl::ACL_PRIVATE); + } + + private static function signedURL(Connector $s3, array $options, string $aclPrivilege): bool + { + $spaces = isset($options['spaces']) && boolval($options['spaces']); + $tempData = static::getRandomData(AbstractTest::TEN_KB); + $input = Input::createFromData($tempData); + $prefix = $spaces ? 'test file' : 'test'; + $uri = $prefix . '.' . hash('md5', microtime(false)) . '.dat'; + + $s3->putObject($input, $options['bucket'], $uri, $aclPrivilege); + + $downloadURL = $s3->getAuthenticatedURL($options['bucket'], $uri, null, $options['ssl']); + + echo "\n\tDownload URL: $downloadURL\n"; + + $downloadedData = @file_get_contents($downloadURL); + + try + { + $s3->deleteObject($options['bucket'], $uri); + } + catch (\Exception $e) + { + // Ignore deletion errors + } + + if ($downloadedData === false) + { + throw new RuntimeException("Failed to download from signed URL ‘{$downloadURL}′"); + } + + static::assert(static::areStringsEqual($tempData, $downloadedData), "Wrong data received from signed URL ‘{$downloadURL}′"); + + return true; + } +} \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/SingleSmallFile.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/SingleSmallFile.php new file mode 100644 index 0000000000..51716621fb --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/SingleSmallFile.php @@ -0,0 +1,43 @@ +<?php +/** + * Akeeba Engine + * + * @package akeebaengine + * @copyright Copyright (c)2006-2024 Nicholas K. Dionysopoulos / Akeeba Ltd + * @license GNU General Public License version 3, or later + */ + +namespace Akeeba\MiniTest\Test; + +use Akeeba\S3\Connector; +use Akeeba\S3\Input; + +/** + * Upload, download and delete small files (under 1MB) using a string source + * + * @package Akeeba\MiniTest\Test + */ +class SingleSmallFile extends AbstractTest +{ + public static function upload(Connector $s3, array $options): bool + { + $uri = 'test.txt'; + $sourceData = <<< TEXT +This is a small text file. +TEXT; + + + // Upload the data. Throws exception if it fails. + $bucket = $options['bucket']; + $input = Input::createFromData($sourceData); + + $s3->putObject($input, $bucket, $uri); + + $downloadedData = $s3->getObject($bucket, $uri); + $result = static::areStringsEqual($sourceData, $downloadedData); + + $s3->deleteObject($bucket, $uri); + + return $result ?? true; + } +} \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/SmallFiles.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/SmallFiles.php new file mode 100644 index 0000000000..57e2910b36 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/SmallFiles.php @@ -0,0 +1,109 @@ +<?php +/** + * Akeeba Engine + * + * @package akeebaengine + * @copyright Copyright (c)2006-2024 Nicholas K. Dionysopoulos / Akeeba Ltd + * @license GNU General Public License version 3, or later + */ + +namespace Akeeba\MiniTest\Test; + + +use Akeeba\S3\Connector; +use Akeeba\S3\Input; + +/** + * Upload, download and delete small files (under 1MB) using a file source + * + * @package Akeeba\MiniTest\Test + */ +class SmallFiles extends AbstractTest +{ + /** + * Should I download the file after uploading it to test for contents consistency? + * + * @var bool + */ + protected static $downloadAfter = true; + + /** + * Should I delete the uploaded file after the test case is done? + * + * @var bool + */ + protected static $deleteRemote = true; + + public static function upload10KbRoot(Connector $s3, array $options): bool + { + return static::upload($s3, $options, AbstractTest::TEN_KB, 'root_10kb.dat'); + } + + public static function upload10KbRootGreek(Connector $s3, array $options): bool + { + return static::upload($s3, $options, AbstractTest::TEN_KB, 'δοκιμή_10kb.dat'); + } + + public static function upload10KbFolderGreek(Connector $s3, array $options): bool + { + return static::upload($s3, $options, AbstractTest::TEN_KB, 'ο_φάκελός_μου/δοκιμή_10kb.dat'); + } + + public static function upload600KbRoot(Connector $s3, array $options): bool + { + return static::upload($s3, $options, AbstractTest::SIX_HUNDRED_KB, 'root_600kb.dat'); + } + + public static function upload10KbFolder(Connector $s3, array $options): bool + { + return static::upload($s3, $options, AbstractTest::TEN_KB, 'my_folder/10kb.dat'); + } + + public static function upload600KbFolder(Connector $s3, array $options): bool + { + return static::upload($s3, $options, AbstractTest::SIX_HUNDRED_KB, 'my_folder/600kb.dat'); + } + + protected static function upload(Connector $s3, array $options, int $size, string $uri): bool + { + // Randomize the name. Required for archive buckets where you cannot overwrite data. + $dotPos = strrpos($uri, '.'); + $uri = substr($uri, 0, $dotPos) . '.' . hash('md5', microtime(false)) . substr($uri, $dotPos); + + // Create a file with random data + $sourceFile = static::createFile($size); + + // Upload the file. Throws exception if it fails. + $bucket = $options['bucket']; + $input = Input::createFromFile($sourceFile); + + $s3->putObject($input, $bucket, $uri); + + // Tentatively accept that this method succeeded. + $result = true; + + // Should I download the file and compare its contents? + if (static::$downloadAfter) + { + // Donwload the data. Throws exception if it fails. + $downloadedFile = tempnam(static::getTempFolder(), 'as3'); + $s3->getObject($bucket, $uri, $downloadedFile); + + // Compare the file contents. + $result = static::areFilesEqual($sourceFile, $downloadedFile); + } + + // Remove the local files + @unlink($sourceFile); + @unlink($downloadedFile); + + // Should I delete the remotely stored file? + if (static::$deleteRemote) + { + // Delete the remote file. Throws exception if it fails. + $s3->deleteObject($bucket, $uri); + } + + return $result; + } +} \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/SmallFilesNoDelete.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/SmallFilesNoDelete.php new file mode 100644 index 0000000000..fee30e5f97 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/SmallFilesNoDelete.php @@ -0,0 +1,28 @@ +<?php +/** + * Akeeba Engine + * + * @package akeebaengine + * @copyright Copyright (c)2006-2024 Nicholas K. Dionysopoulos / Akeeba Ltd + * @license GNU General Public License version 3, or later + */ + +namespace Akeeba\MiniTest\Test; + + +use Akeeba\S3\Connector; + +/** + * Upload and download small files (under 1MB) using a file source + * + * @package Akeeba\MiniTest\Test + */ +class SmallFilesNoDelete extends SmallFiles +{ + public static function setup(Connector $s3, array $options): void + { + static::$deleteRemote = false; + + parent::setup($s3, $options); + } +} \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/SmallFilesOnlyUpload.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/SmallFilesOnlyUpload.php new file mode 100644 index 0000000000..1d2aa370b3 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/SmallFilesOnlyUpload.php @@ -0,0 +1,31 @@ +<?php +/** + * Akeeba Engine + * + * @package akeebaengine + * @copyright Copyright (c)2006-2024 Nicholas K. Dionysopoulos / Akeeba Ltd + * @license GNU General Public License version 3, or later + */ + +namespace Akeeba\MiniTest\Test; + + +use Akeeba\S3\Connector; + +/** + * Upload small files (under 1MB) using a file source + * + * @package Akeeba\MiniTest\Test + */ +class SmallFilesOnlyUpload extends SmallFiles +{ + public static function setup(Connector $s3, array $options): void + { + static::$deleteRemote = false; + static::$downloadAfter = false; + + parent::setup($s3, $options); + } + + +} \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/SmallInlineFiles.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/SmallInlineFiles.php new file mode 100644 index 0000000000..7119e3695b --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/SmallInlineFiles.php @@ -0,0 +1,57 @@ +<?php +/** + * Akeeba Engine + * + * @package akeebaengine + * @copyright Copyright (c)2006-2024 Nicholas K. Dionysopoulos / Akeeba Ltd + * @license GNU General Public License version 3, or later + */ + +namespace Akeeba\MiniTest\Test; + +use Akeeba\S3\Connector; +use Akeeba\S3\Input; + +/** + * Upload, download and delete small files (under 1MB) using a string source + * + * @package Akeeba\MiniTest\Test + */ +class SmallInlineFiles extends SmallFiles +{ + protected static function upload(Connector $s3, array $options, int $size, string $uri): bool + { + // Randomize the name. Required for archive buckets where you cannot overwrite data. + $dotPos = strrpos($uri, '.'); + $uri = substr($uri, 0, $dotPos) . '.' . hash('md5', microtime(false)) . substr($uri, $dotPos); + + // Create some random data to upload + $sourceData = static::getRandomData($size); + + // Upload the data. Throws exception if it fails. + $bucket = $options['bucket']; + $input = Input::createFromData($sourceData); + + $s3->putObject($input, $bucket, $uri); + + // Tentatively accept that this method succeeded. + $result = true; + + // Should I download the file and compare its contents with my random data? + if (static::$downloadAfter) + { + $downloadedData = $s3->getObject($bucket, $uri); + + $result = static::areStringsEqual($sourceData, $downloadedData); + } + + // Should I delete the remotely stored file? + if (static::$deleteRemote) + { + // Delete the remote file. Throws exception if it fails. + $s3->deleteObject($bucket, $uri); + } + + return $result; + } +} \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/SmallInlineFilesNoDelete.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/SmallInlineFilesNoDelete.php new file mode 100644 index 0000000000..f17f84d9c8 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/SmallInlineFilesNoDelete.php @@ -0,0 +1,28 @@ +<?php +/** + * Akeeba Engine + * + * @package akeebaengine + * @copyright Copyright (c)2006-2024 Nicholas K. Dionysopoulos / Akeeba Ltd + * @license GNU General Public License version 3, or later + */ + +namespace Akeeba\MiniTest\Test; + + +use Akeeba\S3\Connector; + +/** + * Upload and download small files (under 1MB) using a string source + * + * @package Akeeba\MiniTest\Test + */ +class SmallInlineFilesNoDelete extends SmallInlineFiles +{ + public static function setup(Connector $s3, array $options): void + { + static:: $deleteRemote = false; + + parent::setup($s3, $options); + } +} \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/SmallInlineFilesOnlyUpload.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/SmallInlineFilesOnlyUpload.php new file mode 100644 index 0000000000..3d9202e74c --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/SmallInlineFilesOnlyUpload.php @@ -0,0 +1,30 @@ +<?php +/** + * Akeeba Engine + * + * @package akeebaengine + * @copyright Copyright (c)2006-2024 Nicholas K. Dionysopoulos / Akeeba Ltd + * @license GNU General Public License version 3, or later + */ + +namespace Akeeba\MiniTest\Test; + + +use Akeeba\S3\Connector; + +/** + * Upload small files (under 1MB) using a string source + * + * @package Akeeba\MiniTest\Test + */ +class SmallInlineFilesOnlyUpload extends SmallInlineFiles +{ + public static function setup(Connector $s3, array $options): void + { + static::$deleteRemote = false; + static::$downloadAfter = false; + + parent::setup($s3, $options); + } + +} \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/SmallInlineXMLFiles.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/SmallInlineXMLFiles.php new file mode 100644 index 0000000000..57975284d3 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/SmallInlineXMLFiles.php @@ -0,0 +1,131 @@ +<?php +/** + * Akeeba Engine + * + * @package akeebaengine + * @copyright Copyright (c)2006-2024 Nicholas K. Dionysopoulos / Akeeba Ltd + * @license GNU General Public License version 3, or later + */ + +namespace Akeeba\MiniTest\Test; + + +use Akeeba\S3\Connector; +use Akeeba\S3\Input; + +/** + * Upload, download and delete small XML files (under 1MB) using a string source + * + * @package Akeeba\MiniTest\Test + */ +class SmallInlineXMLFiles extends SmallFiles +{ + public static function upload10KbRoot(Connector $s3, array $options): bool + { + return static::upload($s3, $options, AbstractTest::TEN_KB, 'root_10kb.xml'); + } + + public static function upload10KbRootGreek(Connector $s3, array $options): bool + { + return static::upload($s3, $options, AbstractTest::TEN_KB, 'δοκιμή_10kb.xml'); + } + + public static function upload10KbFolderGreek(Connector $s3, array $options): bool + { + return static::upload($s3, $options, AbstractTest::TEN_KB, 'ο_φάκελός_μου/δοκιμή_10kb.xml'); + } + + public static function upload600KbRoot(Connector $s3, array $options): bool + { + return static::upload($s3, $options, AbstractTest::SIX_HUNDRED_KB, 'root_600kb.xml'); + } + + public static function upload10KbFolder(Connector $s3, array $options): bool + { + return static::upload($s3, $options, AbstractTest::TEN_KB, 'my_folder/10kb.xml'); + } + + public static function upload600KbFolder(Connector $s3, array $options): bool + { + return static::upload($s3, $options, AbstractTest::SIX_HUNDRED_KB, 'my_folder/600kb.xml'); + } + + protected static function upload(Connector $s3, array $options, int $size, string $uri): bool + { + // Randomize the name. Required for archive buckets where you cannot overwrite data. + $dotPos = strrpos($uri, '.'); + $uri = substr($uri, 0, $dotPos) . '.' . hash('md5', microtime(false)) . substr($uri, $dotPos); + + // Create some random data to upload + $sourceData = static::createXMLFile($size); + + // Upload the data. Throws exception if it fails. + $bucket = $options['bucket']; + $input = Input::createFromData($sourceData); + + $s3->putObject($input, $bucket, $uri); + + // Tentatively accept that this method succeeded. + $result = true; + + // Should I download the file and compare its contents with my random data? + if (static::$downloadAfter) + { + $downloadedData = $s3->getObject($bucket, $uri); + + $result = static::areStringsEqual($sourceData, $downloadedData); + } + + // Should I delete the remotely stored file? + if (static::$deleteRemote) + { + // Delete the remote file. Throws exception if it fails. + $s3->deleteObject($bucket, $uri); + } + + return $result; + } + + private static function createXMLFile(int $size): string + { + $out = <<< XML +<?xml version="1.0" encoding="utf-8" ?> +<root> +XML; + + $chunks = floor(($size - 55) / 1024); + + for ($i = 1; $i <= $chunks; $i++) + { + $randomBlock = static::genRandomData(1024 - 63); + $out .= <<< XML + <element> + <id>$i</id> + <data><![CDATA[$randomBlock]]></data> + </element> +XML; + + } + + + $out .= <<< XML +</root> +XML; + + return $out; + } + + private static function genRandomData(int $length): string + { + $chars = 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ01234567890'; + $maxLength = strlen($chars) - 1; + $salt = ''; + + for ($i = 0; $i < $length; $i++) + { + $salt .= substr($chars, random_int(0, $maxLength), 1); + } + + return $salt; + } +} \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/StorageClasses.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/StorageClasses.php new file mode 100644 index 0000000000..275967a90e --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/Test/StorageClasses.php @@ -0,0 +1,74 @@ +<?php +/** + * Akeeba Engine + * + * @package akeebaengine + * @copyright Copyright (c)2006-2024 Nicholas K. Dionysopoulos / Akeeba Ltd + * @license GNU General Public License version 3, or later + */ + +namespace Akeeba\MiniTest\Test; + + +use Akeeba\S3\Acl; +use Akeeba\S3\Connector; +use Akeeba\S3\Input; +use Akeeba\S3\StorageClass; + +class StorageClasses extends AbstractTest +{ + protected static $downloadAfter = true; + + protected static $deleteRemote = true; + + public static function uploadRRS(Connector $s3, array $options): bool + { + return static::upload($s3, $options, static::TEN_KB, 'rrs_test_10kb.dat', StorageClass::REDUCED_REDUNDANCY); + } + + public static function uploadIntelligentTiering(Connector $s3, array $options): bool + { + return static::upload($s3, $options, static::TEN_KB, 'rrs_test_10kb.dat', StorageClass::INTELLIGENT_TIERING); + } + + protected static function upload(Connector $s3, array $options, int $size, string $uri, string $storageClass = null) + { + // Randomize the name. Required for archive buckets where you cannot overwrite data. + $dotPos = strrpos($uri, '.'); + $uri = substr($uri, 0, $dotPos) . '.' . hash('md5', microtime(false)) . substr($uri, $dotPos); + + // Create some random data to upload + $sourceData = static::getRandomData($size); + + // Upload the data. Throws exception if it fails. + $bucket = $options['bucket']; + $input = Input::createFromData($sourceData); + + // Get the headers + $headers = []; + StorageClass::setStorageClass($headers, $storageClass); + + $s3->putObject($input, $bucket, $uri, Acl::ACL_PRIVATE, $headers); + + // Tentatively accept that this method succeeded. + $result = true; + + // Should I download the file and compare its contents with my random data? + if (static::$downloadAfter) + { + $downloadedData = $s3->getObject($bucket, $uri); + + $result = static::areStringsEqual($sourceData, $downloadedData); + } + + // Should I delete the remotely stored file? + if (static::$deleteRemote) + { + // Delete the remote file. Throws exception if it fails. + $s3->deleteObject($bucket, $uri); + } + + return $result; + } + +} \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/config.dist.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/config.dist.php new file mode 100644 index 0000000000..f67e521e06 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/config.dist.php @@ -0,0 +1,303 @@ +<?php +/** + * Akeeba Engine + * + * @package akeebaengine + * @copyright Copyright (c)2006-2024 Nicholas K. Dionysopoulos / Akeeba Ltd + * @license GNU General Public License version 3, or later + */ + +// Create the 2100 test files in the bucket? +define('CREATE_2100_FILES', true); + +/** + * Configure the connection options for S3 and S3-compatible services here. Use them in the $testConfigurations array. + */ +$serviceConfigurations = [ + 's3-v4' => [ + 'access' => 'AK0123456789BCDEFGHI', + 'secret' => 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX', + 'region' => 'eu-west-1', + 'bucket' => 'mybucket', + 'signature' => 'v4', + 'dualstack' => false, + 'path_access' => false, + 'ssl' => false, + 'endpoint' => null, + ], + 's3-v2' => [ + 'access' => 'AK0123456789BCDEFGHI', + 'secret' => 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX', + 'region' => 'eu-west-1', + 'bucket' => 'mybucket', + 'signature' => 'v2', + 'dualstack' => false, + 'path_access' => false, + 'ssl' => false, + 'endpoint' => null, + ], + 'localstack-v4' => [ + 'access' => 'KYLOREN', + 'secret' => 'BenSolo', + 'region' => 'us-east-1', + 'bucket' => 'test', + 'signature' => 'v4', + 'dualstack' => false, + 'path_access' => true, + 'ssl' => false, + 'endpoint' => 'localhost.localstack.cloud:4566', + ], + 'localstack-v2' => [ + 'access' => 'KYLOREN', + 'secret' => 'BenSolo', + 'region' => 'us-east-1', + 'bucket' => 'test', + 'signature' => 'v2', + 'dualstack' => false, + 'path_access' => true, + 'ssl' => false, + 'endpoint' => 'localhost.localstack.cloud:4566', + ], +]; + +/** + * Test EVERYTHING. + */ +$allTheTests = [ + 'BucketsList', + 'BucketLocation', + 'HeadObject', + 'ListFiles', + 'SmallFiles', + 'SmallInlineFiles', + 'SmallFilesNoDelete', + 'SmallFilesOnlyUpload', + 'SmallInlineFilesNoDelete', + 'SmallInlineFilesOnlyUpload', + 'SmallInlineXMLFiles', + 'BigFiles', + 'Multipart', + 'StorageClasses', + 'SignedURLs', +]; + +if (CREATE_2100_FILES) +{ + $allTheTests[] = 'ListThousandsOfFiles'; +} + +/** + * Tests for standard key pairs allowing us to read, write and delete + * + * This is the main test suite + */ +$standardTests = [ + 'BucketsList', + 'BucketLocation', + 'HeadObject', + 'ListFiles', + 'SmallFiles', + 'SmallInlineFiles', + 'SmallInlineXMLFiles', + 'BigFiles', + 'Multipart', + 'StorageClasses', + 'SignedURLs', +]; + +/** + * Tests for key pairs or buckets which do NOT allow us to delete, but DO allow us to write and read data + * + * Example: archival buckets + */ +$noDeleteTests = [ + 'SmallFilesNoDelete', + 'SmallInlineFilesNoDelete', +]; + +/** + * Tests for key pairs which do NOT allow us to read, but DO allow us to write/delete + * + * Example: write-only key pairs per my documentation information from 2011 :) + */ +$writeOnlyTests = [ + 'SmallFilesOnlyUpload', + 'SmallInlineFilesOnlyUpload', +]; + +/** + * These are the individual test configurations. + * + * Each configuration consists of two keys: + * + * * **configuration** Overrides to the default configuration. + * * **tests** The names of the test classes to execute. Use the format ['classname', 'method'] to execute + * specific test methods only. + */ +$testConfigurations = [ +// Format of each +// 'Description of this configuration' => array( +// 'configuration' => array( +// // You can skip one or more keys. The defaults will be used. +// 'access' => 'a different access key', +// 'secret' => 'a different secret key', +// 'region' => 'eu-west-1', +// 'bucket' => 'different_example', +// 'signature' => 'v2', +// 'dualstack' => true, +// 'path_access' => true, +// 'ssl' => true, +// // Only if you want to use a custom, non-Amazon endpoint +// 'endpoint' => null, +// ), +// 'tests' => array( +// // Use a start to run all tests +// '*', +// // Alternatively you can define single test classes: +// 'SmallFiles', +// // ..or specific tests: +// array('SmallFiles', 'upload10KbRoot'), +// ) +// ), + /**/ + + /** + * These are the standard tests we run for each region and key pair. + * + * For all available regions please consult https://docs.aws.amazon.com/general/latest/gr/s3.html + * + * It is recommended to run against the following regions: + * - eu-east-1 The original Amazon S3 region, it often has special meaning in APIs. + * - eu-west-1 Ireland. The original EU region for S3, as a test for the non-default region. + * - eu-central-1 Frankfurt. This region –like all newer regions– only allows v4 signatures! + * - cn-north-1 Beijing, China. Requires running it from inside China. + * - NON-AMAZON A custom endpoint for a third party, S3-compatible API. Ideally one for v2 and one for v4. + * + * Further to that test the following: + * - Write-only, bucket-restricted keys + * - Read/write, bucket-restricted keys + * - Buckets with dots + * - Buckets with uppercase letters + * - Buckets with international letters + * - Access from within EC2 + */ + + // Amazon S3, v2 signatures + 'S3, v2, subdomain, single stack' => [ + 'configuration' => array_merge( + $serviceConfigurations['s3-v2'], + [ + 'dualstack' => false, + 'path_access' => false, + ] + ), + 'tests' => $standardTests, + 'skip' => false, + ], + 'S3, v2, subdomain, dual stack' => [ + 'configuration' => array_merge( + $serviceConfigurations['s3-v2'], + [ + 'dualstack' => true, + 'path_access' => false, + ] + ), + 'tests' => $standardTests, + 'skip' => false, + ], + 'S3, v2, path, single stack' => [ + 'configuration' => array_merge( + $serviceConfigurations['s3-v2'], + [ + 'dualstack' => false, + 'path_access' => true, + ] + ), + 'tests' => $standardTests, + 'skip' => false, + ], + 'S3, v2, path, dual stack' => [ + 'configuration' => array_merge( + $serviceConfigurations['s3-v2'], + [ + 'dualstack' => true, + 'path_access' => true, + ] + ), + 'tests' => $standardTests, + 'skip' => false, + ], + + // Amazon S3, v4 signatures + 'S3, v4, subdomain, single stack' => [ + 'configuration' => array_merge( + $serviceConfigurations['s3-v4'], + [ + 'dualstack' => false, + 'path_access' => false, + ] + ), + 'tests' => $standardTests, + 'skip' => false, + ], + 'S3, v4, subdomain, dual stack' => [ + 'configuration' => array_merge( + $serviceConfigurations['s3-v4'], + [ + 'dualstack' => true, + 'path_access' => false, + ] + ), + 'tests' => $standardTests, + 'skip' => false, + ], + 'S3, v4, path, single stack' => [ + 'configuration' => array_merge( + $serviceConfigurations['s3-v4'], + [ + 'dualstack' => false, + 'path_access' => true, + ] + ), + 'tests' => $standardTests, + 'skip' => false, + ], + 'S3, v4, path, dual stack' => [ + 'configuration' => array_merge( + $serviceConfigurations['s3-v4'], + [ + 'dualstack' => true, + 'path_access' => true, + ] + ), + 'tests' => $standardTests, + 'skip' => false, + ], + + // LocalStack + 'LocalStack, V2 (always path access, single stack)' => [ + 'configuration' => $serviceConfigurations['localstack-v2'], + 'tests' => $allTheTests, + 'skip' => false, + ], + + 'LocalStack, V4 (always path access, single stack)' => [ + 'configuration' => $serviceConfigurations['localstack-v4'], + 'tests' => $allTheTests, + 'skip' => false, + ], + + /** + * In the real config file we also have tests running on: + * + * - Wasabi, v2, path-style access. + * - Wasabi, v4, path-style access. + * - Synology C2, subdomain access. + * + * See [[NOTES.md]] for more information. If you have another environment you think we should test with please + * update NOTES.md and make a pull request, along with the reasoning behind it. + * + * There are known failures for some cases, notably LocalStack v4 (something is amiss?) and C2 (necessary flag is + * not yet supported by the minitest framework). + */ +]; \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/minitest.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/minitest.php new file mode 100644 index 0000000000..d465b5d37e --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/minitest/minitest.php @@ -0,0 +1,456 @@ +<?php +/** + * Akeeba Engine + * + * @package akeebaengine + * @copyright Copyright (c)2006-2024 Nicholas K. Dionysopoulos / Akeeba Ltd + * @license GNU General Public License version 3, or later + */ + +use Akeeba\S3\Configuration; +use Akeeba\S3\Connector; + +/** + * The Miniature Test Framework For The Akeeba S3 Library + * + * This is a self-contained test-suite runner. Running minitest.php will execute all the tests against all + * configurations set up in the config.php file. When it's decked out with all real world examples this can take many + * hours to complete (it's not as "mini" as its name would like you to believe). + * + * Please read NOTES.md before proceeding and do keep in mind that some tests may fail for reasons outside the control + * of the library such as network conditions, whether PHP has a configured Certification Authority cache etc. + * + * As to why we didn't use Unit Tests: Elementary, dear Watson. Unit Tests are great when testing your code against a + * specification. In this case, the specification would be the Amazon S3 API documentation. Sounds great in theory, but + * not even Amazon itself works according to its own documentation, let alone the third party "S3-compatible" services + * which each one implements its own interpretation of that documentation. Therefore, slow-as-heck integration testing + * is the only way to do any kind of meaningful testing. + */ + +// Necessary for including the library +define('AKEEBAENGINE', 1); + +if (!file_exists(__DIR__ . '/../vendor/autoload.php')) +{ + die ('Please run composer install before running the mini test suite.'); +} + +// Use Composer's autoloader to load the library +/** @var \Composer\Autoload\ClassLoader $autoloader */ +$autoloader = require_once(__DIR__ . '/../vendor/autoload.php'); + +// Add the minitest PSR-4 path map to Composer's autoloader +$autoloader->addPsr4('Akeeba\\MiniTest\\', __DIR__); + +function getAllTestClasses(): array +{ + static $testClasses = []; + + if (!empty($testClasses)) + { + return $testClasses; + } + + $folder = __DIR__ . '/Test'; + $di = new DirectoryIterator($folder); + + foreach ($di as $entry) + { + if ($entry->isDot() || !$entry->isFile()) + { + continue; + } + + $baseName = $entry->getBasename('.php'); + $className = '\\Akeeba\\MiniTest\\Test\\' . $baseName; + + if (!class_exists($className)) + { + continue; + } + + $reflectedClass = new ReflectionClass($className); + + if ($reflectedClass->isAbstract()) + { + continue; + } + + $testClasses[] = $className; + } + + return $testClasses; +} + +function getTestMethods(string $className): array +{ + static $classMethodMap = []; + + if (isset($classMethodMap[$className])) + { + return $classMethodMap[$className]; + } + + $classMethodMap[$className] = []; + + if (!class_exists($className)) + { + return $classMethodMap[$className]; + } + + $reflectedClass = new ReflectionClass($className); + $methods = $reflectedClass->getMethods(ReflectionMethod::IS_PUBLIC | ReflectionMethod::IS_STATIC); + + $classMethodMap[$className] = array_map( + function (ReflectionMethod $refMethod) { + if ($refMethod->isPrivate() || $refMethod->isProtected() || $refMethod->isAbstract()) + { + return null; + } + + if (!$refMethod->isStatic()) + { + return null; + } + + return $refMethod->getName(); + }, $methods + ); + + $classMethodMap[$className] = array_filter( + $classMethodMap[$className], function ($method) { + if (is_null($method)) + { + return false; + } + + if (in_array($method, ['setup', 'teardown'])) + { + return false; + } + + return true; + } + ); + + return $classMethodMap[$className]; +} + +function simplifyClassName(?string $className): string +{ + if (empty($className)) + { + return ''; + } + + $namespace = __NAMESPACE__ . '\\Test\\'; + + if (strpos($className, $namespace) === 0) + { + return substr($className, strlen($namespace)); + } + + return $className; +} + +if (!file_exists(__DIR__ . '/config.php')) +{ + die ('Please rename config.dist.php to config.php and customise it before running the mini test suite.'); +} + +require __DIR__ . '/config.php'; + +global $testConfigurations; + +$total = 0; +$broken = 0; +$failed = 0; +$successful = 0; + +foreach ($testConfigurations as $description => $setup) +{ + echo "▶ " . $description . PHP_EOL; + echo str_repeat('〰', 80) . PHP_EOL . PHP_EOL; + + if ($setup['skip'] ?? false) + { + echo "\t🤡 Skipping\n\n"; + + continue; + } + + // Extract the configuration options + if (!isset($setup['configuration'])) + { + $setup['configuration'] = []; + } + + $configOptions = array_merge( + [ + 'access' => defined('DEFAULT_ACCESS_KEY') ? DEFAULT_ACCESS_KEY : null, + 'secret' => defined('DEFAULT_SECRET_KEY') ? DEFAULT_SECRET_KEY : null, + 'region' => defined('DEFAULT_REGION') ? DEFAULT_REGION : null, + 'bucket' => defined('DEFAULT_BUCKET') ? DEFAULT_BUCKET : null, + 'signature' => defined('DEFAULT_SIGNATURE') ? DEFAULT_SIGNATURE : null, + 'dualstack' => defined('DEFAULT_DUALSTACK') ? DEFAULT_DUALSTACK : null, + 'path_access' => defined('DEFAULT_PATH_ACCESS') ? DEFAULT_PATH_ACCESS : null, + 'ssl' => defined('DEFAULT_SSL') ? DEFAULT_SSL : null, + 'endpoint' => defined('DEFAULT_ENDPOINT') ? constant('DEFAULT_ENDPOINT') : null, + 'alternateDateHeaderFormat' => defined('DEFAULT_ALTERNATE_DATE_FORMAT') ? constant( + 'DEFAULT_ALTERNATE_DATE_FORMAT' + ) : false, + 'useHTTPDateHeader' => defined('DEFAULT_USE_HTTP_HEADER') ? constant('DEFAULT_USE_HTTP_HEADER') + : false, + ], $setup['configuration'] + ); + + // Extract the test classes/methods to run + if (!isset($setup['tests'])) + { + $setup['tests'] = getAllTestClasses(); + } + + $tests = $setup['tests']; + + if (!is_array($tests) || (is_array($tests) && in_array('*', $tests))) + { + $tests = getAllTestClasses(); + } + + // Create the S3 configuration object + $s3Configuration = new Configuration( + $configOptions['access'], $configOptions['secret'], $configOptions['signature'], $configOptions['region'] + ); + $s3Configuration->setRegion($configOptions['region']); + $s3Configuration->setSignatureMethod($configOptions['signature']); + + if (!is_null($configOptions['endpoint'])) + { + $s3Configuration->setEndpoint($configOptions['endpoint']); + // We need to redo this because setting the endpoint may reset these options + $s3Configuration->setRegion($configOptions['region']); + $s3Configuration->setSignatureMethod($configOptions['signature']); + } + + $s3Configuration->setUseDualstackUrl($configOptions['dualstack']); + $s3Configuration->setUseLegacyPathStyle($configOptions['path_access']); + $s3Configuration->setSSL($configOptions['ssl']); + + // Feature flags + if (isset($configOptions['alternateDateHeaderFormat'])) + { + $s3Configuration->setAlternateDateHeaderFormat((bool) $configOptions['alternateDateHeaderFormat']); + } + + if (isset($configOptions['useHTTPDateHeader'])) + { + $s3Configuration->setUseHTTPDateHeader((bool) $configOptions['useHTTPDateHeader']); + } + + if (isset($configOptions['preSignedBucketInURL'])) + { + $s3Configuration->setPreSignedBucketInURL((bool) $configOptions['preSignedBucketInURL']); + } + + // Create the connector object + $s3Connector = new Connector($s3Configuration); + + // Run the tests + foreach ($tests as $testInfo) + { + if (!is_array($testInfo)) + { + $className = $testInfo; + + if (!class_exists($className)) + { + $className = '\\Akeeba\\MiniTest\\Test\\' . $className; + } + + if (!class_exists($className)) + { + $total++; + $broken++; + echo " ⁉️ Test class {$className} not found." . PHP_EOL; + + continue; + } + + $testInfo = array_map( + function ($method) use ($className) { + return [$className, $method]; + }, getTestMethods($className) + ); + } + else + { + [$className, $method] = $testInfo; + + if (!class_exists($className)) + { + $className = '\\Akeeba\\MiniTest\\Test\\' . $className; + } + + if (!class_exists($className)) + { + $total++; + $broken++; + echo " ⁉️ Test class {$className} not found." . PHP_EOL; + + continue; + } + + $testInfo = [ + [$className, $method], + ]; + } + + $firstOne = false; + $className = null; + $callableSetup = null; + $callableTeardown = null; + $simplifiedClassname = simplifyClassName($className); + + if (!empty($testInfo)) + { + $firstOne = array_shift($testInfo); + array_unshift($testInfo, $firstOne); + } + + if ($firstOne) + { + [$className,] = $firstOne; + + if ($className) + { + $callableSetup = [$className, 'setup']; + $callableTeardown = [$className, 'teardown']; + } + } + + if (is_callable($callableSetup)) + { + [$classNameSetup, $method] = $callableSetup; + $simplifiedClassname = simplifyClassName($classNameSetup); + echo " ⏱ Preparing {$simplifiedClassname}:{$method}…"; + call_user_func($callableSetup, $s3Connector, $configOptions); + echo "\r Prepared {$simplifiedClassname} " . PHP_EOL; + } + + foreach ($testInfo as $callable) + { + $total++; + [$className, $method] = $callable; + + if (!class_exists($className)) + { + $broken++; + echo " ⁉️ Test class {$className} not found." . PHP_EOL; + + continue; + } + + if (!method_exists($className, $method)) + { + $broken++; + echo " ⁉️ Method {$method} not found in test class {$className}." . PHP_EOL; + + continue; + } + + echo " ⏱ {$simplifiedClassname}:{$method}…"; + $errorException = null; + + try + { + $result = call_user_func([$className, $method], $s3Connector, $configOptions); + } + catch (Exception $e) + { + $result = false; + $errorException = $e; + } + + echo "\r " . ($result ? '✔' : '🚨') . " {$simplifiedClassname}:{$method} " . PHP_EOL; + + if ($result) + { + $successful++; + continue; + } + + $failed++; + + if (is_null($errorException)) + { + echo " Returned false" . PHP_EOL; + + continue; + } + + echo " {$errorException->getCode()} – {$errorException->getMessage()}" . PHP_EOL; + echo " {$errorException->getFile()}({$errorException->getLine()})" . PHP_EOL . PHP_EOL; + + $errorLines = explode("\n", $errorException->getTraceAsString()); + + foreach ($errorLines as $line) + { + echo " $line" . PHP_EOL; + } + } + + if (is_callable($callableTeardown)) + { + [$className, $method] = $callableSetup; + echo " ⏱ Tearing down {$className}:{$method}…"; + call_user_func($callableTeardown, $s3Connector, $configOptions); + echo "\r Tore down {$className} " . PHP_EOL; + } + } + + echo PHP_EOL; +} + +echo PHP_EOL; +echo str_repeat('⎺', 80) . PHP_EOL; +echo PHP_EOL; + +echo "Summary:" . PHP_EOL; +if ($broken) +{ + echo " Broken : $broken" . PHP_EOL; +} +if ($failed) +{ + echo " Failed : $failed" . PHP_EOL; +} +if ($successful) +{ + echo " Successful : $successful" . PHP_EOL; +} +echo " Total : $total" . PHP_EOL . PHP_EOL; + +echo "Conclusion: " . PHP_EOL . " "; + +if ($failed > 0) +{ + echo "❌ FAILED 😭😭😭" . PHP_EOL; + + exit(1); +} + +if ($successful === 0) +{ + echo "🔥 No tests executed! 🤪" . PHP_EOL; + + exit (3); +} + +if ($broken > 0) +{ + echo "⁉️ SUCCESS but some tests are broken 🤦" . PHP_EOL; + + exit (2); +} + +echo "✅ PASSED" . PHP_EOL; \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Acl.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Acl.php new file mode 100644 index 0000000000..178932a69d --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Acl.php @@ -0,0 +1,31 @@ +<?php +/** + * Akeeba Engine + * + * @package akeebaengine + * @copyright Copyright (c)2006-2024 Nicholas K. Dionysopoulos / Akeeba Ltd + * @license GNU General Public License version 3, or later + */ + +namespace Akeeba\S3; + +// Protection against direct access +defined('AKEEBAENGINE') || die(); + +/** + * Shortcuts to often used access control privileges + */ +class Acl +{ + public const ACL_PRIVATE = 'private'; + + public const ACL_PUBLIC_READ = 'public-read'; + + public const ACL_PUBLIC_READ_WRITE = 'public-read-write'; + + public const ACL_AUTHENTICATED_READ = 'authenticated-read'; + + public const ACL_BUCKET_OWNER_READ = 'bucket-owner-read'; + + public const ACL_BUCKET_OWNER_FULL_CONTROL = 'bucket-owner-full-control'; +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Configuration.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Configuration.php new file mode 100644 index 0000000000..9128ae50c1 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Configuration.php @@ -0,0 +1,447 @@ +<?php +/** + * Akeeba Engine + * + * @package akeebaengine + * @copyright Copyright (c)2006-2024 Nicholas K. Dionysopoulos / Akeeba Ltd + * @license GNU General Public License version 3, or later + */ + +namespace Akeeba\S3; + +// Protection against direct access +defined('AKEEBAENGINE') || die(); + +/** + * Holds the Amazon S3 confiugration credentials + */ +class Configuration +{ + /** + * Access Key + * + * @var string + */ + protected $access = ''; + + /** + * Secret Key + * + * @var string + */ + protected $secret = ''; + + /** + * Security token. This is only required with temporary credentials provisioned by an EC2 instance. + * + * @var string + */ + protected $token = ''; + + /** + * Signature calculation method ('v2' or 'v4') + * + * @var string + */ + protected $signatureMethod = 'v2'; + + /** + * AWS region, used for v4 signatures + * + * @var string + */ + protected $region = 'us-east-1'; + + /** + * Should I use SSL (HTTPS) to communicate to Amazon S3? + * + * @var bool + */ + protected $useSSL = true; + + /** + * Should I use SSL (HTTPS) to communicate to Amazon S3? + * + * @var bool + */ + protected $useDualstackUrl = false; + + /** + * Should I use legacy, path-style access to the bucket? When it's turned off (default) we use virtual hosting style + * paths which are RECOMMENDED BY AMAZON per http://docs.aws.amazon.com/AmazonS3/latest/API/APIRest.html + * + * @var bool + */ + protected $useLegacyPathStyle = false; + + /** + * Amazon S3 endpoint. You can use a custom endpoint with v2 signatures to access third party services which offer + * S3 compatibility, e.g. OwnCloud, Google Storage etc. + * + * @var string + */ + protected $endpoint = 's3.amazonaws.com'; + + /** + * Should I use an alternative date header format (D, d M Y H:i:s T instead of D, d M Y H:i:s O) for non-Amazon, + * S3-compatible services? + * + * This is enabled by default. + * + * @var bool + */ + protected $alternateDateHeaderFormat = true; + + /** + * Should I use the standard HTTP Date header instead of the X-Amz-Date header? + * + * @var bool + */ + protected $useHTTPDateHeader = false; + + /** + * Should pre-signed URLs include the bucket name in the URL? Only applies to v4 signatures. + * + * Amazon S3 and most implementations need this turned off (default). LocalStack seems to not work properly with the + * bucket name as a subdomain, hence the need for this flag. + * + * @var bool + */ + protected $preSignedBucketInURL = false; + + /** + * Public constructor + * + * @param string $access Amazon S3 Access Key + * @param string $secret Amazon S3 Secret Key + * @param string $signatureMethod Signature method (v2 or v4) + * @param string $region Region, only required for v4 signatures + */ + function __construct(string $access, string $secret, string $signatureMethod = 'v2', string $region = '') + { + $this->setAccess($access); + $this->setSecret($secret); + $this->setSignatureMethod($signatureMethod); + $this->setRegion($region); + } + + /** + * Get the Amazon access key + * + * @return string + */ + public function getAccess(): string + { + return $this->access; + } + + /** + * Set the Amazon access key + * + * @param string $access The access key to set + * + * @throws Exception\InvalidAccessKey + */ + public function setAccess(string $access): void + { + if (empty($access)) + { + throw new Exception\InvalidAccessKey; + } + + $this->access = $access; + } + + /** + * Get the Amazon secret key + * + * @return string + */ + public function getSecret(): string + { + return $this->secret; + } + + /** + * Set the Amazon secret key + * + * @param string $secret The secret key to set + * + * @throws Exception\InvalidSecretKey + */ + public function setSecret(string $secret): void + { + if (empty($secret)) + { + throw new Exception\InvalidSecretKey; + } + + $this->secret = $secret; + } + + /** + * Return the security token. Only for temporary credentials provisioned through an EC2 instance. + * + * @return string + */ + public function getToken(): string + { + return $this->token; + } + + /** + * Set the security token. Only for temporary credentials provisioned through an EC2 instance. + * + * @param string $token + */ + public function setToken(string $token): void + { + $this->token = $token; + } + + /** + * Get the signature method to use + * + * @return string + */ + public function getSignatureMethod(): string + { + return $this->signatureMethod; + } + + /** + * Set the signature method to use + * + * @param string $signatureMethod One of v2 or v4 + * + * @throws Exception\InvalidSignatureMethod + */ + public function setSignatureMethod(string $signatureMethod): void + { + $signatureMethod = strtolower($signatureMethod); + $signatureMethod = trim($signatureMethod); + + if (!in_array($signatureMethod, ['v2', 'v4'])) + { + throw new Exception\InvalidSignatureMethod; + } + + $this->signatureMethod = $signatureMethod; + + // If you switch to v2 signatures we unset the region. + if ($signatureMethod == 'v2') + { + $this->setRegion(''); + + /** + * If we are using Amazon S3 proper (not a custom endpoint) we have to set path style access to false. + * Amazon S3 does not support v2 signatures with path style access at all (it returns an error telling + * us to use the virtual hosting endpoint BUCKETNAME.s3.amazonaws.com). + */ + if (strpos($this->endpoint, 'amazonaws.com') !== false) + { + $this->setUseLegacyPathStyle(false); + } + + } + } + + /** + * Get the Amazon S3 region + * + * @return string + */ + public function getRegion(): string + { + return $this->region; + } + + /** + * Set the Amazon S3 region + * + * @param string $region + */ + public function setRegion(string $region): void + { + /** + * You can only leave the region empty if you're using v2 signatures. Anything else gets you an exception. + */ + if (empty($region) && ($this->signatureMethod == 'v4')) + { + throw new Exception\InvalidRegion; + } + + /** + * Setting a Chinese-looking region force-changes the endpoint but ONLY if you were using the original Amazon S3 + * endpoint. If you're using a custom endpoint and provide a region with 'cn-' in its name we don't override + * your custom endpoint. + */ + if (($this->endpoint == 's3.amazonaws.com') && (substr($region, 0, 3) == 'cn-')) + { + $this->setEndpoint('amazonaws.com.cn'); + } + + $this->region = $region; + } + + /** + * Is the connection to be made over HTTPS? + * + * @return bool + */ + public function isSSL(): bool + { + return $this->useSSL; + } + + /** + * Set the connection SSL preference + * + * @param bool $useSSL True to use HTTPS + */ + public function setSSL(bool $useSSL): void + { + $this->useSSL = $useSSL ? true : false; + } + + /** + * Get the Amazon S3 endpoint + * + * @return string + */ + public function getEndpoint(): string + { + return $this->endpoint; + } + + /** + * Set the Amazon S3 endpoint. Do NOT use a protocol + * + * @param string $endpoint Custom endpoint, e.g. 's3.example.com' or 'www.example.com/s3api' + */ + public function setEndpoint(string $endpoint): void + { + if (stristr($endpoint, '://')) + { + throw new Exception\InvalidEndpoint; + } + + /** + * If you set a custom endpoint we have to switch to v2 signatures since our v4 implementation only supports + * Amazon endpoints. + */ + if ((strpos($endpoint, 'amazonaws.com') === false)) + { + $this->setSignatureMethod('v2'); + } + + $this->endpoint = $endpoint; + } + + /** + * Should I use legacy, path-style access to the bucket? You should only use it with custom endpoints. Amazon itself + * is currently deprecating support for path-style access but has extended the migration date to an unknown + * time https://aws.amazon.com/blogs/aws/amazon-s3-path-deprecation-plan-the-rest-of-the-story/ + * + * @return bool + */ + public function getUseLegacyPathStyle(): bool + { + return $this->useLegacyPathStyle; + } + + /** + * Set the flag for using legacy, path-style access to the bucket + * + * @param bool $useLegacyPathStyle + */ + public function setUseLegacyPathStyle(bool $useLegacyPathStyle): void + { + $this->useLegacyPathStyle = $useLegacyPathStyle; + + /** + * If we are using Amazon S3 proper (not a custom endpoint) we have to set path style access to false. + * Amazon S3 does not support v2 signatures with path style access at all (it returns an error telling + * us to use the virtual hosting endpoint BUCKETNAME.s3.amazonaws.com). + */ + if ((strpos($this->endpoint, 'amazonaws.com') !== false) && ($this->signatureMethod == 'v2')) + { + $this->useLegacyPathStyle = false; + } + } + + /** + * Should we use the dualstack URL (which will ship traffic over ipv6 in most cases). For more information on these + * endpoints please read https://docs.aws.amazon.com/AmazonS3/latest/dev/dual-stack-endpoints.html + * + * @return bool + */ + public function getDualstackUrl(): bool + { + return $this->useDualstackUrl; + } + + /** + * Set the flag for using legacy, path-style access to the bucket + * + * @param bool $useDualstackUrl + */ + public function setUseDualstackUrl(bool $useDualstackUrl): void + { + $this->useDualstackUrl = $useDualstackUrl; + } + + /** + * Get the flag for using an alternate date format for non-Amazon, S3-compatible services. + * + * @return bool + */ + public function getAlternateDateHeaderFormat(): bool + { + return $this->alternateDateHeaderFormat; + } + + /** + * Set the flag for using an alternate date format for non-Amazon, S3-compatible services. + * + * @param bool $alternateDateHeaderFormat + * + * @return void + */ + public function setAlternateDateHeaderFormat(bool $alternateDateHeaderFormat): void + { + $this->alternateDateHeaderFormat = $alternateDateHeaderFormat; + } + + /** + * Get the flag indicating whether to use the HTTP Date header + * + * @return bool Flag indicating whether to use the HTTP Date header + */ + public function getUseHTTPDateHeader(): bool + { + return $this->useHTTPDateHeader; + } + + /** + * Set the flag indicating whether to use the HTTP Date header. + * + * @param bool $useHTTPDateHeader Whether to use the HTTP Date header + * + * @return void + */ + public function setUseHTTPDateHeader(bool $useHTTPDateHeader): void + { + $this->useHTTPDateHeader = $useHTTPDateHeader; + } + + public function getPreSignedBucketInURL(): bool + { + return $this->preSignedBucketInURL; + } + + public function setPreSignedBucketInURL(bool $preSignedBucketInURL): void + { + $this->preSignedBucketInURL = $preSignedBucketInURL; + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Connector.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Connector.php new file mode 100644 index 0000000000..e57e710f9a --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Connector.php @@ -0,0 +1,983 @@ +<?php +/** + * Akeeba Engine + * + * @package akeebaengine + * @copyright Copyright (c)2006-2024 Nicholas K. Dionysopoulos / Akeeba Ltd + * @license GNU General Public License version 3, or later + */ + +namespace Akeeba\S3; + +// Protection against direct access +use Akeeba\S3\Exception\CannotDeleteFile; +use Akeeba\S3\Exception\CannotGetBucket; +use Akeeba\S3\Exception\CannotGetFile; +use Akeeba\S3\Exception\CannotListBuckets; +use Akeeba\S3\Exception\CannotOpenFileForWrite; +use Akeeba\S3\Exception\CannotPutFile; +use Akeeba\S3\Response\Error; + +defined('AKEEBAENGINE') || die(); + +class Connector +{ + /** + * Amazon S3 configuration object + * + * @var Configuration + */ + private $configuration = null; + + /** + * Connector constructor. + * + * @param Configuration $configuration The configuration object to use + */ + public function __construct(Configuration $configuration) + { + $this->configuration = $configuration; + } + + /** + * Put an object to Amazon S3, i.e. upload a file. If the object already exists it will be overwritten. + * + * @param Input $input Input object + * @param string $bucket Bucket name. If you're using v4 signatures it MUST be on the region defined. + * @param string $uri Object URI. Think of it as the absolute path of the file in the bucket. + * @param string $acl ACL constant, by default the object is private (visible only to the uploading + * user) + * @param array $requestHeaders Array of request headers + * + * @return void + * + * @throws CannotPutFile If the upload is not possible + */ + public function putObject(Input $input, string $bucket, string $uri, string $acl = Acl::ACL_PRIVATE, array $requestHeaders = []): void + { + $request = new Request('PUT', $bucket, $uri, $this->configuration); + $request->setInput($input); + + // Custom request headers (Content-Type, Content-Disposition, Content-Encoding) + if (count($requestHeaders)) + { + foreach ($requestHeaders as $h => $v) + { + if (strtolower(substr($h, 0, 6)) == 'x-amz-') + { + $request->setAmzHeader(strtolower($h), $v); + } + else + { + $request->setHeader($h, $v); + } + } + } + + if (isset($requestHeaders['Content-Type'])) + { + $input->setType($requestHeaders['Content-Type']); + } + + if (($input->getSize() <= 0) || (($input->getInputType() == Input::INPUT_DATA) && (!strlen($input->getDataReference())))) + { + if (substr($uri, -1) !== '/') + { + throw new CannotPutFile('Missing input parameters', 0); + } + } + + // We need to post with Content-Length and Content-Type, MD5 is optional + $request->setHeader('Content-Type', $input->getType()); + $request->setHeader('Content-Length', $input->getSize()); + + if ($input->getMd5sum()) + { + $request->setHeader('Content-MD5', $input->getMd5sum()); + } + + $request->setAmzHeader('x-amz-acl', $acl); + + $response = $request->getResponse(); + + if ($response->code !== 200) + { + if (!$response->error->isError()) + { + throw new CannotPutFile("Unexpected HTTP status {$response->code}", $response->code); + } + + if (is_object($response->body) && ($response->body instanceof \SimpleXMLElement) && (strpos($input->getSize(), ',') === false)) + { + // For some reason, trying to single part upload files on some hosts comes back with an inexplicable + // error from Amazon that we need to set Content-Length:5242880,5242880 instead of + // Content-Length:5242880 which is AGAINST Amazon's documentation. In this case we pass the header + // 'workaround-braindead-error-from-amazon' and retry. Uh, OK? + if (isset($response->body->CanonicalRequest)) + { + $amazonsCanonicalRequest = (string) $response->body->CanonicalRequest; + $lines = explode("\n", $amazonsCanonicalRequest); + + foreach ($lines as $line) + { + if (substr($line, 0, 15) != 'content-length:') + { + continue; + } + + [$junk, $stupidAmazonDefinedContentLength] = explode(":", $line); + + if (strpos($stupidAmazonDefinedContentLength, ',') !== false) + { + if (!isset($requestHeaders['workaround-braindead-error-from-amazon'])) + { + $requestHeaders['workaround-braindead-error-from-amazon'] = 'you can\'t fix stupid'; + + $this->putObject($input, $bucket, $uri, $acl, $requestHeaders); + + return; + } + } + } + } + } + } + + + if ($response->error->isError()) + { + throw new CannotPutFile( + sprintf(__METHOD__ . "(): [%s] %s\n\nDebug info:\n%s", $response->error->getCode(), $response->error->getMessage(), print_r($response->body, true)) + ); + } + } + + /** + * Get (download) an object + * + * @param string $bucket Bucket name + * @param string $uri Object URI + * @param string|resource|null $saveTo Filename or resource to write to + * @param int|null $from Start of the download range, null to download the entire object + * @param int|null $to End of the download range, null to download the entire object + * + * @return string|null No return if $saveTo is specified; data as string otherwise + * + */ + public function getObject(string $bucket, string $uri, $saveTo = null, ?int $from = null, ?int $to = null): ?string + { + $request = new Request('GET', $bucket, $uri, $this->configuration); + + $fp = null; + + if (!is_resource($saveTo) && is_string($saveTo)) + { + $fp = @fopen($saveTo, 'w'); + + if ($fp === false) + { + throw new CannotOpenFileForWrite($saveTo); + } + } + + if (is_resource($saveTo)) + { + $fp = $saveTo; + } + + if (is_resource($fp)) + { + $request->setFp($fp); + } + + // Set the range header + if ((!empty($from) && !empty($to)) || (!is_null($from) && !empty($to))) + { + $request->setHeader('Range', "bytes=$from-$to"); + } + + $response = $request->getResponse(true); + + if (!$response->error->isError() && (($response->code !== 200) && ($response->code !== 206))) + { + $response->error = new Error( + $response->code, + "Unexpected HTTP status {$response->code}" + ); + } + + if ($response->error->isError()) + { + throw new CannotGetFile( + sprintf( + __METHOD__ . "({%s}, {%s}): [%s] %s\n\nDebug info:\n%s", + $bucket, + $uri, + $response->error->getCode(), + $response->error->getMessage(), + print_r($response->body, true) + ) + ); + } + + if (!is_resource($fp)) + { + return $response->body; + } + + return null; + } + + /** + * Get information about an object. + * + * @param string $bucket Bucket name + * @param string $uri Object URI + * + * @return array The headers returned by Amazon S3 + * + * @throws CannotGetFile If the file does not exist + * @see https://docs.aws.amazon.com/AmazonS3/latest/API/API_HeadObject.html + */ + public function headObject(string $bucket, string $uri): array + { + $request = new Request('HEAD', $bucket, $uri, $this->configuration); + + $response = $request->getResponse(); + + if (!$response->error->isError() && (($response->code !== 200) && ($response->code !== 206))) + { + $response->error = new Error( + $response->code, + "Unexpected HTTP status {$response->code}" + ); + } + + if ($response->error->isError()) + { + throw new CannotGetFile( + sprintf( + __METHOD__ . "({%s}, {%s}): [%s] %s\n\nDebug info:\n%s", + $bucket, + $uri, + $response->error->getCode(), + $response->error->getMessage(), + print_r($response->body, true) + ) + ); + } + + return $response->getHeaders(); + } + + + /** + * Delete an object + * + * @param string $bucket Bucket name + * @param string $uri Object URI + * + * @return void + */ + public function deleteObject(string $bucket, string $uri): void + { + $request = new Request('DELETE', $bucket, $uri, $this->configuration); + $response = $request->getResponse(); + + if (!$response->error->isError() && ($response->code !== 204)) + { + $response->error = new Error( + $response->code, + "Unexpected HTTP status {$response->code}" + ); + } + + if ($response->error->isError()) + { + throw new CannotDeleteFile( + sprintf( + __METHOD__ . "({%s}, {%s}): [%s] %s", + $bucket, + $uri, + $response->error->getCode(), + $response->error->getMessage() + ) + ); + } + } + + /** + * Get a query string authenticated URL + * + * @param string $bucket Bucket name + * @param string $uri Object URI + * @param int|null $lifetime Lifetime in seconds + * @param bool $https Use HTTPS ($hostBucket should be false for SSL verification)? + * + * @return string + */ + public function getAuthenticatedURL(string $bucket, string $uri, ?int $lifetime = null, bool $https = false): string + { + // Get a request from the URI and bucket + $questionmarkPos = strpos($uri, '?'); + $query = ''; + + if ($questionmarkPos !== false) + { + $query = substr($uri, $questionmarkPos + 1); + $uri = substr($uri, 0, $questionmarkPos); + } + + + /** + * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + * !!!! DO NOT TOUCH THIS CODE. YOU WILL BREAK PRE-SIGNED URLS WITH v4 SIGNATURES. !!!! + * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + * + * The following two lines seem weird and possibly extraneous at first glance. However, they are VERY important. + * If you remove them pre-signed URLs for v4 signatures will break! That's because pre-signed URLs with v4 + * signatures follow different rules than with v2 signatures. + * + * Authenticated (pre-signed) URLs are always made against the generic S3 region endpoint, not the bucket's + * virtual-hosting-style domain name. The bucket is always the first component of the path. + * + * For example, given a bucket called foobar, and an object baz.txt in it, we are pre-signing the URL + * https://s3-eu-west-1.amazonaws.com/foobar/baz.txt, not + * https://foobar.s3-eu-west-1.amazonaws.com/foobar/baz.txt (as we'd be doing with v2 signatures). + * + * The problem is that the Request object needs to be created before we can convey the intent (regular request + * or generation of a pre-signed URL). As a result its constructor creates the (immutable) request URI solely + * based on whether the Configuration object's getUseLegacyPathStyle() returns false or not. + * + * Since we want to request URI to contain the bucket name we need to tell the Request object's constructor that + * we are creating a Request object for path-style access, i.e. the useLegacyPathStyle flag in the Configuration + * object is true. Naturally, the default behavior being virtual-hosting-style access to buckets, this flag is + * most likely **false**. + * + * Therefore, we need to clone the Configuration object, set the flag to true and create a Request object using + * the falsified Configuration object. + * + * Note that v2 signatures are not affected. In v2 we are always appending the bucket name to the path, despite + * the fact that we include the bucket name in the domain name. + * + * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + * !!!! DO NOT TOUCH THIS CODE. YOU WILL BREAK PRE-SIGNED URLS WITH v4 SIGNATURES. !!!! + * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + */ + $newConfig = clone $this->configuration; + $newConfig->setUseLegacyPathStyle(true); + + // Create the request object. + $request = new Request('GET', $bucket, $uri, $newConfig); + + if ($query) + { + parse_str($query, $parameters); + + if (count($parameters)) + { + foreach ($parameters as $k => $v) + { + $request->setParameter($k, $v); + } + } + } + + // Get the signed URI from the Request object + return $request->getAuthenticatedURL($lifetime, $https); + } + + /** + * Get the location (region) of a bucket. You need this to use the V4 API on that bucket! + * + * @param string $bucket Bucket name + * + * @return string + */ + public function getBucketLocation(string $bucket): string + { + $request = new Request('GET', $bucket, '', $this->configuration); + $request->setParameter('location', null); + + $response = $request->getResponse(); + + if (!$response->error->isError() && $response->code !== 200) + { + $response->error = new Error( + $response->code, + "Unexpected HTTP status {$response->code}" + ); + } + + if ($response->error->isError()) + { + throw new CannotGetBucket( + sprintf(__METHOD__ . "(): [%s] %s", $response->error->getCode(), $response->error->getMessage()) + ); + } + + $result = 'us-east-1'; + + if ($response->hasBody()) + { + $result = (string) $response->body; + } + + switch ($result) + { + // "EU" is an alias for 'eu-west-1', however the canonical location name you MUST use is 'eu-west-1' + case 'EU': + case 'eu': + $result = 'eu-west-1'; + break; + + // If the bucket location is 'us-east-1' you get an empty string. @#$%^&*()!! + case '': + $result = 'us-east-1'; + break; + } + + return $result; + } + + /** + * Get the contents of a bucket + * + * If maxKeys is null this method will loop through truncated result sets + * + * @param string $bucket Bucket name + * @param string|null $prefix Prefix (directory) + * @param string|null $marker Marker (last file listed) + * @param int|null $maxKeys Maximum number of keys ("files" and "directories") to return + * @param string $delimiter Delimiter, typically "/" + * @param bool $returnCommonPrefixes Set to true to return CommonPrefixes + * + * @return array + */ + public function getBucket(string $bucket, ?string $prefix = null, ?string $marker = null, ?int $maxKeys = null, string $delimiter = '/', bool $returnCommonPrefixes = false): array + { + $internalResult = $this->internalGetBucket($bucket, $prefix, $marker, $maxKeys, $delimiter, $returnCommonPrefixes); + + /** + * @var array $objects + * @var ?string $nextMarker + */ + extract($internalResult); + unset($internalResult); + + // Loop through truncated results if maxKeys isn't specified or we don't have enough object records yet. + if ($nextMarker !== null && ($maxKeys === null || count($objects) < $maxKeys)) + { + do + { + $internalResult = $this->internalGetBucket($bucket, $prefix, $nextMarker, $maxKeys, $delimiter, $returnCommonPrefixes); + + $nextMarker = $internalResult['nextMarker']; + $objects = array_merge($objects, $internalResult['objects']); + + unset($internalResult); + + // If the last call did not return a nextMarker I am done iterating. + if ($nextMarker === null) + { + break; + } + + // If we have maxKeys AND the number of objects is at least this many I am done iterating. + if ($maxKeys !== null && count($objects) >= $maxKeys) + { + break; + } + } while (true); + } + + if ($maxKeys !== null) + { + return array_splice($objects, 0, $maxKeys); + } + + return $objects; + } + + /** + * Get a list of buckets + * + * @param bool $detailed Returns detailed bucket list when true + * + * @return array + */ + public function listBuckets(bool $detailed = false): array + { + // When listing buckets with the AWSv4 signature method we MUST set the region to us-east-1. Don't ask... + $configuration = clone $this->configuration; + $configuration->setRegion('us-east-1'); + + $request = new Request('GET', '', '', $configuration); + $response = $request->getResponse(); + + if (!$response->error->isError() && (($response->code !== 200))) + { + $response->error = new Error( + $response->code, + "Unexpected HTTP status {$response->code}" + ); + } + + if ($response->error->isError()) + { + throw new CannotListBuckets( + sprintf(__METHOD__ . "(): [%s] %s", $response->error->getCode(), $response->error->getMessage()) + ); + } + + $results = []; + + if (!isset($response->body->Buckets)) + { + return $results; + } + + if ($detailed) + { + if (isset($response->body->Owner, $response->body->Owner->ID, $response->body->Owner->DisplayName)) + { + $results['owner'] = [ + 'id' => (string) $response->body->Owner->ID, + 'name' => (string) $response->body->Owner->DisplayName, + ]; + } + + $results['buckets'] = []; + + foreach ($response->body->Buckets->Bucket as $b) + { + $results['buckets'][] = [ + 'name' => (string) $b->Name, + 'time' => strtotime((string) $b->CreationDate), + ]; + } + } + else + { + foreach ($response->body->Buckets->Bucket as $b) + { + $results[] = (string) $b->Name; + } + } + + return $results; + } + + /** + * Start a multipart upload of an object + * + * @param Input $input Input data + * @param string $bucket Bucket name + * @param string $uri Object URI + * @param string $acl ACL constant + * @param array $requestHeaders Array of request headers + * + * @return string The upload session ID (UploadId) + */ + public function startMultipart(Input $input, string $bucket, string $uri, string $acl = Acl::ACL_PRIVATE, array $requestHeaders = []): string + { + $request = new Request('POST', $bucket, $uri, $this->configuration); + $request->setParameter('uploads', ''); + + // Custom request headers (Content-Type, Content-Disposition, Content-Encoding) + if (is_array($requestHeaders)) + { + foreach ($requestHeaders as $h => $v) + { + if (strtolower(substr($h, 0, 6)) == 'x-amz-') + { + $request->setAmzHeader(strtolower($h), $v); + } + else + { + $request->setHeader($h, $v); + } + } + } + + $request->setAmzHeader('x-amz-acl', $acl); + + if (isset($requestHeaders['Content-Type'])) + { + $input->setType($requestHeaders['Content-Type']); + } + + $request->setHeader('Content-Type', $input->getType()); + + $response = $request->getResponse(); + + if (!$response->error->isError() && ($response->code !== 200)) + { + $response->error = new Error( + $response->code, + "Unexpected HTTP status {$response->code}" + ); + } + + if ($response->error->isError()) + { + throw new CannotPutFile( + sprintf( + __METHOD__ . "(): [%s] %s\n\nDebug info:\n%s", + $response->error->getCode(), + $response->error->getMessage(), + print_r($response->body, true) + ) + ); + } + + return (string) $response->body->UploadId; + } + + /** + * Uploads a part of a multipart object upload + * + * @param Input $input Input data. You MUST specify the UploadID and PartNumber + * @param string $bucket Bucket name + * @param string $uri Object URI + * @param array $requestHeaders Array of request headers or content type as a string + * @param int $chunkSize Size of each upload chunk, in bytes. It cannot be less than 5242880 bytes (5Mb) + * + * @return null|string The ETag of the upload part of null if we have ran out of parts to upload + */ + public function uploadMultipart(Input $input, string $bucket, string $uri, array $requestHeaders = [], int $chunkSize = 5242880): ?string + { + if ($chunkSize < 5242880) + { + $chunkSize = 5242880; + } + + // We need a valid UploadID and PartNumber + $UploadID = $input->getUploadID(); + $PartNumber = $input->getPartNumber(); + + if (empty($UploadID)) + { + throw new CannotPutFile( + __METHOD__ . '(): No UploadID specified' + ); + } + + if (empty($PartNumber)) + { + throw new CannotPutFile( + __METHOD__ . '(): No PartNumber specified' + ); + } + + $UploadID = urlencode($UploadID); + $PartNumber = (int) $PartNumber; + + $request = new Request('PUT', $bucket, $uri, $this->configuration); + $request->setParameter('partNumber', $PartNumber); + $request->setParameter('uploadId', $UploadID); + $request->setInput($input); + + // Full data length + $totalSize = $input->getSize(); + + // No Content-Type for multipart uploads + $input->setType(null); + + // Calculate part offset + $partOffset = $chunkSize * ($PartNumber - 1); + + if ($partOffset > $totalSize) + { + // This is to signify that we ran out of parts ;) + return null; + } + + // How many parts are there? + $totalParts = floor($totalSize / $chunkSize); + + if ($totalParts * $chunkSize < $totalSize) + { + $totalParts++; + } + + // Calculate Content-Length + $size = $chunkSize; + + if ($PartNumber >= $totalParts) + { + $size = $totalSize - ($PartNumber - 1) * $chunkSize; + } + + if ($size <= 0) + { + // This is to signify that we ran out of parts ;) + return null; + } + + $input->setSize($size); + + switch ($input->getInputType()) + { + case Input::INPUT_DATA: + $input->setData(substr($input->getData(), ($PartNumber - 1) * $chunkSize, $input->getSize())); + break; + + case Input::INPUT_FILE: + case Input::INPUT_RESOURCE: + $fp = $input->getFp(); + fseek($fp, ($PartNumber - 1) * $chunkSize); + break; + } + + // Custom request headers (Content-Type, Content-Disposition, Content-Encoding) + if (is_array($requestHeaders)) + { + foreach ($requestHeaders as $h => $v) + { + if (strtolower(substr($h, 0, 6)) == 'x-amz-') + { + $request->setAmzHeader(strtolower($h), $v); + } + else + { + $request->setHeader($h, $v); + } + } + } + + $request->setHeader('Content-Length', $input->getSize()); + + if ($input->getInputType() === Input::INPUT_DATA) + { + $request->setHeader('Content-Type', "application/x-www-form-urlencoded"); + } + + $response = $request->getResponse(); + + if ($response->code !== 200) + { + if (!$response->error->isError()) + { + $response->error = new Error( + $response->code, + "Unexpected HTTP status {$response->code}" + ); + } + + if (is_object($response->body) && ($response->body instanceof \SimpleXMLElement) && (strpos($input->getSize(), ',') === false)) + { + // For some moronic reason, trying to multipart upload files on some hosts comes back with a crazy + // error from Amazon that we need to set Content-Length:5242880,5242880 instead of + // Content-Length:5242880 which is AGAINST Amazon's documentation. In this case we pass the header + // 'workaround-broken-content-length' and retry. Whatever. + if (isset($response->body->CanonicalRequest)) + { + $amazonsCanonicalRequest = (string) $response->body->CanonicalRequest; + $lines = explode("\n", $amazonsCanonicalRequest); + + foreach ($lines as $line) + { + if (substr($line, 0, 15) != 'content-length:') + { + continue; + } + + [$junk, $stupidAmazonDefinedContentLength] = explode(":", $line); + + if (strpos($stupidAmazonDefinedContentLength, ',') !== false) + { + if (!isset($requestHeaders['workaround-broken-content-length'])) + { + $requestHeaders['workaround-broken-content-length'] = true; + + // This is required to reset the input size to its default value. If you don't do that + // only one part will ever be uploaded. Oops! + $input->setSize(-1); + + return $this->uploadMultipart($input, $bucket, $uri, $requestHeaders, $chunkSize); + } + } + } + } + + } + + throw new CannotPutFile( + sprintf(__METHOD__ . "(): [%s] %s\n\nDebug info:\n%s", $response->error->getCode(), $response->error->getMessage(), print_r($response->body, true)) + ); + } + + // Return the ETag header + return $response->headers['hash']; + } + + /** + * Finalizes the multi-part upload. The $input object should contain two keys, etags an array of ETags of the + * uploaded parts and UploadID the multipart upload ID. + * + * @param Input $input The array of input elements + * @param string $bucket The bucket where the object is being stored + * @param string $uri The key (path) to the object + * + * @return void + */ + public function finalizeMultipart(Input $input, string $bucket, string $uri): void + { + $etags = $input->getEtags(); + $UploadID = $input->getUploadID(); + + if (empty($etags)) + { + throw new CannotPutFile( + __METHOD__ . '(): No ETags array specified' + ); + } + + if (empty($UploadID)) + { + throw new CannotPutFile( + __METHOD__ . '(): No UploadID specified' + ); + } + + // Create the message + $message = "<CompleteMultipartUpload>\n"; + $part = 0; + + foreach ($etags as $etag) + { + $part++; + $message .= "\t<Part>\n\t\t<PartNumber>$part</PartNumber>\n\t\t<ETag>\"$etag\"</ETag>\n\t</Part>\n"; + } + + $message .= "</CompleteMultipartUpload>"; + + // Get a request query + $reqInput = Input::createFromData($message); + + $request = new Request('POST', $bucket, $uri, $this->configuration); + $request->setParameter('uploadId', $UploadID); + $request->setInput($reqInput); + + // Do post + $request->setHeader('Content-Type', 'application/xml'); // Even though the Amazon API doc doesn't mention it, it's required... :( + $response = $request->getResponse(); + + if (!$response->error->isError() && ($response->code != 200)) + { + $response->error = new Error( + $response->code, + "Unexpected HTTP status {$response->code}" + ); + } + + if ($response->error->isError()) + { + if ($response->error->getCode() == 'RequestTimeout') + { + return; + } + + throw new CannotPutFile( + sprintf(__METHOD__ . "(): [%s] %s\n\nDebug info:\n%s", $response->error->getCode(), $response->error->getMessage(), print_r($response->body, true)) + ); + } + } + + /** + * Returns the configuration object + * + * @return Configuration + */ + public function getConfiguration(): Configuration + { + return $this->configuration; + } + + private function internalGetBucket(string $bucket, ?string $prefix = null, ?string $marker = null, ?int $maxKeys = null, string $delimiter = '/', bool $returnCommonPrefixes = false): array + { + $request = new Request('GET', $bucket, '', $this->configuration); + + if (!empty($prefix)) + { + $request->setParameter('prefix', $prefix); + } + + if (!empty($marker)) + { + $request->setParameter('marker', $marker); + } + + if (!empty($maxKeys)) + { + $request->setParameter('max-keys', $maxKeys); + } + + if (!empty($delimiter)) + { + $request->setParameter('delimiter', $delimiter); + } + + $response = $request->getResponse(); + + if (!$response->error->isError() && $response->code !== 200) + { + $response->error = new Error( + $response->code, + "Unexpected HTTP status {$response->code}" + ); + } + + if ($response->error->isError()) + { + throw new CannotGetBucket( + sprintf(__METHOD__ . "(): [%s] %s", $response->error->getCode(), $response->error->getMessage()) + ); + } + + $results = [ + 'objects' => [], + 'nextMarker' => null, + ]; + + if ($response->hasBody() && isset($response->body->Contents)) + { + foreach ($response->body->Contents as $c) + { + $results['objects'][(string) $c->Key] = [ + 'name' => (string) $c->Key, + 'time' => strtotime((string) $c->LastModified), + 'size' => (int) $c->Size, + 'hash' => substr((string) $c->ETag, 1, -1), + ]; + + $results['nextMarker'] = (string) $c->Key; + } + } + + if ($returnCommonPrefixes && $response->hasBody() && isset($response->body->CommonPrefixes)) + { + foreach ($response->body->CommonPrefixes as $c) + { + $results['objects'][(string) $c->Prefix] = ['prefix' => (string) $c->Prefix]; + } + } + + if ($response->hasBody() && isset($response->body->IsTruncated) && + ((string) $response->body->IsTruncated == 'false') + ) + { + $results['nextMarker'] = null; + + return $results; + } + + if ($response->hasBody() && isset($response->body->NextMarker)) + { + $results['nextMarker'] = (string) $response->body->NextMarker; + } + + return $results; + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Exception/CannotDeleteFile.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Exception/CannotDeleteFile.php new file mode 100644 index 0000000000..7bb4703518 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Exception/CannotDeleteFile.php @@ -0,0 +1,19 @@ +<?php +/** + * Akeeba Engine + * + * @package akeebaengine + * @copyright Copyright (c)2006-2024 Nicholas K. Dionysopoulos / Akeeba Ltd + * @license GNU General Public License version 3, or later + */ + +namespace Akeeba\S3\Exception; + +// Protection against direct access +defined('AKEEBAENGINE') || die(); + +use RuntimeException; + +class CannotDeleteFile extends RuntimeException +{ +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Exception/CannotGetBucket.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Exception/CannotGetBucket.php new file mode 100644 index 0000000000..0910fb61b5 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Exception/CannotGetBucket.php @@ -0,0 +1,19 @@ +<?php +/** + * Akeeba Engine + * + * @package akeebaengine + * @copyright Copyright (c)2006-2024 Nicholas K. Dionysopoulos / Akeeba Ltd + * @license GNU General Public License version 3, or later + */ + +namespace Akeeba\S3\Exception; + +// Protection against direct access +defined('AKEEBAENGINE') || die(); + +use RuntimeException; + +class CannotGetBucket extends RuntimeException +{ +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Exception/CannotGetFile.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Exception/CannotGetFile.php new file mode 100644 index 0000000000..3582cea1d7 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Exception/CannotGetFile.php @@ -0,0 +1,19 @@ +<?php +/** + * Akeeba Engine + * + * @package akeebaengine + * @copyright Copyright (c)2006-2024 Nicholas K. Dionysopoulos / Akeeba Ltd + * @license GNU General Public License version 3, or later + */ + +namespace Akeeba\S3\Exception; + +// Protection against direct access +defined('AKEEBAENGINE') || die(); + +use RuntimeException; + +class CannotGetFile extends RuntimeException +{ +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Exception/CannotListBuckets.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Exception/CannotListBuckets.php new file mode 100644 index 0000000000..86799275f3 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Exception/CannotListBuckets.php @@ -0,0 +1,19 @@ +<?php +/** + * Akeeba Engine + * + * @package akeebaengine + * @copyright Copyright (c)2006-2024 Nicholas K. Dionysopoulos / Akeeba Ltd + * @license GNU General Public License version 3, or later + */ + +namespace Akeeba\S3\Exception; + +// Protection against direct access +defined('AKEEBAENGINE') || die(); + +use RuntimeException; + +class CannotListBuckets extends RuntimeException +{ +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Exception/CannotOpenFileForRead.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Exception/CannotOpenFileForRead.php new file mode 100644 index 0000000000..ea8c729e53 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Exception/CannotOpenFileForRead.php @@ -0,0 +1,27 @@ +<?php +/** + * Akeeba Engine + * + * @package akeebaengine + * @copyright Copyright (c)2006-2024 Nicholas K. Dionysopoulos / Akeeba Ltd + * @license GNU General Public License version 3, or later + */ + +namespace Akeeba\S3\Exception; + +// Protection against direct access +defined('AKEEBAENGINE') || die(); + +use Exception; +use RuntimeException; + +class CannotOpenFileForRead extends RuntimeException +{ + public function __construct(string $file = "", int $code = 0, Exception $previous = null) + { + $message = "Cannot open $file for reading"; + + parent::__construct($message, $code, $previous); + } + +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Exception/CannotOpenFileForWrite.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Exception/CannotOpenFileForWrite.php new file mode 100644 index 0000000000..9a7fcde93f --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Exception/CannotOpenFileForWrite.php @@ -0,0 +1,27 @@ +<?php +/** + * Akeeba Engine + * + * @package akeebaengine + * @copyright Copyright (c)2006-2024 Nicholas K. Dionysopoulos / Akeeba Ltd + * @license GNU General Public License version 3, or later + */ + +namespace Akeeba\S3\Exception; + +// Protection against direct access +defined('AKEEBAENGINE') || die(); + +use Exception; +use RuntimeException; + +class CannotOpenFileForWrite extends RuntimeException +{ + public function __construct(string $file = "", int $code = 0, Exception $previous = null) + { + $message = "Cannot open $file for writing"; + + parent::__construct($message, $code, $previous); + } + +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Exception/CannotPutFile.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Exception/CannotPutFile.php new file mode 100644 index 0000000000..2656eeae4e --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Exception/CannotPutFile.php @@ -0,0 +1,19 @@ +<?php +/** + * Akeeba Engine + * + * @package akeebaengine + * @copyright Copyright (c)2006-2024 Nicholas K. Dionysopoulos / Akeeba Ltd + * @license GNU General Public License version 3, or later + */ + +namespace Akeeba\S3\Exception; + +// Protection against direct access +defined('AKEEBAENGINE') || die(); + +use RuntimeException; + +class CannotPutFile extends RuntimeException +{ +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Exception/ConfigurationError.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Exception/ConfigurationError.php new file mode 100644 index 0000000000..f478968759 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Exception/ConfigurationError.php @@ -0,0 +1,23 @@ +<?php +/** + * Akeeba Engine + * + * @package akeebaengine + * @copyright Copyright (c)2006-2024 Nicholas K. Dionysopoulos / Akeeba Ltd + * @license GNU General Public License version 3, or later + */ + +namespace Akeeba\S3\Exception; + +// Protection against direct access +defined('AKEEBAENGINE') || die(); + +use RuntimeException; + +/** + * Configuration error + */ +abstract class ConfigurationError extends RuntimeException +{ + +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Exception/InvalidAccessKey.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Exception/InvalidAccessKey.php new file mode 100644 index 0000000000..d8e7afe7f9 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Exception/InvalidAccessKey.php @@ -0,0 +1,32 @@ +<?php +/** + * Akeeba Engine + * + * @package akeebaengine + * @copyright Copyright (c)2006-2024 Nicholas K. Dionysopoulos / Akeeba Ltd + * @license GNU General Public License version 3, or later + */ + +namespace Akeeba\S3\Exception; + +// Protection against direct access +defined('AKEEBAENGINE') || die(); + +use Exception; + +/** + * Invalid Amazon S3 access key + */ +class InvalidAccessKey extends ConfigurationError +{ + public function __construct(string $message = "", int $code = 0, Exception $previous = null) + { + if (empty($message)) + { + $message = 'The Amazon S3 Access Key provided is invalid'; + } + + parent::__construct($message, $code, $previous); + } + +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Exception/InvalidBody.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Exception/InvalidBody.php new file mode 100644 index 0000000000..4971a468e4 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Exception/InvalidBody.php @@ -0,0 +1,33 @@ +<?php +/** + * Akeeba Engine + * + * @package akeebaengine + * @copyright Copyright (c)2006-2024 Nicholas K. Dionysopoulos / Akeeba Ltd + * @license GNU General Public License version 3, or later + */ + +namespace Akeeba\S3\Exception; + +// Protection against direct access +defined('AKEEBAENGINE') || die(); + +use Exception; +use RuntimeException; + +/** + * Invalid response body type + */ +class InvalidBody extends RuntimeException +{ + public function __construct(string $message = "", int $code = 0, Exception $previous = null) + { + if (empty($message)) + { + $message = 'Invalid response body type'; + } + + parent::__construct($message, $code, $previous); + } + +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Exception/InvalidEndpoint.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Exception/InvalidEndpoint.php new file mode 100644 index 0000000000..0ef7a3fee6 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Exception/InvalidEndpoint.php @@ -0,0 +1,32 @@ +<?php +/** + * Akeeba Engine + * + * @package akeebaengine + * @copyright Copyright (c)2006-2024 Nicholas K. Dionysopoulos / Akeeba Ltd + * @license GNU General Public License version 3, or later + */ + +namespace Akeeba\S3\Exception; + +// Protection against direct access +defined('AKEEBAENGINE') || die(); + +use Exception; + +/** + * Invalid Amazon S3 endpoint + */ +class InvalidEndpoint extends ConfigurationError +{ + public function __construct(string $message = "", int $code = 0, Exception $previous = null) + { + if (empty($message)) + { + $message = 'The custom S3 endpoint provided is invalid. Do NOT include the protocol (http:// or https://). Valid examples are s3.example.com and www.example.com/s3Api'; + } + + parent::__construct($message, $code, $previous); + } + +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Exception/InvalidFilePointer.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Exception/InvalidFilePointer.php new file mode 100644 index 0000000000..4b6bc1c46c --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Exception/InvalidFilePointer.php @@ -0,0 +1,30 @@ +<?php +/** + * Akeeba Engine + * + * @package akeebaengine + * @copyright Copyright (c)2006-2024 Nicholas K. Dionysopoulos / Akeeba Ltd + * @license GNU General Public License version 3, or later + */ + +namespace Akeeba\S3\Exception; + +// Protection against direct access +defined('AKEEBAENGINE') || die(); + +use Exception; +use InvalidArgumentException; + +class InvalidFilePointer extends InvalidArgumentException +{ + public function __construct(string $message = "", int $code = 0, Exception $previous = null) + { + if (empty($message)) + { + $message = 'The specified file pointer is not a valid stream resource'; + } + + parent::__construct($message, $code, $previous); + } + +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Exception/InvalidRegion.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Exception/InvalidRegion.php new file mode 100644 index 0000000000..6fd7a9eb25 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Exception/InvalidRegion.php @@ -0,0 +1,32 @@ +<?php +/** + * Akeeba Engine + * + * @package akeebaengine + * @copyright Copyright (c)2006-2024 Nicholas K. Dionysopoulos / Akeeba Ltd + * @license GNU General Public License version 3, or later + */ + +namespace Akeeba\S3\Exception; + +// Protection against direct access +defined('AKEEBAENGINE') || die(); + +use Exception; + +/** + * Invalid Amazon S3 region + */ +class InvalidRegion extends ConfigurationError +{ + public function __construct(string $message = "", int $code = 0, Exception $previous = null) + { + if (empty($message)) + { + $message = 'The Amazon S3 region provided is invalid.'; + } + + parent::__construct($message, $code, $previous); + } + +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Exception/InvalidSecretKey.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Exception/InvalidSecretKey.php new file mode 100644 index 0000000000..31e964efc2 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Exception/InvalidSecretKey.php @@ -0,0 +1,32 @@ +<?php +/** + * Akeeba Engine + * + * @package akeebaengine + * @copyright Copyright (c)2006-2024 Nicholas K. Dionysopoulos / Akeeba Ltd + * @license GNU General Public License version 3, or later + */ + +namespace Akeeba\S3\Exception; + +// Protection against direct access +defined('AKEEBAENGINE') || die(); + +use Exception; + +/** + * Invalid Amazon S3 secret key + */ +class InvalidSecretKey extends ConfigurationError +{ + public function __construct(string $message = "", int $code = 0, Exception $previous = null) + { + if (empty($message)) + { + $message = 'The Amazon S3 Secret Key provided is invalid'; + } + + parent::__construct($message, $code, $previous); + } + +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Exception/InvalidSignatureMethod.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Exception/InvalidSignatureMethod.php new file mode 100644 index 0000000000..44b8b5c73e --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Exception/InvalidSignatureMethod.php @@ -0,0 +1,32 @@ +<?php +/** + * Akeeba Engine + * + * @package akeebaengine + * @copyright Copyright (c)2006-2024 Nicholas K. Dionysopoulos / Akeeba Ltd + * @license GNU General Public License version 3, or later + */ + +namespace Akeeba\S3\Exception; + +// Protection against direct access +defined('AKEEBAENGINE') || die(); + +use Exception; + +/** + * Invalid Amazon S3 signature method + */ +class InvalidSignatureMethod extends ConfigurationError +{ + public function __construct(string $message = "", int $code = 0, Exception $previous = null) + { + if (empty($message)) + { + $message = 'The Amazon S3 signature method provided is invalid. Only v2 and v4 signatures are supported.'; + } + + parent::__construct($message, $code, $previous); + } + +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Exception/PropertyNotFound.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Exception/PropertyNotFound.php new file mode 100644 index 0000000000..58eb775556 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Exception/PropertyNotFound.php @@ -0,0 +1,22 @@ +<?php +/** + * Akeeba Engine + * + * @package akeebaengine + * @copyright Copyright (c)2006-2024 Nicholas K. Dionysopoulos / Akeeba Ltd + * @license GNU General Public License version 3, or later + */ + +namespace Akeeba\S3\Exception; + +// Protection against direct access +defined('AKEEBAENGINE') || die(); + +use LogicException; + +/** + * Invalid magic property name + */ +class PropertyNotFound extends LogicException +{ +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Input.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Input.php new file mode 100644 index 0000000000..cdc50921ae --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Input.php @@ -0,0 +1,766 @@ +<?php +/** + * Akeeba Engine + * + * @package akeebaengine + * @copyright Copyright (c)2006-2024 Nicholas K. Dionysopoulos / Akeeba Ltd + * @license GNU General Public License version 3, or later + */ + +namespace Akeeba\S3; + +// Protection against direct access +defined('AKEEBAENGINE') || die(); + +/** + * Defines an input source for PUT/POST requests to Amazon S3 + */ +class Input +{ + /** + * Input type: resource + */ + public const INPUT_RESOURCE = 1; + + /** + * Input type: file + */ + public const INPUT_FILE = 2; + + /** + * Input type: raw data + */ + public const INPUT_DATA = 3; + + /** + * File pointer, in case we have a resource + * + * @var resource + */ + private $fp = null; + + /** + * Absolute filename to the file + * + * @var string + */ + private $file = null; + + /** + * Data to upload, as a string + * + * @var string + */ + private $data = null; + + /** + * Length of the data to upload + * + * @var int + */ + private $size = -1; + + /** + * Content type (MIME type) + * + * @var string|null + */ + private $type = ''; + + /** + * MD5 sum of the data to upload, as base64 encoded string. If it's false no MD5 sum will be returned. + * + * @var string|null + */ + private $md5sum = null; + + /** + * SHA-256 sum of the data to upload, as lowercase hex string. + * + * @var string|null + */ + private $sha256 = null; + + /** + * The Upload Session ID used for multipart uploads + * + * @var string|null + */ + private $UploadID = null; + + /** + * The part number used in multipart uploads + * + * @var int|null + */ + private $PartNumber = null; + + /** + * The list of ETags used when finalising a multipart upload + * + * @var string[] + */ + private $etags = []; + + /** + * Create an input object from a file (also: any valid URL wrapper) + * + * @param string $file Absolute file path or any valid URL fopen() wrapper + * @param null|string $md5sum The MD5 sum. null to auto calculate, empty string to never calculate. + * @param null|string $sha256sum The SHA256 sum. null to auto calculate. + * + * @return Input + */ + public static function createFromFile(string $file, ?string $md5sum = null, ?string $sha256sum = null): self + { + $input = new Input(); + + $input->setFile($file); + $input->setMd5sum($md5sum); + $input->setSha256($sha256sum); + + return $input; + } + + /** + * Create an input object from a stream resource / file pointer. + * + * Please note that the contentLength cannot be calculated automatically unless you have a seekable stream resource. + * + * @param resource $resource The file pointer or stream resource + * @param int $contentLength The length of the content in bytes. Set to -1 for auto calculation. + * @param null|string $md5sum The MD5 sum. null to auto calculate, empty string to never calculate. + * @param null|string $sha256sum The SHA256 sum. null to auto calculate. + * + * @return Input + */ + public static function createFromResource(&$resource, int $contentLength, ?string $md5sum = null, ?string $sha256sum = null): self + { + $input = new Input(); + + $input->setFp($resource); + $input->setSize($contentLength); + $input->setMd5sum($md5sum); + $input->setSha256($sha256sum); + + return $input; + } + + /** + * Create an input object from raw data. + * + * Please bear in mind that the data is being duplicated in memory. Therefore you'll need at least 2xstrlen($data) + * of free memory when you are using this method. You can instantiate an object and use assignData to work around + * this limitation when handling large amounts of data which may cause memory outages (typically: over 10Mb). + * + * @param string $data The data to use. + * @param null|string $md5sum The MD5 sum. null to auto calculate, empty string to never calculate. + * @param null|string $sha256sum The SHA256 sum. null to auto calculate. + * + * @return Input + */ + public static function createFromData(string &$data, ?string $md5sum = null, ?string $sha256sum = null): self + { + $input = new Input(); + + $input->setData($data); + $input->setMd5sum($md5sum); + $input->setSha256($sha256sum); + + return $input; + } + + /** + * Destructor. + */ + function __destruct() + { + if (is_resource($this->fp)) + { + try + { + @fclose($this->fp); + } + catch (\Throwable $e) + { + } + } + } + + /** + * Returns the input type (resource, file or data) + * + * @return int + */ + public function getInputType(): int + { + if (!empty($this->file)) + { + return self::INPUT_FILE; + } + + if (!empty($this->fp)) + { + return self::INPUT_RESOURCE; + } + + return self::INPUT_DATA; + } + + /** + * Return the file pointer to the data, or null if this is not a resource input + * + * @return resource|null + */ + public function getFp() + { + if (!is_resource($this->fp)) + { + return null; + } + + return $this->fp; + } + + /** + * Set the file pointer (or, generally, stream resource) + * + * @param resource $fp + */ + public function setFp($fp): void + { + if (!is_resource($fp)) + { + throw new Exception\InvalidFilePointer('$fp is not a file resource'); + } + + $this->fp = $fp; + } + + /** + * Get the absolute path to the input file, or null if this is not a file input + * + * @return string|null + */ + public function getFile(): ?string + { + if (empty($this->file)) + { + return null; + } + + return $this->file; + } + + /** + * Set the absolute path to the input file + * + * @param string $file + */ + public function setFile(string $file): void + { + $this->file = $file; + $this->data = null; + + if (is_resource($this->fp)) + { + try + { + @fclose($this->fp); + } + catch (\Throwable $e) + { + } + } + + $this->fp = @fopen($file, 'r'); + + if ($this->fp === false) + { + throw new Exception\CannotOpenFileForRead($file); + } + } + + /** + * Return the raw input data, or null if this is a file or stream input + * + * @return string|null + */ + public function getData(): ?string + { + if (empty($this->data) && ($this->getInputType() != self::INPUT_DATA)) + { + return null; + } + + return $this->data; + } + + /** + * Set the raw input data + * + * @param string $data + */ + public function setData(string $data): void + { + $this->data = $data; + + if (is_resource($this->fp)) + { + try + { + @fclose($this->fp); + } + catch (\Throwable $e) + { + } + } + + $this->file = null; + $this->fp = null; + } + + /** + * Return a reference to the raw input data + * + * @return string|null + */ + public function &getDataReference(): ?string + { + if (empty($this->data) && ($this->getInputType() != self::INPUT_DATA)) + { + $this->data = null; + } + + return $this->data; + } + + /** + * Set the raw input data by doing an assignment instead of memory copy. While this conserves memory you cannot use + * this with hardcoded strings, method results etc without going through a variable first. + * + * @param string $data + */ + public function assignData(string &$data): void + { + $this->data = $data; + + if (is_resource($this->fp)) + { + try + { + @fclose($this->fp); + } + catch (\Throwable $e) + { + } + } + + $this->file = null; + $this->fp = null; + } + + /** + * Returns the size of the data to be uploaded, in bytes. If it's not already specified it will try to guess. + * + * @return int + */ + public function getSize(): int + { + if ($this->size < 0) + { + $this->size = $this->getInputSize(); + } + + return $this->size; + } + + /** + * Set the size of the data to be uploaded. + * + * @param int $size + */ + public function setSize(int $size) + { + $this->size = $size; + } + + /** + * Get the MIME type of the data + * + * @return string|null + */ + public function getType(): ?string + { + if (empty($this->type)) + { + $this->type = 'application/octet-stream'; + + if ($this->getInputType() == self::INPUT_FILE) + { + $this->type = $this->getMimeType($this->file); + } + } + + return $this->type; + } + + /** + * Set the MIME type of the data + * + * @param string|null $type + */ + public function setType(?string $type) + { + $this->type = $type; + } + + /** + * Get the MD5 sum of the content + * + * @return null|string + */ + public function getMd5sum(): ?string + { + if ($this->md5sum === '') + { + return null; + } + + if (is_null($this->md5sum)) + { + $this->md5sum = $this->calculateMd5(); + } + + return $this->md5sum; + } + + /** + * Set the MD5 sum of the content as a base64 encoded string of the raw MD5 binary value. + * + * WARNING: Do not set a binary MD5 sum or a hex-encoded MD5 sum, it will result in an invalid signature error! + * + * Set to null to automatically calculate it from the raw data. Set to an empty string to force it to never be + * calculated and no value for it set either. + * + * @param string|null $md5sum + */ + public function setMd5sum(?string $md5sum): void + { + $this->md5sum = $md5sum; + } + + /** + * Get the SHA-256 hash of the content + * + * @return string + */ + public function getSha256(): string + { + if (empty($this->sha256)) + { + $this->sha256 = $this->calculateSha256(); + } + + return $this->sha256; + } + + /** + * Set the SHA-256 sum of the content. It must be a lowercase hexadecimal encoded string. + * + * Set to null to automatically calculate it from the raw data. + * + * @param string|null $sha256 + */ + public function setSha256(?string $sha256): void + { + $this->sha256 = is_null($sha256) ? null : strtolower($sha256); + } + + /** + * Get the Upload Session ID for multipart uploads + * + * @return string|null + */ + public function getUploadID(): ?string + { + return $this->UploadID; + } + + /** + * Set the Upload Session ID for multipart uploads + * + * @param string|null $UploadID + */ + public function setUploadID(?string $UploadID): void + { + $this->UploadID = $UploadID; + } + + /** + * Get the part number for multipart uploads. + * + * Returns null if the part number has not been set yet. + * + * @return int|null + */ + public function getPartNumber(): ?int + { + return $this->PartNumber; + } + + /** + * Set the part number for multipart uploads + * + * @param int $PartNumber + */ + public function setPartNumber(int $PartNumber): void + { + // Clamp the part number to integers greater than zero. + $this->PartNumber = max(1, (int) $PartNumber); + } + + /** + * Get the list of ETags for multipart uploads + * + * @return string[] + */ + public function getEtags(): array + { + return $this->etags; + } + + /** + * Set the list of ETags for multipart uploads + * + * @param string[] $etags + */ + public function setEtags(array $etags): void + { + $this->etags = $etags; + } + + /** + * Calculates the upload size from the input source. For data it's the entire raw string length. For a file resource + * it's the entire file's length. For seekable stream resources it's the remaining data from the current seek + * position to EOF. + * + * WARNING: You should never try to specify files or resources over 2Gb minus 1 byte otherwise 32-bit versions of + * PHP (anything except Linux x64 builds) will fail in unpredictable ways: the internal int representation in PHP + * depends on the target platform and is typically a signed 32-bit integer. + * + * @return int + */ + private function getInputSize(): int + { + switch ($this->getInputType()) + { + case self::INPUT_DATA: + return function_exists('mb_strlen') ? mb_strlen($this->data ?? '', '8bit') : strlen($this->data ?? ''); + break; + + case self::INPUT_FILE: + clearstatcache(true, $this->file); + + $filesize = @filesize($this->file); + + return ($filesize === false) ? 0 : $filesize; + break; + + case self::INPUT_RESOURCE: + $meta = stream_get_meta_data($this->fp); + + if ($meta['seekable']) + { + $pos = ftell($this->fp); + $endPos = fseek($this->fp, 0, SEEK_END); + fseek($this->fp, $pos, SEEK_SET); + + return $endPos - $pos + 1; + } + + break; + } + + return 0; + } + + /** + * Get the MIME type of a file + * + * @param string $file The absolute path to the file for which we want to get the MIME type + * + * @return string The MIME type of the file + */ + private function getMimeType(string $file): string + { + $type = false; + + // Fileinfo documentation says fileinfo_open() will use the + // MAGIC env var for the magic file + if (extension_loaded('fileinfo') && isset($_ENV['MAGIC']) && + ($finfo = finfo_open(FILEINFO_MIME, $_ENV['MAGIC'])) !== false + ) + { + if (($type = finfo_file($finfo, $file)) !== false) + { + // Remove the charset and grab the last content-type + $type = explode(' ', str_replace('; charset=', ';charset=', $type)); + $type = array_pop($type); + $type = explode(';', $type); + $type = trim(array_shift($type)); + } + + finfo_close($finfo); + } + elseif (function_exists('mime_content_type')) + { + $type = trim(mime_content_type($file)); + } + + if ($type !== false && strlen($type) > 0) + { + return $type; + } + + // Otherwise do it the old fashioned way + static $exts = [ + 'jpg' => 'image/jpeg', + 'gif' => 'image/gif', + 'png' => 'image/png', + 'tif' => 'image/tiff', + 'tiff' => 'image/tiff', + 'ico' => 'image/x-icon', + 'swf' => 'application/x-shockwave-flash', + 'pdf' => 'application/pdf', + 'zip' => 'application/zip', + 'gz' => 'application/x-gzip', + 'tar' => 'application/x-tar', + 'bz' => 'application/x-bzip', + 'bz2' => 'application/x-bzip2', + 'txt' => 'text/plain', + 'asc' => 'text/plain', + 'htm' => 'text/html', + 'html' => 'text/html', + 'css' => 'text/css', + 'js' => 'text/javascript', + 'xml' => 'text/xml', + 'xsl' => 'application/xsl+xml', + 'ogg' => 'application/ogg', + 'mp3' => 'audio/mpeg', + 'wav' => 'audio/x-wav', + 'avi' => 'video/x-msvideo', + 'mpg' => 'video/mpeg', + 'mpeg' => 'video/mpeg', + 'mov' => 'video/quicktime', + 'flv' => 'video/x-flv', + 'php' => 'text/x-php', + ]; + + $ext = strtolower(pathInfo($file, PATHINFO_EXTENSION)); + + return $exts[$ext] ?? 'application/octet-stream'; + } + + /** + * Calculate the MD5 sum of the input data + * + * @return string Base-64 encoded MD5 sum + */ + private function calculateMd5(): string + { + switch ($this->getInputType()) + { + case self::INPUT_DATA: + return base64_encode( + function_exists('hash') + ? hash('md5', $this->data, true) + : md5($this->data, true) + ); + break; + + case self::INPUT_FILE: + return base64_encode( + function_exists('hash_file') + ? hash_file('md5', $this->file, true) + : md5_file($this->file, true) + ); + break; + + case self::INPUT_RESOURCE: + $ctx = hash_init('md5'); + $pos = ftell($this->fp); + $size = $this->getSize(); + $done = 0; + $batch = min(1048576, $size); + + while ($done < $size) + { + $toRead = min($batch, $done - $size); + $data = @fread($this->fp, $toRead); + hash_update($ctx, $data); + unset($data); + } + + fseek($this->fp, $pos, SEEK_SET); + + return base64_encode(hash_final($ctx, true)); + + break; + } + + return ''; + } + + /** + * Calcualte the SHA256 data of the input data + * + * @return string Lowercase hex representation of the SHA-256 sum + */ + private function calculateSha256(): string + { + $inputType = $this->getInputType(); + switch ($inputType) + { + case self::INPUT_DATA: + return hash('sha256', $this->data, false); + break; + + case self::INPUT_FILE: + case self::INPUT_RESOURCE: + if ($inputType == self::INPUT_FILE) + { + $filesize = @filesize($this->file); + $fPos = @ftell($this->fp); + + if (($filesize == $this->getSize()) && ($fPos === 0)) + { + return hash_file('sha256', $this->file, false); + } + } + + $ctx = hash_init('sha256'); + $pos = ftell($this->fp); + $size = $this->getSize(); + $done = 0; + $batch = min(1048576, $size); + + while ($done < $size) + { + $toRead = min($batch, $size - $done); + $data = @fread($this->fp, $toRead); + $done += $toRead; + hash_update($ctx, $data); + unset($data); + } + + fseek($this->fp, $pos, SEEK_SET); + + return hash_final($ctx, false); + + break; + } + + return ''; + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Request.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Request.php new file mode 100644 index 0000000000..d9b1833a40 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Request.php @@ -0,0 +1,823 @@ +<?php +/** + * Akeeba Engine + * + * @package akeebaengine + * @copyright Copyright (c)2006-2024 Nicholas K. Dionysopoulos / Akeeba Ltd + * @license GNU General Public License version 3, or later + */ + +namespace Akeeba\S3; + +use Akeeba\S3\Response\Error; + +// Protection against direct access +defined('AKEEBAENGINE') || die(); + + +class Request +{ + /** + * The HTTP verb to use + * + * @var string + */ + private $verb = 'GET'; + + /** + * The bucket we are using + * + * @var string + */ + private $bucket = ''; + + /** + * The object URI, relative to the bucket's root + * + * @var string + */ + private $uri = ''; + + /** + * The remote resource we are querying + * + * @var string + */ + private $resource = ''; + + /** + * Query string parameters + * + * @var array + */ + private $parameters = []; + + /** + * Amazon-specific headers to pass to the request + * + * @var array + */ + private $amzHeaders = []; + + /** + * Regular HTTP headers to send in the request + * + * @var array + */ + private $headers = [ + 'Host' => '', + 'Date' => '', + 'Content-MD5' => '', + 'Content-Type' => '', + ]; + + /** + * Input data for the request + * + * @var Input + */ + private $input = null; + + /** + * The file resource we are writing data to + * + * @var resource|null + */ + private $fp = null; + + /** + * The Amazon S3 configuration object + * + * @var Configuration + */ + private $configuration = null; + + /** + * The response object + * + * @var Response + */ + private $response = null; + + /** + * The location of the CA certificate cache. It can be a file or a directory. If it's not specified, the location + * set in AKEEBA_CACERT_PEM will be used + * + * @var string|null + */ + private $caCertLocation = null; + + /** + * Constructor + * + * @param string $verb HTTP verb, e.g. 'POST' + * @param string $bucket Bucket name, e.g. 'example-bucket' + * @param string $uri Object URI + * @param Configuration $configuration The Amazon S3 configuration object to use + * + * @return void + */ + function __construct(string $verb, string $bucket, string $uri, Configuration $configuration) + { + $this->verb = $verb; + $this->bucket = $bucket; + $this->uri = '/'; + $this->configuration = $configuration; + + if (!empty($uri)) + { + $this->uri = '/' . str_replace('%2F', '/', rawurlencode($uri)); + } + + $this->headers['Host'] = $this->getHostName($configuration, $this->bucket); + $this->resource = $this->uri; + + if (($this->bucket !== '') && $configuration->getUseLegacyPathStyle()) + { + $this->resource = '/' . $this->bucket . $this->uri; + + $this->uri = $this->resource; + } + + // The date must always be added as a header + $this->headers['Date'] = gmdate('D, d M Y H:i:s O'); + + // S3-"compatible" services use a different date format. Because why not? + if ($this->configuration->getAlternateDateHeaderFormat() && strpos($this->headers['Host'], '.amazonaws.com') === false) + { + $this->headers['Date'] = gmdate('D, d M Y H:i:s T'); + } + + // If there is a security token we need to set up the X-Amz-Security-Token header + $token = $this->configuration->getToken(); + + if (!empty($token)) + { + $this->setAmzHeader('x-amz-security-token', $token); + } + + // Initialize the response object + $this->response = new Response(); + } + + /** + * Get the input object + * + * @return Input|null + */ + public function getInput(): ?Input + { + return $this->input; + } + + /** + * Set the input object + * + * @param Input $input + * + * @return void + */ + public function setInput(Input $input): void + { + $this->input = $input; + } + + /** + * Set a request parameter + * + * @param string $key The parameter name + * @param string|null $value The parameter value + * + * @return void + */ + public function setParameter(string $key, ?string $value): void + { + $this->parameters[$key] = $value; + } + + /** + * Set a request header + * + * @param string $key The header name + * @param string $value The header value + * + * @return void + */ + public function setHeader(string $key, string $value): void + { + $this->headers[$key] = $value; + } + + /** + * Set an x-amz-meta-* header + * + * @param string $key The header name + * @param string $value The header value + * + * @return void + */ + public function setAmzHeader(string $key, string $value): void + { + $this->amzHeaders[$key] = $value; + } + + /** + * Get the HTTP verb of this request + * + * @return string + */ + public function getVerb(): string + { + return $this->verb; + } + + /** + * Get the S3 bucket's name + * + * @return string + */ + public function getBucket(): string + { + return $this->bucket; + } + + /** + * Get the absolute URI of the resource we're accessing + * + * @return string + */ + public function getResource(): string + { + return $this->resource; + } + + /** + * Get the parameters array + * + * @return array + */ + public function getParameters(): array + { + return $this->parameters; + } + + /** + * Get the Amazon headers array + * + * @return array + */ + public function getAmzHeaders(): array + { + return $this->amzHeaders; + } + + /** + * Get the other headers array + * + * @return array + */ + public function getHeaders(): array + { + return $this->headers; + } + + /** + * Get a reference to the Amazon configuration object + * + * @return Configuration + */ + public function getConfiguration(): Configuration + { + return $this->configuration; + } + + /** + * Get the file pointer resource (for PUT and POST requests) + * + * @return resource|null + */ + public function &getFp() + { + return $this->fp; + } + + /** + * Set the data resource as a file pointer + * + * @param resource $fp + */ + public function setFp($fp): void + { + $this->fp = $fp; + } + + /** + * Get the certificate authority location + * + * @return string|null + */ + public function getCaCertLocation(): ?string + { + if (!empty($this->caCertLocation)) + { + return $this->caCertLocation; + } + + if (defined('AKEEBA_CACERT_PEM')) + { + return AKEEBA_CACERT_PEM; + } + + return null; + } + + /** + * @param null|string $caCertLocation + */ + public function setCaCertLocation(?string $caCertLocation): void + { + if (empty($caCertLocation)) + { + $caCertLocation = null; + } + + if (!is_null($caCertLocation) && !is_file($caCertLocation) && !is_dir($caCertLocation)) + { + $caCertLocation = null; + } + + $this->caCertLocation = $caCertLocation; + } + + /** + * Get a pre-signed URL for the request. + * + * Typically used to pre-sign GET requests to objects, i.e. give shareable pre-authorized URLs for downloading + * private or otherwise inaccessible files from S3. + * + * @param int|null $lifetime Lifetime in seconds + * @param bool $https Use HTTPS ($hostBucket should be false for SSL verification)? + * + * @return string The authenticated URL, complete with signature + */ + public function getAuthenticatedURL(?int $lifetime = null, bool $https = false): string + { + $this->processParametersIntoResource(); + $signer = Signature::getSignatureObject($this, $this->configuration->getSignatureMethod()); + + return $signer->getAuthenticatedURL($lifetime, $https); + } + + /** + * Get the S3 response + * + * @return Response + */ + public function getResponse(bool $rawResponse = false): Response + { + $this->processParametersIntoResource(); + + $schema = 'http://'; + + if ($this->configuration->isSSL()) + { + $schema = 'https://'; + } + + // Very special case. IF the URI ends in /?location AND the region is us-east-1 (Host is + // s3-external-1.amazonaws.com) THEN the host MUST become s3.amazonaws.com for the request to work. This is case + // of us not knowing the region of the bucket, therefore having to use a special endpoint which lets us query + // the region of the bucket without knowing its region. See + // http://stackoverflow.com/questions/27091816/retrieve-buckets-objects-without-knowing-buckets-region-with-aws-s3-rest-api + if ((substr($this->uri, -10) == '/?location') && ($this->headers['Host'] == 's3-external-1.amazonaws.com')) + { + $this->headers['Host'] = 's3.amazonaws.com'; + } + + $url = $schema . $this->headers['Host'] . $this->uri; + + // Basic setup + $curl = curl_init(); + curl_setopt($curl, CURLOPT_USERAGENT, 'AkeebaBackupProfessional/S3PostProcessor'); + + if ($this->configuration->isSSL()) + { + // Set the CA certificate cache location + $caCert = $this->getCaCertLocation(); + + if (!empty($caCert)) + { + if (is_dir($caCert)) + { + @curl_setopt($curl, CURLOPT_CAPATH, $caCert); + } + else + { + @curl_setopt($curl, CURLOPT_CAINFO, $caCert); + } + } + + /** + * Verify the host name in the certificate and the certificate itself. + * + * Caveat: if your bucket contains dots in the name we have to turn off host verification due to the way the + * S3 SSL certificates are set up. + */ + $isAmazonS3 = (substr($this->headers['Host'], -14) == '.amazonaws.com') + || substr( + $this->headers['Host'], -16 + ) == 'amazonaws.com.cn'; + $tooManyDots = substr_count($this->headers['Host'], '.') > 4; + + $verifyHost = ($isAmazonS3 && $tooManyDots) ? 0 : 2; + + curl_setopt($curl, CURLOPT_SSL_VERIFYHOST, $verifyHost); + curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, true); + } + + curl_setopt($curl, CURLOPT_URL, $url); + + /** + * Set the optional x-amz-date header instead of the standard HTTP Date header. + * + * Amazon S3 proper expects to get the date from the Date header. It also allows you to instead use the optional + * X-Amz-Date header as a means to resolve situations where your HTTP library does not let you control the + * standard Date header. In other words, it accepts both, it encourages the standard Date header, but it will + * give priority to the X-Amz-Date header to help you get out of a sticky situation. + * + * Unfortunately, third party services which claim to be "S3-compatible" are written by people with poor reading + * skills or, more likely, under unrealistic time constraints to deliver working code. They are implementing the + * date handling behaviout wrong. Instead of using the Date header unless the X-Amz-Date header is set, they + * **expect** to only ever see the X-Amz-Date header. If it's missing, they do not fall back to the standard + * Date header; they just spit out a message about the signature being wrong. Wasabi and ExoScale are two prime + * examples of that, and only when using v2 signatures. + * + * To avoid this problem, we are now defaulting to always using the X-Amz-Date header everywhere. If you want to + * revert to using the Date header with S3 proper please use setUseHTTPDateHeader(true) to your configuration + * object. In this case DO NOT set the X-Amz-Date header yourself, or you're going to have a *really* bad time. + */ + if (!$this->configuration->getUseHTTPDateHeader()) + { + $this->amzHeaders['x-amz-date'] = (new \DateTime($this->headers['Date']))->format('Ymd\THis\Z'); + + unset ($this->headers['Date']); + } + + /** + * Remove empty headers. + * + * While Amazon S3 proper and most third party implementations have no problem with that, there a few of them + * (such as Synology C2) which choke on empty headers. + */ + $this->headers = array_filter($this->headers); + + // Get the request signature + $signer = Signature::getSignatureObject($this, $this->configuration->getSignatureMethod()); + $signer->preProcessHeaders($this->headers, $this->amzHeaders); + + // Headers + $headers = []; + + foreach ($this->amzHeaders as $header => $value) + { + if (strlen($value) > 0) + { + $headers[] = $header . ': ' . $value; + } + } + + foreach ($this->headers as $header => $value) + { + if (strlen($value) > 0) + { + $headers[] = $header . ': ' . $value; + } + } + + $headers[] = 'Authorization: ' . $signer->getAuthorizationHeader(); + + curl_setopt($curl, CURLOPT_HTTPHEADER, $headers); + curl_setopt($curl, CURLOPT_HEADER, false); + curl_setopt($curl, CURLOPT_RETURNTRANSFER, false); + curl_setopt($curl, CURLOPT_WRITEFUNCTION, [$this, '__responseWriteCallback']); + curl_setopt($curl, CURLOPT_HEADERFUNCTION, [$this, '__responseHeaderCallback']); + curl_setopt($curl, CURLOPT_FOLLOWLOCATION, true); + + // Request types + switch ($this->verb) + { + case 'GET': + break; + + case 'PUT': + case 'POST': + if (!is_object($this->input) || !($this->input instanceof Input)) + { + $this->input = new Input(); + } + + $size = $this->input->getSize(); + $type = $this->input->getInputType(); + + if ($type == Input::INPUT_DATA) + { + curl_setopt($curl, CURLOPT_CUSTOMREQUEST, $this->verb); + + $data = $this->input->getDataReference(); + + if (strlen($data ?? '')) + { + curl_setopt($curl, CURLOPT_POSTFIELDS, $data); + } + + if ($size > 0) + { + curl_setopt($curl, CURLOPT_BUFFERSIZE, $size); + } + } + else + { + curl_setopt($curl, CURLOPT_PUT, true); + curl_setopt($curl, CURLOPT_INFILE, $this->input->getFp()); + + if ($size > 0) + { + curl_setopt($curl, CURLOPT_INFILESIZE, $size); + } + } + + + break; + + case 'HEAD': + curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'HEAD'); + curl_setopt($curl, CURLOPT_NOBODY, true); + break; + + case 'DELETE': + curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'DELETE'); + break; + + default: + break; + } + + // Execute, grab errors + $this->response->resetBody(); + + if (curl_exec($curl)) + { + $this->response->code = curl_getinfo($curl, CURLINFO_HTTP_CODE); + } + else + { + $this->response->error = new Error( + curl_errno($curl), + curl_error($curl), + $this->resource + ); + } + + @curl_close($curl); + + // Set the body data + $this->response->finaliseBody($rawResponse); + + // Clean up file resources + if (!is_null($this->fp) && is_resource($this->fp)) + { + try + { + @fclose($this->fp); + } + catch (\Throwable $e) + { + } + } + + return $this->response; + } + + + /** + * cURL write callback + * + * @param resource &$curl cURL resource + * @param string &$data Data + * + * @return int Length in bytes + */ + protected function __responseWriteCallback($curl, string $data): int + { + if (in_array($this->response->code, [0, 200, 206]) && !is_null($this->fp) && is_resource($this->fp)) + { + return fwrite($this->fp, $data); + } + + $this->response->addToBody($data); + + return strlen($data); + } + + /** + * cURL header callback + * + * @param resource $curl cURL resource + * @param string &$data Data + * + * @return int Length in bytes + */ + protected function __responseHeaderCallback($curl, string $data): int + { + if (($strlen = strlen($data)) <= 2) + { + return $strlen; + } + + if (substr($data, 0, 4) == 'HTTP') + { + $this->response->code = (int) substr($data, 9, 3); + + return $strlen; + } + + // Ignore malformed headers without a value. + if (strpos($data, ':') === false) + { + return $strlen; + } + + [$header, $value] = explode(':', trim($data), 2); + $header = trim($header ?? ''); + $value = trim($value ?? ''); + + switch (strtolower($header)) + { + case 'last-modified': + $this->response->setHeader('time', strtotime($value)); + break; + + case 'content-length': + $this->response->setHeader('size', (int) $value); + break; + + case 'content-type': + $this->response->setHeader('type', $value); + break; + + case 'etag': + $this->response->setHeader('hash', trim($value, '"')); + break; + + default: + $this->response->setHeader(strtolower($header), is_numeric($value) ? (int) $value : $value); + + if (preg_match('/^x-amz-meta-.*$/', $header)) + { + $this->setHeader($header, is_numeric($value) ? (int) $value : $value); + } + break; + } + + return $strlen; + } + + /** + * Processes $this->parameters as a query string into $this->resource + * + * @return void + */ + private function processParametersIntoResource(): void + { + if (count($this->parameters)) + { + $query = substr($this->uri, -1) !== '?' ? '?' : '&'; + + ksort($this->parameters); + + foreach ($this->parameters as $var => $value) + { + if ($value == null || $value == '') + { + $query .= $var . '&'; + } + else + { + // Parameters must be URL-encoded + $query .= $var . '=' . rawurlencode($value) . '&'; + } + } + + $query = substr($query, 0, -1); + $this->uri .= $query; + + if (array_key_exists('acl', $this->parameters) || array_key_exists('location', $this->parameters) + || array_key_exists('torrent', $this->parameters) + || array_key_exists('logging', $this->parameters) + || array_key_exists('uploads', $this->parameters) + || array_key_exists('uploadId', $this->parameters) + || array_key_exists('partNumber', $this->parameters) + ) + { + $this->resource .= $query; + } + } + } + + /** + * Get the region-specific hostname for an operation given a configuration and a bucket name. This ensures we can + * always use an HTTPS connection, even with buckets containing dots in their names, without SSL certificate host + * name validation issues. + * + * Please note that this requires the pathStyle flag to be set in Configuration because Amazon RECOMMENDS using the + * virtual-hosted style request where applicable. See http://docs.aws.amazon.com/AmazonS3/latest/API/APIRest.html + * Quoting this documentation: + * "Although the path-style is still supported for legacy applications, we recommend using the virtual-hosted style + * where applicable." + * + * @param Configuration $configuration + * @param string $bucket + * + * @return string + */ + private function getHostName(Configuration $configuration, string $bucket): string + { + // http://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region + $endpoint = $configuration->getEndpoint(); + $region = $configuration->getRegion(); + + // If it's a bucket in China we need to use a different endpoint + if (($endpoint == 's3.amazonaws.com') && (substr($region, 0, 3) == 'cn-')) + { + $endpoint = 'amazonaws.com.cn'; + } + + /** + * If there is no bucket we use the default endpoint, whatever it is. For Amazon S3 this format is only used + * when we are making account-level, cross-region requests, e.g. list all buckets. For S3-compatible APIs it + * depends on the API, but generally it's just for listing available buckets. + */ + if (empty($bucket)) + { + return $endpoint; + } + + /** + * Are we using v2 signatures? In this case we use the endpoint defined by the user without translating it. + */ + if ($configuration->getSignatureMethod() != 'v4') + { + // Legacy path style: the hostname is the endpoint + if ($configuration->getUseLegacyPathStyle()) + { + return $endpoint; + } + + // Virtual hosting style: the hostname is the bucket, dot and endpoint. + return $bucket . '.' . $endpoint; + } + + /** + * Only applies to Amazon S3 proper. + * + * When using the Amazon S3 with the v4 signature API we have to use a different hostname per region. The + * mapping can be found in https://docs.aws.amazon.com/general/latest/gr/s3.html#s3_region + * + * This means changing the endpoint to s3.REGION.amazonaws.com with the following exceptions: + * For China: s3.REGION.amazonaws.com.cn + * + * v4 signing does NOT support non-Amazon endpoints. + */ + if (in_array($endpoint, ['s3.amazonaws.com', 'amazonaws.com.cn'])) + { + // Most endpoints: s3-REGION.amazonaws.com + $regionalEndpoint = $region . '.amazonaws.com'; + + // Exception: China + if (substr($region, 0, 3) == 'cn-') + { + // Chinese endpoint, e.g.: s3.cn-north-1.amazonaws.com.cn + $regionalEndpoint = $regionalEndpoint . '.cn'; + } + + // If dual-stack URLs are enabled then prepend the endpoint + if ($configuration->getDualstackUrl()) + { + $endpoint = 's3.dualstack.' . $regionalEndpoint; + } + else + { + $endpoint = 's3.' . $regionalEndpoint; + } + } + + // Legacy path style access: return just the endpoint + if ($configuration->getUseLegacyPathStyle()) + { + return $endpoint; + } + + // Recommended virtual hosting access: bucket, dot, endpoint. + return $bucket . '.' . $endpoint; + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Response.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Response.php new file mode 100644 index 0000000000..56bb5d834f --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Response.php @@ -0,0 +1,351 @@ +<?php +/** + * Akeeba Engine + * + * @package akeebaengine + * @copyright Copyright (c)2006-2024 Nicholas K. Dionysopoulos / Akeeba Ltd + * @license GNU General Public License version 3, or later + */ + +namespace Akeeba\S3; + +use Akeeba\S3\Exception\PropertyNotFound; +use Akeeba\S3\Response\Error; +use SimpleXMLElement; + +// Protection against direct access +defined('AKEEBAENGINE') || die(); + +/** + * Amazon S3 API response object + * + * @property Error $error Response error object + * @property string|SimpleXMLElement|null $body Body data + * @property int $code Response code + * @property array $headers Any headers we may have + */ +class Response +{ + /** + * Error object + * + * @var Error + */ + private $error = null; + + /** + * Response body + * + * @var string|SimpleXMLElement|null + */ + private $body = null; + + /** + * Status code of the response, e.g. 200 for OK, 403 for Forbidden etc + * + * @var int + */ + private $code = 0; + + /** + * Response headers + * + * @var array + */ + private $headers = []; + + /** + * Response constructor. + */ + public function __construct() + { + $this->error = new Error(); + } + + /** + * Is this an error response? + * + * @return bool + */ + public function isError(): bool + { + return is_null($this->error) || $this->error->isError(); + } + + /** + * Does this response have a body? + * + * @return bool + */ + public function hasBody(): bool + { + return !empty($this->body); + } + + /** + * Get the response error object + * + * @return Error + */ + public function getError(): Error + { + return $this->error; + } + + /** + * Set the response error object + * + * @param Error $error + */ + public function setError(Error $error): void + { + $this->error = $error; + } + + /** + * Get the response body + * + * If there is no body set up you get NULL. + * + * If the body is binary data (e.g. downloading a file) or other non-XML data you get a string. + * + * If the body was an XML string – the standard Amazon S3 REST API response type – you get a SimpleXMLElement + * object. + * + * @return string|SimpleXMLElement|null + */ + public function getBody() + { + return $this->body; + } + + /** + * Set the response body. If it's a string we'll try to parse it as XML. + * + * @param string|SimpleXMLElement|null $body + */ + public function setBody($body, bool $rawResponse = false): void + { + $this->body = null; + + if (empty($body)) + { + return; + } + + $this->body = $body; + + $this->finaliseBody($rawResponse); + } + + public function resetBody(): void + { + $this->body = null; + } + + public function addToBody(string $data): void + { + if (empty($this->body)) + { + $this->body = ''; + } + + $this->body .= $data; + } + + public function finaliseBody(bool $rawResponse = false): void + { + if (!$this->hasBody()) + { + return; + } + + if (!isset($this->headers['type'])) + { + $this->headers['type'] = 'text/plain'; + } + + if ( + !$rawResponse + && is_string($this->body) + && + ( + ($this->headers['type'] == 'application/xml') + || (substr($this->body, 0, 5) == '<?xml') + ) + ) + { + $this->body = simplexml_load_string($this->body); + } + + if (is_object($this->body) && ($this->body instanceof SimpleXMLElement)) + { + $this->parseBody(); + } + } + + /** + * Returns the status code of the response + * + * @return int + */ + public function getCode(): int + { + return $this->code; + } + + /** + * Sets the status code of the response + * + * @param int $code + */ + public function setCode(int $code): void + { + $this->code = $code; + } + + /** + * Get the response headers + * + * @return array + */ + public function getHeaders(): array + { + return $this->headers; + } + + /** + * Set the response headers + * + * @param array $headers + */ + public function setHeaders(array $headers): void + { + $this->headers = $headers; + } + + /** + * Set a single header + * + * @param string $name The header name + * @param string $value The header value + * + * @return void + */ + public function setHeader(string $name, string $value): void + { + $this->headers[$name] = $value; + } + + /** + * Does a header by this name exist? + * + * @param string $name The header to look for + * + * @return bool True if it exists + */ + public function hasHeader(string $name): bool + { + return array_key_exists($name, $this->headers); + } + + /** + * Unset a response header + * + * @param string $name The header to unset + * + * @return void + */ + public function unsetHeader(string $name): void + { + if ($this->hasHeader($name)) + { + unset ($this->headers[$name]); + } + } + + /** + * Magic getter for the protected properties + * + * @param string $name + * + * @return mixed + */ + public function __get(string $name) + { + switch ($name) + { + case 'error': + return $this->getError(); + break; + + case 'body': + return $this->getBody(); + break; + + case 'code': + return $this->getCode(); + break; + + case 'headers': + return $this->getHeaders(); + break; + } + + throw new PropertyNotFound("Property $name not found in " . get_class($this)); + } + + /** + * Magic setter for the protected properties + * + * @param string $name The name of the property + * @param mixed $value The value of the property + * + * @return void + */ + public function __set(string $name, $value): void + { + switch ($name) + { + case 'error': + $this->setError($value); + break; + + case 'body': + $this->setBody($value); + break; + + case 'code': + $this->setCode($value); + break; + + case 'headers': + $this->setHeaders($value); + break; + + default: + throw new PropertyNotFound("Property $name not found in " . get_class($this)); + } + } + + /** + * Scans the SimpleXMLElement body for errors and propagates them to the Error object + */ + protected function parseBody(): void + { + if (!in_array($this->code, [200, 204]) && + isset($this->body->Code, $this->body->Message) + ) + { + $this->error = new Error( + 500, + (string) $this->body->Code . ':' . (string) $this->body->Message + ); + + if (isset($this->body->Resource)) + { + $this->error->setResource((string) $this->body->Resource); + } + } + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Response/Error.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Response/Error.php new file mode 100644 index 0000000000..f316b6ae09 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Response/Error.php @@ -0,0 +1,139 @@ +<?php +/** + * Akeeba Engine + * + * @package akeebaengine + * @copyright Copyright (c)2006-2024 Nicholas K. Dionysopoulos / Akeeba Ltd + * @license GNU General Public License version 3, or later + */ + +namespace Akeeba\S3\Response; + +// Protection against direct access +defined('AKEEBAENGINE') || die(); + +/** + * S3 response error object + */ +class Error +{ + /** + * Error code + * + * @var int + */ + private $code = 0; + + /** + * Error message + * + * @var string + */ + private $message = ''; + + /** + * URI to the resource that throws the error + * + * @var string + */ + private $resource = ''; + + /** + * Create a new error object + * + * @param int $code The error code + * @param string $message The error message + * @param string $resource The URI to the resource throwing the error + * + * @return void + */ + function __construct($code = 0, $message = '', $resource = '') + { + $this->setCode($code); + $this->setMessage($message); + $this->setResource($resource); + } + + /** + * Get the error code + * + * @return int + */ + public function getCode(): int + { + return $this->code; + } + + /** + * Set the error code + * + * @param int $code Set to zeroo or a negative value to clear errors + * + * @return void + */ + public function setCode(int $code): void + { + if ($code <= 0) + { + $code = 0; + $this->setMessage(''); + $this->setResource(''); + } + + $this->code = $code; + } + + /** + * Get the error message + * + * @return string + */ + public function getMessage(): string + { + return $this->message; + } + + /** + * Set the error message + * + * @param string $message The error message to set + * + * @return void + */ + public function setMessage(string $message): void + { + $this->message = $message; + } + + /** + * Get the URI of the resource throwing the error + * + * @return string + */ + public function getResource(): string + { + return $this->resource; + } + + /** + * Set the URI of the resource throwing the error + * + * @param string $resource + * + * @return void + */ + public function setResource(string $resource): void + { + $this->resource = $resource; + } + + /** + * Do we actually have an error? + * + * @return bool + */ + public function isError(): bool + { + return ($this->code > 0) || !empty($this->message); + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Signature.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Signature.php new file mode 100644 index 0000000000..a1def56cdd --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Signature.php @@ -0,0 +1,80 @@ +<?php +/** + * Akeeba Engine + * + * @package akeebaengine + * @copyright Copyright (c)2006-2024 Nicholas K. Dionysopoulos / Akeeba Ltd + * @license GNU General Public License version 3, or later + */ + +namespace Akeeba\S3; + +// Protection against direct access +defined('AKEEBAENGINE') || die(); + +/** + * Base class for request signing objects. + */ +abstract class Signature +{ + /** + * The request we will be signing + * + * @var Request + */ + protected $request = null; + + /** + * Signature constructor. + * + * @param Request $request The request we will be signing + */ + public function __construct(Request $request) + { + $this->request = $request; + } + + /** + * Get a signature object for the request + * + * @param Request $request The request which needs signing + * @param string $method The signature method, "v2" or "v4" + * + * @return Signature + */ + public static function getSignatureObject(Request $request, string $method = 'v2'): self + { + $className = __NAMESPACE__ . '\\Signature\\' . ucfirst($method); + + return new $className($request); + } + + /** + * Returns the authorization header for the request + * + * @return string + */ + abstract public function getAuthorizationHeader(): string; + + /** + * Pre-process the request headers before we convert them to cURL-compatible format. Used by signature engines to + * add custom headers, e.g. x-amz-content-sha256 + * + * @param array $headers The associative array of headers to process + * @param array $amzHeaders The associative array of amz-* headers to process + * + * @return void + */ + abstract public function preProcessHeaders(array &$headers, array &$amzHeaders): void; + + /** + * Get a pre-signed URL for the request. Typically used to pre-sign GET requests to objects, i.e. give shareable + * pre-authorized URLs for downloading files from S3. + * + * @param integer|null $lifetime Lifetime in seconds. NULL for default lifetime. + * @param bool $https Use HTTPS ($hostBucket should be false for SSL verification)? + * + * @return string The authenticated URL, complete with signature + */ + abstract public function getAuthenticatedURL(?int $lifetime = null, bool $https = false): string; +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Signature/V2.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Signature/V2.php new file mode 100644 index 0000000000..ef7e7daad0 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Signature/V2.php @@ -0,0 +1,218 @@ +<?php +/** + * Akeeba Engine + * + * @package akeebaengine + * @copyright Copyright (c)2006-2024 Nicholas K. Dionysopoulos / Akeeba Ltd + * @license GNU General Public License version 3, or later + */ + +namespace Akeeba\S3\Signature; + +// Protection against direct access +defined('AKEEBAENGINE') || die(); + +use Akeeba\S3\Signature; + +/** + * Implements the Amazon AWS v2 signatures + * + * @see http://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html + */ +class V2 extends Signature +{ + /** + * Pre-process the request headers before we convert them to cURL-compatible format. Used by signature engines to + * add custom headers, e.g. x-amz-content-sha256 + * + * @param array $headers The associative array of headers to process + * @param array $amzHeaders The associative array of amz-* headers to process + * + * @return void + */ + public function preProcessHeaders(array &$headers, array &$amzHeaders): void + { + // No pre-processing required for V2 signatures + } + + /** + * Get a pre-signed URL for the request. Typically used to pre-sign GET requests to objects, i.e. give shareable + * pre-authorized URLs for downloading files from S3. + * + * @param integer|null $lifetime Lifetime in seconds. NULL for default lifetime. + * @param bool $https Use HTTPS ($hostBucket should be false for SSL verification)? + * + * @return string The presigned URL + */ + public function getAuthenticatedURL(?int $lifetime = null, bool $https = false): string + { + // Set the Expires header + if (is_null($lifetime)) + { + $lifetime = 10; + } + + $expires = time() + $lifetime; + $this->request->setHeader('Expires', $expires); + + $bucket = $this->request->getBucket(); + $uri = $this->request->getResource(); + $headers = $this->request->getHeaders(); + $accessKey = $this->request->getConfiguration()->getAccess(); + $protocol = $https ? 'https' : 'http'; + $signature = $this->getAuthorizationHeader(); + + $search = '/' . $bucket; + + // This does not look right... The bucket name must be included in the URL. +// if (strpos($uri, $search) === 0) +// { +// $uri = substr($uri, strlen($search)); +// } + + $queryParameters = array_merge($this->request->getParameters(), [ + 'AWSAccessKeyId' => $accessKey, + 'Expires' => sprintf('%u', $expires), + 'Signature' => $signature, + ]); + + $query = http_build_query($queryParameters); + + // fix authenticated url for Google Cloud Storage - https://cloud.google.com/storage/docs/access-control/create-signed-urls-program + if ($this->request->getConfiguration()->getEndpoint() === "storage.googleapis.com") + { + // replace host with endpoint + $headers['Host'] = 'storage.googleapis.com'; + // replace "AWSAccessKeyId" with "GoogleAccessId" + $query = str_replace('AWSAccessKeyId', 'GoogleAccessId', $query); + // add bucket to url + $uri = '/' . $bucket . $uri; + } + + $url = $protocol . '://' . $headers['Host'] . $uri; + $url .= (strpos($uri, '?') !== false) ? '&' : '?'; + $url .= $query; + + return $url; + } + + /** + * Returns the authorization header for the request + * + * @return string + */ + public function getAuthorizationHeader(): string + { + $verb = strtoupper($this->request->getVerb()); + $resourcePath = $this->request->getResource(); + $headers = $this->request->getHeaders(); + $amzHeaders = $this->request->getAmzHeaders(); + $parameters = $this->request->getParameters(); + $bucket = $this->request->getBucket(); + $isPresignedURL = false; + + $amz = []; + $amzString = ''; + + // Collect AMZ headers for signature + foreach ($amzHeaders as $header => $value) + { + if (strlen($value) > 0) + { + $amz[] = strtolower($header) . ':' . $value; + } + } + + // AMZ headers must be sorted and sent as separate lines + if (count($amz) > 0) + { + sort($amz); + $amzString = "\n" . implode("\n", $amz); + } + + // If the Expires query string parameter is set up we're pre-signing a download URL. The string to sign is a bit + // different in this case; it does not include the Date, it includes the Expires. + // See http://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html#RESTAuthenticationQueryStringAuth + if (isset($headers['Expires'])) + { + if (isset($headers['Date'])) + { + $headers['Date'] = $headers['Expires']; + } + else + { + $amzHeaders['x-amz-date'] = $headers['Expires']; + } + + unset ($headers['Expires']); + + $isPresignedURL = true; + } + + /** + * The resource path in S3 V2 signatures must ALWAYS contain the bucket name if a bucket is defined, even if we + * are not using path-style access to the resource + */ + if (!empty($bucket) && !$this->request->getConfiguration()->getUseLegacyPathStyle()) + { + $resourcePath = '/' . $bucket . $resourcePath; + } + + $stringToSign = $verb . "\n" . + ($headers['Content-MD5'] ?? '') . "\n" . + ($headers['Content-Type'] ?? '') . "\n" . + ($headers['Date'] ?? '') . + $amzString . "\n" . + $resourcePath; + + // CloudFront only requires a date to be signed + if ($headers['Host'] == 'cloudfront.amazonaws.com') + { + $stringToSign = $headers['Date'] ?? $amzHeaders['x-amz-date'] ?? ''; + } + + $amazonV2Hash = $this->amazonV2Hash($stringToSign); + + // For presigned URLs we only return the Base64-encoded signature without the AWS format specifier and the + // public access key. + if ($isPresignedURL) + { + return $amazonV2Hash; + } + + return 'AWS ' . + $this->request->getConfiguration()->getAccess() . ':' . + $amazonV2Hash; + } + + /** + * Creates a HMAC-SHA1 hash. Uses the hash extension if present, otherwise falls back to slower, manual calculation. + * + * @param string $stringToSign String to sign + * + * @return string + */ + private function amazonV2Hash(string $stringToSign): string + { + $secret = $this->request->getConfiguration()->getSecret(); + + if (extension_loaded('hash')) + { + $raw = hash_hmac('sha1', $stringToSign, $secret, true); + + return base64_encode($raw); + } + + $raw = pack('H*', sha1( + (str_pad($secret, 64, chr(0x00)) ^ (str_repeat(chr(0x5c), 64))) . + pack('H*', sha1( + (str_pad($secret, 64, chr(0x00)) ^ (str_repeat(chr(0x36), 64))) . $stringToSign + ) + ) + ) + ); + + return base64_encode($raw); + } + +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Signature/V4.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Signature/V4.php new file mode 100644 index 0000000000..daf27afc15 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/Signature/V4.php @@ -0,0 +1,539 @@ +<?php +/** + * Akeeba Engine + * + * @package akeebaengine + * @copyright Copyright (c)2006-2024 Nicholas K. Dionysopoulos / Akeeba Ltd + * @license GNU General Public License version 3, or later + */ + +namespace Akeeba\S3\Signature; + +// Protection against direct access +defined('AKEEBAENGINE') || die(); + +use Akeeba\S3\Signature; +use DateTime; + +/** + * Implements the Amazon AWS v4 signatures + * + * @see http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html + */ +class V4 extends Signature +{ + /** + * Pre-process the request headers before we convert them to cURL-compatible format. Used by signature engines to + * add custom headers, e.g. x-amz-content-sha256 + * + * @param array $headers The associative array of headers to process + * @param array $amzHeaders The associative array of amz-* headers to process + * + * @return void + */ + public function preProcessHeaders(array &$headers, array &$amzHeaders): void + { + // Do we already have an SHA-256 payload hash? + if (isset($amzHeaders['x-amz-content-sha256'])) + { + return; + } + + // Set the payload hash header + $input = $this->request->getInput(); + + if (is_object($input)) + { + $requestPayloadHash = $input->getSha256(); + } + else + { + $requestPayloadHash = hash('sha256', '', false); + } + + $amzHeaders['x-amz-content-sha256'] = $requestPayloadHash; + } + + /** + * Get a pre-signed URL for the request. Typically used to pre-sign GET requests to objects, i.e. give shareable + * pre-authorized URLs for downloading files from S3. + * + * @param integer|null $lifetime Lifetime in seconds. NULL for default lifetime. + * @param bool $https Use HTTPS ($hostBucket should be false for SSL verification)? + * + * @return string The presigned URL + */ + public function getAuthenticatedURL(?int $lifetime = null, bool $https = false): string + { + // Set the Expires header + if (is_null($lifetime)) + { + $lifetime = 10; + } + + /** + * Authenticated URLs must always go through the generic regional endpoint, not the virtual hosting-style domain + * name. This means that if you have a bucket "example" in the EU West 1 (Ireland) region we have to go through + * http://s3-eu-west-1.amazonaws.com/example instead of http://example.amazonaws.com/ for all authenticated URLs + */ + $region = $this->request->getConfiguration()->getRegion(); + $bucket = $this->request->getBucket(); + $hostname = $this->getPresignedHostnameForRegion($region); + + if (!$this->request->getConfiguration()->getPreSignedBucketInURL() && $this->isValidBucketName($bucket)) + { + $hostname = $bucket . '.' . $hostname; + } + + $this->request->setHeader('Host', $hostname); + + // Set the expiration time in seconds + $this->request->setHeader('Expires', (int) $lifetime); + + // Get the query parameters, including the calculated signature + $uri = $this->request->getResource(); + $headers = $this->request->getHeaders(); + $protocol = $https ? 'https' : 'http'; + $serialisedParams = $this->getAuthorizationHeader(); + + // The query parameters are returned serialized; unserialize them, then build and return the URL. + $queryParameters = unserialize($serialisedParams); + + // This should be toggleable + if ( + !$this->request->getConfiguration()->getPreSignedBucketInURL() + && $this->isValidBucketName($bucket) + && strpos($uri, '/' . $bucket) === 0) + { + $uri = substr($uri, strlen($bucket) + 1); + } + + $query = http_build_query($queryParameters); + + $url = $protocol . '://' . $headers['Host'] . $uri; + $url .= (strpos($uri, '?') !== false) ? '&' : '?'; + $url .= $query; + + return $url; + } + + /** + * Returns the authorization header for the request + * + * @return string + */ + public function getAuthorizationHeader(): string + { + $verb = strtoupper($this->request->getVerb()); + $resourcePath = $this->request->getResource(); + $headers = $this->request->getHeaders(); + $amzHeaders = $this->request->getAmzHeaders(); + $parameters = $this->request->getParameters(); + $bucket = $this->request->getBucket(); + $isPresignedURL = false; + + // See the Connector class for the explanation behind this ugly workaround + $amazonIsBraindead = isset($headers['workaround-braindead-error-from-amazon']); + + if ($amazonIsBraindead) + { + unset ($headers['workaround-braindead-error-from-amazon']); + } + + // Get the credentials scope + $signatureDate = new DateTime($headers['Date'] ?? $amzHeaders['x-amz-date']); + + $credentialScope = $signatureDate->format('Ymd') . '/' . + $this->request->getConfiguration()->getRegion() . '/' . + 's3/aws4_request'; + + /** + * If the Expires header is set up we're pre-signing a download URL. The string to sign is a bit + * different in this case and we have to pass certain headers as query string parameters. + * + * @see http://docs.aws.amazon.com/general/latest/gr/sigv4-create-string-to-sign.html + */ + if (isset($headers['Expires'])) + { + $gmtDate = clone $signatureDate; + $gmtDate->setTimezone(new \DateTimeZone('GMT')); + + $parameters['X-Amz-Algorithm'] = "AWS4-HMAC-SHA256"; + $parameters['X-Amz-Credential'] = $this->request->getConfiguration()->getAccess() . '/' . $credentialScope; + $parameters['X-Amz-Date'] = $gmtDate->format('Ymd\THis\Z'); + $parameters['X-Amz-Expires'] = sprintf('%u', $headers['Expires']); + $token = $this->request->getConfiguration()->getToken(); + + if (!empty($token)) + { + $parameters['x-amz-security-token'] = $token; + } + + unset($headers['Expires']); + unset($headers['Date']); + unset($headers['Content-MD5']); + unset($headers['Content-Type']); + + $isPresignedURL = true; + } + + // ========== Step 1: Create a canonical request ========== + // See http://docs.aws.amazon.com/general/latest/gr/sigv4-create-canonical-request.html + + $canonicalHeaders = ""; + $signedHeadersArray = []; + + // Calculate the canonical headers and the signed headers + if ($isPresignedURL) + { + // Presigned URLs use UNSIGNED-PAYLOAD instead + unset($amzHeaders['x-amz-content-sha256']); + } + + $allHeaders = array_merge($headers, $amzHeaders); + ksort($allHeaders); + + foreach ($allHeaders as $k => $v) + { + $lowercaseHeaderName = strtolower($k); + + if ($amazonIsBraindead && ($lowercaseHeaderName == 'content-length')) + { + /** + * I know it looks crazy. It is. Somehow Amazon requires me to do this and only on _some_ servers, mind + * you. This is something undocumented and which is not covered by their official SDK. I had to write + * my own library because of that and the official SDK's inability to upload large files without using + * at least as much memory as the file itself (which doesn't fly well for files around 2Gb, let me tell + * you that!). + */ + $v = "$v,$v"; + } + + $canonicalHeaders .= $lowercaseHeaderName . ':' . trim($v) . "\n"; + $signedHeadersArray[] = $lowercaseHeaderName; + } + + $signedHeaders = implode(';', $signedHeadersArray); + + if ($isPresignedURL) + { + $parameters['X-Amz-SignedHeaders'] = $signedHeaders; + } + + // The canonical URI is the resource path + $canonicalURI = $resourcePath; + $bucketResource = '/' . $bucket . '/'; + $regionalHostname = ($headers['Host'] != 's3.amazonaws.com') + && ($headers['Host'] != $bucket . '.s3.amazonaws.com'); + + /** + * Yet another special case for third party, S3-compatible services, when using pre-signed URLs. + * + * Given a bucket `example` and filepath `foo/bar.txt` the canonical URI to sign is supposed to be + * /example/foo/bar.txt regardless of whether we are using path style or subdomain hosting style access to the + * bucket. + * + * When calculating a pre-signed URL, the URL we will be accessing will be something to the tune of + * example.endpoint.com/foo/bar.txt. Amazon S3 proper allows us to use EITHER the nominal canonical URI + * /foo/bar.txt OR the /example/foo/bar.txt canonical URI for consistency. Some third party providers, like + * Wasabi, will choke on the former and complain about the signature being invalid. + * + * To address this issue we check if all the following conditions are met: + * - We are calculating a signature for a pre-signed URL. + * - The service is NOT Amazon S3 proper. + * - The domain name starts with the bucket name. + * In this case, and this case only, we set $regionalHostname to false. This triggers an if-block further down + * which strips the `/bucketName/` prefix from the canonical URI, converting it to `/`. Therefore, the canonical + * URI in the signature becomes the nominal URI we will be accessing in the bucket, solving the problem with + * those third party services. + */ + // Figuring out whether it's a regional hostname DOES NOT work above if it's not AWS S3 proper. Let's fix that. + if ($isPresignedURL && strpos($headers['Host'], 'amazonaws.com') === false && !strpos($headers['Host'], $bucket . '.')) + { + $regionalHostname = false; + } + + // Special case: if the canonical URI ends in /?location the bucket name DOES count as part of the canonical URL + // even though the Host is s3.amazonaws.com (in which case it normally shouldn't count). Yeah, I know, it makes + // no sense!!! + if (!$regionalHostname && ($headers['Host'] == 's3.amazonaws.com') + && (substr($canonicalURI, -10) == '/?location')) + { + $regionalHostname = true; + } + + if (!$regionalHostname && (strpos($canonicalURI, $bucketResource) === 0 || strpos($canonicalURI, substr($bucketResource, 0, -1)) === 0)) + { + if ($canonicalURI === substr($bucketResource, 0, -1)) + { + $canonicalURI = '/'; + } + else + { + $canonicalURI = substr($canonicalURI, strlen($bucketResource) - 1); + } + } + + // If the resource path has a query yank it and parse it into the parameters array + $questionMarkPos = strpos($canonicalURI, '?'); + + if ($questionMarkPos !== false) + { + $canonicalURI = substr($canonicalURI, 0, $questionMarkPos); + $queryString = @substr($canonicalURI, $questionMarkPos + 1); + @parse_str($queryString, $extraQuery); + + if (count($extraQuery)) + { + $parameters = array_merge($parameters, $extraQuery); + } + } + + // The canonical query string is the string representation of $parameters, alpha sorted by key + ksort($parameters); + + // We build the query the hard way because http_build_query in PHP 5.3 does NOT have the fourth parameter + // (encoding type), defaulting to RFC 1738 encoding whereas S3 expects RFC 3986 encoding + $canonicalQueryString = ''; + + if (!empty($parameters)) + { + $temp = []; + + foreach ($parameters as $k => $v) + { + $temp[] = $this->urlencode($k) . '=' . $this->urlencode($v); + } + + $canonicalQueryString = implode('&', $temp); + } + + // Get the payload hash + $requestPayloadHash = 'UNSIGNED-PAYLOAD'; + + if (isset($amzHeaders['x-amz-content-sha256'])) + { + $requestPayloadHash = $amzHeaders['x-amz-content-sha256']; + } + + // Calculate the canonical request + $canonicalRequest = $verb . "\n" . + $canonicalURI . "\n" . + $canonicalQueryString . "\n" . + $canonicalHeaders . "\n" . + $signedHeaders . "\n" . + $requestPayloadHash; + + $hashedCanonicalRequest = hash('sha256', $canonicalRequest); + + // ========== Step 2: Create a string to sign ========== + // See http://docs.aws.amazon.com/general/latest/gr/sigv4-create-string-to-sign.html + + if (!isset($headers['Date'])) + { + $headers['Date'] = ''; + } + + /** + * The Date in the String-to-Sign is a messy situation. + * + * Amazon's documentation says it must be in ISO 8601 format: `Ymd\THis\Z`. Unfortunately, Amazon's + * documentation is actually wrong :troll_face: The actual Amazon S3 service expects the date to be formatted as + * per RFC1123. + * + * Most third party implementations have caught up to the fact that Amazon has documented the v4 signatures + * wrongly (naughty AWS!) and accept either format. + * + * Some other third party implementations, which never bothered to validate their implementations against Amazon + * S3 proper, only expect what Amazon has documented as "ISO 8601". Therefore, we detect third party services + * and switch to the as-documented date format. + * + * Some other third party services, like Wasabi, are broken in yet a different way. They will only use the date + * from the x-amz-date header, WITHOUT falling back to the Date header if the former is not present. This is + * the opposite of Amazon S3 proper which does expect the Date header. That's why the Request class sets both + * headers if the request is made to a service _other_ than Amazon S3 proper. + */ + $dateToSignFor = strpos($headers['Host'], '.amazonaws.com') !== false + ? (($headers['Date'] ?? null) ?: ($amzHeaders['x-amz-date'] ?? null) ?: $signatureDate->format('Ymd\THis\Z')) + : $signatureDate->format('Ymd\THis\Z'); + + $stringToSign = "AWS4-HMAC-SHA256\n" . + $dateToSignFor . "\n" . + $credentialScope . "\n" . + $hashedCanonicalRequest; + + if ($isPresignedURL) + { + $stringToSign = "AWS4-HMAC-SHA256\n" . + $parameters['X-Amz-Date'] . "\n" . + $credentialScope . "\n" . + $hashedCanonicalRequest; + } + + // ========== Step 3: Calculate the signature ========== + // See http://docs.aws.amazon.com/general/latest/gr/sigv4-calculate-signature.html + $kSigning = $this->getSigningKey($signatureDate); + + $signature = hash_hmac('sha256', $stringToSign, $kSigning, false); + + // ========== Step 4: Add the signing information to the Request ========== + // See http://docs.aws.amazon.com/general/latest/gr/sigv4-add-signature-to-request.html + + $authorization = 'AWS4-HMAC-SHA256 Credential=' . + $this->request->getConfiguration()->getAccess() . '/' . $credentialScope . ', ' . + 'SignedHeaders=' . $signedHeaders . ', ' . + 'Signature=' . $signature; + + // For presigned URLs we only return the Base64-encoded signature without the AWS format specifier and the + // public access key. + if ($isPresignedURL) + { + $parameters['X-Amz-Signature'] = $signature; + + return serialize($parameters); + } + + return $authorization; + } + + /** + * Calculate the AWS4 signing key + * + * @param DateTime $signatureDate The date the signing key is good for + * + * @return string + */ + private function getSigningKey(DateTime $signatureDate): string + { + $kSecret = $this->request->getConfiguration()->getSecret(); + $kDate = hash_hmac('sha256', $signatureDate->format('Ymd'), 'AWS4' . $kSecret, true); + $kRegion = hash_hmac('sha256', $this->request->getConfiguration()->getRegion(), $kDate, true); + $kService = hash_hmac('sha256', 's3', $kRegion, true); + $kSigning = hash_hmac('sha256', 'aws4_request', $kService, true); + + return $kSigning; + } + + private function urlencode(?string $toEncode): string + { + if (empty($toEncode)) + { + return ''; + } + + return str_replace('+', '%20', urlencode($toEncode)); + } + + /** + * Get the correct hostname for the given AWS region + * + * @param string $region + * + * @return string + */ + private function getPresignedHostnameForRegion(string $region): string + { + $config = $this->request->getConfiguration(); + $endpoint = $config->getEndpoint(); + + if (empty($endpoint)) + { + $endpoint = 's3.' . $region . '.amazonaws.com'; + } + + // As of October 2023, AWS does not consider DualStack signed URLs as valid. Whatever. + $dualstackEnabled = false && $this->request->getConfiguration()->getDualstackUrl(); + + // If dual-stack URLs are enabled then prepend the endpoint + if ($dualstackEnabled) + { + $endpoint = 's3.dualstack.' . $region . '.amazonaws.com'; + } + + if ($region == 'cn-north-1') + { + return $endpoint . '.cn'; + } + + return $endpoint; + } + + /** + * Is this a valid bucket name? + * + * @param string $bucketName The bucket name to check + * @param bool $asSubdomain Should I put additional restrictions for use as a subdomain? + * + * @return bool + * @since 2.3.1 + * + * @see https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html + */ + private function isValidBucketName(string $bucketName, bool $asSubdomain = true): bool + { + /** + * If there are dots in the bucket name I can't use it as a subdomain. + * + * "If you include dots in a bucket's name, you can't use virtual-host-style addressing over HTTPS, unless you + * perform your own certificate validation. This is because the security certificates used for virtual hosting + * of buckets don't work for buckets with dots in their names." + */ + if ($asSubdomain && strpos($bucketName, '.') !== false) + { + return false; + } + + /** + * - Bucket names must be between 3 (min) and 63 (max) characters long. + * - Bucket names can consist only of lowercase letters, numbers, dots (.), and hyphens (-). + */ + if (!preg_match('/^[a-z0-9\-.]{3,63}$/', $bucketName)) + { + return false; + } + + // Bucket names must begin and end with a letter or number. + if (!preg_match('/^[a-z0-9].*[a-z0-9]$/', $bucketName)) + { + return false; + } + + // Bucket names must not contain two adjacent periods. + if (preg_match('/\.\./', $bucketName)) + { + return false; + } + + // Bucket names must not be formatted as an IP address (for example, 192.168.5.4). + if (preg_match('/^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$/', $bucketName)) + { + return false; + } + + // Bucket names must not start with the prefix xn--. + if (strpos($bucketName, 'xn--') === 0) + { + return false; + } + + // Bucket names must not start with the prefix sthree- and the prefix sthree-configurator. + if (strpos($bucketName, 'sthree-') === 0) + { + return false; + } + + // Bucket names must not end with the suffix -s3alias. + if (substr($bucketName, -8) === '-s3alias') + { + return false; + } + + // Bucket names must not end with the suffix --ol-s3. + if (substr($bucketName, -7) === '--ol-s3') + { + return false; + } + + return true; + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/StorageClass.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/StorageClass.php new file mode 100644 index 0000000000..91f9bb84a2 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/StorageClass.php @@ -0,0 +1,98 @@ +<?php +/** + * Akeeba Engine + * + * @package akeebaengine + * @copyright Copyright (c)2006-2024 Nicholas K. Dionysopoulos / Akeeba Ltd + * @license GNU General Public License version 3, or later + */ + +namespace Akeeba\S3; + +/** + * Amazon S3 Storage Classes + * + * When you want to override the default storage class of the bucket pass + * array('X-Amz-Storage-Class' => StorageClass::STANDARD) + * in the $headers array of Connector::putObject(). + * + * Alternatively, run the $headers array through setStorageClass(), e.g. + * $headers = array(); // You can put your stuff here + * StorageClass::setStorageClass($headers, StorageClass::STANDARD); + * $connector->putObject($myInput, 'bucketname', 'path/to/object.dat', Acl::PRIVATE, $headers) + * + * @see https://aws.amazon.com/s3/storage-classes/ + */ +class StorageClass +{ + /** + * Amazon S3 Standard (S3 Standard) + */ + public const STANDARD = 'STANDARD'; + + /** + * Reduced redundancy storage + * + * Not recommended anymore. Use INTELLIGENT_TIERING instead. + */ + public const REDUCED_REDUNDANCY = 'REDUCED_REDUNDANCY'; + + /** + * Amazon S3 Intelligent-Tiering (S3 Intelligent-Tiering) + */ + public const INTELLIGENT_TIERING = 'INTELLIGENT_TIERING'; + + /** + * Amazon S3 Standard-Infrequent Access (S3 Standard-IA) + */ + public const STANDARD_IA = 'STANDARD_IA'; + + /** + * Amazon S3 One Zone-Infrequent Access (S3 One Zone-IA) + */ + public const ONEZONE_IA = 'ONEZONE_IA'; + + /** + * Amazon S3 Glacier (S3 Glacier) + */ + public const GLACIER = 'GLACIER'; + + /** + * Amazon S3 Glacier Deep Archive (S3 Glacier Deep Archive) + */ + public const DEEP_ARCHIVE = 'DEEP_ARCHIVE'; + + /** + * Manipulate the $headers array, setting the X-Amz-Storage-Class header for the requested storage class. + * + * This method will automatically remove any previously set X-Amz-Storage-Class header, case-insensitive. The reason + * for that is that Amazon headers **are** case-insensitive and you could easily end up having two separate headers + * with competing storage classes. This would mess up the signature and your request would promptly fail. + * + * @param array $headers + * @param string $storageClass + * + * @return void + */ + public static function setStorageClass(array &$headers, string $storageClass): void + { + // Remove all previously set X-Amz-Storage-Class headers (case-insensitive) + $killList = []; + + foreach ($headers as $key => $value) + { + if (strtolower($key) === 'x-amz-storage-class') + { + $killList[] = $key; + } + } + + foreach ($killList as $key) + { + unset($headers[$key]); + } + + // Add the new X-Amz-Storage-Class header + $headers['X-Amz-Storage-Class'] = $storageClass; + } +} \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/aliasing.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/aliasing.php new file mode 100644 index 0000000000..f5a1189797 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/akeeba/s3/src/aliasing.php @@ -0,0 +1,35 @@ +<?php +/** + * Akeeba Engine + * + * @package akeebaengine + * @copyright Copyright (c)2006-2024 Nicholas K. Dionysopoulos / Akeeba Ltd + * @license GNU General Public License version 3, or later + */ + +/** + * Automatic aliasing of the old namespace to the new, as you use each old class. + */ +spl_autoload_register( + static function (string $className) + { + $oldNS = 'Akeeba\Engine\Postproc\Connector\S3v4'; + $newNS = 'Akeeba\S3'; + + $className = trim($className, '\\'); + + if (strpos($className, $oldNS) !== 0) + { + return false; + } + + $newClassName = $newNS . '\\' . trim(substr($className, strlen($oldNS)), '\\'); + + if (class_exists($newClassName, true)) + { + class_alias($newClassName, $className, false); + } + + return true; + } +); diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/autoload.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/autoload.php new file mode 100644 index 0000000000..bab64e642c --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/autoload.php @@ -0,0 +1,7 @@ +<?php + +// autoload.php @generated by Composer + +require_once __DIR__ . '/composer/autoload_real.php'; + +return ComposerAutoloaderInit03a8066c470486be30535b543d47f96a::getLoader(); diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/bin/lessc b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/bin/lessc new file mode 100755 index 0000000000..8def1ea729 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/bin/lessc @@ -0,0 +1,200 @@ +#!/usr/bin/env php +<?php + +require_once __DIR__ . '/../lib/Less/Autoloader.php'; +Less_Autoloader::register(); + +// Create our environment +$env = array('compress' => false, 'relativeUrls' => false); +$silent = false; +$watch = false; +$rootpath = ''; + +// Check for arguments +array_shift($argv); +if (!count($argv)) { + $argv[] = '-h'; +} + +// parse arguments +foreach ($argv as $key => $arg) { + if (preg_match('/^--?([a-z][0-9a-z-]*)(?:=([^\s]+))?$/i', $arg, $matches)) { + $option = $matches[1]; + $value = isset($matches[2]) ? $matches[2] : false; + unset($argv[$key]); + + switch ($option) { + case 'h': + case 'help': + echo <<<EOD +Usage: lessc [options] sources [destination] + + -h, --help Print help (this message) and exit. + -s, --silent Suppress output of error messages. + -v, --version Print version number and exit. + -x, --compress Compress output by removing some whitespaces. + --include-path=PATHS Set include paths. Separated by `:'. Use `;' on Windows. + --strict-imports Force evaluation of imports. + -m=, --math= + always Less will eagerly perform math operations always. + parens-division Math performed except for division (/) operator + parens | strict Math only performed inside parentheses'); + -su=on|off Allow mixed units, e.g. 1px+1em or 1px*1px which have units + --strict-units=on|off that cannot be represented. + -ru, --relative-urls re-write relative urls to the base less file. + -rp, --rootpath=URL Set rootpath for url rewriting in relative imports and urls. + Works with or without the relative-urls option. + -w, --watch Watch input files for changes. + -------------------------- Deprecated ---------------- + -sm=on|off Legacy parens-only math. Use --math instead. + --strict-math=on|off + +EOD; + exit; + case 's': + case 'silent': + $silent = true; + break; + + case 'w': + case 'watch': + $watch = true; + break; + + case 'v': + case 'version': + echo "lessc " . Less_Version::version . " (less.php)\n\n"; + exit; + + case 'rp': + case 'rootpath': + $rootpath = $value; + break; + + + //parser options + case 'compress': + $env['compress'] = true; + break; + + case 'ru': + case 'relative-urls': + $env['relativeUrls'] = true; + break; + + case 'su': + case 'strict-units': + $env['strictUnits'] = ($value === 'on'); + break; + + case 'sm': + case 'strict-math': + fwrite( STDERR, "lessc: The --strict-math option has been deprecated. Use --math=parens\n" ); + $env['strictMath'] = ( $value === "on" ); + break; + + case 'm': + case 'math': + $env['math'] = $value; + break; + + case 'x': + case 'include-path': + $env['import_dirs'] = preg_split('#;|\:#', $value); + break; + + } + } +} + +if (count($argv) > 1) { + $output = array_pop($argv); + $inputs = $argv; +} +else { + $inputs = $argv; + $output = false; +} + +if (!count($inputs)) { + echo("lessc: no input files\n"); + exit; +} + +if ($watch) { + if (!$output) { + echo("lessc: you must specify the output file if --watch is given\n"); + exit; + } + + $lastAction = 0; + + echo("lessc: watching input files\n"); + + while (1) { + clearstatcache(); + + $updated = false; + foreach ($inputs as $input) { + if ($input == '-') { + if (count($inputs) == 1) { + echo("lessc: during watching files is not possible to watch stdin\n"); + exit; + } + else { + continue; + } + } + + if (filemtime($input) > $lastAction) { + $updated = true; + break; + } + } + + if ($updated) { + $lastAction = time(); + $parser = new Less_Parser($env); + foreach ($inputs as $input) { + try { + $parser->parseFile($input, $rootpath); + } + catch (Exception $e) { + echo("lessc: " . $e->getMessage() . " \n"); + continue; // Invalid processing + } + } + + file_put_contents($output, $parser->getCss()); + echo("lessc: output file recompiled\n"); + } + + sleep(1); + } +} +else { + $parser = new Less_Parser($env); + foreach ($inputs as $input) { + if ($input == '-') { + $content = file_get_contents('php://stdin'); + $parser->parse($content); + } + else { + try { + $parser->parseFile($input); + } + catch (Exception $e) { + if (!$silent) { + echo("lessc: " . ((string)$e) . " \n"); + } + } + } + } + + if ($output) { + file_put_contents($output, $parser->getCss()); + } + else { + echo $parser->getCss(); + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Exceptions/APIError.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Exceptions/APIError.php new file mode 100644 index 0000000000..b7be26d86f --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Exceptions/APIError.php @@ -0,0 +1,74 @@ +<?php + +namespace ChargeBee\ChargeBee\Exceptions; + +use Exception; + +class APIError extends Exception +{ + private $httpStatusCode; + private $jsonObject; + private $type; + private $apiErrorCode; + private $param; + private $headers; + public function __construct($httpStatusCode, $jsonObject, $responseHeaders) + { + parent::__construct($jsonObject['message']); + + $this->jsonObject = $jsonObject; + $this->type = isset($jsonObject['type']) ? $jsonObject['type'] : null; + $this->apiErrorCode = $jsonObject['api_error_code']; + $this->param = isset($jsonObject['param']) ? $jsonObject['param'] : null; + $this->httpStatusCode = $httpStatusCode; + $this->headers = $responseHeaders; + } + + public function getHttpStatusCode() + { + return $this->httpStatusCode; + } + + public function getType() + { + return $this->type; + } + + public function getApiErrorCode() + { + return $this->apiErrorCode; + } + + public function getParam() + { + return $this->param; + } + + /** + * This function has been deprecated. Use getHttpStatusCode. + * @deprecated + */ + public function getHttpCode() + { + return $this->httpStatusCode; + } + + /** + * This function has been deprecated. There IO errors are now thrown as + * IOException. + * @deprecated + */ + public function getErrorNo() + { + return 0; + } + + public function getJsonObject() + { + return $this->jsonObject; + } + public function getHeaders() + { + return $this->headers; + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Exceptions/InvalidRequestException.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Exceptions/InvalidRequestException.php new file mode 100644 index 0000000000..a8e7e22bfd --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Exceptions/InvalidRequestException.php @@ -0,0 +1,13 @@ +<?php + +namespace ChargeBee\ChargeBee\Exceptions; + +use ChargeBee\ChargeBee\Exceptions\APIError; + +class InvalidRequestException extends APIError +{ + public function __construct($httpStatusCode, $jsonObject, $responseHeaders) + { + parent::__construct($httpStatusCode, $jsonObject, $responseHeaders); + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Exceptions/OperationFailedException.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Exceptions/OperationFailedException.php new file mode 100644 index 0000000000..872d48f3fd --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Exceptions/OperationFailedException.php @@ -0,0 +1,13 @@ +<?php + +namespace ChargeBee\ChargeBee\Exceptions; + +use ChargeBee\ChargeBee\Exceptions\APIError; + +class OperationFailedException extends APIError +{ + public function __construct($httpStatusCode, $jsonObject, $responseHeaders) + { + parent::__construct($httpStatusCode, $jsonObject, $responseHeaders); + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Exceptions/PaymentException.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Exceptions/PaymentException.php new file mode 100644 index 0000000000..825f8d3e71 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Exceptions/PaymentException.php @@ -0,0 +1,13 @@ +<?php + +namespace ChargeBee\ChargeBee\Exceptions; + +use ChargeBee\ChargeBee\Exceptions\APIError; + +class PaymentException extends APIError +{ + public function __construct($httpStatusCode, $jsonObject, $responseHeaders) + { + parent::__construct($httpStatusCode, $jsonObject, $responseHeaders); + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Guzzle.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Guzzle.php new file mode 100644 index 0000000000..1709bc32e7 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Guzzle.php @@ -0,0 +1,152 @@ +<?php + + +namespace ChargeBee\ChargeBee; + +use ChargeBee\ChargeBee; +use ChargeBee\ChargeBee\Exceptions\IOException; +use ChargeBee\ChargeBee\Exceptions\PaymentException; +use ChargeBee\ChargeBee\Exceptions\OperationFailedException; +use ChargeBee\ChargeBee\Exceptions\InvalidRequestException; +use ChargeBee\ChargeBee\Exceptions\APIError; +use Exception; +use GuzzleHttp\Client; +use GuzzleHttp\Exception\RequestException; + +class Guzzle +{ + public static function utf8($value) { + if (is_string($value)) + return mb_convert_encoding($value, "UTF-8"); + else + return $value; + } + + public static function doRequest($meth, $url, $env, $params = array(), $headers = array()) { + list($response, $httpCode, $responseHeaders) = self::request($meth, $url, $env, $params, $headers); + $respJson = self::processResponse($response, $httpCode, $responseHeaders); + $response = new Response($respJson, $responseHeaders); + return $response; + } + + public static function request($meth, $url, $env, $params, $headers) { + $client = new Client(); + + $opts = array( + 'connect_timeout' => Environment::$connectTimeoutInSecs, + 'timeout' => Environment::$requestTimeoutInSecs, + 'allow_redirects' => true, + 'http_errors' => false + ); + if ($meth == Request::GET) { + if (count($params) > 0) { + $opts['query'] = $params; + } + } else if ($meth == Request::POST) { + $opts['form_params'] = $params; + } else { + throw new Exception("Invalid http method $meth"); + } + $url = self::utf8($env->apiUrl($url)); + + $userAgent = "Chargebee-PHP-Client" . " v" . Version::VERSION; + $httpHeaders = array_merge($headers, ['Accept' => 'application/json', 'User-Agent' => $userAgent, 'Lang-Version' => phpversion() , 'OS-Version' => PHP_OS]); + + $opts['headers'] = $httpHeaders; + $opts['auth'] = [$env->getApiKey(), '']; + + // Specifying a CA bundle results in the following error when running in Google App Engine: + // "Unsupported SSL context options are set. The following options are present, but have been ignored: allow_self_signed, cafile" + // https://cloud.google.com/appengine/docs/php/outbound-requests#secure_connections_and_https + $opts['verify'] = ChargeBee::getVerifyCaCerts() && !self::isAppEngine() ? ChargeBee::getCaCertPath() : false; + + $response = null; + try { + $response = $client->request($meth, $url, $opts); + } catch (RequestException $e) { + $errno = $e->getCode(); + $guzzleMsg = $e->getMessage(); + $message = "IO exception occurred when trying to connect to " . $url . " . Reason : " . $guzzleMsg; + throw new IOException($message, $errno); + } + $responseHeaders = $response->getHeaders(); + $httpCode = $response->getStatusCode(); + return array((string)$response->getBody(), $httpCode, $responseHeaders); + } + + /** + * Recommended way to check if script is running in Google App Engine: + * https://github.com/google/google-api-php-client/blob/master/src/Google/Client.php#L799 + * + * @return bool Returns true if running in Google App Engine + */ + private static function isAppEngine() { + return (isset($_SERVER['SERVER_SOFTWARE']) && strpos($_SERVER['SERVER_SOFTWARE'], 'Google App Engine') !== false); + } + + /** + * @param $response + * @param $httpCode + * + * @return mixed + * @throws APIError + * @throws InvalidRequestException + * @throws OperationFailedException + * @throws PaymentException + */ + public static function processResponse($response, $httpCode, $responseHeaders){ + $respJson = json_decode($response, true); + if(!$respJson){ + if (strpos($response, '503') !== false) + throw new Exception("Sorry, the server is currently unable to handle the request due to a temporary overload or scheduled maintenance. Please retry after sometime. \n type: internal_temporary_error, \n http_status_code: 503, \n error_code: internal_temporary_error"); + else if (strpos($response, '504') !== false) + throw new Exception("The server did not receive a timely response from an upstream server, request aborted. If this problem persists, contact us at support@chargebee.com. \n type: gateway_timeout, \n http_status_code: 504, \n error_code: gateway_timeout"); + else + throw new Exception("Sorry, something went wrong when trying to process the request. If this problem persists, contact us at support@chargebee.com. \n type: internal_error, \n http_status_code: 500, \n error_code: internal_error "); + } + if ($httpCode < 200 || $httpCode > 299) { + self::handleAPIRespError($httpCode, $respJson, $response, $responseHeaders); + } + return $respJson; + } + + /** + * @param $httpCode + * @param $respJson + * @param $response + * + * @throws APIError + * @throws InvalidRequestException + * @throws OperationFailedException + * @throws PaymentException + */ + public static function handleAPIRespError($httpCode, $respJson, $response, $responseHeaders){ + if (!isset($respJson['api_error_code'])) { + throw new Exception("No api_error_code attribute in content. Probably not a ChargeBee's error response. The content is \n " . $response); + } + $type = "unknown"; + if (isset($respJson['type'])) { + $type = $respJson['type']; + } + if ($type == "payment") { + throw new PaymentException($httpCode, $respJson, $responseHeaders); + } elseif ($type == "operation_failed") { + throw new OperationFailedException($httpCode, $respJson, $responseHeaders); + } elseif ($type == "invalid_request") { + throw new InvalidRequestException($httpCode, $respJson, $responseHeaders); + } else { + throw new APIError($httpCode, $respJson, $responseHeaders); + } + } + +} + +class Response { + public $data; + public $headers; + + public function __construct($data, $headers) { + $this->data = $data; + $this->headers = $headers; + } +} \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/Addon.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/Addon.php new file mode 100644 index 0000000000..1cd2628f15 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/Addon.php @@ -0,0 +1,101 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; +use ChargeBee\ChargeBee\Request; +use ChargeBee\ChargeBee\Util; + +class Addon extends Model +{ + + protected $allowed = [ + 'id', + 'name', + 'invoiceName', + 'description', + 'pricingModel', + 'type', + 'chargeType', + 'price', + 'currencyCode', + 'period', + 'periodUnit', + 'unit', + 'status', + 'archivedAt', + 'enabledInPortal', + 'taxCode', + 'hsnCode', + 'taxjarProductCode', + 'avalaraSaleType', + 'avalaraTransactionType', + 'avalaraServiceType', + 'sku', + 'accountingCode', + 'accountingCategory1', + 'accountingCategory2', + 'accountingCategory3', + 'accountingCategory4', + 'isShippable', + 'shippingFrequencyPeriod', + 'shippingFrequencyPeriodUnit', + 'resourceVersion', + 'updatedAt', + 'priceInDecimal', + 'includedInMrr', + 'channel', + 'prorationType', + 'invoiceNotes', + 'taxable', + 'taxProfileId', + 'metaData', + 'tiers', + 'taxProvidersFields', + 'showDescriptionInInvoices', + 'showDescriptionInQuotes', + ]; + + + + # OPERATIONS + #----------- + + public static function create($params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("addons"), $params, $env, $headers); + } + + public static function update($id, $params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("addons",$id), $params, $env, $headers); + } + + public static function all($params = array(), $env = null, $headers = array()) + { + return Request::sendListRequest(Request::GET, Util::encodeURIPath("addons"), $params, $env, $headers); + } + + public static function retrieve($id, $env = null, $headers = array()) + { + return Request::send(Request::GET, Util::encodeURIPath("addons",$id), array(), $env, $headers); + } + + public static function delete($id, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("addons",$id,"delete"), array(), $env, $headers); + } + + public static function copy($params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("addons","copy"), $params, $env, $headers); + } + + public static function unarchive($id, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("addons",$id,"unarchive"), array(), $env, $headers); + } + + } + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/AddonTaxProvidersField.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/AddonTaxProvidersField.php new file mode 100644 index 0000000000..28149b6f2d --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/AddonTaxProvidersField.php @@ -0,0 +1,17 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; + +class AddonTaxProvidersField extends Model +{ + protected $allowed = [ + 'providerName', + 'fieldId', + 'fieldValue', + ]; + +} + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/Attribute.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/Attribute.php new file mode 100644 index 0000000000..24dc2fa040 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/Attribute.php @@ -0,0 +1,24 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; +use ChargeBee\ChargeBee\Request; +use ChargeBee\ChargeBee\Util; + +class Attribute extends Model +{ + + protected $allowed = [ + 'name', + 'value', + ]; + + + + # OPERATIONS + #----------- + + } + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/BusinessEntity.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/BusinessEntity.php new file mode 100644 index 0000000000..3203181391 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/BusinessEntity.php @@ -0,0 +1,39 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; +use ChargeBee\ChargeBee\Request; +use ChargeBee\ChargeBee\Util; + +class BusinessEntity extends Model +{ + + protected $allowed = [ + 'id', + 'name', + 'status', + 'deleted', + 'createdAt', + 'resourceVersion', + 'updatedAt', + ]; + + + + # OPERATIONS + #----------- + + public static function createTransfers($params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("business_entities","transfers"), $params, $env, $headers); + } + + public static function getTransfers($params = array(), $env = null, $headers = array()) + { + return Request::send(Request::GET, Util::encodeURIPath("business_entities","transfers"), $params, $env, $headers); + } + + } + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/BusinessEntityTransfer.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/BusinessEntityTransfer.php new file mode 100644 index 0000000000..a26c9d146b --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/BusinessEntityTransfer.php @@ -0,0 +1,30 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; +use ChargeBee\ChargeBee\Request; +use ChargeBee\ChargeBee\Util; + +class BusinessEntityTransfer extends Model +{ + + protected $allowed = [ + 'id', + 'resourceType', + 'resourceId', + 'activeResourceId', + 'destinationBusinessEntityId', + 'sourceBusinessEntityId', + 'reasonCode', + 'createdAt', + ]; + + + + # OPERATIONS + #----------- + + } + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/CreditNote.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/CreditNote.php new file mode 100644 index 0000000000..6188bd030f --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/CreditNote.php @@ -0,0 +1,138 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; +use ChargeBee\ChargeBee\Request; +use ChargeBee\ChargeBee\Util; + +class CreditNote extends Model +{ + + protected $allowed = [ + 'id', + 'customerId', + 'subscriptionId', + 'referenceInvoiceId', + 'type', + 'reasonCode', + 'status', + 'vatNumber', + 'date', + 'priceType', + 'currencyCode', + 'total', + 'amountAllocated', + 'amountRefunded', + 'amountAvailable', + 'refundedAt', + 'voidedAt', + 'generatedAt', + 'resourceVersion', + 'updatedAt', + 'channel', + 'einvoice', + 'subTotal', + 'subTotalInLocalCurrency', + 'totalInLocalCurrency', + 'localCurrencyCode', + 'roundOffAmount', + 'fractionalCorrection', + 'lineItems', + 'discounts', + 'lineItemDiscounts', + 'lineItemTiers', + 'taxes', + 'lineItemTaxes', + 'linkedRefunds', + 'allocations', + 'deleted', + 'taxCategory', + 'localCurrencyExchangeRate', + 'createReasonCode', + 'vatNumberPrefix', + 'businessEntityId', + 'shippingAddress', + 'billingAddress', + 'siteDetailsAtCreation', + 'taxOrigin', + ]; + + + + # OPERATIONS + #----------- + + public static function create($params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("credit_notes"), $params, $env, $headers); + } + + public static function retrieve($id, $env = null, $headers = array()) + { + return Request::send(Request::GET, Util::encodeURIPath("credit_notes",$id), array(), $env, $headers); + } + + public static function pdf($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("credit_notes",$id,"pdf"), $params, $env, $headers); + } + + public static function downloadEinvoice($id, $env = null, $headers = array()) + { + return Request::send(Request::GET, Util::encodeURIPath("credit_notes",$id,"download_einvoice"), array(), $env, $headers); + } + + public static function refund($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("credit_notes",$id,"refund"), $params, $env, $headers); + } + + public static function recordRefund($id, $params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("credit_notes",$id,"record_refund"), $params, $env, $headers); + } + + public static function voidCreditNote($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("credit_notes",$id,"void"), $params, $env, $headers); + } + + public static function all($params = array(), $env = null, $headers = array()) + { + return Request::sendListRequest(Request::GET, Util::encodeURIPath("credit_notes"), $params, $env, $headers); + } + + public static function creditNotesForCustomer($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::GET, Util::encodeURIPath("customers",$id,"credit_notes"), $params, $env, $headers); + } + + public static function delete($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("credit_notes",$id,"delete"), $params, $env, $headers); + } + + public static function removeTaxWithheldRefund($id, $params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("credit_notes",$id,"remove_tax_withheld_refund"), $params, $env, $headers); + } + + public static function resendEinvoice($id, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("credit_notes",$id,"resend_einvoice"), array(), $env, $headers); + } + + public static function sendEinvoice($id, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("credit_notes",$id,"send_einvoice"), array(), $env, $headers); + } + + public static function importCreditNote($params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("credit_notes","import_credit_note"), $params, $env, $headers); + } + + } + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/CreditNoteEstimateLineItem.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/CreditNoteEstimateLineItem.php new file mode 100644 index 0000000000..faf6a7ccf7 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/CreditNoteEstimateLineItem.php @@ -0,0 +1,38 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; + +class CreditNoteEstimateLineItem extends Model +{ + protected $allowed = [ + 'id', + 'subscriptionId', + 'dateFrom', + 'dateTo', + 'unitAmount', + 'quantity', + 'amount', + 'pricingModel', + 'isTaxed', + 'taxAmount', + 'taxRate', + 'unitAmountInDecimal', + 'quantityInDecimal', + 'amountInDecimal', + 'discountAmount', + 'itemLevelDiscountAmount', + 'usagePercentage', + 'referenceLineItemId', + 'description', + 'entityDescription', + 'entityType', + 'taxExemptReason', + 'entityId', + 'customerId', + ]; + +} + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/CreditNoteEstimateLineItemTax.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/CreditNoteEstimateLineItemTax.php new file mode 100644 index 0000000000..764a6af278 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/CreditNoteEstimateLineItemTax.php @@ -0,0 +1,29 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; + +class CreditNoteEstimateLineItemTax extends Model +{ + protected $allowed = [ + 'lineItemId', + 'taxName', + 'taxRate', + 'dateTo', + 'dateFrom', + 'proratedTaxableAmount', + 'isPartialTaxApplied', + 'isNonComplianceTax', + 'taxableAmount', + 'taxAmount', + 'taxJurisType', + 'taxJurisName', + 'taxJurisCode', + 'taxAmountInLocalCurrency', + 'localCurrencyCode', + ]; + +} + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/CreditNoteLineItem.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/CreditNoteLineItem.php new file mode 100644 index 0000000000..10483fd4bc --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/CreditNoteLineItem.php @@ -0,0 +1,38 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; + +class CreditNoteLineItem extends Model +{ + protected $allowed = [ + 'id', + 'subscriptionId', + 'dateFrom', + 'dateTo', + 'unitAmount', + 'quantity', + 'amount', + 'pricingModel', + 'isTaxed', + 'taxAmount', + 'taxRate', + 'unitAmountInDecimal', + 'quantityInDecimal', + 'amountInDecimal', + 'discountAmount', + 'itemLevelDiscountAmount', + 'usagePercentage', + 'referenceLineItemId', + 'description', + 'entityDescription', + 'entityType', + 'taxExemptReason', + 'entityId', + 'customerId', + ]; + +} + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/CreditNoteLineItemTax.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/CreditNoteLineItemTax.php new file mode 100644 index 0000000000..d5b5e006f4 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/CreditNoteLineItemTax.php @@ -0,0 +1,29 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; + +class CreditNoteLineItemTax extends Model +{ + protected $allowed = [ + 'lineItemId', + 'taxName', + 'taxRate', + 'dateTo', + 'dateFrom', + 'proratedTaxableAmount', + 'isPartialTaxApplied', + 'isNonComplianceTax', + 'taxableAmount', + 'taxAmount', + 'taxJurisType', + 'taxJurisName', + 'taxJurisCode', + 'taxAmountInLocalCurrency', + 'localCurrencyCode', + ]; + +} + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/CreditNoteSiteDetailsAtCreation.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/CreditNoteSiteDetailsAtCreation.php new file mode 100644 index 0000000000..d24d4c0ca3 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/CreditNoteSiteDetailsAtCreation.php @@ -0,0 +1,16 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; + +class CreditNoteSiteDetailsAtCreation extends Model +{ + protected $allowed = [ + 'timezone', + 'organizationAddress', + ]; + +} + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/CreditNoteTaxOrigin.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/CreditNoteTaxOrigin.php new file mode 100644 index 0000000000..27e4d92352 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/CreditNoteTaxOrigin.php @@ -0,0 +1,16 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; + +class CreditNoteTaxOrigin extends Model +{ + protected $allowed = [ + 'country', + 'registrationNumber', + ]; + +} + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/Currency.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/Currency.php new file mode 100644 index 0000000000..ffb2d47523 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/Currency.php @@ -0,0 +1,58 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; +use ChargeBee\ChargeBee\Request; +use ChargeBee\ChargeBee\Util; + +class Currency extends Model +{ + + protected $allowed = [ + 'id', + 'enabled', + 'forexType', + 'currencyCode', + 'isBaseCurrency', + 'manualExchangeRate', + ]; + + + + # OPERATIONS + #----------- + + public static function all($env = null, $headers = array()) + { + return Request::sendListRequest(Request::GET, Util::encodeURIPath("currencies","list"), array(), $env, $headers); + } + + public static function retrieve($id, $env = null, $headers = array()) + { + return Request::send(Request::GET, Util::encodeURIPath("currencies",$id), array(), $env, $headers); + } + + public static function create($params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("currencies"), $params, $env, $headers); + } + + public static function update($id, $params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("currencies",$id), $params, $env, $headers); + } + + public static function addSchedule($id, $params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("currencies",$id,"add_schedule"), $params, $env, $headers); + } + + public static function removeSchedule($id, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("currencies",$id,"remove_schedule"), array(), $env, $headers); + } + + } + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/Customer.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/Customer.php new file mode 100644 index 0000000000..d4c3732bbe --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/Customer.php @@ -0,0 +1,213 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; +use ChargeBee\ChargeBee\Request; +use ChargeBee\ChargeBee\Util; + +class Customer extends Model +{ + + protected $allowed = [ + 'id', + 'firstName', + 'lastName', + 'email', + 'phone', + 'company', + 'vatNumber', + 'autoCollection', + 'offlinePaymentMethod', + 'netTermDays', + 'vatNumberValidatedTime', + 'vatNumberStatus', + 'allowDirectDebit', + 'isLocationValid', + 'createdAt', + 'createdFromIp', + 'exemptionDetails', + 'taxability', + 'entityCode', + 'exemptNumber', + 'resourceVersion', + 'updatedAt', + 'locale', + 'billingDate', + 'billingMonth', + 'billingDateMode', + 'billingDayOfWeek', + 'billingDayOfWeekMode', + 'piiCleared', + 'autoCloseInvoices', + 'channel', + 'activeId', + 'cardStatus', + 'fraudFlag', + 'primaryPaymentSourceId', + 'backupPaymentSourceId', + 'billingAddress', + 'referralUrls', + 'contacts', + 'paymentMethod', + 'invoiceNotes', + 'businessEntityId', + 'preferredCurrencyCode', + 'promotionalCredits', + 'unbilledCharges', + 'refundableCredits', + 'excessPayments', + 'balances', + 'entityIdentifiers', + 'taxProvidersFields', + 'isEinvoiceEnabled', + 'einvoicingMethod', + 'metaData', + 'deleted', + 'registeredForGst', + 'consolidatedInvoicing', + 'customerType', + 'businessCustomerWithoutVatNumber', + 'clientProfileId', + 'relationship', + 'useDefaultHierarchySettings', + 'parentAccountAccess', + 'childAccountAccess', + 'vatNumberPrefix', + 'entityIdentifierScheme', + 'entityIdentifierStandard', + ]; + + + + # OPERATIONS + #----------- + + public static function create($params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("customers"), $params, $env, $headers); + } + + public static function all($params = array(), $env = null, $headers = array()) + { + return Request::sendListRequest(Request::GET, Util::encodeURIPath("customers"), $params, $env, $headers); + } + + public static function retrieve($id, $env = null, $headers = array()) + { + return Request::send(Request::GET, Util::encodeURIPath("customers",$id), array(), $env, $headers); + } + + public static function update($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("customers",$id), $params, $env, $headers); + } + + public static function updatePaymentMethod($id, $params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("customers",$id,"update_payment_method"), $params, $env, $headers); + } + + public static function updateBillingInfo($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("customers",$id,"update_billing_info"), $params, $env, $headers); + } + + public static function contactsForCustomer($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::GET, Util::encodeURIPath("customers",$id,"contacts"), $params, $env, $headers); + } + + public static function assignPaymentRole($id, $params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("customers",$id,"assign_payment_role"), $params, $env, $headers); + } + + public static function addContact($id, $params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("customers",$id,"add_contact"), $params, $env, $headers); + } + + public static function updateContact($id, $params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("customers",$id,"update_contact"), $params, $env, $headers); + } + + public static function deleteContact($id, $params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("customers",$id,"delete_contact"), $params, $env, $headers); + } + + public static function addPromotionalCredits($id, $params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("customers",$id,"add_promotional_credits"), $params, $env, $headers); + } + + public static function deductPromotionalCredits($id, $params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("customers",$id,"deduct_promotional_credits"), $params, $env, $headers); + } + + public static function setPromotionalCredits($id, $params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("customers",$id,"set_promotional_credits"), $params, $env, $headers); + } + + public static function recordExcessPayment($id, $params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("customers",$id,"record_excess_payment"), $params, $env, $headers); + } + + public static function collectPayment($id, $params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("customers",$id,"collect_payment"), $params, $env, $headers); + } + + public static function delete($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("customers",$id,"delete"), $params, $env, $headers); + } + + public static function move($params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("customers","move"), $params, $env, $headers); + } + + public static function changeBillingDate($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("customers",$id,"change_billing_date"), $params, $env, $headers); + } + + public static function merge($params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("customers","merge"), $params, $env, $headers); + } + + public static function clearPersonalData($id, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("customers",$id,"clear_personal_data"), array(), $env, $headers); + } + + public static function relationships($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("customers",$id,"relationships"), $params, $env, $headers); + } + + public static function deleteRelationship($id, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("customers",$id,"delete_relationship"), array(), $env, $headers); + } + + public static function hierarchy($id, $params, $env = null, $headers = array()) + { + return Request::send(Request::GET, Util::encodeURIPath("customers",$id,"hierarchy"), $params, $env, $headers); + } + + public static function updateHierarchySettings($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("customers",$id,"update_hierarchy_settings"), $params, $env, $headers); + } + + } + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/CustomerEntitlement.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/CustomerEntitlement.php new file mode 100644 index 0000000000..47f0ddc424 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/CustomerEntitlement.php @@ -0,0 +1,33 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; +use ChargeBee\ChargeBee\Request; +use ChargeBee\ChargeBee\Util; + +class CustomerEntitlement extends Model +{ + + protected $allowed = [ + 'customerId', + 'subscriptionId', + 'featureId', + 'value', + 'name', + 'isEnabled', + ]; + + + + # OPERATIONS + #----------- + + public static function entitlementsForCustomer($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::GET, Util::encodeURIPath("customers",$id,"customer_entitlements"), $params, $env, $headers); + } + + } + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/CustomerTaxProvidersField.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/CustomerTaxProvidersField.php new file mode 100644 index 0000000000..23867547d5 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/CustomerTaxProvidersField.php @@ -0,0 +1,17 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; + +class CustomerTaxProvidersField extends Model +{ + protected $allowed = [ + 'providerName', + 'fieldId', + 'fieldValue', + ]; + +} + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/Entitlement.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/Entitlement.php new file mode 100644 index 0000000000..be9456477d --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/Entitlement.php @@ -0,0 +1,39 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; +use ChargeBee\ChargeBee\Request; +use ChargeBee\ChargeBee\Util; + +class Entitlement extends Model +{ + + protected $allowed = [ + 'id', + 'entityId', + 'entityType', + 'featureId', + 'featureName', + 'value', + 'name', + ]; + + + + # OPERATIONS + #----------- + + public static function all($params = array(), $env = null, $headers = array()) + { + return Request::sendListRequest(Request::GET, Util::encodeURIPath("entitlements"), $params, $env, $headers); + } + + public static function create($params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("entitlements"), $params, $env, $headers); + } + + } + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/EntitlementOverride.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/EntitlementOverride.php new file mode 100644 index 0000000000..b901ae4983 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/EntitlementOverride.php @@ -0,0 +1,42 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; +use ChargeBee\ChargeBee\Request; +use ChargeBee\ChargeBee\Util; + +class EntitlementOverride extends Model +{ + + protected $allowed = [ + 'id', + 'entityId', + 'entityType', + 'featureId', + 'featureName', + 'value', + 'name', + 'expiresAt', + 'effectiveFrom', + 'scheduleStatus', + ]; + + + + # OPERATIONS + #----------- + + public static function addEntitlementOverrideForSubscription($id, $params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("subscriptions",$id,"entitlement_overrides"), $params, $env, $headers); + } + + public static function listEntitlementOverrideForSubscription($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::GET, Util::encodeURIPath("subscriptions",$id,"entitlement_overrides"), $params, $env, $headers); + } + + } + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/Event.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/Event.php new file mode 100644 index 0000000000..d30a501ebe --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/Event.php @@ -0,0 +1,69 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; +use ChargeBee\ChargeBee\Request; +use ChargeBee\ChargeBee\Util; +use ChargeBee\ChargeBee\Environment; +use Exception; +use RuntimeException; + +class Event extends Model +{ + + protected $allowed = [ + 'id', + 'occurredAt', + 'source', + 'user', + 'webhookStatus', + 'webhookFailureReason', + 'webhooks', + 'eventType', + 'apiVersion', + 'originUser', + ]; + + public function content() + { + return new Content($this->_values['content']); + } + + public static function deserialize($json) + { + $webhookData = json_decode($json, true); + if(!$webhookData) { + throw new Exception("Response not in JSON format. Might not be a ChargeBee webhook call."); + } + if($webhookData != null) + { + if( isset($webhookData['api_version']) ) { + $apiVersion = strtoupper($webhookData['api_version']); + if($apiVersion != null && strcasecmp($apiVersion, Environment::API_VERSION) != 0){ + throw new RuntimeException("API version [".$apiVersion."] in response does not match " + ."with client library API version [".strtoupper(Environment::API_VERSION)."]"); + } + } + return new self($webhookData); + } + return null; + } + + + # OPERATIONS + #----------- + + public static function all($params = array(), $env = null, $headers = array()) + { + return Request::sendListRequest(Request::GET, Util::encodeURIPath("events"), $params, $env, $headers); + } + + public static function retrieve($id, $env = null, $headers = array()) + { + return Request::send(Request::GET, Util::encodeURIPath("events",$id), array(), $env, $headers); + } + + } + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/Export.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/Export.php new file mode 100644 index 0000000000..79a9c9d24d --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/Export.php @@ -0,0 +1,131 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; +use ChargeBee\ChargeBee\Request; +use ChargeBee\ChargeBee\Util; +use ChargeBee\ChargeBee\Environment; + +class Export extends Model +{ + + protected $allowed = [ + 'id', + 'operationType', + 'mimeType', + 'status', + 'createdAt', + 'download', + ]; + +public function waitForExportCompletion($env = null, $headers = array()) { + $count = 0; + while($this->status == "in_process") { + if( $count++ > 50) { + throw new RuntimeException("Export is taking too long"); + } + sleep(Environment::$exportWaitInSecs); + $this->_values = self::retrieve($this->id, $env, $headers)->export()->getValues(); + $this->_load(); + } + return $this; +} + + + # OPERATIONS + #----------- + + public static function retrieve($id, $env = null, $headers = array()) + { + return Request::send(Request::GET, Util::encodeURIPath("exports",$id), array(), $env, $headers); + } + + public static function revenueRecognition($params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("exports","revenue_recognition"), $params, $env, $headers); + } + + public static function deferredRevenue($params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("exports","deferred_revenue"), $params, $env, $headers); + } + + public static function plans($params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("exports","plans"), $params, $env, $headers); + } + + public static function addons($params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("exports","addons"), $params, $env, $headers); + } + + public static function coupons($params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("exports","coupons"), $params, $env, $headers); + } + + public static function customers($params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("exports","customers"), $params, $env, $headers); + } + + public static function subscriptions($params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("exports","subscriptions"), $params, $env, $headers); + } + + public static function invoices($params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("exports","invoices"), $params, $env, $headers); + } + + public static function creditNotes($params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("exports","credit_notes"), $params, $env, $headers); + } + + public static function transactions($params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("exports","transactions"), $params, $env, $headers); + } + + public static function orders($params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("exports","orders"), $params, $env, $headers); + } + + public static function itemFamilies($params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("exports","item_families"), $params, $env, $headers); + } + + public static function items($params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("exports","items"), $params, $env, $headers); + } + + public static function itemPrices($params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("exports","item_prices"), $params, $env, $headers); + } + + public static function attachedItems($params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("exports","attached_items"), $params, $env, $headers); + } + + public static function differentialPrices($params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("exports","differential_prices"), $params, $env, $headers); + } + + public static function priceVariants($params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("exports","price_variants"), $params, $env, $headers); + } + + } + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/GatewayErrorDetail.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/GatewayErrorDetail.php new file mode 100644 index 0000000000..6d2e9ec564 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/GatewayErrorDetail.php @@ -0,0 +1,35 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; +use ChargeBee\ChargeBee\Request; +use ChargeBee\ChargeBee\Util; + +class GatewayErrorDetail extends Model +{ + + protected $allowed = [ + 'requestId', + 'errorCategory', + 'errorCode', + 'errorMessage', + 'declineCode', + 'declineMessage', + 'networkErrorCode', + 'networkErrorMessage', + 'errorField', + 'recommendationCode', + 'recommendationMessage', + 'processorErrorCode', + 'processorErrorMessage', + ]; + + + + # OPERATIONS + #----------- + + } + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/ImpactedItemPrice.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/ImpactedItemPrice.php new file mode 100644 index 0000000000..d36aa669c3 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/ImpactedItemPrice.php @@ -0,0 +1,25 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; +use ChargeBee\ChargeBee\Request; +use ChargeBee\ChargeBee\Util; + +class ImpactedItemPrice extends Model +{ + + protected $allowed = [ + 'count', + 'download', + 'itemPrices', + ]; + + + + # OPERATIONS + #----------- + + } + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/ImpactedItemPriceDownload.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/ImpactedItemPriceDownload.php new file mode 100644 index 0000000000..57137b6242 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/ImpactedItemPriceDownload.php @@ -0,0 +1,17 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; + +class ImpactedItemPriceDownload extends Model +{ + protected $allowed = [ + 'downloadUrl', + 'validTill', + 'mimeType', + ]; + +} + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/Installment.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/Installment.php new file mode 100644 index 0000000000..3dfedee14a --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/Installment.php @@ -0,0 +1,40 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; +use ChargeBee\ChargeBee\Request; +use ChargeBee\ChargeBee\Util; + +class Installment extends Model +{ + + protected $allowed = [ + 'id', + 'invoiceId', + 'date', + 'amount', + 'status', + 'createdAt', + 'resourceVersion', + 'updatedAt', + ]; + + + + # OPERATIONS + #----------- + + public static function retrieve($id, $env = null, $headers = array()) + { + return Request::send(Request::GET, Util::encodeURIPath("installments",$id), array(), $env, $headers); + } + + public static function all($params, $env = null, $headers = array()) + { + return Request::sendListRequest(Request::GET, Util::encodeURIPath("installments"), $params, $env, $headers); + } + + } + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/InstallmentConfig.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/InstallmentConfig.php new file mode 100644 index 0000000000..13d4149989 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/InstallmentConfig.php @@ -0,0 +1,47 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; +use ChargeBee\ChargeBee\Request; +use ChargeBee\ChargeBee\Util; + +class InstallmentConfig extends Model +{ + + protected $allowed = [ + 'id', + 'description', + 'numberOfInstallments', + 'periodUnit', + 'period', + 'preferredDay', + 'createdAt', + 'resourceVersion', + 'updatedAt', + 'installments', + ]; + + + + # OPERATIONS + #----------- + + public static function create($params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("installment_configs"), $params, $env, $headers); + } + + public static function retrieve($id, $env = null, $headers = array()) + { + return Request::send(Request::GET, Util::encodeURIPath("installment_configs",$id), array(), $env, $headers); + } + + public static function delete($id, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("installment_configs",$id,"delete"), array(), $env, $headers); + } + + } + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/InstallmentConfigInstallment.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/InstallmentConfigInstallment.php new file mode 100644 index 0000000000..af54eee2e6 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/InstallmentConfigInstallment.php @@ -0,0 +1,16 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; + +class InstallmentConfigInstallment extends Model +{ + protected $allowed = [ + 'period', + 'amountPercentage', + ]; + +} + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/InstallmentDetail.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/InstallmentDetail.php new file mode 100644 index 0000000000..d5f79e756d --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/InstallmentDetail.php @@ -0,0 +1,26 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; +use ChargeBee\ChargeBee\Request; +use ChargeBee\ChargeBee\Util; + +class InstallmentDetail extends Model +{ + + protected $allowed = [ + 'id', + 'invoiceId', + 'amount', + 'installments', + ]; + + + + # OPERATIONS + #----------- + + } + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/InstallmentDetailInstallment.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/InstallmentDetailInstallment.php new file mode 100644 index 0000000000..85ef16f977 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/InstallmentDetailInstallment.php @@ -0,0 +1,22 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; + +class InstallmentDetailInstallment extends Model +{ + protected $allowed = [ + 'id', + 'invoiceId', + 'date', + 'amount', + 'status', + 'createdAt', + 'resourceVersion', + 'updatedAt', + ]; + +} + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/Invoice.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/Invoice.php new file mode 100644 index 0000000000..f3bf0708e7 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/Invoice.php @@ -0,0 +1,273 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; +use ChargeBee\ChargeBee\Request; +use ChargeBee\ChargeBee\Util; + +class Invoice extends Model +{ + + protected $allowed = [ + 'id', + 'poNumber', + 'customerId', + 'subscriptionId', + 'recurring', + 'status', + 'vatNumber', + 'priceType', + 'date', + 'dueDate', + 'netTermDays', + 'exchangeRate', + 'currencyCode', + 'total', + 'amountPaid', + 'amountAdjusted', + 'writeOffAmount', + 'creditsApplied', + 'amountDue', + 'paidAt', + 'dunningStatus', + 'nextRetryAt', + 'voidedAt', + 'resourceVersion', + 'updatedAt', + 'subTotal', + 'subTotalInLocalCurrency', + 'totalInLocalCurrency', + 'localCurrencyCode', + 'tax', + 'localCurrencyExchangeRate', + 'firstInvoice', + 'newSalesAmount', + 'hasAdvanceCharges', + 'termFinalized', + 'isGifted', + 'generatedAt', + 'expectedPaymentDate', + 'amountToCollect', + 'roundOffAmount', + 'lineItems', + 'discounts', + 'lineItemDiscounts', + 'taxes', + 'lineItemTaxes', + 'lineItemTiers', + 'linkedPayments', + 'dunningAttempts', + 'appliedCredits', + 'adjustmentCreditNotes', + 'issuedCreditNotes', + 'linkedOrders', + 'notes', + 'shippingAddress', + 'statementDescriptor', + 'billingAddress', + 'einvoice', + 'paymentOwner', + 'voidReasonCode', + 'deleted', + 'taxCategory', + 'vatNumberPrefix', + 'channel', + 'businessEntityId', + 'siteDetailsAtCreation', + 'taxOrigin', + ]; + + + + # OPERATIONS + #----------- + + public static function create($params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("invoices"), $params, $env, $headers); + } + + public static function createForChargeItemsAndCharges($params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("invoices","create_for_charge_items_and_charges"), $params, $env, $headers); + } + + public static function charge($params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("invoices","charge"), $params, $env, $headers); + } + + public static function chargeAddon($params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("invoices","charge_addon"), $params, $env, $headers); + } + + public static function createForChargeItem($params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("invoices","create_for_charge_item"), $params, $env, $headers); + } + + public static function stopDunning($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("invoices",$id,"stop_dunning"), $params, $env, $headers); + } + + public static function importInvoice($params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("invoices","import_invoice"), $params, $env, $headers); + } + + public static function applyPayments($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("invoices",$id,"apply_payments"), $params, $env, $headers); + } + + public static function syncUsages($id, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("invoices",$id,"sync_usages"), array(), $env, $headers); + } + + public static function deleteLineItems($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("invoices",$id,"delete_line_items"), $params, $env, $headers); + } + + public static function applyCredits($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("invoices",$id,"apply_credits"), $params, $env, $headers); + } + + public static function all($params = array(), $env = null, $headers = array()) + { + return Request::sendListRequest(Request::GET, Util::encodeURIPath("invoices"), $params, $env, $headers); + } + + public static function invoicesForCustomer($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::GET, Util::encodeURIPath("customers",$id,"invoices"), $params, $env, $headers); + } + + public static function invoicesForSubscription($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::GET, Util::encodeURIPath("subscriptions",$id,"invoices"), $params, $env, $headers); + } + + public static function retrieve($id, $env = null, $headers = array()) + { + return Request::send(Request::GET, Util::encodeURIPath("invoices",$id), array(), $env, $headers); + } + + public static function pdf($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("invoices",$id,"pdf"), $params, $env, $headers); + } + + public static function downloadEinvoice($id, $env = null, $headers = array()) + { + return Request::send(Request::GET, Util::encodeURIPath("invoices",$id,"download_einvoice"), array(), $env, $headers); + } + + public static function listPaymentReferenceNumbers($params = array(), $env = null, $headers = array()) + { + return Request::send(Request::GET, Util::encodeURIPath("invoices","payment_reference_numbers"), $params, $env, $headers); + } + + public static function addCharge($id, $params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("invoices",$id,"add_charge"), $params, $env, $headers); + } + + public static function addAddonCharge($id, $params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("invoices",$id,"add_addon_charge"), $params, $env, $headers); + } + + public static function addChargeItem($id, $params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("invoices",$id,"add_charge_item"), $params, $env, $headers); + } + + public static function close($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("invoices",$id,"close"), $params, $env, $headers); + } + + public static function collectPayment($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("invoices",$id,"collect_payment"), $params, $env, $headers); + } + + public static function recordPayment($id, $params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("invoices",$id,"record_payment"), $params, $env, $headers); + } + + public static function recordTaxWithheld($id, $params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("invoices",$id,"record_tax_withheld"), $params, $env, $headers); + } + + public static function removeTaxWithheld($id, $params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("invoices",$id,"remove_tax_withheld"), $params, $env, $headers); + } + + public static function refund($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("invoices",$id,"refund"), $params, $env, $headers); + } + + public static function recordRefund($id, $params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("invoices",$id,"record_refund"), $params, $env, $headers); + } + + public static function removePayment($id, $params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("invoices",$id,"remove_payment"), $params, $env, $headers); + } + + public static function removeCreditNote($id, $params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("invoices",$id,"remove_credit_note"), $params, $env, $headers); + } + + public static function voidInvoice($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("invoices",$id,"void"), $params, $env, $headers); + } + + public static function writeOff($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("invoices",$id,"write_off"), $params, $env, $headers); + } + + public static function delete($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("invoices",$id,"delete"), $params, $env, $headers); + } + + public static function updateDetails($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("invoices",$id,"update_details"), $params, $env, $headers); + } + + public static function installments($id, $params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("invoices",$id,"installments"), $params, $env, $headers); + } + + public static function resendEinvoice($id, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("invoices",$id,"resend_einvoice"), array(), $env, $headers); + } + + public static function sendEinvoice($id, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("invoices",$id,"send_einvoice"), array(), $env, $headers); + } + + } + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/InvoiceEstimateLineItem.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/InvoiceEstimateLineItem.php new file mode 100644 index 0000000000..f7e564e5bb --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/InvoiceEstimateLineItem.php @@ -0,0 +1,38 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; + +class InvoiceEstimateLineItem extends Model +{ + protected $allowed = [ + 'id', + 'subscriptionId', + 'dateFrom', + 'dateTo', + 'unitAmount', + 'quantity', + 'amount', + 'pricingModel', + 'isTaxed', + 'taxAmount', + 'taxRate', + 'unitAmountInDecimal', + 'quantityInDecimal', + 'amountInDecimal', + 'discountAmount', + 'itemLevelDiscountAmount', + 'usagePercentage', + 'referenceLineItemId', + 'description', + 'entityDescription', + 'entityType', + 'taxExemptReason', + 'entityId', + 'customerId', + ]; + +} + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/InvoiceEstimateLineItemTax.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/InvoiceEstimateLineItemTax.php new file mode 100644 index 0000000000..2b2d311872 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/InvoiceEstimateLineItemTax.php @@ -0,0 +1,29 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; + +class InvoiceEstimateLineItemTax extends Model +{ + protected $allowed = [ + 'lineItemId', + 'taxName', + 'taxRate', + 'dateTo', + 'dateFrom', + 'proratedTaxableAmount', + 'isPartialTaxApplied', + 'isNonComplianceTax', + 'taxableAmount', + 'taxAmount', + 'taxJurisType', + 'taxJurisName', + 'taxJurisCode', + 'taxAmountInLocalCurrency', + 'localCurrencyCode', + ]; + +} + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/InvoiceLineItem.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/InvoiceLineItem.php new file mode 100644 index 0000000000..1ce80e0297 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/InvoiceLineItem.php @@ -0,0 +1,38 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; + +class InvoiceLineItem extends Model +{ + protected $allowed = [ + 'id', + 'subscriptionId', + 'dateFrom', + 'dateTo', + 'unitAmount', + 'quantity', + 'amount', + 'pricingModel', + 'isTaxed', + 'taxAmount', + 'taxRate', + 'unitAmountInDecimal', + 'quantityInDecimal', + 'amountInDecimal', + 'discountAmount', + 'itemLevelDiscountAmount', + 'usagePercentage', + 'referenceLineItemId', + 'description', + 'entityDescription', + 'entityType', + 'taxExemptReason', + 'entityId', + 'customerId', + ]; + +} + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/InvoiceLineItemTax.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/InvoiceLineItemTax.php new file mode 100644 index 0000000000..fb3252c2e5 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/InvoiceLineItemTax.php @@ -0,0 +1,29 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; + +class InvoiceLineItemTax extends Model +{ + protected $allowed = [ + 'lineItemId', + 'taxName', + 'taxRate', + 'dateTo', + 'dateFrom', + 'proratedTaxableAmount', + 'isPartialTaxApplied', + 'isNonComplianceTax', + 'taxableAmount', + 'taxAmount', + 'taxJurisType', + 'taxJurisName', + 'taxJurisCode', + 'taxAmountInLocalCurrency', + 'localCurrencyCode', + ]; + +} + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/InvoiceSiteDetailsAtCreation.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/InvoiceSiteDetailsAtCreation.php new file mode 100644 index 0000000000..5388fc6a30 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/InvoiceSiteDetailsAtCreation.php @@ -0,0 +1,16 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; + +class InvoiceSiteDetailsAtCreation extends Model +{ + protected $allowed = [ + 'timezone', + 'organizationAddress', + ]; + +} + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/InvoiceStatementDescriptor.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/InvoiceStatementDescriptor.php new file mode 100644 index 0000000000..f8171a2e81 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/InvoiceStatementDescriptor.php @@ -0,0 +1,16 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; + +class InvoiceStatementDescriptor extends Model +{ + protected $allowed = [ + 'id', + 'descriptor', + ]; + +} + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/InvoiceTaxOrigin.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/InvoiceTaxOrigin.php new file mode 100644 index 0000000000..44b1beb75c --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/InvoiceTaxOrigin.php @@ -0,0 +1,16 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; + +class InvoiceTaxOrigin extends Model +{ + protected $allowed = [ + 'country', + 'registrationNumber', + ]; + +} + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/ItemPrice.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/ItemPrice.php new file mode 100644 index 0000000000..1b4d8e6f4f --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/ItemPrice.php @@ -0,0 +1,97 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; +use ChargeBee\ChargeBee\Request; +use ChargeBee\ChargeBee\Util; + +class ItemPrice extends Model +{ + + protected $allowed = [ + 'id', + 'name', + 'itemFamilyId', + 'itemId', + 'description', + 'status', + 'externalName', + 'priceVariantId', + 'prorationType', + 'pricingModel', + 'price', + 'priceInDecimal', + 'period', + 'currencyCode', + 'periodUnit', + 'trialPeriod', + 'trialPeriodUnit', + 'trialEndAction', + 'shippingPeriod', + 'shippingPeriodUnit', + 'billingCycles', + 'freeQuantity', + 'freeQuantityInDecimal', + 'channel', + 'resourceVersion', + 'updatedAt', + 'createdAt', + 'archivedAt', + 'invoiceNotes', + 'tiers', + 'isTaxable', + 'taxDetail', + 'taxProvidersFields', + 'accountingDetail', + 'metadata', + 'itemType', + 'archivable', + 'parentItemId', + 'showDescriptionInInvoices', + 'showDescriptionInQuotes', + ]; + + + + # OPERATIONS + #----------- + + public static function create($params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("item_prices"), $params, $env, $headers); + } + + public static function retrieve($id, $env = null, $headers = array()) + { + return Request::send(Request::GET, Util::encodeURIPath("item_prices",$id), array(), $env, $headers); + } + + public static function update($id, $params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("item_prices",$id), $params, $env, $headers); + } + + public static function all($params = array(), $env = null, $headers = array()) + { + return Request::sendListRequest(Request::GET, Util::encodeURIPath("item_prices"), $params, $env, $headers); + } + + public static function delete($id, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("item_prices",$id,"delete"), array(), $env, $headers); + } + + public static function findApplicableItems($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::GET, Util::encodeURIPath("item_prices",$id,"applicable_items"), $params, $env, $headers); + } + + public static function findApplicableItemPrices($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::GET, Util::encodeURIPath("item_prices",$id,"applicable_item_prices"), $params, $env, $headers); + } + + } + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/ItemPriceTaxProvidersField.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/ItemPriceTaxProvidersField.php new file mode 100644 index 0000000000..deba803f74 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/ItemPriceTaxProvidersField.php @@ -0,0 +1,17 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; + +class ItemPriceTaxProvidersField extends Model +{ + protected $allowed = [ + 'providerName', + 'fieldId', + 'fieldValue', + ]; + +} + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/Metadata.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/Metadata.php new file mode 100644 index 0000000000..28f870fd1f --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/Metadata.php @@ -0,0 +1,23 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; +use ChargeBee\ChargeBee\Request; +use ChargeBee\ChargeBee\Util; + +class Metadata extends Model +{ + + protected $allowed = [ + 'changeType', + ]; + + + + # OPERATIONS + #----------- + + } + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/OrderLineItemTax.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/OrderLineItemTax.php new file mode 100644 index 0000000000..fa7ac659a3 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/OrderLineItemTax.php @@ -0,0 +1,29 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; + +class OrderLineItemTax extends Model +{ + protected $allowed = [ + 'lineItemId', + 'taxName', + 'taxRate', + 'dateTo', + 'dateFrom', + 'proratedTaxableAmount', + 'isPartialTaxApplied', + 'isNonComplianceTax', + 'taxableAmount', + 'taxAmount', + 'taxJurisType', + 'taxJurisName', + 'taxJurisCode', + 'taxAmountInLocalCurrency', + 'localCurrencyCode', + ]; + +} + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/PaymentIntentPaymentAttempt.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/PaymentIntentPaymentAttempt.php new file mode 100644 index 0000000000..d56728868d --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/PaymentIntentPaymentAttempt.php @@ -0,0 +1,23 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; + +class PaymentIntentPaymentAttempt extends Model +{ + protected $allowed = [ + 'id', + 'status', + 'paymentMethodType', + 'idAtGateway', + 'errorCode', + 'errorText', + 'createdAt', + 'modifiedAt', + 'errorDetail', + ]; + +} + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/PaymentSource.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/PaymentSource.php new file mode 100644 index 0000000000..e62465f6df --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/PaymentSource.php @@ -0,0 +1,126 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; +use ChargeBee\ChargeBee\Request; +use ChargeBee\ChargeBee\Util; + +class PaymentSource extends Model +{ + + protected $allowed = [ + 'id', + 'resourceVersion', + 'updatedAt', + 'createdAt', + 'customerId', + 'type', + 'referenceId', + 'status', + 'gateway', + 'gatewayAccountId', + 'ipAddress', + 'issuingCountry', + 'card', + 'bankAccount', + 'boleto', + 'billingAddress', + 'amazonPayment', + 'upi', + 'paypal', + 'venmo', + 'klarnaPayNow', + 'mandates', + 'deleted', + 'businessEntityId', + ]; + + + + # OPERATIONS + #----------- + + public static function createUsingTempToken($params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("payment_sources","create_using_temp_token"), $params, $env, $headers); + } + + public static function createUsingPermanentToken($params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("payment_sources","create_using_permanent_token"), $params, $env, $headers); + } + + public static function createUsingToken($params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("payment_sources","create_using_token"), $params, $env, $headers); + } + + public static function createUsingPaymentIntent($params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("payment_sources","create_using_payment_intent"), $params, $env, $headers); + } + + public static function createVoucherPaymentSource($params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("payment_sources","create_voucher_payment_source"), $params, $env, $headers); + } + + public static function createCard($params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("payment_sources","create_card"), $params, $env, $headers); + } + + public static function createBankAccount($params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("payment_sources","create_bank_account"), $params, $env, $headers); + } + + public static function updateCard($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("payment_sources",$id,"update_card"), $params, $env, $headers); + } + + public static function updateBankAccount($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("payment_sources",$id,"update_bank_account"), $params, $env, $headers); + } + + public static function verifyBankAccount($id, $params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("payment_sources",$id,"verify_bank_account"), $params, $env, $headers); + } + + public static function retrieve($id, $env = null, $headers = array()) + { + return Request::send(Request::GET, Util::encodeURIPath("payment_sources",$id), array(), $env, $headers); + } + + public static function all($params = array(), $env = null, $headers = array()) + { + return Request::sendListRequest(Request::GET, Util::encodeURIPath("payment_sources"), $params, $env, $headers); + } + + public static function switchGatewayAccount($id, $params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("payment_sources",$id,"switch_gateway_account"), $params, $env, $headers); + } + + public static function exportPaymentSource($id, $params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("payment_sources",$id,"export_payment_source"), $params, $env, $headers); + } + + public static function delete($id, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("payment_sources",$id,"delete"), array(), $env, $headers); + } + + public static function deleteLocal($id, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("payment_sources",$id,"delete_local"), array(), $env, $headers); + } + + } + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/PaymentSourceKlarnaPayNow.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/PaymentSourceKlarnaPayNow.php new file mode 100644 index 0000000000..10f027af02 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/PaymentSourceKlarnaPayNow.php @@ -0,0 +1,15 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; + +class PaymentSourceKlarnaPayNow extends Model +{ + protected $allowed = [ + 'email', + ]; + +} + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/Plan.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/Plan.php new file mode 100644 index 0000000000..cad1c17712 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/Plan.php @@ -0,0 +1,113 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; +use ChargeBee\ChargeBee\Request; +use ChargeBee\ChargeBee\Util; + +class Plan extends Model +{ + + protected $allowed = [ + 'id', + 'name', + 'invoiceName', + 'description', + 'price', + 'currencyCode', + 'period', + 'periodUnit', + 'trialPeriod', + 'trialPeriodUnit', + 'trialEndAction', + 'pricingModel', + 'chargeModel', + 'freeQuantity', + 'setupCost', + 'downgradePenalty', + 'status', + 'archivedAt', + 'billingCycles', + 'redirectUrl', + 'enabledInHostedPages', + 'enabledInPortal', + 'addonApplicability', + 'taxCode', + 'hsnCode', + 'taxjarProductCode', + 'avalaraSaleType', + 'avalaraTransactionType', + 'avalaraServiceType', + 'sku', + 'accountingCode', + 'accountingCategory1', + 'accountingCategory2', + 'accountingCategory3', + 'accountingCategory4', + 'isShippable', + 'shippingFrequencyPeriod', + 'shippingFrequencyPeriodUnit', + 'resourceVersion', + 'updatedAt', + 'giftable', + 'claimUrl', + 'freeQuantityInDecimal', + 'priceInDecimal', + 'channel', + 'invoiceNotes', + 'taxable', + 'taxProfileId', + 'metaData', + 'tiers', + 'taxProvidersFields', + 'applicableAddons', + 'attachedAddons', + 'eventBasedAddons', + 'showDescriptionInInvoices', + 'showDescriptionInQuotes', + ]; + + + + # OPERATIONS + #----------- + + public static function create($params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("plans"), $params, $env, $headers); + } + + public static function update($id, $params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("plans",$id), $params, $env, $headers); + } + + public static function all($params = array(), $env = null, $headers = array()) + { + return Request::sendListRequest(Request::GET, Util::encodeURIPath("plans"), $params, $env, $headers); + } + + public static function retrieve($id, $env = null, $headers = array()) + { + return Request::send(Request::GET, Util::encodeURIPath("plans",$id), array(), $env, $headers); + } + + public static function delete($id, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("plans",$id,"delete"), array(), $env, $headers); + } + + public static function copy($params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("plans","copy"), $params, $env, $headers); + } + + public static function unarchive($id, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("plans",$id,"unarchive"), array(), $env, $headers); + } + + } + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/PlanTaxProvidersField.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/PlanTaxProvidersField.php new file mode 100644 index 0000000000..8ab267da2e --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/PlanTaxProvidersField.php @@ -0,0 +1,17 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; + +class PlanTaxProvidersField extends Model +{ + protected $allowed = [ + 'providerName', + 'fieldId', + 'fieldValue', + ]; + +} + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/PriceVariant.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/PriceVariant.php new file mode 100644 index 0000000000..dd668643c3 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/PriceVariant.php @@ -0,0 +1,58 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; +use ChargeBee\ChargeBee\Request; +use ChargeBee\ChargeBee\Util; + +class PriceVariant extends Model +{ + + protected $allowed = [ + 'id', + 'name', + 'externalName', + 'variantGroup', + 'description', + 'status', + 'createdAt', + 'resourceVersion', + 'updatedAt', + 'archivedAt', + 'attributes', + ]; + + + + # OPERATIONS + #----------- + + public static function create($params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("price_variants"), $params, $env, $headers); + } + + public static function retrieve($id, $env = null, $headers = array()) + { + return Request::send(Request::GET, Util::encodeURIPath("price_variants",$id), array(), $env, $headers); + } + + public static function update($id, $params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("price_variants",$id), $params, $env, $headers); + } + + public static function delete($id, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("price_variants",$id,"delete"), array(), $env, $headers); + } + + public static function all($params = array(), $env = null, $headers = array()) + { + return Request::sendListRequest(Request::GET, Util::encodeURIPath("price_variants"), $params, $env, $headers); + } + + } + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/PriceVariantAttribute.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/PriceVariantAttribute.php new file mode 100644 index 0000000000..a4ebd9db83 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/PriceVariantAttribute.php @@ -0,0 +1,16 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; + +class PriceVariantAttribute extends Model +{ + protected $allowed = [ + 'name', + 'value', + ]; + +} + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/PricingPageSession.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/PricingPageSession.php new file mode 100644 index 0000000000..bbdc3c00ca --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/PricingPageSession.php @@ -0,0 +1,36 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; +use ChargeBee\ChargeBee\Request; +use ChargeBee\ChargeBee\Util; + +class PricingPageSession extends Model +{ + + protected $allowed = [ + 'id', + 'url', + 'createdAt', + 'expiresAt', + ]; + + + + # OPERATIONS + #----------- + + public static function createForNewSubscription($params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("pricing_page_sessions","create_for_new_subscription"), $params, $env, $headers); + } + + public static function createForExistingSubscription($params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("pricing_page_sessions","create_for_existing_subscription"), $params, $env, $headers); + } + + } + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/QuoteLineGroupLineItem.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/QuoteLineGroupLineItem.php new file mode 100644 index 0000000000..ad485ffeac --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/QuoteLineGroupLineItem.php @@ -0,0 +1,38 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; + +class QuoteLineGroupLineItem extends Model +{ + protected $allowed = [ + 'id', + 'subscriptionId', + 'dateFrom', + 'dateTo', + 'unitAmount', + 'quantity', + 'amount', + 'pricingModel', + 'isTaxed', + 'taxAmount', + 'taxRate', + 'unitAmountInDecimal', + 'quantityInDecimal', + 'amountInDecimal', + 'discountAmount', + 'itemLevelDiscountAmount', + 'usagePercentage', + 'referenceLineItemId', + 'description', + 'entityDescription', + 'entityType', + 'taxExemptReason', + 'entityId', + 'customerId', + ]; + +} + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/QuoteLineGroupLineItemTax.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/QuoteLineGroupLineItemTax.php new file mode 100644 index 0000000000..a6b982064b --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/QuoteLineGroupLineItemTax.php @@ -0,0 +1,29 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; + +class QuoteLineGroupLineItemTax extends Model +{ + protected $allowed = [ + 'lineItemId', + 'taxName', + 'taxRate', + 'dateTo', + 'dateFrom', + 'proratedTaxableAmount', + 'isPartialTaxApplied', + 'isNonComplianceTax', + 'taxableAmount', + 'taxAmount', + 'taxJurisType', + 'taxJurisName', + 'taxJurisCode', + 'taxAmountInLocalCurrency', + 'localCurrencyCode', + ]; + +} + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/QuoteLineItem.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/QuoteLineItem.php new file mode 100644 index 0000000000..f7f70d1733 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/QuoteLineItem.php @@ -0,0 +1,38 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; + +class QuoteLineItem extends Model +{ + protected $allowed = [ + 'id', + 'subscriptionId', + 'dateFrom', + 'dateTo', + 'unitAmount', + 'quantity', + 'amount', + 'pricingModel', + 'isTaxed', + 'taxAmount', + 'taxRate', + 'unitAmountInDecimal', + 'quantityInDecimal', + 'amountInDecimal', + 'discountAmount', + 'itemLevelDiscountAmount', + 'usagePercentage', + 'referenceLineItemId', + 'description', + 'entityDescription', + 'entityType', + 'taxExemptReason', + 'entityId', + 'customerId', + ]; + +} + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/QuoteLineItemTax.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/QuoteLineItemTax.php new file mode 100644 index 0000000000..5164ab758a --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/QuoteLineItemTax.php @@ -0,0 +1,29 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; + +class QuoteLineItemTax extends Model +{ + protected $allowed = [ + 'lineItemId', + 'taxName', + 'taxRate', + 'dateTo', + 'dateFrom', + 'proratedTaxableAmount', + 'isPartialTaxApplied', + 'isNonComplianceTax', + 'taxableAmount', + 'taxAmount', + 'taxJurisType', + 'taxJurisName', + 'taxJurisCode', + 'taxAmountInLocalCurrency', + 'localCurrencyCode', + ]; + +} + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/QuotedSubscriptionSubscriptionItem.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/QuotedSubscriptionSubscriptionItem.php new file mode 100644 index 0000000000..e6ccfd50ae --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/QuotedSubscriptionSubscriptionItem.php @@ -0,0 +1,35 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; + +class QuotedSubscriptionSubscriptionItem extends Model +{ + protected $allowed = [ + 'itemPriceId', + 'itemType', + 'quantity', + 'quantityInDecimal', + 'meteredQuantity', + 'lastCalculatedAt', + 'unitPrice', + 'unitPriceInDecimal', + 'amount', + 'amountInDecimal', + 'billingPeriod', + 'billingPeriodUnit', + 'freeQuantity', + 'freeQuantityInDecimal', + 'trialEnd', + 'billingCycles', + 'servicePeriodDays', + 'chargeOnEvent', + 'chargeOnce', + 'chargeOnOption', + 'prorationType', + ]; + +} + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/Ramp.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/Ramp.php new file mode 100644 index 0000000000..ce9cfe9957 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/Ramp.php @@ -0,0 +1,65 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; +use ChargeBee\ChargeBee\Request; +use ChargeBee\ChargeBee\Util; + +class Ramp extends Model +{ + + protected $allowed = [ + 'id', + 'description', + 'subscriptionId', + 'effectiveFrom', + 'status', + 'createdAt', + 'resourceVersion', + 'updatedAt', + 'itemsToAdd', + 'itemsToUpdate', + 'couponsToAdd', + 'discountsToAdd', + 'itemTiers', + 'itemsToRemove', + 'couponsToRemove', + 'discountsToRemove', + 'deleted', + 'statusTransitionReason', + ]; + + + + # OPERATIONS + #----------- + + public static function createForSubscription($id, $params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("subscriptions",$id,"create_ramp"), $params, $env, $headers); + } + + public static function update($id, $params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("ramps",$id,"update"), $params, $env, $headers); + } + + public static function retrieve($id, $env = null, $headers = array()) + { + return Request::send(Request::GET, Util::encodeURIPath("ramps",$id), array(), $env, $headers); + } + + public static function delete($id, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("ramps",$id,"delete"), array(), $env, $headers); + } + + public static function all($params, $env = null, $headers = array()) + { + return Request::sendListRequest(Request::GET, Util::encodeURIPath("ramps"), $params, $env, $headers); + } + + } + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/RampCouponsToAdd.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/RampCouponsToAdd.php new file mode 100644 index 0000000000..3f9dba1b58 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/RampCouponsToAdd.php @@ -0,0 +1,16 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; + +class RampCouponsToAdd extends Model +{ + protected $allowed = [ + 'couponId', + 'applyTill', + ]; + +} + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/RampDiscountsToAdd.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/RampDiscountsToAdd.php new file mode 100644 index 0000000000..3714462afd --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/RampDiscountsToAdd.php @@ -0,0 +1,26 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; + +class RampDiscountsToAdd extends Model +{ + protected $allowed = [ + 'id', + 'invoiceName', + 'type', + 'percentage', + 'amount', + 'durationType', + 'period', + 'periodUnit', + 'includedInMrr', + 'applyOn', + 'itemPriceId', + 'createdAt', + ]; + +} + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/RampItemTier.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/RampItemTier.php new file mode 100644 index 0000000000..8adc0a826a --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/RampItemTier.php @@ -0,0 +1,22 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; + +class RampItemTier extends Model +{ + protected $allowed = [ + 'itemPriceId', + 'startingUnit', + 'endingUnit', + 'price', + 'startingUnitInDecimal', + 'endingUnitInDecimal', + 'priceInDecimal', + 'index', + ]; + +} + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/RampItemsToAdd.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/RampItemsToAdd.php new file mode 100644 index 0000000000..a9e50e0bb9 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/RampItemsToAdd.php @@ -0,0 +1,27 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; + +class RampItemsToAdd extends Model +{ + protected $allowed = [ + 'itemPriceId', + 'itemType', + 'quantity', + 'quantityInDecimal', + 'unitPrice', + 'unitPriceInDecimal', + 'amount', + 'amountInDecimal', + 'freeQuantity', + 'freeQuantityInDecimal', + 'billingCycles', + 'servicePeriodDays', + 'meteredQuantity', + ]; + +} + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/RampItemsToUpdate.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/RampItemsToUpdate.php new file mode 100644 index 0000000000..d93ad59e92 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/RampItemsToUpdate.php @@ -0,0 +1,27 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; + +class RampItemsToUpdate extends Model +{ + protected $allowed = [ + 'itemPriceId', + 'itemType', + 'quantity', + 'quantityInDecimal', + 'unitPrice', + 'unitPriceInDecimal', + 'amount', + 'amountInDecimal', + 'freeQuantity', + 'freeQuantityInDecimal', + 'billingCycles', + 'servicePeriodDays', + 'meteredQuantity', + ]; + +} + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/RampStatusTransitionReason.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/RampStatusTransitionReason.php new file mode 100644 index 0000000000..695452950f --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/RampStatusTransitionReason.php @@ -0,0 +1,16 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; + +class RampStatusTransitionReason extends Model +{ + protected $allowed = [ + 'code', + 'message', + ]; + +} + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/Subscription.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/Subscription.php new file mode 100644 index 0000000000..4b6ba2d8b6 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/Subscription.php @@ -0,0 +1,285 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; +use ChargeBee\ChargeBee\Request; +use ChargeBee\ChargeBee\Util; + +class Subscription extends Model +{ + + protected $allowed = [ + 'id', + 'currencyCode', + 'planId', + 'planQuantity', + 'planUnitPrice', + 'setupFee', + 'billingPeriod', + 'billingPeriodUnit', + 'startDate', + 'trialEnd', + 'remainingBillingCycles', + 'poNumber', + 'autoCollection', + 'planQuantityInDecimal', + 'planUnitPriceInDecimal', + 'customerId', + 'planAmount', + 'planFreeQuantity', + 'status', + 'trialStart', + 'trialEndAction', + 'currentTermStart', + 'currentTermEnd', + 'nextBillingAt', + 'createdAt', + 'startedAt', + 'activatedAt', + 'giftId', + 'contractTermBillingCycleOnRenewal', + 'overrideRelationship', + 'pauseDate', + 'resumeDate', + 'cancelledAt', + 'cancelReason', + 'affiliateToken', + 'createdFromIp', + 'resourceVersion', + 'updatedAt', + 'hasScheduledAdvanceInvoices', + 'hasScheduledChanges', + 'paymentSourceId', + 'planFreeQuantityInDecimal', + 'planAmountInDecimal', + 'cancelScheduleCreatedAt', + 'offlinePaymentMethod', + 'channel', + 'netTermDays', + 'activeId', + 'subscriptionItems', + 'itemTiers', + 'chargedItems', + 'dueInvoicesCount', + 'dueSince', + 'totalDues', + 'mrr', + 'arr', + 'exchangeRate', + 'baseCurrencyCode', + 'addons', + 'eventBasedAddons', + 'chargedEventBasedAddons', + 'coupon', + 'coupons', + 'shippingAddress', + 'referralInfo', + 'invoiceNotes', + 'metaData', + 'metadata', + 'deleted', + 'changesScheduledAt', + 'contractTerm', + 'cancelReasonCode', + 'freePeriod', + 'freePeriodUnit', + 'createPendingInvoices', + 'autoCloseInvoices', + 'discounts', + 'businessEntityId', + ]; + + + + # OPERATIONS + #----------- + + public static function create($params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("subscriptions"), $params, $env, $headers); + } + + public static function createForCustomer($id, $params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("customers",$id,"subscriptions"), $params, $env, $headers); + } + + public static function createWithItems($id, $params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("customers",$id,"subscription_for_items"), $params, $env, $headers); + } + + public static function all($params = array(), $env = null, $headers = array()) + { + return Request::sendListRequest(Request::GET, Util::encodeURIPath("subscriptions"), $params, $env, $headers); + } + + public static function subscriptionsForCustomer($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::GET, Util::encodeURIPath("customers",$id,"subscriptions"), $params, $env, $headers); + } + + public static function contractTermsForSubscription($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::GET, Util::encodeURIPath("subscriptions",$id,"contract_terms"), $params, $env, $headers); + } + + public static function listDiscounts($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::GET, Util::encodeURIPath("subscriptions",$id,"discounts"), $params, $env, $headers); + } + + public static function retrieve($id, $env = null, $headers = array()) + { + return Request::send(Request::GET, Util::encodeURIPath("subscriptions",$id), array(), $env, $headers); + } + + public static function retrieveWithScheduledChanges($id, $env = null, $headers = array()) + { + return Request::send(Request::GET, Util::encodeURIPath("subscriptions",$id,"retrieve_with_scheduled_changes"), array(), $env, $headers); + } + + public static function removeScheduledChanges($id, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("subscriptions",$id,"remove_scheduled_changes"), array(), $env, $headers); + } + + public static function removeScheduledCancellation($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("subscriptions",$id,"remove_scheduled_cancellation"), $params, $env, $headers); + } + + public static function removeCoupons($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("subscriptions",$id,"remove_coupons"), $params, $env, $headers); + } + + public static function update($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("subscriptions",$id), $params, $env, $headers); + } + + public static function updateForItems($id, $params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("subscriptions",$id,"update_for_items"), $params, $env, $headers); + } + + public static function changeTermEnd($id, $params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("subscriptions",$id,"change_term_end"), $params, $env, $headers); + } + + public static function reactivate($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("subscriptions",$id,"reactivate"), $params, $env, $headers); + } + + public static function addChargeAtTermEnd($id, $params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("subscriptions",$id,"add_charge_at_term_end"), $params, $env, $headers); + } + + public static function chargeAddonAtTermEnd($id, $params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("subscriptions",$id,"charge_addon_at_term_end"), $params, $env, $headers); + } + + public static function chargeFutureRenewals($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("subscriptions",$id,"charge_future_renewals"), $params, $env, $headers); + } + + public static function editAdvanceInvoiceSchedule($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("subscriptions",$id,"edit_advance_invoice_schedule"), $params, $env, $headers); + } + + public static function retrieveAdvanceInvoiceSchedule($id, $env = null, $headers = array()) + { + return Request::send(Request::GET, Util::encodeURIPath("subscriptions",$id,"retrieve_advance_invoice_schedule"), array(), $env, $headers); + } + + public static function removeAdvanceInvoiceSchedule($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("subscriptions",$id,"remove_advance_invoice_schedule"), $params, $env, $headers); + } + + public static function regenerateInvoice($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("subscriptions",$id,"regenerate_invoice"), $params, $env, $headers); + } + + public static function importSubscription($params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("subscriptions","import_subscription"), $params, $env, $headers); + } + + public static function importForCustomer($id, $params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("customers",$id,"import_subscription"), $params, $env, $headers); + } + + public static function importContractTerm($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("subscriptions",$id,"import_contract_term"), $params, $env, $headers); + } + + public static function importUnbilledCharges($id, $params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("subscriptions",$id,"import_unbilled_charges"), $params, $env, $headers); + } + + public static function importForItems($id, $params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("customers",$id,"import_for_items"), $params, $env, $headers); + } + + public static function overrideBillingProfile($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("subscriptions",$id,"override_billing_profile"), $params, $env, $headers); + } + + public static function delete($id, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("subscriptions",$id,"delete"), array(), $env, $headers); + } + + public static function pause($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("subscriptions",$id,"pause"), $params, $env, $headers); + } + + public static function cancel($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("subscriptions",$id,"cancel"), $params, $env, $headers); + } + + public static function cancelForItems($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("subscriptions",$id,"cancel_for_items"), $params, $env, $headers); + } + + public static function resume($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("subscriptions",$id,"resume"), $params, $env, $headers); + } + + public static function removeScheduledPause($id, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("subscriptions",$id,"remove_scheduled_pause"), array(), $env, $headers); + } + + public static function removeScheduledResumption($id, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("subscriptions",$id,"remove_scheduled_resumption"), array(), $env, $headers); + } + + public static function move($id, $params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("subscriptions",$id,"move"), $params, $env, $headers); + } + + } + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/SubscriptionEntitlement.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/SubscriptionEntitlement.php new file mode 100644 index 0000000000..1f8098dac6 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/SubscriptionEntitlement.php @@ -0,0 +1,45 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; +use ChargeBee\ChargeBee\Request; +use ChargeBee\ChargeBee\Util; + +class SubscriptionEntitlement extends Model +{ + + protected $allowed = [ + 'subscriptionId', + 'featureId', + 'featureName', + 'featureUnit', + 'featureType', + 'value', + 'name', + 'isOverridden', + 'isEnabled', + 'effectiveFrom', + 'scheduleStatus', + 'expiresAt', + 'components', + ]; + + + + # OPERATIONS + #----------- + + public static function subscriptionEntitlementsForSubscription($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::GET, Util::encodeURIPath("subscriptions",$id,"subscription_entitlements"), $params, $env, $headers); + } + + public static function setSubscriptionEntitlementAvailability($id, $params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("subscriptions",$id,"subscription_entitlements/set_availability"), $params, $env, $headers); + } + + } + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/SubscriptionSubscriptionItem.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/SubscriptionSubscriptionItem.php new file mode 100644 index 0000000000..48d55790ca --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/SubscriptionSubscriptionItem.php @@ -0,0 +1,35 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; + +class SubscriptionSubscriptionItem extends Model +{ + protected $allowed = [ + 'itemPriceId', + 'itemType', + 'quantity', + 'quantityInDecimal', + 'meteredQuantity', + 'lastCalculatedAt', + 'unitPrice', + 'unitPriceInDecimal', + 'amount', + 'amountInDecimal', + 'billingPeriod', + 'billingPeriodUnit', + 'freeQuantity', + 'freeQuantityInDecimal', + 'trialEnd', + 'billingCycles', + 'servicePeriodDays', + 'chargeOnEvent', + 'chargeOnce', + 'chargeOnOption', + 'prorationType', + ]; + +} + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/Transaction.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/Transaction.php new file mode 100644 index 0000000000..ea33283dca --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/Transaction.php @@ -0,0 +1,123 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; +use ChargeBee\ChargeBee\Request; +use ChargeBee\ChargeBee\Util; + +class Transaction extends Model +{ + + protected $allowed = [ + 'id', + 'customerId', + 'subscriptionId', + 'gatewayAccountId', + 'paymentSourceId', + 'paymentMethod', + 'referenceNumber', + 'gateway', + 'type', + 'date', + 'settledAt', + 'exchangeRate', + 'currencyCode', + 'amount', + 'idAtGateway', + 'status', + 'fraudFlag', + 'initiatorType', + 'threeDSecure', + 'authorizationReason', + 'errorCode', + 'errorText', + 'voidedAt', + 'resourceVersion', + 'updatedAt', + 'fraudReason', + 'customPaymentMethodId', + 'amountUnused', + 'maskedCardNumber', + 'referenceTransactionId', + 'refundedTxnId', + 'referenceAuthorizationId', + 'amountCapturable', + 'reversalTransactionId', + 'linkedInvoices', + 'linkedCreditNotes', + 'linkedRefunds', + 'linkedPayments', + 'deleted', + 'iin', + 'last4', + 'merchantReferenceId', + 'businessEntityId', + 'paymentMethodDetails', + 'errorDetail', + 'customPaymentMethodName', + ]; + + + + # OPERATIONS + #----------- + + public static function createAuthorization($params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("transactions","create_authorization"), $params, $env, $headers); + } + + public static function voidTransaction($id, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("transactions",$id,"void"), array(), $env, $headers); + } + + public static function recordRefund($id, $params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("transactions",$id,"record_refund"), $params, $env, $headers); + } + + public static function reconcile($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("transactions",$id,"reconcile"), $params, $env, $headers); + } + + public static function refund($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("transactions",$id,"refund"), $params, $env, $headers); + } + + public static function all($params = array(), $env = null, $headers = array()) + { + return Request::sendListRequest(Request::GET, Util::encodeURIPath("transactions"), $params, $env, $headers); + } + + public static function transactionsForCustomer($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::GET, Util::encodeURIPath("customers",$id,"transactions"), $params, $env, $headers); + } + + public static function transactionsForSubscription($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::GET, Util::encodeURIPath("subscriptions",$id,"transactions"), $params, $env, $headers); + } + + public static function paymentsForInvoice($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::GET, Util::encodeURIPath("invoices",$id,"payments"), $params, $env, $headers); + } + + public static function retrieve($id, $env = null, $headers = array()) + { + return Request::send(Request::GET, Util::encodeURIPath("transactions",$id), array(), $env, $headers); + } + + public static function deleteOfflineTransaction($id, $params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("transactions",$id,"delete_offline_transaction"), $params, $env, $headers); + } + + } + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/TransactionGatewayErrorDetail.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/TransactionGatewayErrorDetail.php new file mode 100644 index 0000000000..6dd3224924 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/TransactionGatewayErrorDetail.php @@ -0,0 +1,27 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; + +class TransactionGatewayErrorDetail extends Model +{ + protected $allowed = [ + 'requestId', + 'errorCategory', + 'errorCode', + 'errorMessage', + 'declineCode', + 'declineMessage', + 'networkErrorCode', + 'networkErrorMessage', + 'errorField', + 'recommendationCode', + 'recommendationMessage', + 'processorErrorCode', + 'processorErrorMessage', + ]; + +} + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/UnbilledCharge.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/UnbilledCharge.php new file mode 100644 index 0000000000..924751f4d8 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/UnbilledCharge.php @@ -0,0 +1,76 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; +use ChargeBee\ChargeBee\Request; +use ChargeBee\ChargeBee\Util; + +class UnbilledCharge extends Model +{ + + protected $allowed = [ + 'id', + 'customerId', + 'subscriptionId', + 'dateFrom', + 'dateTo', + 'unitAmount', + 'pricingModel', + 'quantity', + 'amount', + 'currencyCode', + 'discountAmount', + 'description', + 'entityType', + 'entityId', + 'isVoided', + 'voidedAt', + 'unitAmountInDecimal', + 'quantityInDecimal', + 'amountInDecimal', + 'updatedAt', + 'tiers', + 'isAdvanceCharge', + 'businessEntityId', + 'deleted', + ]; + + + + # OPERATIONS + #----------- + + public static function createUnbilledCharge($params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("unbilled_charges","create"), $params, $env, $headers); + } + + public static function create($params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("unbilled_charges"), $params, $env, $headers); + } + + public static function invoiceUnbilledCharges($params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("unbilled_charges","invoice_unbilled_charges"), $params, $env, $headers); + } + + public static function delete($id, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("unbilled_charges",$id,"delete"), array(), $env, $headers); + } + + public static function all($params = array(), $env = null, $headers = array()) + { + return Request::sendListRequest(Request::GET, Util::encodeURIPath("unbilled_charges"), $params, $env, $headers); + } + + public static function invoiceNowEstimate($params = array(), $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("unbilled_charges","invoice_now_estimate"), $params, $env, $headers); + } + + } + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/Usage.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/Usage.php new file mode 100644 index 0000000000..71c7bb71fd --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Models/Usage.php @@ -0,0 +1,59 @@ +<?php + +namespace ChargeBee\ChargeBee\Models; + +use ChargeBee\ChargeBee\Model; +use ChargeBee\ChargeBee\Request; +use ChargeBee\ChargeBee\Util; + +class Usage extends Model +{ + + protected $allowed = [ + 'id', + 'usageDate', + 'subscriptionId', + 'itemPriceId', + 'invoiceId', + 'lineItemId', + 'quantity', + 'source', + 'note', + 'resourceVersion', + 'updatedAt', + 'createdAt', + ]; + + + + # OPERATIONS + #----------- + + public static function create($id, $params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("subscriptions",$id,"usages"), $params, $env, $headers); + } + + public static function retrieve($id, $params, $env = null, $headers = array()) + { + return Request::send(Request::GET, Util::encodeURIPath("subscriptions",$id,"usages"), $params, $env, $headers); + } + + public static function delete($id, $params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("subscriptions",$id,"delete_usage"), $params, $env, $headers); + } + + public static function all($params = array(), $env = null, $headers = array()) + { + return Request::sendListRequest(Request::GET, Util::encodeURIPath("usages"), $params, $env, $headers); + } + + public static function pdf($params, $env = null, $headers = array()) + { + return Request::send(Request::POST, Util::encodeURIPath("usages","pdf"), $params, $env, $headers); + } + + } + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Result.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Result.php new file mode 100644 index 0000000000..818369e1d6 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Result.php @@ -0,0 +1,888 @@ +<?php + +namespace ChargeBee\ChargeBee; + +use ChargeBee\ChargeBee\Models; + +define('IDEMPOTENCY_REPLAY_HEADER', 'chargebee-idempotency-replayed'); + +class Result +{ + private $_response; + private $_responseHeaders; + private $_responseObj; + + public function __construct($_response, $_responseHeaders = null) + { + $this->_response = $_response; + $this->_responseHeaders = $_responseHeaders; + $this->_responseObj = array(); + } + + public function getResponseHeaders() + { + return $this->_responseHeaders; + } + + public function isIdempotencyReplayed() + { + $headers = $this->getResponseHeaders(); + if (isset($headers[IDEMPOTENCY_REPLAY_HEADER])) { + $value = $headers[IDEMPOTENCY_REPLAY_HEADER][0]; + return boolval($value); + } + return false; + } + + public function subscription() + { + $subscription = $this->_get('subscription', Models\Subscription::class, + array( + 'subscription_items' => Models\SubscriptionSubscriptionItem::class, + 'item_tiers' => Models\SubscriptionItemTier::class, + 'charged_items' => Models\SubscriptionChargedItem::class, + 'addons' => Models\SubscriptionAddon::class, + 'event_based_addons' => Models\SubscriptionEventBasedAddon::class, + 'charged_event_based_addons' => Models\SubscriptionChargedEventBasedAddon::class, + 'coupons' => Models\SubscriptionCoupon::class, + 'shipping_address' => Models\SubscriptionShippingAddress::class, + 'referral_info' => Models\SubscriptionReferralInfo::class, + 'contract_term' => Models\SubscriptionContractTerm::class, + 'discounts' => Models\SubscriptionDiscount::class + )); + return $subscription; + } + + public function contractTerm() + { + $contract_term = $this->_get('contract_term', Models\ContractTerm::class); + return $contract_term; + } + + public function discount() + { + $discount = $this->_get('discount', Models\Discount::class); + return $discount; + } + + public function advanceInvoiceSchedule() + { + $advance_invoice_schedule = $this->_get('advance_invoice_schedule', Models\AdvanceInvoiceSchedule::class, + array( + 'fixed_interval_schedule' => Models\AdvanceInvoiceScheduleFixedIntervalSchedule::class, + 'specific_dates_schedule' => Models\AdvanceInvoiceScheduleSpecificDatesSchedule::class + )); + return $advance_invoice_schedule; + } + + public function customer() + { + $customer = $this->_get('customer', Models\Customer::class, + array( + 'billing_address' => Models\CustomerBillingAddress::class, + 'referral_urls' => Models\CustomerReferralUrl::class, + 'contacts' => Models\CustomerContact::class, + 'payment_method' => Models\CustomerPaymentMethod::class, + 'balances' => Models\CustomerBalance::class, + 'entity_identifiers' => Models\CustomerEntityIdentifier::class, + 'tax_providers_fields' => Models\CustomerTaxProvidersField::class, + 'relationship' => Models\CustomerRelationship::class, + 'parent_account_access' => Models\CustomerParentAccountAccess::class, + 'child_account_access' => Models\CustomerChildAccountAccess::class + )); + return $customer; + } + + public function hierarchy() + { + $hierarchy = $this->_get('hierarchy', Models\Hierarchy::class); + return $hierarchy; + } + + public function contact() + { + $contact = $this->_get('contact', Models\Contact::class); + return $contact; + } + + public function businessEntityTransfer() + { + $business_entity_transfer = $this->_get('business_entity_transfer', Models\BusinessEntityTransfer::class); + return $business_entity_transfer; + } + + public function token() + { + $token = $this->_get('token', Models\Token::class); + return $token; + } + + public function paymentSource() + { + $payment_source = $this->_get('payment_source', Models\PaymentSource::class, + array( + 'card' => Models\PaymentSourceCard::class, + 'bank_account' => Models\PaymentSourceBankAccount::class, + 'cust_voucher_source' => Models\PaymentSourceCustVoucherSource::class, + 'billing_address' => Models\PaymentSourceBillingAddress::class, + 'amazon_payment' => Models\PaymentSourceAmazonPayment::class, + 'upi' => Models\PaymentSourceUpi::class, + 'paypal' => Models\PaymentSourcePaypal::class, + 'venmo' => Models\PaymentSourceVenmo::class, + 'klarna_pay_now' => Models\PaymentSourceKlarnaPayNow::class, + 'mandates' => Models\PaymentSourceMandate::class + )); + return $payment_source; + } + + public function thirdPartyPaymentMethod() + { + $third_party_payment_method = $this->_get('third_party_payment_method', Models\ThirdPartyPaymentMethod::class); + return $third_party_payment_method; + } + + public function virtualBankAccount() + { + $virtual_bank_account = $this->_get('virtual_bank_account', Models\VirtualBankAccount::class); + return $virtual_bank_account; + } + + public function card() + { + $card = $this->_get('card', Models\Card::class); + return $card; + } + + public function promotionalCredit() + { + $promotional_credit = $this->_get('promotional_credit', Models\PromotionalCredit::class); + return $promotional_credit; + } + + public function invoice() + { + $invoice = $this->_get('invoice', Models\Invoice::class, + array( + 'line_items' => Models\InvoiceLineItem::class, + 'discounts' => Models\InvoiceDiscount::class, + 'line_item_discounts' => Models\InvoiceLineItemDiscount::class, + 'taxes' => Models\InvoiceTax::class, + 'line_item_taxes' => Models\InvoiceLineItemTax::class, + 'line_item_tiers' => Models\InvoiceLineItemTier::class, + 'linked_payments' => Models\InvoiceLinkedPayment::class, + 'dunning_attempts' => Models\InvoiceDunningAttempt::class, + 'applied_credits' => Models\InvoiceAppliedCredit::class, + 'adjustment_credit_notes' => Models\InvoiceAdjustmentCreditNote::class, + 'issued_credit_notes' => Models\InvoiceIssuedCreditNote::class, + 'linked_orders' => Models\InvoiceLinkedOrder::class, + 'notes' => Models\InvoiceNote::class, + 'shipping_address' => Models\InvoiceShippingAddress::class, + 'statement_descriptor' => Models\InvoiceStatementDescriptor::class, + 'billing_address' => Models\InvoiceBillingAddress::class, + 'einvoice' => Models\InvoiceEinvoice::class, + 'site_details_at_creation' => Models\InvoiceSiteDetailsAtCreation::class, + 'tax_origin' => Models\InvoiceTaxOrigin::class + )); + return $invoice; + } + + public function paymentReferenceNumber() + { + $payment_reference_number = $this->_get('payment_reference_number', Models\PaymentReferenceNumber::class); + return $payment_reference_number; + } + + public function taxWithheld() + { + $tax_withheld = $this->_get('tax_withheld', Models\TaxWithheld::class); + return $tax_withheld; + } + + public function creditNote() + { + $credit_note = $this->_get('credit_note', Models\CreditNote::class, + array( + 'einvoice' => Models\CreditNoteEinvoice::class, + 'line_items' => Models\CreditNoteLineItem::class, + 'discounts' => Models\CreditNoteDiscount::class, + 'line_item_discounts' => Models\CreditNoteLineItemDiscount::class, + 'line_item_tiers' => Models\CreditNoteLineItemTier::class, + 'taxes' => Models\CreditNoteTax::class, + 'line_item_taxes' => Models\CreditNoteLineItemTax::class, + 'linked_refunds' => Models\CreditNoteLinkedRefund::class, + 'allocations' => Models\CreditNoteAllocation::class, + 'shipping_address' => Models\CreditNoteShippingAddress::class, + 'billing_address' => Models\CreditNoteBillingAddress::class, + 'site_details_at_creation' => Models\CreditNoteSiteDetailsAtCreation::class, + 'tax_origin' => Models\CreditNoteTaxOrigin::class + )); + return $credit_note; + } + + public function unbilledCharge() + { + $unbilled_charge = $this->_get('unbilled_charge', Models\UnbilledCharge::class, + array( + 'tiers' => Models\UnbilledChargeTier::class + )); + return $unbilled_charge; + } + + public function order() + { + $order = $this->_get('order', Models\Order::class, + array( + 'order_line_items' => Models\OrderOrderLineItem::class, + 'shipping_address' => Models\OrderShippingAddress::class, + 'billing_address' => Models\OrderBillingAddress::class, + 'line_item_taxes' => Models\OrderLineItemTax::class, + 'line_item_discounts' => Models\OrderLineItemDiscount::class, + 'linked_credit_notes' => Models\OrderLinkedCreditNote::class, + 'resent_orders' => Models\OrderResentOrder::class + )); + return $order; + } + + public function gift() + { + $gift = $this->_get('gift', Models\Gift::class, + array( + 'gifter' => Models\GiftGifter::class, + 'gift_receiver' => Models\GiftGiftReceiver::class, + 'gift_timelines' => Models\GiftGiftTimeline::class + )); + return $gift; + } + + public function transaction() + { + $transaction = $this->_get('transaction', Models\Transaction::class, + array( + 'linked_invoices' => Models\TransactionLinkedInvoice::class, + 'linked_credit_notes' => Models\TransactionLinkedCreditNote::class, + 'linked_refunds' => Models\TransactionLinkedRefund::class, + 'linked_payments' => Models\TransactionLinkedPayment::class, + 'gateway_error_detail' => Models\TransactionGatewayErrorDetail::class + )); + return $transaction; + } + + public function hostedPage() + { + $hosted_page = $this->_get('hosted_page', Models\HostedPage::class); + return $hosted_page; + } + + public function estimate() + { + $estimate = $this->_get('estimate', Models\Estimate::class, array(), + array( + 'subscription_estimate' => Models\SubscriptionEstimate::class, + 'subscription_estimates' => Models\SubscriptionEstimate::class, + 'invoice_estimate' => Models\InvoiceEstimate::class, + 'invoice_estimates' => Models\InvoiceEstimate::class, + 'next_invoice_estimate' => Models\InvoiceEstimate::class, + 'credit_note_estimates' => Models\CreditNoteEstimate::class, + 'unbilled_charge_estimates' => Models\UnbilledCharge::class + )); + $estimate->_initDependant($this->_response['estimate'], 'subscription_estimate', + array( + 'shipping_address' => Models\SubscriptionEstimateShippingAddress::class, + 'contract_term' => Models\SubscriptionEstimateContractTerm::class + )); + $estimate->_initDependant($this->_response['estimate'], 'invoice_estimate', + array( + 'line_items' => Models\InvoiceEstimateLineItem::class, + 'discounts' => Models\InvoiceEstimateDiscount::class, + 'taxes' => Models\InvoiceEstimateTax::class, + 'line_item_taxes' => Models\InvoiceEstimateLineItemTax::class, + 'line_item_tiers' => Models\InvoiceEstimateLineItemTier::class, + 'line_item_discounts' => Models\InvoiceEstimateLineItemDiscount::class + )); + $estimate->_initDependant($this->_response['estimate'], 'next_invoice_estimate', + array( + 'line_items' => Models\InvoiceEstimateLineItem::class, + 'discounts' => Models\InvoiceEstimateDiscount::class, + 'taxes' => Models\InvoiceEstimateTax::class, + 'line_item_taxes' => Models\InvoiceEstimateLineItemTax::class, + 'line_item_tiers' => Models\InvoiceEstimateLineItemTier::class, + 'line_item_discounts' => Models\InvoiceEstimateLineItemDiscount::class + )); + $estimate->_initDependantList($this->_response['estimate'], 'subscription_estimates', + array( + 'shipping_address' => Models\SubscriptionEstimateShippingAddress::class, + 'contract_term' => Models\SubscriptionEstimateContractTerm::class + )); + $estimate->_initDependantList($this->_response['estimate'], 'invoice_estimates', + array( + 'line_items' => Models\InvoiceEstimateLineItem::class, + 'discounts' => Models\InvoiceEstimateDiscount::class, + 'taxes' => Models\InvoiceEstimateTax::class, + 'line_item_taxes' => Models\InvoiceEstimateLineItemTax::class, + 'line_item_tiers' => Models\InvoiceEstimateLineItemTier::class, + 'line_item_discounts' => Models\InvoiceEstimateLineItemDiscount::class + )); + $estimate->_initDependantList($this->_response['estimate'], 'credit_note_estimates', + array( + 'line_items' => Models\CreditNoteEstimateLineItem::class, + 'discounts' => Models\CreditNoteEstimateDiscount::class, + 'taxes' => Models\CreditNoteEstimateTax::class, + 'line_item_taxes' => Models\CreditNoteEstimateLineItemTax::class, + 'line_item_discounts' => Models\CreditNoteEstimateLineItemDiscount::class, + 'line_item_tiers' => Models\CreditNoteEstimateLineItemTier::class + )); + $estimate->_initDependantList($this->_response['estimate'], 'unbilled_charge_estimates', + array( + 'tiers' => Models\UnbilledChargeTier::class + )); + return $estimate; + } + + public function quote() + { + $quote = $this->_get('quote', Models\Quote::class, + array( + 'line_items' => Models\QuoteLineItem::class, + 'discounts' => Models\QuoteDiscount::class, + 'line_item_discounts' => Models\QuoteLineItemDiscount::class, + 'taxes' => Models\QuoteTax::class, + 'line_item_taxes' => Models\QuoteLineItemTax::class, + 'line_item_tiers' => Models\QuoteLineItemTier::class, + 'shipping_address' => Models\QuoteShippingAddress::class, + 'billing_address' => Models\QuoteBillingAddress::class + )); + return $quote; + } + + public function quotedSubscription() + { + $quoted_subscription = $this->_get('quoted_subscription', Models\QuotedSubscription::class, + array( + 'addons' => Models\QuotedSubscriptionAddon::class, + 'event_based_addons' => Models\QuotedSubscriptionEventBasedAddon::class, + 'coupons' => Models\QuotedSubscriptionCoupon::class, + 'subscription_items' => Models\QuotedSubscriptionSubscriptionItem::class, + 'item_tiers' => Models\QuotedSubscriptionItemTier::class, + 'quoted_contract_term' => Models\QuotedSubscriptionQuotedContractTerm::class + )); + return $quoted_subscription; + } + + public function quotedCharge() + { + $quoted_charge = $this->_get('quoted_charge', Models\QuotedCharge::class, + array( + 'charges' => Models\QuotedChargeCharge::class, + 'addons' => Models\QuotedChargeAddon::class, + 'invoice_items' => Models\QuotedChargeInvoiceItem::class, + 'item_tiers' => Models\QuotedChargeItemTier::class, + 'coupons' => Models\QuotedChargeCoupon::class + )); + return $quoted_charge; + } + + public function quoteLineGroup() + { + $quote_line_group = $this->_get('quote_line_group', Models\QuoteLineGroup::class, + array( + 'line_items' => Models\QuoteLineGroupLineItem::class, + 'discounts' => Models\QuoteLineGroupDiscount::class, + 'line_item_discounts' => Models\QuoteLineGroupLineItemDiscount::class, + 'taxes' => Models\QuoteLineGroupTax::class, + 'line_item_taxes' => Models\QuoteLineGroupLineItemTax::class + )); + return $quote_line_group; + } + + public function plan() + { + $plan = $this->_get('plan', Models\Plan::class, + array( + 'tiers' => Models\PlanTier::class, + 'tax_providers_fields' => Models\PlanTaxProvidersField::class, + 'applicable_addons' => Models\PlanApplicableAddon::class, + 'attached_addons' => Models\PlanAttachedAddon::class, + 'event_based_addons' => Models\PlanEventBasedAddon::class + )); + return $plan; + } + + public function addon() + { + $addon = $this->_get('addon', Models\Addon::class, + array( + 'tiers' => Models\AddonTier::class, + 'tax_providers_fields' => Models\AddonTaxProvidersField::class + )); + return $addon; + } + + public function coupon() + { + $coupon = $this->_get('coupon', Models\Coupon::class, + array( + 'item_constraints' => Models\CouponItemConstraint::class, + 'item_constraint_criteria' => Models\CouponItemConstraintCriteria::class, + 'coupon_constraints' => Models\CouponCouponConstraint::class + )); + return $coupon; + } + + public function couponSet() + { + $coupon_set = $this->_get('coupon_set', Models\CouponSet::class); + return $coupon_set; + } + + public function couponCode() + { + $coupon_code = $this->_get('coupon_code', Models\CouponCode::class); + return $coupon_code; + } + + public function address() + { + $address = $this->_get('address', Models\Address::class); + return $address; + } + + public function usage() + { + $usage = $this->_get('usage', Models\Usage::class); + return $usage; + } + + public function event() + { + $event = $this->_get('event', Models\Event::class, + array( + 'webhooks' => Models\EventWebhook::class + )); + return $event; + } + + public function comment() + { + $comment = $this->_get('comment', Models\Comment::class); + return $comment; + } + + public function download() + { + $download = $this->_get('download', Models\Download::class); + return $download; + } + + public function portalSession() + { + $portal_session = $this->_get('portal_session', Models\PortalSession::class, + array( + 'linked_customers' => Models\PortalSessionLinkedCustomer::class + )); + return $portal_session; + } + + public function siteMigrationDetail() + { + $site_migration_detail = $this->_get('site_migration_detail', Models\SiteMigrationDetail::class); + return $site_migration_detail; + } + + public function resourceMigration() + { + $resource_migration = $this->_get('resource_migration', Models\ResourceMigration::class); + return $resource_migration; + } + + public function timeMachine() + { + $time_machine = $this->_get('time_machine', Models\TimeMachine::class); + return $time_machine; + } + + public function export() + { + $export = $this->_get('export', Models\Export::class, + array( + 'download' => Models\ExportDownload::class + )); + return $export; + } + + public function paymentIntent() + { + $payment_intent = $this->_get('payment_intent', Models\PaymentIntent::class, + array( + 'payment_attempt' => Models\PaymentIntentPaymentAttempt::class + )); + return $payment_intent; + } + + public function gatewayErrorDetail() + { + $gateway_error_detail = $this->_get('gateway_error_detail', Models\GatewayErrorDetail::class); + return $gateway_error_detail; + } + + public function itemFamily() + { + $item_family = $this->_get('item_family', Models\ItemFamily::class); + return $item_family; + } + + public function item() + { + $item = $this->_get('item', Models\Item::class, + array( + 'applicable_items' => Models\ItemApplicableItem::class + )); + return $item; + } + + public function priceVariant() + { + $price_variant = $this->_get('price_variant', Models\PriceVariant::class, + array( + 'attributes' => Models\PriceVariantAttribute::class + )); + return $price_variant; + } + + public function attribute() + { + $attribute = $this->_get('attribute', Models\Attribute::class); + return $attribute; + } + + public function itemPrice() + { + $item_price = $this->_get('item_price', Models\ItemPrice::class, + array( + 'tiers' => Models\ItemPriceTier::class, + 'tax_detail' => Models\ItemPriceTaxDetail::class, + 'tax_providers_fields' => Models\ItemPriceTaxProvidersField::class, + 'accounting_detail' => Models\ItemPriceAccountingDetail::class + )); + return $item_price; + } + + public function attachedItem() + { + $attached_item = $this->_get('attached_item', Models\AttachedItem::class); + return $attached_item; + } + + public function differentialPrice() + { + $differential_price = $this->_get('differential_price', Models\DifferentialPrice::class, + array( + 'tiers' => Models\DifferentialPriceTier::class, + 'parent_periods' => Models\DifferentialPriceParentPeriod::class + )); + return $differential_price; + } + + public function feature() + { + $feature = $this->_get('feature', Models\Feature::class, + array( + 'levels' => Models\FeatureLevel::class + )); + return $feature; + } + + public function impactedSubscription() + { + $impacted_subscription = $this->_get('impacted_subscription', Models\ImpactedSubscription::class, + array( + 'download' => Models\ImpactedSubscriptionDownload::class + )); + return $impacted_subscription; + } + + public function impactedItem() + { + $impacted_item = $this->_get('impacted_item', Models\ImpactedItem::class, + array( + 'download' => Models\ImpactedItemDownload::class + )); + return $impacted_item; + } + + public function impactedItemPrice() + { + $impacted_item_price = $this->_get('impacted_item_price', Models\ImpactedItemPrice::class, + array( + 'download' => Models\ImpactedItemPriceDownload::class + )); + return $impacted_item_price; + } + + public function metadata() + { + $metadata = $this->_get('metadata', Models\Metadata::class); + return $metadata; + } + + public function subscriptionEntitlement() + { + $subscription_entitlement = $this->_get('subscription_entitlement', Models\SubscriptionEntitlement::class, + array( + 'component' => Models\SubscriptionEntitlementComponent::class + )); + return $subscription_entitlement; + } + + public function customerEntitlement() + { + $customer_entitlement = $this->_get('customer_entitlement', Models\CustomerEntitlement::class); + return $customer_entitlement; + } + + public function itemEntitlement() + { + $item_entitlement = $this->_get('item_entitlement', Models\ItemEntitlement::class); + return $item_entitlement; + } + + public function entitlement() + { + $entitlement = $this->_get('entitlement', Models\Entitlement::class); + return $entitlement; + } + + public function inAppSubscription() + { + $in_app_subscription = $this->_get('in_app_subscription', Models\InAppSubscription::class); + return $in_app_subscription; + } + + public function nonSubscription() + { + $non_subscription = $this->_get('non_subscription', Models\NonSubscription::class); + return $non_subscription; + } + + public function entitlementOverride() + { + $entitlement_override = $this->_get('entitlement_override', Models\EntitlementOverride::class); + return $entitlement_override; + } + + public function businessEntity() + { + $business_entity = $this->_get('business_entity', Models\BusinessEntity::class); + return $business_entity; + } + + public function purchase() + { + $purchase = $this->_get('purchase', Models\Purchase::class); + return $purchase; + } + + public function paymentVoucher() + { + $payment_voucher = $this->_get('payment_voucher', Models\PaymentVoucher::class, + array( + 'linked_invoices' => Models\PaymentVoucherLinkedInvoice::class + )); + return $payment_voucher; + } + + public function currency() + { + $currency = $this->_get('currency', Models\Currency::class); + return $currency; + } + + public function ramp() + { + $ramp = $this->_get('ramp', Models\Ramp::class, + array( + 'items_to_add' => Models\RampItemsToAdd::class, + 'items_to_update' => Models\RampItemsToUpdate::class, + 'coupons_to_add' => Models\RampCouponsToAdd::class, + 'discounts_to_add' => Models\RampDiscountsToAdd::class, + 'item_tiers' => Models\RampItemTier::class, + 'status_transition_reason' => Models\RampStatusTransitionReason::class + )); + return $ramp; + } + + public function installmentConfig() + { + $installment_config = $this->_get('installment_config', Models\InstallmentConfig::class, + array( + 'installments' => Models\InstallmentConfigInstallment::class + )); + return $installment_config; + } + + public function installment() + { + $installment = $this->_get('installment', Models\Installment::class); + return $installment; + } + + public function installmentDetail() + { + $installment_detail = $this->_get('installment_detail', Models\InstallmentDetail::class, + array( + 'installments' => Models\InstallmentDetailInstallment::class + )); + return $installment_detail; + } + + public function pricingPageSession() + { + $pricing_page_session = $this->_get('pricing_page_session', Models\PricingPageSession::class); + return $pricing_page_session; + } + + public function advanceInvoiceSchedules() + { + $advance_invoice_schedules = $this->_getList('advance_invoice_schedules', Models\AdvanceInvoiceSchedule::class, + array( + 'fixed_interval_schedule' => Models\AdvanceInvoiceScheduleFixedIntervalSchedule::class, + 'specific_dates_schedule' => Models\AdvanceInvoiceScheduleSpecificDatesSchedule::class + )); + return $advance_invoice_schedules; + } + + public function hierarchies() + { + $hierarchies = $this->_getList('hierarchies', Models\Hierarchy::class, + array( + )); + return $hierarchies; + } + + public function invoices() + { + $invoices = $this->_getList('invoices', Models\Invoice::class, + array( + 'line_items' => Models\InvoiceLineItem::class, + 'discounts' => Models\InvoiceDiscount::class, + 'line_item_discounts' => Models\InvoiceLineItemDiscount::class, + 'taxes' => Models\InvoiceTax::class, + 'line_item_taxes' => Models\InvoiceLineItemTax::class, + 'line_item_tiers' => Models\InvoiceLineItemTier::class, + 'linked_payments' => Models\InvoiceLinkedPayment::class, + 'dunning_attempts' => Models\InvoiceDunningAttempt::class, + 'applied_credits' => Models\InvoiceAppliedCredit::class, + 'adjustment_credit_notes' => Models\InvoiceAdjustmentCreditNote::class, + 'issued_credit_notes' => Models\InvoiceIssuedCreditNote::class, + 'linked_orders' => Models\InvoiceLinkedOrder::class, + 'notes' => Models\InvoiceNote::class, + 'shipping_address' => Models\InvoiceShippingAddress::class, + 'statement_descriptor' => Models\InvoiceStatementDescriptor::class, + 'billing_address' => Models\InvoiceBillingAddress::class, + 'einvoice' => Models\InvoiceEinvoice::class, + 'site_details_at_creation' => Models\InvoiceSiteDetailsAtCreation::class, + 'tax_origin' => Models\InvoiceTaxOrigin::class + )); + return $invoices; + } + + public function differentialPrices() + { + $differential_prices = $this->_getList('differential_prices', Models\DifferentialPrice::class, + array( + 'tiers' => Models\DifferentialPriceTier::class, + 'parent_periods' => Models\DifferentialPriceParentPeriod::class + )); + return $differential_prices; + } + + public function creditNotes() + { + $credit_notes = $this->_getList('credit_notes', Models\CreditNote::class, + array( + 'einvoice' => Models\CreditNoteEinvoice::class, + 'line_items' => Models\CreditNoteLineItem::class, + 'discounts' => Models\CreditNoteDiscount::class, + 'line_item_discounts' => Models\CreditNoteLineItemDiscount::class, + 'line_item_tiers' => Models\CreditNoteLineItemTier::class, + 'taxes' => Models\CreditNoteTax::class, + 'line_item_taxes' => Models\CreditNoteLineItemTax::class, + 'linked_refunds' => Models\CreditNoteLinkedRefund::class, + 'allocations' => Models\CreditNoteAllocation::class, + 'shipping_address' => Models\CreditNoteShippingAddress::class, + 'billing_address' => Models\CreditNoteBillingAddress::class, + 'site_details_at_creation' => Models\CreditNoteSiteDetailsAtCreation::class, + 'tax_origin' => Models\CreditNoteTaxOrigin::class + )); + return $credit_notes; + } + + public function unbilledCharges() + { + $unbilled_charges = $this->_getList('unbilled_charges', Models\UnbilledCharge::class, + array( + 'tiers' => Models\UnbilledChargeTier::class + )); + return $unbilled_charges; + } + + public function downloads() + { + $downloads = $this->_getList('downloads', Models\Download::class, + array( + )); + return $downloads; + } + + public function inAppSubscriptions() + { + $in_app_subscriptions = $this->_getList('in_app_subscriptions', Models\InAppSubscription::class, + array( + )); + return $in_app_subscriptions; + } + + + public function toJson() + { + return json_encode($this->_response); + } + + private function _getList($type, $class, $subTypes = array(), $dependantTypes = array(), $dependantSubTypes = array()) + { + if(!array_key_exists($type, $this->_response)) + { + return null; + } + if(!array_key_exists($type, $this->_responseObj)) + { + $setVal = array(); + foreach($this->_response[$type] as $stV) + { + $obj = new $class($stV, $subTypes, $dependantTypes); + foreach($dependantSubTypes as $k => $v) + { + $obj->_initDependant($stV, $k, $v); + } + array_push($setVal, $obj); + } + $this->_responseObj[$type] = $setVal; + } + return $this->_responseObj[$type]; + } + + private function _get($type, $class, $subTypes = array(), $dependantTypes = array()) + { + if(!array_key_exists($type, $this->_response)) + { + return null; + } + if(!array_key_exists($type, $this->_responseObj)) + { + $this->_responseObj[$type] = new $class($this->_response[$type], $subTypes, $dependantTypes); + } + return $this->_responseObj[$type]; + } + +} + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Util.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Util.php new file mode 100644 index 0000000000..11d8d74955 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Util.php @@ -0,0 +1,80 @@ +<?php + +namespace ChargeBee\ChargeBee; + +use Exception; + +class Util +{ + public static function toCamelCaseFromUnderscore($str) + { + $func = function ($c) { + return strtoupper($c[1]); + }; + + return preg_replace_callback('/_([a-z])/', $func, $str); + } + + public static function toUnderscoreFromCamelCase($str) + { + $func = function ($c) { + return "_" . strtolower($c[1]); + }; + + if (preg_match('/_/', $str)) { + return $str; + } + + return preg_replace_callback('/([A-Z])/', $func, $str); + } + + public static function serialize($value, $prefix = null, $idx = null) + { + if ($value && !is_array($value)) { + throw new Exception("only arrays are allowed as value"); + } + + $serialized = []; + foreach ($value as $k => $v) { + if (is_array($v) && !is_int($k)) { + $serialized = array_merge($serialized, self::serialize($v, self::toUnderscoreFromCamelCase($k))); + } elseif (is_array($v) && is_int($k)) { + $serialized = array_merge($serialized, self::serialize($v, $prefix, $k)); + } else { + $usK = self::toUnderscoreFromCamelCase($k); + $key = (!is_null($prefix)?$prefix:'').(!is_null($prefix)?'['.$usK.']':$usK).(!is_null($idx)?'['.$idx.']':''); + $serialized[$key] = self::asString($v); + } + } + + return $serialized; + } + + public static function asString($value) + { + if (is_null($value)) { + return ''; + } elseif (is_bool($value)) { + return ($value) ? 'true' : 'false'; + } else { + return (string)$value; + } + } + + public static function encodeURIPath() + { + $uriPaths = ""; + + foreach (func_get_args() as $arg) { + $arg = trim($arg); + + if ($arg == null || strlen($arg) < 1) { + throw new Exception("Id cannot be null or empty"); + } + + $uriPaths .= "/" . implode('/', array_map('rawurlencode', explode('/', $arg))); + } + + return $uriPaths; + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Version.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Version.php new file mode 100644 index 0000000000..da54e44282 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/ChargeBee/Version.php @@ -0,0 +1,10 @@ +<?php + +namespace ChargeBee\ChargeBee; + +final class Version +{ + const VERSION = '3.33.0'; +} + +?> diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/init.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/init.php new file mode 100644 index 0000000000..846c80e75b --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/chargebee/chargebee-php/lib/init.php @@ -0,0 +1,257 @@ +<?php + + +require(dirname(__FILE__) . '/AbstractChargeBee.php'); +require(dirname(__FILE__) . '/ChargeBee.php'); +require(dirname(__FILE__) . '/ChargeBee/Version.php'); +require(dirname(__FILE__) . '/ChargeBee/Environment.php'); +require(dirname(__FILE__) . '/ChargeBee/Util.php'); + +require(dirname(__FILE__) . '/ChargeBee/Exceptions/IOException.php'); +require(dirname(__FILE__) . '/ChargeBee/Exceptions/APIError.php'); +require(dirname(__FILE__) . '/ChargeBee/Exceptions/PaymentException.php'); +require(dirname(__FILE__) . '/ChargeBee/Exceptions/OperationFailedException.php'); +require(dirname(__FILE__) . '/ChargeBee/Exceptions/InvalidRequestException.php'); + +require(dirname(__FILE__) . '/ChargeBee/Request.php'); +require(dirname(__FILE__) . '/ChargeBee/Guzzle.php'); + +require(dirname(__FILE__) . '/ChargeBee/Result.php'); +require(dirname(__FILE__) . '/ChargeBee/ListResult.php'); + +require(dirname(__FILE__) . '/ChargeBee/Model.php'); + +require(dirname(__FILE__) . '/ChargeBee/Models/Addon.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/AddonTaxProvidersField.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/AddonTier.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/Address.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/AdvanceInvoiceSchedule.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/AdvanceInvoiceScheduleFixedIntervalSchedule.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/AdvanceInvoiceScheduleSpecificDatesSchedule.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/AttachedItem.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/Attribute.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/BusinessEntity.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/BusinessEntityTransfer.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/Card.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/Comment.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/Contact.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/ContractTerm.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/Coupon.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/CouponCode.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/CouponCouponConstraint.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/CouponItemConstraint.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/CouponItemConstraintCriteria.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/CouponSet.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/CreditNote.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/CreditNoteAllocation.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/CreditNoteBillingAddress.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/CreditNoteDiscount.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/CreditNoteEinvoice.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/CreditNoteEstimate.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/CreditNoteEstimateDiscount.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/CreditNoteEstimateLineItem.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/CreditNoteEstimateLineItemDiscount.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/CreditNoteEstimateLineItemTax.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/CreditNoteEstimateLineItemTier.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/CreditNoteEstimateTax.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/CreditNoteLineItem.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/CreditNoteLineItemDiscount.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/CreditNoteLineItemTax.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/CreditNoteLineItemTier.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/CreditNoteLinkedRefund.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/CreditNoteShippingAddress.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/CreditNoteSiteDetailsAtCreation.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/CreditNoteTax.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/CreditNoteTaxOrigin.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/Currency.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/Customer.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/CustomerBalance.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/CustomerBillingAddress.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/CustomerChildAccountAccess.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/CustomerContact.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/CustomerEntitlement.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/CustomerEntityIdentifier.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/CustomerParentAccountAccess.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/CustomerPaymentMethod.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/CustomerReferralUrl.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/CustomerRelationship.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/CustomerTaxProvidersField.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/DifferentialPrice.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/DifferentialPriceParentPeriod.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/DifferentialPriceTier.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/Discount.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/Download.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/Entitlement.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/EntitlementOverride.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/Estimate.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/Event.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/EventWebhook.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/Export.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/ExportDownload.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/Feature.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/FeatureLevel.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/GatewayErrorDetail.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/Gift.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/GiftGiftReceiver.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/GiftGiftTimeline.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/GiftGifter.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/Hierarchy.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/HostedPage.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/ImpactedItem.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/ImpactedItemDownload.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/ImpactedItemPrice.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/ImpactedItemPriceDownload.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/ImpactedSubscription.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/ImpactedSubscriptionDownload.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/InAppSubscription.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/Installment.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/InstallmentConfig.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/InstallmentConfigInstallment.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/InstallmentDetail.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/InstallmentDetailInstallment.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/Invoice.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/InvoiceAdjustmentCreditNote.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/InvoiceAppliedCredit.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/InvoiceBillingAddress.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/InvoiceDiscount.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/InvoiceDunningAttempt.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/InvoiceEinvoice.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/InvoiceEstimate.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/InvoiceEstimateDiscount.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/InvoiceEstimateLineItem.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/InvoiceEstimateLineItemDiscount.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/InvoiceEstimateLineItemTax.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/InvoiceEstimateLineItemTier.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/InvoiceEstimateTax.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/InvoiceIssuedCreditNote.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/InvoiceLineItem.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/InvoiceLineItemDiscount.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/InvoiceLineItemTax.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/InvoiceLineItemTier.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/InvoiceLinkedOrder.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/InvoiceLinkedPayment.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/InvoiceNote.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/InvoiceShippingAddress.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/InvoiceSiteDetailsAtCreation.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/InvoiceStatementDescriptor.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/InvoiceTax.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/InvoiceTaxOrigin.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/Item.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/ItemApplicableItem.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/ItemEntitlement.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/ItemFamily.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/ItemPrice.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/ItemPriceAccountingDetail.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/ItemPriceTaxDetail.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/ItemPriceTaxProvidersField.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/ItemPriceTier.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/Metadata.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/NonSubscription.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/Order.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/OrderBillingAddress.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/OrderLineItemDiscount.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/OrderLineItemTax.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/OrderLinkedCreditNote.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/OrderOrderLineItem.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/OrderResentOrder.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/OrderShippingAddress.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/PaymentIntent.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/PaymentIntentPaymentAttempt.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/PaymentReferenceNumber.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/PaymentSource.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/PaymentSourceAmazonPayment.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/PaymentSourceBankAccount.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/PaymentSourceBillingAddress.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/PaymentSourceCard.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/PaymentSourceCustVoucherSource.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/PaymentSourceKlarnaPayNow.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/PaymentSourceMandate.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/PaymentSourcePaypal.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/PaymentSourceUpi.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/PaymentSourceVenmo.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/PaymentVoucher.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/PaymentVoucherLinkedInvoice.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/Plan.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/PlanApplicableAddon.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/PlanAttachedAddon.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/PlanEventBasedAddon.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/PlanTaxProvidersField.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/PlanTier.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/PortalSession.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/PortalSessionLinkedCustomer.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/PriceVariant.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/PriceVariantAttribute.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/PricingPageSession.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/PromotionalCredit.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/Purchase.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/Quote.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/QuoteBillingAddress.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/QuoteDiscount.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/QuoteLineGroup.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/QuoteLineGroupDiscount.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/QuoteLineGroupLineItem.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/QuoteLineGroupLineItemDiscount.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/QuoteLineGroupLineItemTax.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/QuoteLineGroupTax.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/QuoteLineItem.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/QuoteLineItemDiscount.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/QuoteLineItemTax.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/QuoteLineItemTier.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/QuoteShippingAddress.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/QuoteTax.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/QuotedCharge.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/QuotedChargeAddon.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/QuotedChargeCharge.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/QuotedChargeCoupon.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/QuotedChargeInvoiceItem.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/QuotedChargeItemTier.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/QuotedSubscription.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/QuotedSubscriptionAddon.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/QuotedSubscriptionCoupon.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/QuotedSubscriptionEventBasedAddon.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/QuotedSubscriptionItemTier.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/QuotedSubscriptionQuotedContractTerm.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/QuotedSubscriptionSubscriptionItem.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/Ramp.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/RampCouponsToAdd.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/RampDiscountsToAdd.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/RampItemTier.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/RampItemsToAdd.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/RampItemsToUpdate.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/RampStatusTransitionReason.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/ResourceMigration.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/SiteMigrationDetail.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/Subscription.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/SubscriptionAddon.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/SubscriptionChargedEventBasedAddon.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/SubscriptionChargedItem.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/SubscriptionContractTerm.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/SubscriptionCoupon.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/SubscriptionDiscount.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/SubscriptionEntitlement.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/SubscriptionEntitlementComponent.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/SubscriptionEstimate.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/SubscriptionEstimateContractTerm.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/SubscriptionEstimateShippingAddress.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/SubscriptionEventBasedAddon.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/SubscriptionItemTier.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/SubscriptionReferralInfo.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/SubscriptionShippingAddress.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/SubscriptionSubscriptionItem.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/TaxWithheld.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/ThirdPartyPaymentMethod.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/TimeMachine.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/Token.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/Transaction.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/TransactionGatewayErrorDetail.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/TransactionLinkedCreditNote.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/TransactionLinkedInvoice.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/TransactionLinkedPayment.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/TransactionLinkedRefund.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/UnbilledCharge.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/UnbilledChargeTier.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/Usage.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/VirtualBankAccount.php'); +require(dirname(__FILE__) . '/ChargeBee/Models/Content.php'); + +?> \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/composer/autoload_psr4.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/composer/autoload_psr4.php new file mode 100644 index 0000000000..3701d2bea3 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/composer/autoload_psr4.php @@ -0,0 +1,31 @@ +<?php + +// autoload_psr4.php @generated by Composer + +$vendorDir = dirname(dirname(__FILE__)); +$baseDir = dirname($vendorDir); + +return array( + 'Twilio\\' => array($vendorDir . '/twilio/sdk/src/Twilio'), + 'Stripe\\' => array($vendorDir . '/stripe/stripe-php/lib'), + 'Spatie\\CalendarLinks\\' => array($vendorDir . '/spatie/calendar-links/src'), + 'Snipe\\BanBuilder\\' => array($vendorDir . '/snipe/banbuilder/src'), + 'Sample\\' => array($vendorDir . '/paypal/paypal-checkout-sdk/samples'), + 'Pusher\\' => array($vendorDir . '/pusher/pusher-php-server/src'), + 'Psr\\Log\\' => array($vendorDir . '/psr/log/src'), + 'Psr\\Http\\Message\\' => array($vendorDir . '/psr/http-message/src', $vendorDir . '/psr/http-factory/src'), + 'Psr\\Http\\Client\\' => array($vendorDir . '/psr/http-client/src'), + 'PayPalHttp\\' => array($vendorDir . '/paypal/paypalhttp/lib/PayPalHttp'), + 'PayPalCheckoutSdk\\' => array($vendorDir . '/paypal/paypal-checkout-sdk/lib/PayPalCheckoutSdk'), + 'PHPMailer\\PHPMailer\\' => array($vendorDir . '/phpmailer/phpmailer/src'), + 'MatthiasMullie\\PathConverter\\' => array($vendorDir . '/matthiasmullie/path-converter/src'), + 'MatthiasMullie\\Minify\\' => array($vendorDir . '/matthiasmullie/minify/src'), + 'Intervention\\Image\\' => array($vendorDir . '/intervention/image/src/Intervention/Image'), + 'GuzzleHttp\\Psr7\\' => array($vendorDir . '/guzzlehttp/psr7/src'), + 'GuzzleHttp\\Promise\\' => array($vendorDir . '/guzzlehttp/promises/src'), + 'GuzzleHttp\\' => array($vendorDir . '/guzzlehttp/guzzle/src'), + 'Embera\\' => array($vendorDir . '/mpratt/embera/src/Embera'), + 'ChargeBee\\' => array($vendorDir . '/chargebee/chargebee-php/lib'), + 'AvtoDev\\Composer\\Cleanup\\' => array($vendorDir . '/avto-dev/composer-cleanup-plugin/src'), + 'Akeeba\\S3\\' => array($vendorDir . '/akeeba/s3/src'), +); diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/composer/autoload_real.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/composer/autoload_real.php new file mode 100644 index 0000000000..32ca225926 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/composer/autoload_real.php @@ -0,0 +1,75 @@ +<?php + +// autoload_real.php @generated by Composer + +class ComposerAutoloaderInit03a8066c470486be30535b543d47f96a +{ + private static $loader; + + public static function loadClassLoader($class) + { + if ('Composer\Autoload\ClassLoader' === $class) { + require __DIR__ . '/ClassLoader.php'; + } + } + + /** + * @return \Composer\Autoload\ClassLoader + */ + public static function getLoader() + { + if (null !== self::$loader) { + return self::$loader; + } + + require __DIR__ . '/platform_check.php'; + + spl_autoload_register(array('ComposerAutoloaderInit03a8066c470486be30535b543d47f96a', 'loadClassLoader'), true, true); + self::$loader = $loader = new \Composer\Autoload\ClassLoader(\dirname(\dirname(__FILE__))); + spl_autoload_unregister(array('ComposerAutoloaderInit03a8066c470486be30535b543d47f96a', 'loadClassLoader')); + + $useStaticLoader = PHP_VERSION_ID >= 50600 && !defined('HHVM_VERSION') && (!function_exists('zend_loader_file_encoded') || !zend_loader_file_encoded()); + if ($useStaticLoader) { + require __DIR__ . '/autoload_static.php'; + + call_user_func(\Composer\Autoload\ComposerStaticInit03a8066c470486be30535b543d47f96a::getInitializer($loader)); + } else { + $map = require __DIR__ . '/autoload_namespaces.php'; + foreach ($map as $namespace => $path) { + $loader->set($namespace, $path); + } + + $map = require __DIR__ . '/autoload_psr4.php'; + foreach ($map as $namespace => $path) { + $loader->setPsr4($namespace, $path); + } + + $classMap = require __DIR__ . '/autoload_classmap.php'; + if ($classMap) { + $loader->addClassMap($classMap); + } + } + + $loader->register(true); + + if ($useStaticLoader) { + $includeFiles = Composer\Autoload\ComposerStaticInit03a8066c470486be30535b543d47f96a::$files; + } else { + $includeFiles = require __DIR__ . '/autoload_files.php'; + } + foreach ($includeFiles as $fileIdentifier => $file) { + composerRequire03a8066c470486be30535b543d47f96a($fileIdentifier, $file); + } + + return $loader; + } +} + +function composerRequire03a8066c470486be30535b543d47f96a($fileIdentifier, $file) +{ + if (empty($GLOBALS['__composer_autoload_files'][$fileIdentifier])) { + require $file; + + $GLOBALS['__composer_autoload_files'][$fileIdentifier] = true; + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/composer/autoload_static.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/composer/autoload_static.php new file mode 100644 index 0000000000..141228e601 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/composer/autoload_static.php @@ -0,0 +1,226 @@ +<?php + +// autoload_static.php @generated by Composer + +namespace Composer\Autoload; + +class ComposerStaticInit03a8066c470486be30535b543d47f96a +{ + public static $files = array ( + '7b11c4dc42b3b3023073cb14e519683c' => __DIR__ . '/..' . '/ralouphie/getallheaders/src/getallheaders.php', + '6e3fae29631ef280660b3cdad06f25a8' => __DIR__ . '/..' . '/symfony/deprecation-contracts/function.php', + '37a3dc5111fe8f707ab4c132ef1dbc62' => __DIR__ . '/..' . '/guzzlehttp/guzzle/src/functions_include.php', + '3109cb1a231dcd04bee1f9f620d46975' => __DIR__ . '/..' . '/paragonie/sodium_compat/autoload.php', + '714ccd4b330431237faf946f71c4c9a4' => __DIR__ . '/..' . '/akeeba/s3/src/aliasing.php', + '2cffec82183ee1cea088009cef9a6fc3' => __DIR__ . '/..' . '/ezyang/htmlpurifier/library/HTMLPurifier.composer.php', + ); + + public static $prefixLengthsPsr4 = array ( + 'T' => + array ( + 'Twilio\\' => 7, + ), + 'S' => + array ( + 'Stripe\\' => 7, + 'Spatie\\CalendarLinks\\' => 21, + 'Snipe\\BanBuilder\\' => 17, + 'Sample\\' => 7, + ), + 'P' => + array ( + 'Pusher\\' => 7, + 'Psr\\Log\\' => 8, + 'Psr\\Http\\Message\\' => 17, + 'Psr\\Http\\Client\\' => 16, + 'PayPalHttp\\' => 11, + 'PayPalCheckoutSdk\\' => 18, + 'PHPMailer\\PHPMailer\\' => 20, + ), + 'M' => + array ( + 'MatthiasMullie\\PathConverter\\' => 29, + 'MatthiasMullie\\Minify\\' => 22, + ), + 'I' => + array ( + 'Intervention\\Image\\' => 19, + ), + 'G' => + array ( + 'GuzzleHttp\\Psr7\\' => 16, + 'GuzzleHttp\\Promise\\' => 19, + 'GuzzleHttp\\' => 11, + ), + 'E' => + array ( + 'Embera\\' => 7, + ), + 'C' => + array ( + 'ChargeBee\\' => 10, + ), + 'A' => + array ( + 'AvtoDev\\Composer\\Cleanup\\' => 25, + 'Akeeba\\S3\\' => 10, + ), + ); + + public static $prefixDirsPsr4 = array ( + 'Twilio\\' => + array ( + 0 => __DIR__ . '/..' . '/twilio/sdk/src/Twilio', + ), + 'Stripe\\' => + array ( + 0 => __DIR__ . '/..' . '/stripe/stripe-php/lib', + ), + 'Spatie\\CalendarLinks\\' => + array ( + 0 => __DIR__ . '/..' . '/spatie/calendar-links/src', + ), + 'Snipe\\BanBuilder\\' => + array ( + 0 => __DIR__ . '/..' . '/snipe/banbuilder/src', + ), + 'Sample\\' => + array ( + 0 => __DIR__ . '/..' . '/paypal/paypal-checkout-sdk/samples', + ), + 'Pusher\\' => + array ( + 0 => __DIR__ . '/..' . '/pusher/pusher-php-server/src', + ), + 'Psr\\Log\\' => + array ( + 0 => __DIR__ . '/..' . '/psr/log/src', + ), + 'Psr\\Http\\Message\\' => + array ( + 0 => __DIR__ . '/..' . '/psr/http-message/src', + 1 => __DIR__ . '/..' . '/psr/http-factory/src', + ), + 'Psr\\Http\\Client\\' => + array ( + 0 => __DIR__ . '/..' . '/psr/http-client/src', + ), + 'PayPalHttp\\' => + array ( + 0 => __DIR__ . '/..' . '/paypal/paypalhttp/lib/PayPalHttp', + ), + 'PayPalCheckoutSdk\\' => + array ( + 0 => __DIR__ . '/..' . '/paypal/paypal-checkout-sdk/lib/PayPalCheckoutSdk', + ), + 'PHPMailer\\PHPMailer\\' => + array ( + 0 => __DIR__ . '/..' . '/phpmailer/phpmailer/src', + ), + 'MatthiasMullie\\PathConverter\\' => + array ( + 0 => __DIR__ . '/..' . '/matthiasmullie/path-converter/src', + ), + 'MatthiasMullie\\Minify\\' => + array ( + 0 => __DIR__ . '/..' . '/matthiasmullie/minify/src', + ), + 'Intervention\\Image\\' => + array ( + 0 => __DIR__ . '/..' . '/intervention/image/src/Intervention/Image', + ), + 'GuzzleHttp\\Psr7\\' => + array ( + 0 => __DIR__ . '/..' . '/guzzlehttp/psr7/src', + ), + 'GuzzleHttp\\Promise\\' => + array ( + 0 => __DIR__ . '/..' . '/guzzlehttp/promises/src', + ), + 'GuzzleHttp\\' => + array ( + 0 => __DIR__ . '/..' . '/guzzlehttp/guzzle/src', + ), + 'Embera\\' => + array ( + 0 => __DIR__ . '/..' . '/mpratt/embera/src/Embera', + ), + 'ChargeBee\\' => + array ( + 0 => __DIR__ . '/..' . '/chargebee/chargebee-php/lib', + ), + 'AvtoDev\\Composer\\Cleanup\\' => + array ( + 0 => __DIR__ . '/..' . '/avto-dev/composer-cleanup-plugin/src', + ), + 'Akeeba\\S3\\' => + array ( + 0 => __DIR__ . '/..' . '/akeeba/s3/src', + ), + ); + + public static $prefixesPsr0 = array ( + 'P' => + array ( + 'Parsedown' => + array ( + 0 => __DIR__ . '/..' . '/erusev/parsedown', + ), + ), + 'O' => + array ( + 'OAuth\\Unit' => + array ( + 0 => __DIR__ . '/..' . '/lusitanian/oauth/tests', + ), + 'OAuth2' => + array ( + 0 => __DIR__ . '/..' . '/bshaffer/oauth2-server-php/src', + ), + 'OAuth' => + array ( + 0 => __DIR__ . '/..' . '/lusitanian/oauth/src', + ), + ), + 'L' => + array ( + 'Less' => + array ( + 0 => __DIR__ . '/..' . '/wikimedia/less.php/lib', + ), + ), + 'H' => + array ( + 'HTMLPurifier' => + array ( + 0 => __DIR__ . '/..' . '/ezyang/htmlpurifier/library', + ), + ), + 'C' => + array ( + 'ChargeBee' => + array ( + 0 => __DIR__ . '/..' . '/chargebee/chargebee-php/lib', + ), + ), + ); + + public static $classMap = array ( + 'Composer\\InstalledVersions' => __DIR__ . '/..' . '/composer/InstalledVersions.php', + 'S3v4\\S3' => __DIR__ . '/..' . '/tpyo/amazon-s3-php-class/S3.php', + 'S3v4\\S3Exception' => __DIR__ . '/..' . '/tpyo/amazon-s3-php-class/S3.php', + 'S3v4\\S3Request' => __DIR__ . '/..' . '/tpyo/amazon-s3-php-class/S3.php', + 'lessc' => __DIR__ . '/..' . '/wikimedia/less.php/lessc.inc.php', + ); + + public static function getInitializer(ClassLoader $loader) + { + return \Closure::bind(function () use ($loader) { + $loader->prefixLengthsPsr4 = ComposerStaticInit03a8066c470486be30535b543d47f96a::$prefixLengthsPsr4; + $loader->prefixDirsPsr4 = ComposerStaticInit03a8066c470486be30535b543d47f96a::$prefixDirsPsr4; + $loader->prefixesPsr0 = ComposerStaticInit03a8066c470486be30535b543d47f96a::$prefixesPsr0; + $loader->classMap = ComposerStaticInit03a8066c470486be30535b543d47f96a::$classMap; + + }, null, ClassLoader::class); + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/composer/installed.json b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/composer/installed.json new file mode 100644 index 0000000000..95e2ca682d --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/composer/installed.json @@ -0,0 +1,2220 @@ +{ + "packages": [ + { + "name": "achingbrain/php5-akismet", + "version": "0.5", + "version_normalized": "0.5.0.0", + "source": { + "type": "git", + "url": "https://github.com/achingbrain/php5-akismet", + "reference": "master" + }, + "type": "library", + "installation-source": "source", + "install-path": "../achingbrain/php5-akismet" + }, + { + "name": "akeeba/s3", + "version": "dev-development", + "version_normalized": "dev-development", + "source": { + "type": "git", + "url": "https://github.com/akeeba/s3.git", + "reference": "850dbfad69afcf43a4f0da29d93101fbb53422fb" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/akeeba/s3/zipball/850dbfad69afcf43a4f0da29d93101fbb53422fb", + "reference": "850dbfad69afcf43a4f0da29d93101fbb53422fb", + "shasum": "" + }, + "require": { + "ext-curl": "*", + "ext-simplexml": "*", + "php": ">=7.1.0 <8.4" + }, + "time": "2024-08-29T12:53:26+00:00", + "default-branch": true, + "type": "library", + "installation-source": "dist", + "autoload": { + "files": [ + "src/aliasing.php" + ], + "psr-4": { + "Akeeba\\S3\\": "src" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "GPL-3.0-or-later" + ], + "authors": [ + { + "name": "Nicholas K. Dionysopoulos", + "email": "nicholas_NO_SPAM_PLEASE@akeeba.com", + "homepage": "http://www.dionysopoulos.me", + "role": "Lead Developer" + } + ], + "description": "A compact, dependency-less Amazon S3 API client implementing the most commonly used features", + "homepage": "https://github.com/akeeba/s3", + "keywords": [ + "s3" + ], + "support": { + "issues": "https://github.com/akeeba/s3/issues", + "source": "https://github.com/akeeba/s3/tree/development" + }, + "install-path": "../akeeba/s3" + }, + { + "name": "avto-dev/composer-cleanup-plugin", + "version": "dev-master", + "version_normalized": "dev-master", + "source": { + "type": "git", + "url": "https://github.com/unacms/composer-cleanup-plugin.git", + "reference": "75187ca4854265174021765e3b67cb973dc37723" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/unacms/composer-cleanup-plugin/zipball/75187ca4854265174021765e3b67cb973dc37723", + "reference": "75187ca4854265174021765e3b67cb973dc37723", + "shasum": "" + }, + "require": { + "composer-plugin-api": "^1.0 || ^2.0", + "php": "^7.2 || ^8.0" + }, + "require-dev": { + "composer/composer": "^1.8.6 || ^2.0", + "phpstan/phpstan": "~0.12.34", + "phpunit/phpunit": "^8.5.4 || ^9.3" + }, + "time": "2021-09-04T13:12:22+00:00", + "default-branch": true, + "type": "composer-plugin", + "extra": { + "class": "AvtoDev\\Composer\\Cleanup\\Plugin" + }, + "installation-source": "dist", + "autoload": { + "psr-4": { + "AvtoDev\\Composer\\Cleanup\\": "src/" + } + }, + "autoload-dev": { + "psr-4": { + "AvtoDev\\Composer\\Cleanup\\Tests\\": "tests/" + } + }, + "scripts": { + "post-update-cmd": [ + "AvtoDev\\Composer\\Cleanup\\Plugin::cleanupAllPackages" + ], + "post-install-cmd": [ + "AvtoDev\\Composer\\Cleanup\\Plugin::cleanupAllPackages" + ], + "phpunit": [ + "@php ./vendor/bin/phpunit --no-coverage --colors=always" + ], + "phpunit-cover": [ + "@php ./vendor/bin/phpunit --coverage-html='./coverage/html'" + ], + "phpstan": [ + "@php ./vendor/bin/phpstan analyze -c ./phpstan.neon.dist --no-progress --ansi" + ], + "test": [ + "@phpstan", + "@phpunit" + ], + "test-cover": [ + "@phpstan", + "@phpunit-cover" + ] + }, + "license": [ + "MIT" + ], + "authors": [ + { + "name": "avto-dev", + "homepage": "https://github.com/avto-dev" + }, + { + "name": "Barry vd. Heuvel", + "email": "barryvdh@gmail.com" + } + ], + "description": "A composer cleanup plugin, to remove tests and documentation to save space", + "support": { + "issues": "https://github.com/avto-dev/composer-cleanup-plugin/issues", + "source": "https://github.com/avto-dev/composer-cleanup-plugin" + }, + "install-path": "../avto-dev/composer-cleanup-plugin" + }, + { + "name": "bshaffer/oauth2-server-php", + "version": "v1.14.1", + "version_normalized": "1.14.1.0", + "source": { + "type": "git", + "url": "https://github.com/bshaffer/oauth2-server-php.git", + "reference": "096db2c86a7d67a2ba45e72be7d208c342694542" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/bshaffer/oauth2-server-php/zipball/096db2c86a7d67a2ba45e72be7d208c342694542", + "reference": "096db2c86a7d67a2ba45e72be7d208c342694542", + "shasum": "" + }, + "require": { + "php": ">=7.2" + }, + "require-dev": { + "aws/aws-sdk-php": "^2.8", + "firebase/php-jwt": "^6.4", + "phpunit/phpunit": "^7.5||^8.0", + "predis/predis": "^1.1", + "thobbs/phpcassa": "dev-master", + "yoast/phpunit-polyfills": "^1.0" + }, + "suggest": { + "aws/aws-sdk-php": "~2.8 is required to use DynamoDB storage", + "firebase/php-jwt": "~v6.4 is required to use JWT features", + "mongodb/mongodb": "^1.1 is required to use MongoDB storage", + "predis/predis": "Required to use Redis storage", + "thobbs/phpcassa": "Required to use Cassandra storage" + }, + "time": "2023-07-07T17:53:54+00:00", + "type": "library", + "installation-source": "dist", + "autoload": { + "psr-0": { + "OAuth2": "src/" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Brent Shaffer", + "email": "bshafs@gmail.com", + "homepage": "http://brentertainment.com" + } + ], + "description": "OAuth2 Server for PHP", + "homepage": "http://github.com/bshaffer/oauth2-server-php", + "keywords": [ + "auth", + "oauth", + "oauth2" + ], + "support": { + "issues": "https://github.com/bshaffer/oauth2-server-php/issues", + "source": "https://github.com/bshaffer/oauth2-server-php/tree/v1.14.1" + }, + "install-path": "../bshaffer/oauth2-server-php" + }, + { + "name": "chargebee/chargebee-php", + "version": "v3.33.0", + "version_normalized": "3.33.0.0", + "source": { + "type": "git", + "url": "https://github.com/chargebee/chargebee-php.git", + "reference": "9423e1bbf8d1f8c48e40347fb1dfe711b817dbf0" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/chargebee/chargebee-php/zipball/9423e1bbf8d1f8c48e40347fb1dfe711b817dbf0", + "reference": "9423e1bbf8d1f8c48e40347fb1dfe711b817dbf0", + "shasum": "" + }, + "require": { + "ext-curl": "*", + "guzzlehttp/guzzle": ">=6.5", + "php": ">=5.6.0" + }, + "require-dev": { + "simpletest/simpletest": "^1.1" + }, + "time": "2024-08-29T06:59:27+00:00", + "type": "library", + "installation-source": "dist", + "autoload": { + "psr-0": { + "ChargeBee": "lib/" + }, + "psr-4": { + "ChargeBee\\": "lib/" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "description": "ChargeBee API client implementation for PHP", + "homepage": "https://github.com/chargebee/chargebee-php", + "keywords": [ + "chargebee", + "payments", + "recurring billing", + "subscription billing" + ], + "support": { + "issues": "https://github.com/chargebee/chargebee-php/issues", + "source": "https://github.com/chargebee/chargebee-php/tree/v3.33.0" + }, + "install-path": "../chargebee/chargebee-php" + }, + { + "name": "curl/cacert", + "version": "0.0.1", + "version_normalized": "0.0.1.0", + "dist": { + "type": "file", + "url": "https://curl.se/ca/cacert.pem" + }, + "type": "library", + "installation-source": "dist", + "install-path": "../curl/cacert" + }, + { + "name": "erusev/parsedown", + "version": "dev-master", + "version_normalized": "dev-master", + "source": { + "type": "git", + "url": "https://github.com/erusev/parsedown.git", + "reference": "26cfde9dbffa43a77bfd45c87b0394df0dfcba85" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/erusev/parsedown/zipball/26cfde9dbffa43a77bfd45c87b0394df0dfcba85", + "reference": "26cfde9dbffa43a77bfd45c87b0394df0dfcba85", + "shasum": "" + }, + "require": { + "ext-mbstring": "*", + "php": ">=5.3.0" + }, + "require-dev": { + "phpunit/phpunit": "^4.8.35" + }, + "time": "2024-07-09T06:15:45+00:00", + "default-branch": true, + "type": "library", + "installation-source": "dist", + "autoload": { + "psr-0": { + "Parsedown": "" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Emanuil Rusev", + "email": "hello@erusev.com", + "homepage": "http://erusev.com" + } + ], + "description": "Parser for Markdown.", + "homepage": "http://parsedown.org", + "keywords": [ + "markdown", + "parser" + ], + "support": { + "issues": "https://github.com/erusev/parsedown/issues", + "source": "https://github.com/erusev/parsedown/tree/master" + }, + "install-path": "../erusev/parsedown" + }, + { + "name": "ezyang/htmlpurifier", + "version": "v4.17.0", + "version_normalized": "4.17.0.0", + "source": { + "type": "git", + "url": "https://github.com/ezyang/htmlpurifier.git", + "reference": "bbc513d79acf6691fa9cf10f192c90dd2957f18c" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/ezyang/htmlpurifier/zipball/bbc513d79acf6691fa9cf10f192c90dd2957f18c", + "reference": "bbc513d79acf6691fa9cf10f192c90dd2957f18c", + "shasum": "" + }, + "require": { + "php": "~5.6.0 || ~7.0.0 || ~7.1.0 || ~7.2.0 || ~7.3.0 || ~7.4.0 || ~8.0.0 || ~8.1.0 || ~8.2.0 || ~8.3.0" + }, + "require-dev": { + "cerdic/css-tidy": "^1.7 || ^2.0", + "simpletest/simpletest": "dev-master" + }, + "suggest": { + "cerdic/css-tidy": "If you want to use the filter 'Filter.ExtractStyleBlocks'.", + "ext-bcmath": "Used for unit conversion and imagecrash protection", + "ext-iconv": "Converts text to and from non-UTF-8 encodings", + "ext-tidy": "Used for pretty-printing HTML" + }, + "time": "2023-11-17T15:01:25+00:00", + "type": "library", + "installation-source": "dist", + "autoload": { + "files": [ + "library/HTMLPurifier.composer.php" + ], + "psr-0": { + "HTMLPurifier": "library/" + }, + "exclude-from-classmap": [ + "/library/HTMLPurifier/Language/" + ] + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "LGPL-2.1-or-later" + ], + "authors": [ + { + "name": "Edward Z. Yang", + "email": "admin@htmlpurifier.org", + "homepage": "http://ezyang.com" + } + ], + "description": "Standards compliant HTML filter written in PHP", + "homepage": "http://htmlpurifier.org/", + "keywords": [ + "html" + ], + "support": { + "issues": "https://github.com/ezyang/htmlpurifier/issues", + "source": "https://github.com/ezyang/htmlpurifier/tree/v4.17.0" + }, + "install-path": "../ezyang/htmlpurifier" + }, + { + "name": "ffmpeg/ffmpeg", + "version": "4.4.0", + "version_normalized": "4.4.0.0", + "dist": { + "type": "file", + "url": "https://github.com/eugeneware/ffmpeg-static/releases/download/b4.4/linux-x64" + }, + "type": "library", + "installation-source": "dist", + "install-path": "../ffmpeg/ffmpeg" + }, + { + "name": "guzzlehttp/guzzle", + "version": "7.9.2", + "version_normalized": "7.9.2.0", + "source": { + "type": "git", + "url": "https://github.com/guzzle/guzzle.git", + "reference": "d281ed313b989f213357e3be1a179f02196ac99b" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/guzzle/guzzle/zipball/d281ed313b989f213357e3be1a179f02196ac99b", + "reference": "d281ed313b989f213357e3be1a179f02196ac99b", + "shasum": "" + }, + "require": { + "ext-json": "*", + "guzzlehttp/promises": "^1.5.3 || ^2.0.3", + "guzzlehttp/psr7": "^2.7.0", + "php": "^7.2.5 || ^8.0", + "psr/http-client": "^1.0", + "symfony/deprecation-contracts": "^2.2 || ^3.0" + }, + "provide": { + "psr/http-client-implementation": "1.0" + }, + "require-dev": { + "bamarni/composer-bin-plugin": "^1.8.2", + "ext-curl": "*", + "guzzle/client-integration-tests": "3.0.2", + "php-http/message-factory": "^1.1", + "phpunit/phpunit": "^8.5.39 || ^9.6.20", + "psr/log": "^1.1 || ^2.0 || ^3.0" + }, + "suggest": { + "ext-curl": "Required for CURL handler support", + "ext-intl": "Required for Internationalized Domain Name (IDN) support", + "psr/log": "Required for using the Log middleware" + }, + "time": "2024-07-24T11:22:20+00:00", + "type": "library", + "extra": { + "bamarni-bin": { + "bin-links": true, + "forward-command": false + } + }, + "installation-source": "dist", + "autoload": { + "files": [ + "src/functions_include.php" + ], + "psr-4": { + "GuzzleHttp\\": "src/" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Graham Campbell", + "email": "hello@gjcampbell.co.uk", + "homepage": "https://github.com/GrahamCampbell" + }, + { + "name": "Michael Dowling", + "email": "mtdowling@gmail.com", + "homepage": "https://github.com/mtdowling" + }, + { + "name": "Jeremy Lindblom", + "email": "jeremeamia@gmail.com", + "homepage": "https://github.com/jeremeamia" + }, + { + "name": "George Mponos", + "email": "gmponos@gmail.com", + "homepage": "https://github.com/gmponos" + }, + { + "name": "Tobias Nyholm", + "email": "tobias.nyholm@gmail.com", + "homepage": "https://github.com/Nyholm" + }, + { + "name": "Márk Sági-Kazár", + "email": "mark.sagikazar@gmail.com", + "homepage": "https://github.com/sagikazarmark" + }, + { + "name": "Tobias Schultze", + "email": "webmaster@tubo-world.de", + "homepage": "https://github.com/Tobion" + } + ], + "description": "Guzzle is a PHP HTTP client library", + "keywords": [ + "client", + "curl", + "framework", + "http", + "http client", + "psr-18", + "psr-7", + "rest", + "web service" + ], + "support": { + "issues": "https://github.com/guzzle/guzzle/issues", + "source": "https://github.com/guzzle/guzzle/tree/7.9.2" + }, + "funding": [ + { + "url": "https://github.com/GrahamCampbell", + "type": "github" + }, + { + "url": "https://github.com/Nyholm", + "type": "github" + }, + { + "url": "https://tidelift.com/funding/github/packagist/guzzlehttp/guzzle", + "type": "tidelift" + } + ], + "install-path": "../guzzlehttp/guzzle" + }, + { + "name": "guzzlehttp/promises", + "version": "2.0.3", + "version_normalized": "2.0.3.0", + "source": { + "type": "git", + "url": "https://github.com/guzzle/promises.git", + "reference": "6ea8dd08867a2a42619d65c3deb2c0fcbf81c8f8" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/guzzle/promises/zipball/6ea8dd08867a2a42619d65c3deb2c0fcbf81c8f8", + "reference": "6ea8dd08867a2a42619d65c3deb2c0fcbf81c8f8", + "shasum": "" + }, + "require": { + "php": "^7.2.5 || ^8.0" + }, + "require-dev": { + "bamarni/composer-bin-plugin": "^1.8.2", + "phpunit/phpunit": "^8.5.39 || ^9.6.20" + }, + "time": "2024-07-18T10:29:17+00:00", + "type": "library", + "extra": { + "bamarni-bin": { + "bin-links": true, + "forward-command": false + } + }, + "installation-source": "dist", + "autoload": { + "psr-4": { + "GuzzleHttp\\Promise\\": "src/" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Graham Campbell", + "email": "hello@gjcampbell.co.uk", + "homepage": "https://github.com/GrahamCampbell" + }, + { + "name": "Michael Dowling", + "email": "mtdowling@gmail.com", + "homepage": "https://github.com/mtdowling" + }, + { + "name": "Tobias Nyholm", + "email": "tobias.nyholm@gmail.com", + "homepage": "https://github.com/Nyholm" + }, + { + "name": "Tobias Schultze", + "email": "webmaster@tubo-world.de", + "homepage": "https://github.com/Tobion" + } + ], + "description": "Guzzle promises library", + "keywords": [ + "promise" + ], + "support": { + "issues": "https://github.com/guzzle/promises/issues", + "source": "https://github.com/guzzle/promises/tree/2.0.3" + }, + "funding": [ + { + "url": "https://github.com/GrahamCampbell", + "type": "github" + }, + { + "url": "https://github.com/Nyholm", + "type": "github" + }, + { + "url": "https://tidelift.com/funding/github/packagist/guzzlehttp/promises", + "type": "tidelift" + } + ], + "install-path": "../guzzlehttp/promises" + }, + { + "name": "guzzlehttp/psr7", + "version": "2.7.0", + "version_normalized": "2.7.0.0", + "source": { + "type": "git", + "url": "https://github.com/guzzle/psr7.git", + "reference": "a70f5c95fb43bc83f07c9c948baa0dc1829bf201" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/guzzle/psr7/zipball/a70f5c95fb43bc83f07c9c948baa0dc1829bf201", + "reference": "a70f5c95fb43bc83f07c9c948baa0dc1829bf201", + "shasum": "" + }, + "require": { + "php": "^7.2.5 || ^8.0", + "psr/http-factory": "^1.0", + "psr/http-message": "^1.1 || ^2.0", + "ralouphie/getallheaders": "^3.0" + }, + "provide": { + "psr/http-factory-implementation": "1.0", + "psr/http-message-implementation": "1.0" + }, + "require-dev": { + "bamarni/composer-bin-plugin": "^1.8.2", + "http-interop/http-factory-tests": "0.9.0", + "phpunit/phpunit": "^8.5.39 || ^9.6.20" + }, + "suggest": { + "laminas/laminas-httphandlerrunner": "Emit PSR-7 responses" + }, + "time": "2024-07-18T11:15:46+00:00", + "type": "library", + "extra": { + "bamarni-bin": { + "bin-links": true, + "forward-command": false + } + }, + "installation-source": "dist", + "autoload": { + "psr-4": { + "GuzzleHttp\\Psr7\\": "src/" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Graham Campbell", + "email": "hello@gjcampbell.co.uk", + "homepage": "https://github.com/GrahamCampbell" + }, + { + "name": "Michael Dowling", + "email": "mtdowling@gmail.com", + "homepage": "https://github.com/mtdowling" + }, + { + "name": "George Mponos", + "email": "gmponos@gmail.com", + "homepage": "https://github.com/gmponos" + }, + { + "name": "Tobias Nyholm", + "email": "tobias.nyholm@gmail.com", + "homepage": "https://github.com/Nyholm" + }, + { + "name": "Márk Sági-Kazár", + "email": "mark.sagikazar@gmail.com", + "homepage": "https://github.com/sagikazarmark" + }, + { + "name": "Tobias Schultze", + "email": "webmaster@tubo-world.de", + "homepage": "https://github.com/Tobion" + }, + { + "name": "Márk Sági-Kazár", + "email": "mark.sagikazar@gmail.com", + "homepage": "https://sagikazarmark.hu" + } + ], + "description": "PSR-7 message implementation that also provides common utility methods", + "keywords": [ + "http", + "message", + "psr-7", + "request", + "response", + "stream", + "uri", + "url" + ], + "support": { + "issues": "https://github.com/guzzle/psr7/issues", + "source": "https://github.com/guzzle/psr7/tree/2.7.0" + }, + "funding": [ + { + "url": "https://github.com/GrahamCampbell", + "type": "github" + }, + { + "url": "https://github.com/Nyholm", + "type": "github" + }, + { + "url": "https://tidelift.com/funding/github/packagist/guzzlehttp/psr7", + "type": "tidelift" + } + ], + "install-path": "../guzzlehttp/psr7" + }, + { + "name": "intervention/image", + "version": "2.7.2", + "version_normalized": "2.7.2.0", + "source": { + "type": "git", + "url": "https://github.com/Intervention/image.git", + "reference": "04be355f8d6734c826045d02a1079ad658322dad" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/Intervention/image/zipball/04be355f8d6734c826045d02a1079ad658322dad", + "reference": "04be355f8d6734c826045d02a1079ad658322dad", + "shasum": "" + }, + "require": { + "ext-fileinfo": "*", + "guzzlehttp/psr7": "~1.1 || ^2.0", + "php": ">=5.4.0" + }, + "require-dev": { + "mockery/mockery": "~0.9.2", + "phpunit/phpunit": "^4.8 || ^5.7 || ^7.5.15" + }, + "suggest": { + "ext-gd": "to use GD library based image processing.", + "ext-imagick": "to use Imagick based image processing.", + "intervention/imagecache": "Caching extension for the Intervention Image library" + }, + "time": "2022-05-21T17:30:32+00:00", + "type": "library", + "extra": { + "branch-alias": { + "dev-master": "2.4-dev" + }, + "laravel": { + "providers": [ + "Intervention\\Image\\ImageServiceProvider" + ], + "aliases": { + "Image": "Intervention\\Image\\Facades\\Image" + } + } + }, + "installation-source": "dist", + "autoload": { + "psr-4": { + "Intervention\\Image\\": "src/Intervention/Image" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Oliver Vogel", + "email": "oliver@intervention.io", + "homepage": "https://intervention.io/" + } + ], + "description": "Image handling and manipulation library with support for Laravel integration", + "homepage": "http://image.intervention.io/", + "keywords": [ + "gd", + "image", + "imagick", + "laravel", + "thumbnail", + "watermark" + ], + "support": { + "issues": "https://github.com/Intervention/image/issues", + "source": "https://github.com/Intervention/image/tree/2.7.2" + }, + "funding": [ + { + "url": "https://paypal.me/interventionio", + "type": "custom" + }, + { + "url": "https://github.com/Intervention", + "type": "github" + } + ], + "install-path": "../intervention/image" + }, + { + "name": "lusitanian/oauth", + "version": "v0.8.11", + "version_normalized": "0.8.11.0", + "source": { + "type": "git", + "url": "https://github.com/Lusitanian/PHPoAuthLib.git", + "reference": "fc11a53db4b66da555a6a11fce294f574a8374f9" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/Lusitanian/PHPoAuthLib/zipball/fc11a53db4b66da555a6a11fce294f574a8374f9", + "reference": "fc11a53db4b66da555a6a11fce294f574a8374f9", + "shasum": "" + }, + "require": { + "php": ">=5.3.0" + }, + "require-dev": { + "phpunit/phpunit": "3.7.*", + "predis/predis": "0.8.*@dev", + "squizlabs/php_codesniffer": "2.*", + "symfony/http-foundation": "~2.1" + }, + "suggest": { + "ext-openssl": "Allows for usage of secure connections with the stream-based HTTP client.", + "predis/predis": "Allows using the Redis storage backend.", + "symfony/http-foundation": "Allows using the Symfony Session storage backend." + }, + "time": "2018-02-14T22:37:14+00:00", + "type": "library", + "extra": { + "branch-alias": { + "dev-master": "0.1-dev" + } + }, + "installation-source": "dist", + "autoload": { + "psr-0": { + "OAuth": "src", + "OAuth\\Unit": "tests" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "David Desberg", + "email": "david@daviddesberg.com" + }, + { + "name": "Elliot Chance", + "email": "elliotchance@gmail.com" + }, + { + "name": "Pieter Hordijk", + "email": "info@pieterhordijk.com" + } + ], + "description": "PHP 5.3+ oAuth 1/2 Library", + "keywords": [ + "Authentication", + "authorization", + "oauth", + "security" + ], + "support": { + "issues": "https://github.com/Lusitanian/PHPoAuthLib/issues", + "source": "https://github.com/Lusitanian/PHPoAuthLib/tree/master" + }, + "install-path": "../lusitanian/oauth" + }, + { + "name": "matthiasmullie/minify", + "version": "1.3.73", + "version_normalized": "1.3.73.0", + "source": { + "type": "git", + "url": "https://github.com/matthiasmullie/minify.git", + "reference": "cb7a9297b4ab070909cefade30ee95054d4ae87a" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/matthiasmullie/minify/zipball/cb7a9297b4ab070909cefade30ee95054d4ae87a", + "reference": "cb7a9297b4ab070909cefade30ee95054d4ae87a", + "shasum": "" + }, + "require": { + "ext-pcre": "*", + "matthiasmullie/path-converter": "~1.1", + "php": ">=5.3.0" + }, + "require-dev": { + "friendsofphp/php-cs-fixer": ">=2.0", + "matthiasmullie/scrapbook": ">=1.3", + "phpunit/phpunit": ">=4.8", + "squizlabs/php_codesniffer": ">=3.0" + }, + "suggest": { + "psr/cache-implementation": "Cache implementation to use with Minify::cache" + }, + "time": "2024-03-15T10:27:10+00:00", + "bin": [ + "bin/minifycss", + "bin/minifyjs" + ], + "type": "library", + "installation-source": "dist", + "autoload": { + "psr-4": { + "MatthiasMullie\\Minify\\": "src/" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Matthias Mullie", + "email": "minify@mullie.eu", + "homepage": "https://www.mullie.eu", + "role": "Developer" + } + ], + "description": "CSS & JavaScript minifier, in PHP. Removes whitespace, strips comments, combines files (incl. @import statements and small assets in CSS files), and optimizes/shortens a few common programming patterns.", + "homepage": "https://github.com/matthiasmullie/minify", + "keywords": [ + "JS", + "css", + "javascript", + "minifier", + "minify" + ], + "support": { + "issues": "https://github.com/matthiasmullie/minify/issues", + "source": "https://github.com/matthiasmullie/minify/tree/1.3.73" + }, + "funding": [ + { + "url": "https://github.com/matthiasmullie", + "type": "github" + } + ], + "install-path": "../matthiasmullie/minify" + }, + { + "name": "matthiasmullie/path-converter", + "version": "1.1.3", + "version_normalized": "1.1.3.0", + "source": { + "type": "git", + "url": "https://github.com/matthiasmullie/path-converter.git", + "reference": "e7d13b2c7e2f2268e1424aaed02085518afa02d9" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/matthiasmullie/path-converter/zipball/e7d13b2c7e2f2268e1424aaed02085518afa02d9", + "reference": "e7d13b2c7e2f2268e1424aaed02085518afa02d9", + "shasum": "" + }, + "require": { + "ext-pcre": "*", + "php": ">=5.3.0" + }, + "require-dev": { + "phpunit/phpunit": "~4.8" + }, + "time": "2019-02-05T23:41:09+00:00", + "type": "library", + "installation-source": "dist", + "autoload": { + "psr-4": { + "MatthiasMullie\\PathConverter\\": "src/" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Matthias Mullie", + "email": "pathconverter@mullie.eu", + "homepage": "http://www.mullie.eu", + "role": "Developer" + } + ], + "description": "Relative path converter", + "homepage": "http://github.com/matthiasmullie/path-converter", + "keywords": [ + "converter", + "path", + "paths", + "relative" + ], + "support": { + "issues": "https://github.com/matthiasmullie/path-converter/issues", + "source": "https://github.com/matthiasmullie/path-converter/tree/1.1.3" + }, + "install-path": "../matthiasmullie/path-converter" + }, + { + "name": "mpratt/embera", + "version": "2.0.41", + "version_normalized": "2.0.41.0", + "source": { + "type": "git", + "url": "https://github.com/mpratt/Embera.git", + "reference": "069305b9252a428ba4ae6eb58d3dc8c6d9be5cd0" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/mpratt/Embera/zipball/069305b9252a428ba4ae6eb58d3dc8c6d9be5cd0", + "reference": "069305b9252a428ba4ae6eb58d3dc8c6d9be5cd0", + "shasum": "" + }, + "require": { + "ext-json": "*", + "php": ">=5.6" + }, + "require-dev": { + "phpstan/phpstan": "^1.4", + "phpunit/phpunit": "^9.0" + }, + "suggest": { + "ext-curl": "Fetch data using curl instead of using file_get_contents" + }, + "time": "2024-08-17T04:27:29+00:00", + "type": "library", + "installation-source": "dist", + "autoload": { + "psr-4": { + "Embera\\": "src/Embera" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Michael Pratt", + "email": "yo@michael-pratt.com", + "homepage": "http://www.michael-pratt.com", + "role": "Author/Developer" + } + ], + "description": "Oembed consumer library. Converts urls into their html embed code. Supports 150+ sites, such as Youtube, Twitter, vimeo, Instagram etc.", + "homepage": "https://github.com/mpratt/Embera", + "keywords": [ + "Auto embed", + "Embed Text", + "Responsive Embeds", + "Url Embed", + "embed", + "instagram", + "oembed", + "twitter", + "vimeo", + "vine", + "youtube" + ], + "support": { + "issues": "https://github.com/mpratt/Embera/issues", + "source": "https://github.com/mpratt/Embera/tree/2.0.41" + }, + "funding": [ + { + "url": "https://paypal.me/mtpratt", + "type": "paypal" + } + ], + "install-path": "../mpratt/embera" + }, + { + "name": "paragonie/random_compat", + "version": "v9.99.100", + "version_normalized": "9.99.100.0", + "source": { + "type": "git", + "url": "https://github.com/paragonie/random_compat.git", + "reference": "996434e5492cb4c3edcb9168db6fbb1359ef965a" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/paragonie/random_compat/zipball/996434e5492cb4c3edcb9168db6fbb1359ef965a", + "reference": "996434e5492cb4c3edcb9168db6fbb1359ef965a", + "shasum": "" + }, + "require": { + "php": ">= 7" + }, + "require-dev": { + "phpunit/phpunit": "4.*|5.*", + "vimeo/psalm": "^1" + }, + "suggest": { + "ext-libsodium": "Provides a modern crypto API that can be used to generate random bytes." + }, + "time": "2020-10-15T08:29:30+00:00", + "type": "library", + "installation-source": "dist", + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Paragon Initiative Enterprises", + "email": "security@paragonie.com", + "homepage": "https://paragonie.com" + } + ], + "description": "PHP 5.x polyfill for random_bytes() and random_int() from PHP 7", + "keywords": [ + "csprng", + "polyfill", + "pseudorandom", + "random" + ], + "support": { + "email": "info@paragonie.com", + "issues": "https://github.com/paragonie/random_compat/issues", + "source": "https://github.com/paragonie/random_compat" + }, + "install-path": "../paragonie/random_compat" + }, + { + "name": "paragonie/sodium_compat", + "version": "v1.21.1", + "version_normalized": "1.21.1.0", + "source": { + "type": "git", + "url": "https://github.com/paragonie/sodium_compat.git", + "reference": "bb312875dcdd20680419564fe42ba1d9564b9e37" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/paragonie/sodium_compat/zipball/bb312875dcdd20680419564fe42ba1d9564b9e37", + "reference": "bb312875dcdd20680419564fe42ba1d9564b9e37", + "shasum": "" + }, + "require": { + "paragonie/random_compat": ">=1", + "php": "^5.2.4|^5.3|^5.4|^5.5|^5.6|^7|^8" + }, + "require-dev": { + "phpunit/phpunit": "^3|^4|^5|^6|^7|^8|^9" + }, + "suggest": { + "ext-libsodium": "PHP < 7.0: Better performance, password hashing (Argon2i), secure memory management (memzero), and better security.", + "ext-sodium": "PHP >= 7.0: Better performance, password hashing (Argon2i), secure memory management (memzero), and better security." + }, + "time": "2024-04-22T22:05:04+00:00", + "type": "library", + "installation-source": "dist", + "autoload": { + "files": [ + "autoload.php" + ] + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "ISC" + ], + "authors": [ + { + "name": "Paragon Initiative Enterprises", + "email": "security@paragonie.com" + }, + { + "name": "Frank Denis", + "email": "jedisct1@pureftpd.org" + } + ], + "description": "Pure PHP implementation of libsodium; uses the PHP extension if it exists", + "keywords": [ + "Authentication", + "BLAKE2b", + "ChaCha20", + "ChaCha20-Poly1305", + "Chapoly", + "Curve25519", + "Ed25519", + "EdDSA", + "Edwards-curve Digital Signature Algorithm", + "Elliptic Curve Diffie-Hellman", + "Poly1305", + "Pure-PHP cryptography", + "RFC 7748", + "RFC 8032", + "Salpoly", + "Salsa20", + "X25519", + "XChaCha20-Poly1305", + "XSalsa20-Poly1305", + "Xchacha20", + "Xsalsa20", + "aead", + "cryptography", + "ecdh", + "elliptic curve", + "elliptic curve cryptography", + "encryption", + "libsodium", + "php", + "public-key cryptography", + "secret-key cryptography", + "side-channel resistant" + ], + "support": { + "issues": "https://github.com/paragonie/sodium_compat/issues", + "source": "https://github.com/paragonie/sodium_compat/tree/v1.21.1" + }, + "install-path": "../paragonie/sodium_compat" + }, + { + "name": "paypal/paypal-checkout-sdk", + "version": "1.0.2", + "version_normalized": "1.0.2.0", + "source": { + "type": "git", + "url": "https://github.com/paypal/Checkout-PHP-SDK.git", + "reference": "19992ce7051ff9e47e643f28abb8cc1b3e5f1812" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/paypal/Checkout-PHP-SDK/zipball/19992ce7051ff9e47e643f28abb8cc1b3e5f1812", + "reference": "19992ce7051ff9e47e643f28abb8cc1b3e5f1812", + "shasum": "" + }, + "require": { + "paypal/paypalhttp": "1.0.1" + }, + "require-dev": { + "phpunit/phpunit": "^5.7" + }, + "time": "2021-09-21T20:57:38+00:00", + "type": "library", + "installation-source": "dist", + "autoload": { + "psr-4": { + "Sample\\": "samples/", + "PayPalCheckoutSdk\\": "lib/PayPalCheckoutSdk" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "https://github.com/paypal/Checkout-PHP-SDK/blob/master/LICENSE" + ], + "authors": [ + { + "name": "PayPal", + "homepage": "https://github.com/paypal/Checkout-PHP-SDK/contributors" + } + ], + "description": "PayPal's PHP SDK for Checkout REST APIs", + "homepage": "http://github.com/paypal/Checkout-PHP-SDK/", + "keywords": [ + "checkout", + "orders", + "payments", + "paypal", + "rest", + "sdk" + ], + "support": { + "source": "https://github.com/paypal/Checkout-PHP-SDK/tree/1.0.2" + }, + "abandoned": true, + "install-path": "../paypal/paypal-checkout-sdk" + }, + { + "name": "paypal/paypalhttp", + "version": "1.0.1", + "version_normalized": "1.0.1.0", + "source": { + "type": "git", + "url": "https://github.com/paypal/paypalhttp_php.git", + "reference": "7b09c89c80828e842c79230e7f156b61fbb68d25" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/paypal/paypalhttp_php/zipball/7b09c89c80828e842c79230e7f156b61fbb68d25", + "reference": "7b09c89c80828e842c79230e7f156b61fbb68d25", + "shasum": "" + }, + "require": { + "ext-curl": "*" + }, + "require-dev": { + "phpunit/phpunit": "^5.7", + "wiremock-php/wiremock-php": "1.43.2" + }, + "time": "2021-09-14T21:35:26+00:00", + "type": "library", + "installation-source": "dist", + "autoload": { + "psr-4": { + "PayPalHttp\\": "lib/PayPalHttp" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "PayPal", + "homepage": "https://github.com/paypal/paypalhttp_php/contributors" + } + ], + "support": { + "issues": "https://github.com/paypal/paypalhttp_php/issues", + "source": "https://github.com/paypal/paypalhttp_php/tree/1.0.1" + }, + "install-path": "../paypal/paypalhttp" + }, + { + "name": "phpmailer/phpmailer", + "version": "v6.9.1", + "version_normalized": "6.9.1.0", + "source": { + "type": "git", + "url": "https://github.com/PHPMailer/PHPMailer.git", + "reference": "039de174cd9c17a8389754d3b877a2ed22743e18" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/PHPMailer/PHPMailer/zipball/039de174cd9c17a8389754d3b877a2ed22743e18", + "reference": "039de174cd9c17a8389754d3b877a2ed22743e18", + "shasum": "" + }, + "require": { + "ext-ctype": "*", + "ext-filter": "*", + "ext-hash": "*", + "php": ">=5.5.0" + }, + "require-dev": { + "dealerdirect/phpcodesniffer-composer-installer": "^1.0", + "doctrine/annotations": "^1.2.6 || ^1.13.3", + "php-parallel-lint/php-console-highlighter": "^1.0.0", + "php-parallel-lint/php-parallel-lint": "^1.3.2", + "phpcompatibility/php-compatibility": "^9.3.5", + "roave/security-advisories": "dev-latest", + "squizlabs/php_codesniffer": "^3.7.2", + "yoast/phpunit-polyfills": "^1.0.4" + }, + "suggest": { + "decomplexity/SendOauth2": "Adapter for using XOAUTH2 authentication", + "ext-mbstring": "Needed to send email in multibyte encoding charset or decode encoded addresses", + "ext-openssl": "Needed for secure SMTP sending and DKIM signing", + "greew/oauth2-azure-provider": "Needed for Microsoft Azure XOAUTH2 authentication", + "hayageek/oauth2-yahoo": "Needed for Yahoo XOAUTH2 authentication", + "league/oauth2-google": "Needed for Google XOAUTH2 authentication", + "psr/log": "For optional PSR-3 debug logging", + "symfony/polyfill-mbstring": "To support UTF-8 if the Mbstring PHP extension is not enabled (^1.2)", + "thenetworg/oauth2-azure": "Needed for Microsoft XOAUTH2 authentication" + }, + "time": "2023-11-25T22:23:28+00:00", + "type": "library", + "installation-source": "dist", + "autoload": { + "psr-4": { + "PHPMailer\\PHPMailer\\": "src/" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "LGPL-2.1-only" + ], + "authors": [ + { + "name": "Marcus Bointon", + "email": "phpmailer@synchromedia.co.uk" + }, + { + "name": "Jim Jagielski", + "email": "jimjag@gmail.com" + }, + { + "name": "Andy Prevost", + "email": "codeworxtech@users.sourceforge.net" + }, + { + "name": "Brent R. Matzelle" + } + ], + "description": "PHPMailer is a full-featured email creation and transfer class for PHP", + "support": { + "issues": "https://github.com/PHPMailer/PHPMailer/issues", + "source": "https://github.com/PHPMailer/PHPMailer/tree/v6.9.1" + }, + "funding": [ + { + "url": "https://github.com/Synchro", + "type": "github" + } + ], + "install-path": "../phpmailer/phpmailer" + }, + { + "name": "psr/http-client", + "version": "1.0.3", + "version_normalized": "1.0.3.0", + "source": { + "type": "git", + "url": "https://github.com/php-fig/http-client.git", + "reference": "bb5906edc1c324c9a05aa0873d40117941e5fa90" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/php-fig/http-client/zipball/bb5906edc1c324c9a05aa0873d40117941e5fa90", + "reference": "bb5906edc1c324c9a05aa0873d40117941e5fa90", + "shasum": "" + }, + "require": { + "php": "^7.0 || ^8.0", + "psr/http-message": "^1.0 || ^2.0" + }, + "time": "2023-09-23T14:17:50+00:00", + "type": "library", + "extra": { + "branch-alias": { + "dev-master": "1.0.x-dev" + } + }, + "installation-source": "dist", + "autoload": { + "psr-4": { + "Psr\\Http\\Client\\": "src/" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "PHP-FIG", + "homepage": "https://www.php-fig.org/" + } + ], + "description": "Common interface for HTTP clients", + "homepage": "https://github.com/php-fig/http-client", + "keywords": [ + "http", + "http-client", + "psr", + "psr-18" + ], + "support": { + "source": "https://github.com/php-fig/http-client" + }, + "install-path": "../psr/http-client" + }, + { + "name": "psr/http-factory", + "version": "1.1.0", + "version_normalized": "1.1.0.0", + "source": { + "type": "git", + "url": "https://github.com/php-fig/http-factory.git", + "reference": "2b4765fddfe3b508ac62f829e852b1501d3f6e8a" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/php-fig/http-factory/zipball/2b4765fddfe3b508ac62f829e852b1501d3f6e8a", + "reference": "2b4765fddfe3b508ac62f829e852b1501d3f6e8a", + "shasum": "" + }, + "require": { + "php": ">=7.1", + "psr/http-message": "^1.0 || ^2.0" + }, + "time": "2024-04-15T12:06:14+00:00", + "type": "library", + "extra": { + "branch-alias": { + "dev-master": "1.0.x-dev" + } + }, + "installation-source": "dist", + "autoload": { + "psr-4": { + "Psr\\Http\\Message\\": "src/" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "PHP-FIG", + "homepage": "https://www.php-fig.org/" + } + ], + "description": "PSR-17: Common interfaces for PSR-7 HTTP message factories", + "keywords": [ + "factory", + "http", + "message", + "psr", + "psr-17", + "psr-7", + "request", + "response" + ], + "support": { + "source": "https://github.com/php-fig/http-factory" + }, + "install-path": "../psr/http-factory" + }, + { + "name": "psr/http-message", + "version": "2.0", + "version_normalized": "2.0.0.0", + "source": { + "type": "git", + "url": "https://github.com/php-fig/http-message.git", + "reference": "402d35bcb92c70c026d1a6a9883f06b2ead23d71" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/php-fig/http-message/zipball/402d35bcb92c70c026d1a6a9883f06b2ead23d71", + "reference": "402d35bcb92c70c026d1a6a9883f06b2ead23d71", + "shasum": "" + }, + "require": { + "php": "^7.2 || ^8.0" + }, + "time": "2023-04-04T09:54:51+00:00", + "type": "library", + "extra": { + "branch-alias": { + "dev-master": "2.0.x-dev" + } + }, + "installation-source": "dist", + "autoload": { + "psr-4": { + "Psr\\Http\\Message\\": "src/" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "PHP-FIG", + "homepage": "https://www.php-fig.org/" + } + ], + "description": "Common interface for HTTP messages", + "homepage": "https://github.com/php-fig/http-message", + "keywords": [ + "http", + "http-message", + "psr", + "psr-7", + "request", + "response" + ], + "support": { + "source": "https://github.com/php-fig/http-message/tree/2.0" + }, + "install-path": "../psr/http-message" + }, + { + "name": "psr/log", + "version": "3.0.1", + "version_normalized": "3.0.1.0", + "source": { + "type": "git", + "url": "https://github.com/php-fig/log.git", + "reference": "79dff0b268932c640297f5208d6298f71855c03e" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/php-fig/log/zipball/79dff0b268932c640297f5208d6298f71855c03e", + "reference": "79dff0b268932c640297f5208d6298f71855c03e", + "shasum": "" + }, + "require": { + "php": ">=8.0.0" + }, + "time": "2024-08-21T13:31:24+00:00", + "type": "library", + "extra": { + "branch-alias": { + "dev-master": "3.x-dev" + } + }, + "installation-source": "dist", + "autoload": { + "psr-4": { + "Psr\\Log\\": "src" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "PHP-FIG", + "homepage": "https://www.php-fig.org/" + } + ], + "description": "Common interface for logging libraries", + "homepage": "https://github.com/php-fig/log", + "keywords": [ + "log", + "psr", + "psr-3" + ], + "support": { + "source": "https://github.com/php-fig/log/tree/3.0.1" + }, + "install-path": "../psr/log" + }, + { + "name": "pusher/pusher-php-server", + "version": "7.2.4", + "version_normalized": "7.2.4.0", + "source": { + "type": "git", + "url": "https://github.com/pusher/pusher-http-php.git", + "reference": "de2f72296808f9cafa6a4462b15a768ff130cddb" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/pusher/pusher-http-php/zipball/de2f72296808f9cafa6a4462b15a768ff130cddb", + "reference": "de2f72296808f9cafa6a4462b15a768ff130cddb", + "shasum": "" + }, + "require": { + "ext-curl": "*", + "ext-json": "*", + "guzzlehttp/guzzle": "^7.2", + "paragonie/sodium_compat": "^1.6", + "php": "^7.3|^8.0", + "psr/log": "^1.0|^2.0|^3.0" + }, + "require-dev": { + "overtrue/phplint": "^2.3", + "phpunit/phpunit": "^9.3" + }, + "time": "2023-12-15T10:58:53+00:00", + "type": "library", + "extra": { + "branch-alias": { + "dev-master": "5.0-dev" + } + }, + "installation-source": "dist", + "autoload": { + "psr-4": { + "Pusher\\": "src/" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "description": "Library for interacting with the Pusher REST API", + "keywords": [ + "events", + "messaging", + "php-pusher-server", + "publish", + "push", + "pusher", + "real time", + "real-time", + "realtime", + "rest", + "trigger" + ], + "support": { + "issues": "https://github.com/pusher/pusher-http-php/issues", + "source": "https://github.com/pusher/pusher-http-php/tree/7.2.4" + }, + "install-path": "../pusher/pusher-php-server" + }, + { + "name": "ralouphie/getallheaders", + "version": "3.0.3", + "version_normalized": "3.0.3.0", + "source": { + "type": "git", + "url": "https://github.com/ralouphie/getallheaders.git", + "reference": "120b605dfeb996808c31b6477290a714d356e822" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/ralouphie/getallheaders/zipball/120b605dfeb996808c31b6477290a714d356e822", + "reference": "120b605dfeb996808c31b6477290a714d356e822", + "shasum": "" + }, + "require": { + "php": ">=5.6" + }, + "require-dev": { + "php-coveralls/php-coveralls": "^2.1", + "phpunit/phpunit": "^5 || ^6.5" + }, + "time": "2019-03-08T08:55:37+00:00", + "type": "library", + "installation-source": "dist", + "autoload": { + "files": [ + "src/getallheaders.php" + ] + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Ralph Khattar", + "email": "ralph.khattar@gmail.com" + } + ], + "description": "A polyfill for getallheaders.", + "support": { + "issues": "https://github.com/ralouphie/getallheaders/issues", + "source": "https://github.com/ralouphie/getallheaders/tree/develop" + }, + "install-path": "../ralouphie/getallheaders" + }, + { + "name": "snipe/banbuilder", + "version": "dev-master", + "version_normalized": "dev-master", + "source": { + "type": "git", + "url": "https://github.com/snipe/banbuilder.git", + "reference": "5e76a97b3ff80e2beaae75ac140c38573ea027a0" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/snipe/banbuilder/zipball/5e76a97b3ff80e2beaae75ac140c38573ea027a0", + "reference": "5e76a97b3ff80e2beaae75ac140c38573ea027a0", + "shasum": "" + }, + "require": { + "php": ">=5.6.0" + }, + "require-dev": { + "phpunit/phpunit": "^5.7.0" + }, + "time": "2023-12-06T20:33:58+00:00", + "default-branch": true, + "type": "library", + "installation-source": "dist", + "autoload": { + "psr-4": { + "Snipe\\BanBuilder\\": "src/" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "AGPL-3.0" + ], + "authors": [ + { + "name": "snipe", + "email": "snipe@snipe.net", + "role": "Creator & Developer" + } + ], + "description": "Library to easily handle profanity filtering in PHP projects.", + "homepage": "http://banbuilder.com", + "keywords": [ + "filter", + "language", + "profanity", + "strings", + "swear" + ], + "support": { + "issues": "https://github.com/snipe/banbuilder/issues", + "source": "https://github.com/snipe/banbuilder/tree/master" + }, + "install-path": "../snipe/banbuilder" + }, + { + "name": "spatie/calendar-links", + "version": "1.11.0", + "version_normalized": "1.11.0.0", + "source": { + "type": "git", + "url": "https://github.com/spatie/calendar-links.git", + "reference": "da41e7edae84859d3d598b0b3ce3233c843c3e46" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/spatie/calendar-links/zipball/da41e7edae84859d3d598b0b3ce3233c843c3e46", + "reference": "da41e7edae84859d3d598b0b3ce3233c843c3e46", + "shasum": "" + }, + "require": { + "php": "^8.1" + }, + "require-dev": { + "friendsofphp/php-cs-fixer": "^3.48", + "phpunit/phpunit": "^10.1", + "spatie/phpunit-snapshot-assertions": "^5.1", + "vimeo/psalm": "^5.20" + }, + "time": "2024-02-19T05:59:13+00:00", + "type": "library", + "installation-source": "dist", + "autoload": { + "psr-4": { + "Spatie\\CalendarLinks\\": "src" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Sebastian De Deyne", + "email": "sebastian@spatie.be", + "homepage": "https://spatie.be", + "role": "Developer" + } + ], + "description": "Generate add to calendar links for Google, iCal and other calendar systems", + "homepage": "https://github.com/spatie/calendar-links", + "keywords": [ + "calendar-links", + "spatie" + ], + "support": { + "issues": "https://github.com/spatie/calendar-links/issues", + "source": "https://github.com/spatie/calendar-links/tree/1.11.0" + }, + "funding": [ + { + "url": "https://spatie.be/open-source/support-us", + "type": "custom" + } + ], + "install-path": "../spatie/calendar-links" + }, + { + "name": "stripe/stripe-php", + "version": "v7.128.0", + "version_normalized": "7.128.0.0", + "source": { + "type": "git", + "url": "https://github.com/stripe/stripe-php.git", + "reference": "c704949c49b72985c76cc61063aa26fefbd2724e" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/stripe/stripe-php/zipball/c704949c49b72985c76cc61063aa26fefbd2724e", + "reference": "c704949c49b72985c76cc61063aa26fefbd2724e", + "shasum": "" + }, + "require": { + "ext-curl": "*", + "ext-json": "*", + "ext-mbstring": "*", + "php": ">=5.6.0" + }, + "require-dev": { + "friendsofphp/php-cs-fixer": "3.5.0", + "phpstan/phpstan": "^1.2", + "phpunit/phpunit": "^5.7 || ^9.0", + "squizlabs/php_codesniffer": "^3.3" + }, + "time": "2022-05-05T17:18:02+00:00", + "type": "library", + "extra": { + "branch-alias": { + "dev-master": "2.0-dev" + } + }, + "installation-source": "dist", + "autoload": { + "psr-4": { + "Stripe\\": "lib/" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Stripe and contributors", + "homepage": "https://github.com/stripe/stripe-php/contributors" + } + ], + "description": "Stripe PHP Library", + "homepage": "https://stripe.com/", + "keywords": [ + "api", + "payment processing", + "stripe" + ], + "support": { + "issues": "https://github.com/stripe/stripe-php/issues", + "source": "https://github.com/stripe/stripe-php/tree/v7.128.0" + }, + "install-path": "../stripe/stripe-php" + }, + { + "name": "symfony/deprecation-contracts", + "version": "v3.5.0", + "version_normalized": "3.5.0.0", + "source": { + "type": "git", + "url": "https://github.com/symfony/deprecation-contracts.git", + "reference": "0e0d29ce1f20deffb4ab1b016a7257c4f1e789a1" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/symfony/deprecation-contracts/zipball/0e0d29ce1f20deffb4ab1b016a7257c4f1e789a1", + "reference": "0e0d29ce1f20deffb4ab1b016a7257c4f1e789a1", + "shasum": "" + }, + "require": { + "php": ">=8.1" + }, + "time": "2024-04-18T09:32:20+00:00", + "type": "library", + "extra": { + "branch-alias": { + "dev-main": "3.5-dev" + }, + "thanks": { + "name": "symfony/contracts", + "url": "https://github.com/symfony/contracts" + } + }, + "installation-source": "dist", + "autoload": { + "files": [ + "function.php" + ] + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Nicolas Grekas", + "email": "p@tchwork.com" + }, + { + "name": "Symfony Community", + "homepage": "https://symfony.com/contributors" + } + ], + "description": "A generic function and convention to trigger deprecation notices", + "homepage": "https://symfony.com", + "support": { + "source": "https://github.com/symfony/deprecation-contracts/tree/v3.5.0" + }, + "funding": [ + { + "url": "https://symfony.com/sponsor", + "type": "custom" + }, + { + "url": "https://github.com/fabpot", + "type": "github" + }, + { + "url": "https://tidelift.com/funding/github/packagist/symfony/symfony", + "type": "tidelift" + } + ], + "install-path": "../symfony/deprecation-contracts" + }, + { + "name": "tpyo/amazon-s3-php-class", + "version": "dev-master", + "version_normalized": "dev-master", + "source": { + "type": "git", + "url": "https://github.com/unacms/amazon-s3-php-class.git", + "reference": "7c62b0e9b7d956a04e377ca236979a78dbac4e66" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/unacms/amazon-s3-php-class/zipball/7c62b0e9b7d956a04e377ca236979a78dbac4e66", + "reference": "7c62b0e9b7d956a04e377ca236979a78dbac4e66", + "shasum": "" + }, + "require": { + "php": ">=5.2.0" + }, + "time": "2022-06-30T03:20:34+00:00", + "default-branch": true, + "type": "library", + "installation-source": "dist", + "autoload": { + "classmap": [ + "S3.php" + ] + }, + "license": [ + "BSD-2-Clause" + ], + "authors": [ + { + "name": "Donovan Schönknecht", + "email": "don@tpyo.net" + } + ], + "description": "A standalone Amazon S3 (REST) client for PHP 5.2.x using CURL that does not require PEAR.", + "homepage": "https://github.com/tpyo/amazon-s3-php-class", + "support": { + "source": "https://github.com/unacms/amazon-s3-php-class/tree/master" + }, + "install-path": "../tpyo/amazon-s3-php-class" + }, + { + "name": "twilio/sdk", + "version": "5.42.2", + "version_normalized": "5.42.2.0", + "source": { + "type": "git", + "url": "https://github.com/twilio/twilio-php.git", + "reference": "0cfcb871b18a9c427dd9e8f0ed7458d43009b48a" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/twilio/twilio-php/zipball/0cfcb871b18a9c427dd9e8f0ed7458d43009b48a", + "reference": "0cfcb871b18a9c427dd9e8f0ed7458d43009b48a", + "shasum": "" + }, + "require": { + "php": ">=5.5.0" + }, + "require-dev": { + "apigen/apigen": "^4.1", + "guzzlehttp/guzzle": "^6.3", + "phpunit/phpunit": ">=4.5" + }, + "suggest": { + "guzzlehttp/guzzle": "An HTTP client to execute the API requests" + }, + "time": "2020-02-05T19:55:13+00:00", + "type": "library", + "installation-source": "dist", + "autoload": { + "psr-4": { + "Twilio\\": "src/Twilio/" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Twilio API Team", + "email": "api@twilio.com" + } + ], + "description": "A PHP wrapper for Twilio's API", + "homepage": "http://github.com/twilio/twilio-php", + "keywords": [ + "api", + "sms", + "twilio" + ], + "support": { + "issues": "https://github.com/twilio/twilio-php/issues", + "source": "https://github.com/twilio/twilio-php/tree/5.42.2" + }, + "install-path": "../twilio/sdk" + }, + { + "name": "unaio/amazon-s3-php-class-hmac-v2", + "version": "0.6", + "version_normalized": "0.6.0.0", + "source": { + "type": "git", + "url": "https://github.com/unaio/amazon-s3-php-class-hmac-v2", + "reference": "3687dec0af7be2cb11f21828aa4b12d20c4c5935" + }, + "type": "library", + "installation-source": "source", + "install-path": "../unaio/amazon-s3-php-class-hmac-v2" + }, + { + "name": "wikimedia/less.php", + "version": "v5.1.1", + "version_normalized": "5.1.1.0", + "source": { + "type": "git", + "url": "https://github.com/wikimedia/less.php.git", + "reference": "29e14517d40b321bdbf8823eae1c327fc6b227f5" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/wikimedia/less.php/zipball/29e14517d40b321bdbf8823eae1c327fc6b227f5", + "reference": "29e14517d40b321bdbf8823eae1c327fc6b227f5", + "shasum": "" + }, + "require": { + "php": ">=7.4.3" + }, + "require-dev": { + "mediawiki/mediawiki-codesniffer": "43.0.0", + "mediawiki/mediawiki-phan-config": "0.14.0", + "mediawiki/minus-x": "1.1.3", + "php-parallel-lint/php-console-highlighter": "1.0.0", + "php-parallel-lint/php-parallel-lint": "1.4.0", + "phpunit/phpunit": "9.6.16" + }, + "time": "2024-08-09T13:59:17+00:00", + "bin": [ + "bin/lessc" + ], + "type": "library", + "installation-source": "dist", + "autoload": { + "psr-0": { + "Less": "lib/" + }, + "classmap": [ + "lessc.inc.php" + ] + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "Apache-2.0" + ], + "authors": [ + { + "name": "Timo Tijhof", + "homepage": "https://timotijhof.net" + }, + { + "name": "Josh Schmidt", + "homepage": "https://github.com/oyejorge" + }, + { + "name": "Matt Agar", + "homepage": "https://github.com/agar" + }, + { + "name": "Martin Jantošovič", + "homepage": "https://github.com/Mordred" + } + ], + "description": "PHP port of the LESS processor", + "homepage": "https://gerrit.wikimedia.org/g/mediawiki/libs/less.php", + "keywords": [ + "css", + "less", + "less.js", + "lesscss", + "php", + "stylesheet" + ], + "support": { + "issues": "https://github.com/wikimedia/less.php/issues", + "source": "https://github.com/wikimedia/less.php/tree/v5.1.1" + }, + "install-path": "../wikimedia/less.php" + } + ], + "dev": true, + "dev-package-names": [] +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/composer/installed.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/composer/installed.php new file mode 100644 index 0000000000..e7a7784af8 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/composer/installed.php @@ -0,0 +1,375 @@ +<?php return array( + 'root' => array( + 'pretty_version' => 'dev-master', + 'version' => 'dev-master', + 'type' => 'library', + 'install_path' => __DIR__ . '/../../', + 'aliases' => array(), + 'reference' => '53588980042992e9da0cf02b65071d4a81815440', + 'name' => 'unaio/una', + 'dev' => true, + ), + 'versions' => array( + 'achingbrain/php5-akismet' => array( + 'pretty_version' => '0.5', + 'version' => '0.5.0.0', + 'type' => 'library', + 'install_path' => __DIR__ . '/../achingbrain/php5-akismet', + 'aliases' => array(), + 'reference' => 'master', + 'dev_requirement' => false, + ), + 'akeeba/s3' => array( + 'pretty_version' => 'dev-development', + 'version' => 'dev-development', + 'type' => 'library', + 'install_path' => __DIR__ . '/../akeeba/s3', + 'aliases' => array( + 0 => '9999999-dev', + ), + 'reference' => '850dbfad69afcf43a4f0da29d93101fbb53422fb', + 'dev_requirement' => false, + ), + 'avto-dev/composer-cleanup-plugin' => array( + 'pretty_version' => 'dev-master', + 'version' => 'dev-master', + 'type' => 'composer-plugin', + 'install_path' => __DIR__ . '/../avto-dev/composer-cleanup-plugin', + 'aliases' => array( + 0 => '9999999-dev', + ), + 'reference' => '75187ca4854265174021765e3b67cb973dc37723', + 'dev_requirement' => false, + ), + 'bshaffer/oauth2-server-php' => array( + 'pretty_version' => 'v1.14.1', + 'version' => '1.14.1.0', + 'type' => 'library', + 'install_path' => __DIR__ . '/../bshaffer/oauth2-server-php', + 'aliases' => array(), + 'reference' => '096db2c86a7d67a2ba45e72be7d208c342694542', + 'dev_requirement' => false, + ), + 'chargebee/chargebee-php' => array( + 'pretty_version' => 'v3.33.0', + 'version' => '3.33.0.0', + 'type' => 'library', + 'install_path' => __DIR__ . '/../chargebee/chargebee-php', + 'aliases' => array(), + 'reference' => '9423e1bbf8d1f8c48e40347fb1dfe711b817dbf0', + 'dev_requirement' => false, + ), + 'curl/cacert' => array( + 'pretty_version' => '0.0.1', + 'version' => '0.0.1.0', + 'type' => 'library', + 'install_path' => __DIR__ . '/../curl/cacert', + 'aliases' => array(), + 'reference' => NULL, + 'dev_requirement' => false, + ), + 'erusev/parsedown' => array( + 'pretty_version' => 'dev-master', + 'version' => 'dev-master', + 'type' => 'library', + 'install_path' => __DIR__ . '/../erusev/parsedown', + 'aliases' => array( + 0 => '9999999-dev', + ), + 'reference' => '26cfde9dbffa43a77bfd45c87b0394df0dfcba85', + 'dev_requirement' => false, + ), + 'ezyang/htmlpurifier' => array( + 'pretty_version' => 'v4.17.0', + 'version' => '4.17.0.0', + 'type' => 'library', + 'install_path' => __DIR__ . '/../ezyang/htmlpurifier', + 'aliases' => array(), + 'reference' => 'bbc513d79acf6691fa9cf10f192c90dd2957f18c', + 'dev_requirement' => false, + ), + 'ffmpeg/ffmpeg' => array( + 'pretty_version' => '4.4.0', + 'version' => '4.4.0.0', + 'type' => 'library', + 'install_path' => __DIR__ . '/../ffmpeg/ffmpeg', + 'aliases' => array(), + 'reference' => NULL, + 'dev_requirement' => false, + ), + 'guzzlehttp/guzzle' => array( + 'pretty_version' => '7.9.2', + 'version' => '7.9.2.0', + 'type' => 'library', + 'install_path' => __DIR__ . '/../guzzlehttp/guzzle', + 'aliases' => array(), + 'reference' => 'd281ed313b989f213357e3be1a179f02196ac99b', + 'dev_requirement' => false, + ), + 'guzzlehttp/promises' => array( + 'pretty_version' => '2.0.3', + 'version' => '2.0.3.0', + 'type' => 'library', + 'install_path' => __DIR__ . '/../guzzlehttp/promises', + 'aliases' => array(), + 'reference' => '6ea8dd08867a2a42619d65c3deb2c0fcbf81c8f8', + 'dev_requirement' => false, + ), + 'guzzlehttp/psr7' => array( + 'pretty_version' => '2.7.0', + 'version' => '2.7.0.0', + 'type' => 'library', + 'install_path' => __DIR__ . '/../guzzlehttp/psr7', + 'aliases' => array(), + 'reference' => 'a70f5c95fb43bc83f07c9c948baa0dc1829bf201', + 'dev_requirement' => false, + ), + 'intervention/image' => array( + 'pretty_version' => '2.7.2', + 'version' => '2.7.2.0', + 'type' => 'library', + 'install_path' => __DIR__ . '/../intervention/image', + 'aliases' => array(), + 'reference' => '04be355f8d6734c826045d02a1079ad658322dad', + 'dev_requirement' => false, + ), + 'lusitanian/oauth' => array( + 'pretty_version' => 'v0.8.11', + 'version' => '0.8.11.0', + 'type' => 'library', + 'install_path' => __DIR__ . '/../lusitanian/oauth', + 'aliases' => array(), + 'reference' => 'fc11a53db4b66da555a6a11fce294f574a8374f9', + 'dev_requirement' => false, + ), + 'matthiasmullie/minify' => array( + 'pretty_version' => '1.3.73', + 'version' => '1.3.73.0', + 'type' => 'library', + 'install_path' => __DIR__ . '/../matthiasmullie/minify', + 'aliases' => array(), + 'reference' => 'cb7a9297b4ab070909cefade30ee95054d4ae87a', + 'dev_requirement' => false, + ), + 'matthiasmullie/path-converter' => array( + 'pretty_version' => '1.1.3', + 'version' => '1.1.3.0', + 'type' => 'library', + 'install_path' => __DIR__ . '/../matthiasmullie/path-converter', + 'aliases' => array(), + 'reference' => 'e7d13b2c7e2f2268e1424aaed02085518afa02d9', + 'dev_requirement' => false, + ), + 'mpratt/embera' => array( + 'pretty_version' => '2.0.41', + 'version' => '2.0.41.0', + 'type' => 'library', + 'install_path' => __DIR__ . '/../mpratt/embera', + 'aliases' => array(), + 'reference' => '069305b9252a428ba4ae6eb58d3dc8c6d9be5cd0', + 'dev_requirement' => false, + ), + 'paragonie/random_compat' => array( + 'pretty_version' => 'v9.99.100', + 'version' => '9.99.100.0', + 'type' => 'library', + 'install_path' => __DIR__ . '/../paragonie/random_compat', + 'aliases' => array(), + 'reference' => '996434e5492cb4c3edcb9168db6fbb1359ef965a', + 'dev_requirement' => false, + ), + 'paragonie/sodium_compat' => array( + 'pretty_version' => 'v1.21.1', + 'version' => '1.21.1.0', + 'type' => 'library', + 'install_path' => __DIR__ . '/../paragonie/sodium_compat', + 'aliases' => array(), + 'reference' => 'bb312875dcdd20680419564fe42ba1d9564b9e37', + 'dev_requirement' => false, + ), + 'paypal/paypal-checkout-sdk' => array( + 'pretty_version' => '1.0.2', + 'version' => '1.0.2.0', + 'type' => 'library', + 'install_path' => __DIR__ . '/../paypal/paypal-checkout-sdk', + 'aliases' => array(), + 'reference' => '19992ce7051ff9e47e643f28abb8cc1b3e5f1812', + 'dev_requirement' => false, + ), + 'paypal/paypalhttp' => array( + 'pretty_version' => '1.0.1', + 'version' => '1.0.1.0', + 'type' => 'library', + 'install_path' => __DIR__ . '/../paypal/paypalhttp', + 'aliases' => array(), + 'reference' => '7b09c89c80828e842c79230e7f156b61fbb68d25', + 'dev_requirement' => false, + ), + 'phpmailer/phpmailer' => array( + 'pretty_version' => 'v6.9.1', + 'version' => '6.9.1.0', + 'type' => 'library', + 'install_path' => __DIR__ . '/../phpmailer/phpmailer', + 'aliases' => array(), + 'reference' => '039de174cd9c17a8389754d3b877a2ed22743e18', + 'dev_requirement' => false, + ), + 'psr/http-client' => array( + 'pretty_version' => '1.0.3', + 'version' => '1.0.3.0', + 'type' => 'library', + 'install_path' => __DIR__ . '/../psr/http-client', + 'aliases' => array(), + 'reference' => 'bb5906edc1c324c9a05aa0873d40117941e5fa90', + 'dev_requirement' => false, + ), + 'psr/http-client-implementation' => array( + 'dev_requirement' => false, + 'provided' => array( + 0 => '1.0', + ), + ), + 'psr/http-factory' => array( + 'pretty_version' => '1.1.0', + 'version' => '1.1.0.0', + 'type' => 'library', + 'install_path' => __DIR__ . '/../psr/http-factory', + 'aliases' => array(), + 'reference' => '2b4765fddfe3b508ac62f829e852b1501d3f6e8a', + 'dev_requirement' => false, + ), + 'psr/http-factory-implementation' => array( + 'dev_requirement' => false, + 'provided' => array( + 0 => '1.0', + ), + ), + 'psr/http-message' => array( + 'pretty_version' => '2.0', + 'version' => '2.0.0.0', + 'type' => 'library', + 'install_path' => __DIR__ . '/../psr/http-message', + 'aliases' => array(), + 'reference' => '402d35bcb92c70c026d1a6a9883f06b2ead23d71', + 'dev_requirement' => false, + ), + 'psr/http-message-implementation' => array( + 'dev_requirement' => false, + 'provided' => array( + 0 => '1.0', + ), + ), + 'psr/log' => array( + 'pretty_version' => '3.0.1', + 'version' => '3.0.1.0', + 'type' => 'library', + 'install_path' => __DIR__ . '/../psr/log', + 'aliases' => array(), + 'reference' => '79dff0b268932c640297f5208d6298f71855c03e', + 'dev_requirement' => false, + ), + 'pusher/pusher-php-server' => array( + 'pretty_version' => '7.2.4', + 'version' => '7.2.4.0', + 'type' => 'library', + 'install_path' => __DIR__ . '/../pusher/pusher-php-server', + 'aliases' => array(), + 'reference' => 'de2f72296808f9cafa6a4462b15a768ff130cddb', + 'dev_requirement' => false, + ), + 'ralouphie/getallheaders' => array( + 'pretty_version' => '3.0.3', + 'version' => '3.0.3.0', + 'type' => 'library', + 'install_path' => __DIR__ . '/../ralouphie/getallheaders', + 'aliases' => array(), + 'reference' => '120b605dfeb996808c31b6477290a714d356e822', + 'dev_requirement' => false, + ), + 'snipe/banbuilder' => array( + 'pretty_version' => 'dev-master', + 'version' => 'dev-master', + 'type' => 'library', + 'install_path' => __DIR__ . '/../snipe/banbuilder', + 'aliases' => array( + 0 => '9999999-dev', + ), + 'reference' => '5e76a97b3ff80e2beaae75ac140c38573ea027a0', + 'dev_requirement' => false, + ), + 'spatie/calendar-links' => array( + 'pretty_version' => '1.11.0', + 'version' => '1.11.0.0', + 'type' => 'library', + 'install_path' => __DIR__ . '/../spatie/calendar-links', + 'aliases' => array(), + 'reference' => 'da41e7edae84859d3d598b0b3ce3233c843c3e46', + 'dev_requirement' => false, + ), + 'stripe/stripe-php' => array( + 'pretty_version' => 'v7.128.0', + 'version' => '7.128.0.0', + 'type' => 'library', + 'install_path' => __DIR__ . '/../stripe/stripe-php', + 'aliases' => array(), + 'reference' => 'c704949c49b72985c76cc61063aa26fefbd2724e', + 'dev_requirement' => false, + ), + 'symfony/deprecation-contracts' => array( + 'pretty_version' => 'v3.5.0', + 'version' => '3.5.0.0', + 'type' => 'library', + 'install_path' => __DIR__ . '/../symfony/deprecation-contracts', + 'aliases' => array(), + 'reference' => '0e0d29ce1f20deffb4ab1b016a7257c4f1e789a1', + 'dev_requirement' => false, + ), + 'tpyo/amazon-s3-php-class' => array( + 'pretty_version' => 'dev-master', + 'version' => 'dev-master', + 'type' => 'library', + 'install_path' => __DIR__ . '/../tpyo/amazon-s3-php-class', + 'aliases' => array( + 0 => '9999999-dev', + ), + 'reference' => '7c62b0e9b7d956a04e377ca236979a78dbac4e66', + 'dev_requirement' => false, + ), + 'twilio/sdk' => array( + 'pretty_version' => '5.42.2', + 'version' => '5.42.2.0', + 'type' => 'library', + 'install_path' => __DIR__ . '/../twilio/sdk', + 'aliases' => array(), + 'reference' => '0cfcb871b18a9c427dd9e8f0ed7458d43009b48a', + 'dev_requirement' => false, + ), + 'unaio/amazon-s3-php-class-hmac-v2' => array( + 'pretty_version' => '0.6', + 'version' => '0.6.0.0', + 'type' => 'library', + 'install_path' => __DIR__ . '/../unaio/amazon-s3-php-class-hmac-v2', + 'aliases' => array(), + 'reference' => '3687dec0af7be2cb11f21828aa4b12d20c4c5935', + 'dev_requirement' => false, + ), + 'unaio/una' => array( + 'pretty_version' => 'dev-master', + 'version' => 'dev-master', + 'type' => 'library', + 'install_path' => __DIR__ . '/../../', + 'aliases' => array(), + 'reference' => '53588980042992e9da0cf02b65071d4a81815440', + 'dev_requirement' => false, + ), + 'wikimedia/less.php' => array( + 'pretty_version' => 'v5.1.1', + 'version' => '5.1.1.0', + 'type' => 'library', + 'install_path' => __DIR__ . '/../wikimedia/less.php', + 'aliases' => array(), + 'reference' => '29e14517d40b321bdbf8823eae1c327fc6b227f5', + 'dev_requirement' => false, + ), + ), +); diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/composer/platform_check.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/composer/platform_check.php new file mode 100644 index 0000000000..4c3a5d68f1 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/composer/platform_check.php @@ -0,0 +1,26 @@ +<?php + +// platform_check.php @generated by Composer + +$issues = array(); + +if (!(PHP_VERSION_ID >= 80100)) { + $issues[] = 'Your Composer dependencies require a PHP version ">= 8.1.0". You are running ' . PHP_VERSION . '.'; +} + +if ($issues) { + if (!headers_sent()) { + header('HTTP/1.1 500 Internal Server Error'); + } + if (!ini_get('display_errors')) { + if (PHP_SAPI === 'cli' || PHP_SAPI === 'phpdbg') { + fwrite(STDERR, 'Composer detected issues in your platform:' . PHP_EOL.PHP_EOL . implode(PHP_EOL, $issues) . PHP_EOL.PHP_EOL); + } elseif (!headers_sent()) { + echo 'Composer detected issues in your platform:' . PHP_EOL.PHP_EOL . str_replace('You are running '.PHP_VERSION.'.', '', implode(PHP_EOL, $issues)) . PHP_EOL.PHP_EOL; + } + } + trigger_error( + 'Composer detected issues in your platform: ' . implode(' ', $issues), + E_USER_ERROR + ); +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/erusev/parsedown/Parsedown.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/erusev/parsedown/Parsedown.php new file mode 100644 index 0000000000..fb5239d1fd --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/erusev/parsedown/Parsedown.php @@ -0,0 +1,1994 @@ +<?php + +# +# +# Parsedown +# http://parsedown.org +# +# (c) Emanuil Rusev +# http://erusev.com +# +# For the full license information, view the LICENSE file that was distributed +# with this source code. +# +# + +class Parsedown +{ + # ~ + + const version = '1.8.0-beta-7'; + + # ~ + + function text($text) + { + $Elements = $this->textElements($text); + + # convert to markup + $markup = $this->elements($Elements); + + # trim line breaks + $markup = trim($markup, "\n"); + + return $markup; + } + + protected function textElements($text) + { + # make sure no definitions are set + $this->DefinitionData = array(); + + # standardize line breaks + $text = str_replace(array("\r\n", "\r"), "\n", $text); + + # remove surrounding line breaks + $text = trim($text, "\n"); + + # split text into lines + $lines = explode("\n", $text); + + # iterate through lines to identify blocks + return $this->linesElements($lines); + } + + # + # Setters + # + + function setBreaksEnabled($breaksEnabled) + { + $this->breaksEnabled = $breaksEnabled; + + return $this; + } + + protected $breaksEnabled; + + function setMarkupEscaped($markupEscaped) + { + $this->markupEscaped = $markupEscaped; + + return $this; + } + + protected $markupEscaped; + + function setUrlsLinked($urlsLinked) + { + $this->urlsLinked = $urlsLinked; + + return $this; + } + + protected $urlsLinked = true; + + function setSafeMode($safeMode) + { + $this->safeMode = (bool) $safeMode; + + return $this; + } + + protected $safeMode; + + function setStrictMode($strictMode) + { + $this->strictMode = (bool) $strictMode; + + return $this; + } + + protected $strictMode; + + protected $safeLinksWhitelist = array( + 'http://', + 'https://', + 'ftp://', + 'ftps://', + 'mailto:', + 'tel:', + 'data:image/png;base64,', + 'data:image/gif;base64,', + 'data:image/jpeg;base64,', + 'irc:', + 'ircs:', + 'git:', + 'ssh:', + 'news:', + 'steam:', + ); + + # + # Lines + # + + protected $BlockTypes = array( + '#' => array('Header'), + '*' => array('Rule', 'List'), + '+' => array('List'), + '-' => array('SetextHeader', 'Table', 'Rule', 'List'), + '0' => array('List'), + '1' => array('List'), + '2' => array('List'), + '3' => array('List'), + '4' => array('List'), + '5' => array('List'), + '6' => array('List'), + '7' => array('List'), + '8' => array('List'), + '9' => array('List'), + ':' => array('Table'), + '<' => array('Comment', 'Markup'), + '=' => array('SetextHeader'), + '>' => array('Quote'), + '[' => array('Reference'), + '_' => array('Rule'), + '`' => array('FencedCode'), + '|' => array('Table'), + '~' => array('FencedCode'), + ); + + # ~ + + protected $unmarkedBlockTypes = array( + 'Code', + ); + + # + # Blocks + # + + protected function lines(array $lines) + { + return $this->elements($this->linesElements($lines)); + } + + protected function linesElements(array $lines) + { + $Elements = array(); + $CurrentBlock = null; + + foreach ($lines as $line) + { + if (chop($line) === '') + { + if (isset($CurrentBlock)) + { + $CurrentBlock['interrupted'] = (isset($CurrentBlock['interrupted']) + ? $CurrentBlock['interrupted'] + 1 : 1 + ); + } + + continue; + } + + while (($beforeTab = strstr($line, "\t", true)) !== false) + { + $shortage = 4 - mb_strlen($beforeTab, 'utf-8') % 4; + + $line = $beforeTab + . str_repeat(' ', $shortage) + . substr($line, strlen($beforeTab) + 1) + ; + } + + $indent = strspn($line, ' '); + + $text = $indent > 0 ? substr($line, $indent) : $line; + + # ~ + + $Line = array('body' => $line, 'indent' => $indent, 'text' => $text); + + # ~ + + if (isset($CurrentBlock['continuable'])) + { + $methodName = 'block' . $CurrentBlock['type'] . 'Continue'; + $Block = $this->$methodName($Line, $CurrentBlock); + + if (isset($Block)) + { + $CurrentBlock = $Block; + + continue; + } + else + { + if ($this->isBlockCompletable($CurrentBlock['type'])) + { + $methodName = 'block' . $CurrentBlock['type'] . 'Complete'; + $CurrentBlock = $this->$methodName($CurrentBlock); + } + } + } + + # ~ + + $marker = $text[0]; + + # ~ + + $blockTypes = $this->unmarkedBlockTypes; + + if (isset($this->BlockTypes[$marker])) + { + foreach ($this->BlockTypes[$marker] as $blockType) + { + $blockTypes []= $blockType; + } + } + + # + # ~ + + foreach ($blockTypes as $blockType) + { + $Block = $this->{"block$blockType"}($Line, $CurrentBlock); + + if (isset($Block)) + { + $Block['type'] = $blockType; + + if ( ! isset($Block['identified'])) + { + if (isset($CurrentBlock)) + { + $Elements[] = $this->extractElement($CurrentBlock); + } + + $Block['identified'] = true; + } + + if ($this->isBlockContinuable($blockType)) + { + $Block['continuable'] = true; + } + + $CurrentBlock = $Block; + + continue 2; + } + } + + # ~ + + if (isset($CurrentBlock) and $CurrentBlock['type'] === 'Paragraph') + { + $Block = $this->paragraphContinue($Line, $CurrentBlock); + } + + if (isset($Block)) + { + $CurrentBlock = $Block; + } + else + { + if (isset($CurrentBlock)) + { + $Elements[] = $this->extractElement($CurrentBlock); + } + + $CurrentBlock = $this->paragraph($Line); + + $CurrentBlock['identified'] = true; + } + } + + # ~ + + if (isset($CurrentBlock['continuable']) and $this->isBlockCompletable($CurrentBlock['type'])) + { + $methodName = 'block' . $CurrentBlock['type'] . 'Complete'; + $CurrentBlock = $this->$methodName($CurrentBlock); + } + + # ~ + + if (isset($CurrentBlock)) + { + $Elements[] = $this->extractElement($CurrentBlock); + } + + # ~ + + return $Elements; + } + + protected function extractElement(array $Component) + { + if ( ! isset($Component['element'])) + { + if (isset($Component['markup'])) + { + $Component['element'] = array('rawHtml' => $Component['markup']); + } + elseif (isset($Component['hidden'])) + { + $Component['element'] = array(); + } + } + + return $Component['element']; + } + + protected function isBlockContinuable($Type) + { + return method_exists($this, 'block' . $Type . 'Continue'); + } + + protected function isBlockCompletable($Type) + { + return method_exists($this, 'block' . $Type . 'Complete'); + } + + # + # Code + + protected function blockCode($Line, $Block = null) + { + if (isset($Block) and $Block['type'] === 'Paragraph' and ! isset($Block['interrupted'])) + { + return; + } + + if ($Line['indent'] >= 4) + { + $text = substr($Line['body'], 4); + + $Block = array( + 'element' => array( + 'name' => 'pre', + 'element' => array( + 'name' => 'code', + 'text' => $text, + ), + ), + ); + + return $Block; + } + } + + protected function blockCodeContinue($Line, $Block) + { + if ($Line['indent'] >= 4) + { + if (isset($Block['interrupted'])) + { + $Block['element']['element']['text'] .= str_repeat("\n", $Block['interrupted']); + + unset($Block['interrupted']); + } + + $Block['element']['element']['text'] .= "\n"; + + $text = substr($Line['body'], 4); + + $Block['element']['element']['text'] .= $text; + + return $Block; + } + } + + protected function blockCodeComplete($Block) + { + return $Block; + } + + # + # Comment + + protected function blockComment($Line) + { + if ($this->markupEscaped or $this->safeMode) + { + return; + } + + if (strpos($Line['text'], '<!--') === 0) + { + $Block = array( + 'element' => array( + 'rawHtml' => $Line['body'], + 'autobreak' => true, + ), + ); + + if (strpos($Line['text'], '-->') !== false) + { + $Block['closed'] = true; + } + + return $Block; + } + } + + protected function blockCommentContinue($Line, array $Block) + { + if (isset($Block['closed'])) + { + return; + } + + $Block['element']['rawHtml'] .= "\n" . $Line['body']; + + if (strpos($Line['text'], '-->') !== false) + { + $Block['closed'] = true; + } + + return $Block; + } + + # + # Fenced Code + + protected function blockFencedCode($Line) + { + $marker = $Line['text'][0]; + + $openerLength = strspn($Line['text'], $marker); + + if ($openerLength < 3) + { + return; + } + + $infostring = trim(substr($Line['text'], $openerLength), "\t "); + + if (strpos($infostring, '`') !== false) + { + return; + } + + $Element = array( + 'name' => 'code', + 'text' => '', + ); + + if ($infostring !== '') + { + /** + * https://www.w3.org/TR/2011/WD-html5-20110525/elements.html#classes + * Every HTML element may have a class attribute specified. + * The attribute, if specified, must have a value that is a set + * of space-separated tokens representing the various classes + * that the element belongs to. + * [...] + * The space characters, for the purposes of this specification, + * are U+0020 SPACE, U+0009 CHARACTER TABULATION (tab), + * U+000A LINE FEED (LF), U+000C FORM FEED (FF), and + * U+000D CARRIAGE RETURN (CR). + */ + $language = substr($infostring, 0, strcspn($infostring, " \t\n\f\r")); + + $Element['attributes'] = array('class' => "language-$language"); + } + + $Block = array( + 'char' => $marker, + 'openerLength' => $openerLength, + 'element' => array( + 'name' => 'pre', + 'element' => $Element, + ), + ); + + return $Block; + } + + protected function blockFencedCodeContinue($Line, $Block) + { + if (isset($Block['complete'])) + { + return; + } + + if (isset($Block['interrupted'])) + { + $Block['element']['element']['text'] .= str_repeat("\n", $Block['interrupted']); + + unset($Block['interrupted']); + } + + if (($len = strspn($Line['text'], $Block['char'])) >= $Block['openerLength'] + and chop(substr($Line['text'], $len), ' ') === '' + ) { + $Block['element']['element']['text'] = substr($Block['element']['element']['text'], 1); + + $Block['complete'] = true; + + return $Block; + } + + $Block['element']['element']['text'] .= "\n" . $Line['body']; + + return $Block; + } + + protected function blockFencedCodeComplete($Block) + { + return $Block; + } + + # + # Header + + protected function blockHeader($Line) + { + $level = strspn($Line['text'], '#'); + + if ($level > 6) + { + return; + } + + $text = trim($Line['text'], '#'); + + if ($this->strictMode and isset($text[0]) and $text[0] !== ' ') + { + return; + } + + $text = trim($text, ' '); + + $Block = array( + 'element' => array( + 'name' => 'h' . $level, + 'handler' => array( + 'function' => 'lineElements', + 'argument' => $text, + 'destination' => 'elements', + ) + ), + ); + + return $Block; + } + + # + # List + + protected function blockList($Line, ?array $CurrentBlock = null) + { + list($name, $pattern) = $Line['text'][0] <= '-' ? array('ul', '[*+-]') : array('ol', '[0-9]{1,9}+[.\)]'); + + if (preg_match('/^('.$pattern.'([ ]++|$))(.*+)/', $Line['text'], $matches)) + { + $contentIndent = strlen($matches[2]); + + if ($contentIndent >= 5) + { + $contentIndent -= 1; + $matches[1] = substr($matches[1], 0, -$contentIndent); + $matches[3] = str_repeat(' ', $contentIndent) . $matches[3]; + } + elseif ($contentIndent === 0) + { + $matches[1] .= ' '; + } + + $markerWithoutWhitespace = strstr($matches[1], ' ', true); + + $Block = array( + 'indent' => $Line['indent'], + 'pattern' => $pattern, + 'data' => array( + 'type' => $name, + 'marker' => $matches[1], + 'markerType' => ($name === 'ul' ? $markerWithoutWhitespace : substr($markerWithoutWhitespace, -1)), + ), + 'element' => array( + 'name' => $name, + 'elements' => array(), + ), + ); + $Block['data']['markerTypeRegex'] = preg_quote($Block['data']['markerType'], '/'); + + if ($name === 'ol') + { + $listStart = ltrim(strstr($matches[1], $Block['data']['markerType'], true), '0') ?: '0'; + + if ($listStart !== '1') + { + if ( + isset($CurrentBlock) + and $CurrentBlock['type'] === 'Paragraph' + and ! isset($CurrentBlock['interrupted']) + ) { + return; + } + + $Block['element']['attributes'] = array('start' => $listStart); + } + } + + $Block['li'] = array( + 'name' => 'li', + 'handler' => array( + 'function' => 'li', + 'argument' => !empty($matches[3]) ? array($matches[3]) : array(), + 'destination' => 'elements' + ) + ); + + $Block['element']['elements'] []= & $Block['li']; + + return $Block; + } + } + + protected function blockListContinue($Line, array $Block) + { + if (isset($Block['interrupted']) and empty($Block['li']['handler']['argument'])) + { + return null; + } + + $requiredIndent = ($Block['indent'] + strlen($Block['data']['marker'])); + + if ($Line['indent'] < $requiredIndent + and ( + ( + $Block['data']['type'] === 'ol' + and preg_match('/^[0-9]++'.$Block['data']['markerTypeRegex'].'(?:[ ]++(.*)|$)/', $Line['text'], $matches) + ) or ( + $Block['data']['type'] === 'ul' + and preg_match('/^'.$Block['data']['markerTypeRegex'].'(?:[ ]++(.*)|$)/', $Line['text'], $matches) + ) + ) + ) { + if (isset($Block['interrupted'])) + { + $Block['li']['handler']['argument'] []= ''; + + $Block['loose'] = true; + + unset($Block['interrupted']); + } + + unset($Block['li']); + + $text = isset($matches[1]) ? $matches[1] : ''; + + $Block['indent'] = $Line['indent']; + + $Block['li'] = array( + 'name' => 'li', + 'handler' => array( + 'function' => 'li', + 'argument' => array($text), + 'destination' => 'elements' + ) + ); + + $Block['element']['elements'] []= & $Block['li']; + + return $Block; + } + elseif ($Line['indent'] < $requiredIndent and $this->blockList($Line)) + { + return null; + } + + if ($Line['text'][0] === '[' and $this->blockReference($Line)) + { + return $Block; + } + + if ($Line['indent'] >= $requiredIndent) + { + if (isset($Block['interrupted'])) + { + $Block['li']['handler']['argument'] []= ''; + + $Block['loose'] = true; + + unset($Block['interrupted']); + } + + $text = substr($Line['body'], $requiredIndent); + + $Block['li']['handler']['argument'] []= $text; + + return $Block; + } + + if ( ! isset($Block['interrupted'])) + { + $text = preg_replace('/^[ ]{0,'.$requiredIndent.'}+/', '', $Line['body']); + + $Block['li']['handler']['argument'] []= $text; + + return $Block; + } + } + + protected function blockListComplete(array $Block) + { + if (isset($Block['loose'])) + { + foreach ($Block['element']['elements'] as &$li) + { + if (end($li['handler']['argument']) !== '') + { + $li['handler']['argument'] []= ''; + } + } + } + + return $Block; + } + + # + # Quote + + protected function blockQuote($Line) + { + if (preg_match('/^>[ ]?+(.*+)/', $Line['text'], $matches)) + { + $Block = array( + 'element' => array( + 'name' => 'blockquote', + 'handler' => array( + 'function' => 'linesElements', + 'argument' => (array) $matches[1], + 'destination' => 'elements', + ) + ), + ); + + return $Block; + } + } + + protected function blockQuoteContinue($Line, array $Block) + { + if (isset($Block['interrupted'])) + { + return; + } + + if ($Line['text'][0] === '>' and preg_match('/^>[ ]?+(.*+)/', $Line['text'], $matches)) + { + $Block['element']['handler']['argument'] []= $matches[1]; + + return $Block; + } + + if ( ! isset($Block['interrupted'])) + { + $Block['element']['handler']['argument'] []= $Line['text']; + + return $Block; + } + } + + # + # Rule + + protected function blockRule($Line) + { + $marker = $Line['text'][0]; + + if (substr_count($Line['text'], $marker) >= 3 and chop($Line['text'], " $marker") === '') + { + $Block = array( + 'element' => array( + 'name' => 'hr', + ), + ); + + return $Block; + } + } + + # + # Setext + + protected function blockSetextHeader($Line, ?array $Block = null) + { + if ( ! isset($Block) or $Block['type'] !== 'Paragraph' or isset($Block['interrupted'])) + { + return; + } + + if ($Line['indent'] < 4 and chop(chop($Line['text'], ' '), $Line['text'][0]) === '') + { + $Block['element']['name'] = $Line['text'][0] === '=' ? 'h1' : 'h2'; + + return $Block; + } + } + + # + # Markup + + protected function blockMarkup($Line) + { + if ($this->markupEscaped or $this->safeMode) + { + return; + } + + if (preg_match('/^<[\/]?+(\w*)(?:[ ]*+'.$this->regexHtmlAttribute.')*+[ ]*+(\/)?>/', $Line['text'], $matches)) + { + $element = strtolower($matches[1]); + + if (in_array($element, $this->textLevelElements)) + { + return; + } + + $Block = array( + 'name' => $matches[1], + 'element' => array( + 'rawHtml' => $Line['text'], + 'autobreak' => true, + ), + ); + + return $Block; + } + } + + protected function blockMarkupContinue($Line, array $Block) + { + if (isset($Block['closed']) or isset($Block['interrupted'])) + { + return; + } + + $Block['element']['rawHtml'] .= "\n" . $Line['body']; + + return $Block; + } + + # + # Reference + + protected function blockReference($Line) + { + if (strpos($Line['text'], ']') !== false + and preg_match('/^\[(.+?)\]:[ ]*+<?(\S+?)>?(?:[ ]+["\'(](.+)["\')])?[ ]*+$/', $Line['text'], $matches) + ) { + $id = strtolower($matches[1]); + + $Data = array( + 'url' => $matches[2], + 'title' => isset($matches[3]) ? $matches[3] : null, + ); + + $this->DefinitionData['Reference'][$id] = $Data; + + $Block = array( + 'element' => array(), + ); + + return $Block; + } + } + + # + # Table + + protected function blockTable($Line, ?array $Block = null) + { + if ( ! isset($Block) or $Block['type'] !== 'Paragraph' or isset($Block['interrupted'])) + { + return; + } + + if ( + strpos($Block['element']['handler']['argument'], '|') === false + and strpos($Line['text'], '|') === false + and strpos($Line['text'], ':') === false + or strpos($Block['element']['handler']['argument'], "\n") !== false + ) { + return; + } + + if (chop($Line['text'], ' -:|') !== '') + { + return; + } + + $alignments = array(); + + $divider = $Line['text']; + + $divider = trim($divider); + $divider = trim($divider, '|'); + + $dividerCells = explode('|', $divider); + + foreach ($dividerCells as $dividerCell) + { + $dividerCell = trim($dividerCell); + + if ($dividerCell === '') + { + return; + } + + $alignment = null; + + if ($dividerCell[0] === ':') + { + $alignment = 'left'; + } + + if (substr($dividerCell, - 1) === ':') + { + $alignment = $alignment === 'left' ? 'center' : 'right'; + } + + $alignments []= $alignment; + } + + # ~ + + $HeaderElements = array(); + + $header = $Block['element']['handler']['argument']; + + $header = trim($header); + $header = trim($header, '|'); + + $headerCells = explode('|', $header); + + if (count($headerCells) !== count($alignments)) + { + return; + } + + foreach ($headerCells as $index => $headerCell) + { + $headerCell = trim($headerCell); + + $HeaderElement = array( + 'name' => 'th', + 'handler' => array( + 'function' => 'lineElements', + 'argument' => $headerCell, + 'destination' => 'elements', + ) + ); + + if (isset($alignments[$index])) + { + $alignment = $alignments[$index]; + + $HeaderElement['attributes'] = array( + 'style' => "text-align: $alignment;", + ); + } + + $HeaderElements []= $HeaderElement; + } + + # ~ + + $Block = array( + 'alignments' => $alignments, + 'identified' => true, + 'element' => array( + 'name' => 'table', + 'elements' => array(), + ), + ); + + $Block['element']['elements'] []= array( + 'name' => 'thead', + ); + + $Block['element']['elements'] []= array( + 'name' => 'tbody', + 'elements' => array(), + ); + + $Block['element']['elements'][0]['elements'] []= array( + 'name' => 'tr', + 'elements' => $HeaderElements, + ); + + return $Block; + } + + protected function blockTableContinue($Line, array $Block) + { + if (isset($Block['interrupted'])) + { + return; + } + + if (count($Block['alignments']) === 1 or $Line['text'][0] === '|' or strpos($Line['text'], '|')) + { + $Elements = array(); + + $row = $Line['text']; + + $row = trim($row); + $row = trim($row, '|'); + + preg_match_all('/(?:(\\\\[|])|[^|`]|`[^`]++`|`)++/', $row, $matches); + + $cells = array_slice($matches[0], 0, count($Block['alignments'])); + + foreach ($cells as $index => $cell) + { + $cell = trim($cell); + + $Element = array( + 'name' => 'td', + 'handler' => array( + 'function' => 'lineElements', + 'argument' => $cell, + 'destination' => 'elements', + ) + ); + + if (isset($Block['alignments'][$index])) + { + $Element['attributes'] = array( + 'style' => 'text-align: ' . $Block['alignments'][$index] . ';', + ); + } + + $Elements []= $Element; + } + + $Element = array( + 'name' => 'tr', + 'elements' => $Elements, + ); + + $Block['element']['elements'][1]['elements'] []= $Element; + + return $Block; + } + } + + # + # ~ + # + + protected function paragraph($Line) + { + return array( + 'type' => 'Paragraph', + 'element' => array( + 'name' => 'p', + 'handler' => array( + 'function' => 'lineElements', + 'argument' => $Line['text'], + 'destination' => 'elements', + ), + ), + ); + } + + protected function paragraphContinue($Line, array $Block) + { + if (isset($Block['interrupted'])) + { + return; + } + + $Block['element']['handler']['argument'] .= "\n".$Line['text']; + + return $Block; + } + + # + # Inline Elements + # + + protected $InlineTypes = array( + '!' => array('Image'), + '&' => array('SpecialCharacter'), + '*' => array('Emphasis'), + ':' => array('Url'), + '<' => array('UrlTag', 'EmailTag', 'Markup'), + '[' => array('Link'), + '_' => array('Emphasis'), + '`' => array('Code'), + '~' => array('Strikethrough'), + '\\' => array('EscapeSequence'), + ); + + # ~ + + protected $inlineMarkerList = '!*_&[:<`~\\'; + + # + # ~ + # + + public function line($text, $nonNestables = array()) + { + return $this->elements($this->lineElements($text, $nonNestables)); + } + + protected function lineElements($text, $nonNestables = array()) + { + # standardize line breaks + $text = str_replace(array("\r\n", "\r"), "\n", $text); + + $Elements = array(); + + $nonNestables = (empty($nonNestables) + ? array() + : array_combine($nonNestables, $nonNestables) + ); + + # $excerpt is based on the first occurrence of a marker + + while ($excerpt = strpbrk($text, $this->inlineMarkerList)) + { + $marker = $excerpt[0]; + + $markerPosition = strlen($text) - strlen($excerpt); + + $Excerpt = array('text' => $excerpt, 'context' => $text); + + foreach ($this->InlineTypes[$marker] as $inlineType) + { + # check to see if the current inline type is nestable in the current context + + if (isset($nonNestables[$inlineType])) + { + continue; + } + + $Inline = $this->{"inline$inlineType"}($Excerpt); + + if ( ! isset($Inline)) + { + continue; + } + + # makes sure that the inline belongs to "our" marker + + if (isset($Inline['position']) and $Inline['position'] > $markerPosition) + { + continue; + } + + # sets a default inline position + + if ( ! isset($Inline['position'])) + { + $Inline['position'] = $markerPosition; + } + + # cause the new element to 'inherit' our non nestables + + + $Inline['element']['nonNestables'] = isset($Inline['element']['nonNestables']) + ? array_merge($Inline['element']['nonNestables'], $nonNestables) + : $nonNestables + ; + + # the text that comes before the inline + $unmarkedText = substr($text, 0, $Inline['position']); + + # compile the unmarked text + $InlineText = $this->inlineText($unmarkedText); + $Elements[] = $InlineText['element']; + + # compile the inline + $Elements[] = $this->extractElement($Inline); + + # remove the examined text + $text = substr($text, $Inline['position'] + $Inline['extent']); + + continue 2; + } + + # the marker does not belong to an inline + + $unmarkedText = substr($text, 0, $markerPosition + 1); + + $InlineText = $this->inlineText($unmarkedText); + $Elements[] = $InlineText['element']; + + $text = substr($text, $markerPosition + 1); + } + + $InlineText = $this->inlineText($text); + $Elements[] = $InlineText['element']; + + foreach ($Elements as &$Element) + { + if ( ! isset($Element['autobreak'])) + { + $Element['autobreak'] = false; + } + } + + return $Elements; + } + + # + # ~ + # + + protected function inlineText($text) + { + $Inline = array( + 'extent' => strlen($text), + 'element' => array(), + ); + + $Inline['element']['elements'] = self::pregReplaceElements( + $this->breaksEnabled ? '/[ ]*+\n/' : '/(?:[ ]*+\\\\|[ ]{2,}+)\n/', + array( + array('name' => 'br'), + array('text' => "\n"), + ), + $text + ); + + return $Inline; + } + + protected function inlineCode($Excerpt) + { + $marker = $Excerpt['text'][0]; + + if (preg_match('/^(['.$marker.']++)[ ]*+(.+?)[ ]*+(?<!['.$marker.'])\1(?!'.$marker.')/s', $Excerpt['text'], $matches)) + { + $text = $matches[2]; + $text = preg_replace('/[ ]*+\n/', ' ', $text); + + return array( + 'extent' => strlen($matches[0]), + 'element' => array( + 'name' => 'code', + 'text' => $text, + ), + ); + } + } + + protected function inlineEmailTag($Excerpt) + { + $hostnameLabel = '[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?'; + + $commonMarkEmail = '[a-zA-Z0-9.!#$%&\'*+\/=?^_`{|}~-]++@' + . $hostnameLabel . '(?:\.' . $hostnameLabel . ')*'; + + if (strpos($Excerpt['text'], '>') !== false + and preg_match("/^<((mailto:)?$commonMarkEmail)>/i", $Excerpt['text'], $matches) + ){ + $url = $matches[1]; + + if ( ! isset($matches[2])) + { + $url = "mailto:$url"; + } + + return array( + 'extent' => strlen($matches[0]), + 'element' => array( + 'name' => 'a', + 'text' => $matches[1], + 'attributes' => array( + 'href' => $url, + ), + ), + ); + } + } + + protected function inlineEmphasis($Excerpt) + { + if ( ! isset($Excerpt['text'][1])) + { + return; + } + + $marker = $Excerpt['text'][0]; + + if ($Excerpt['text'][1] === $marker and preg_match($this->StrongRegex[$marker], $Excerpt['text'], $matches)) + { + $emphasis = 'strong'; + } + elseif (preg_match($this->EmRegex[$marker], $Excerpt['text'], $matches)) + { + $emphasis = 'em'; + } + else + { + return; + } + + return array( + 'extent' => strlen($matches[0]), + 'element' => array( + 'name' => $emphasis, + 'handler' => array( + 'function' => 'lineElements', + 'argument' => $matches[1], + 'destination' => 'elements', + ) + ), + ); + } + + protected function inlineEscapeSequence($Excerpt) + { + if (isset($Excerpt['text'][1]) and in_array($Excerpt['text'][1], $this->specialCharacters)) + { + return array( + 'element' => array('rawHtml' => $Excerpt['text'][1]), + 'extent' => 2, + ); + } + } + + protected function inlineImage($Excerpt) + { + if ( ! isset($Excerpt['text'][1]) or $Excerpt['text'][1] !== '[') + { + return; + } + + $Excerpt['text']= substr($Excerpt['text'], 1); + + $Link = $this->inlineLink($Excerpt); + + if ($Link === null) + { + return; + } + + $Inline = array( + 'extent' => $Link['extent'] + 1, + 'element' => array( + 'name' => 'img', + 'attributes' => array( + 'src' => $Link['element']['attributes']['href'], + 'alt' => $Link['element']['handler']['argument'], + ), + 'autobreak' => true, + ), + ); + + $Inline['element']['attributes'] += $Link['element']['attributes']; + + unset($Inline['element']['attributes']['href']); + + return $Inline; + } + + protected function inlineLink($Excerpt) + { + $Element = array( + 'name' => 'a', + 'handler' => array( + 'function' => 'lineElements', + 'argument' => null, + 'destination' => 'elements', + ), + 'nonNestables' => array('Url', 'Link'), + 'attributes' => array( + 'href' => null, + 'title' => null, + ), + ); + + $extent = 0; + + $remainder = $Excerpt['text']; + + if (preg_match('/\[((?:[^][]++|(?R))*+)\]/', $remainder, $matches)) + { + $Element['handler']['argument'] = $matches[1]; + + $extent += strlen($matches[0]); + + $remainder = substr($remainder, $extent); + } + else + { + return; + } + + if (preg_match('/^[(]\s*+((?:[^ ()]++|[(][^ )]+[)])++)(?:[ ]+("[^"]*+"|\'[^\']*+\'))?\s*+[)]/', $remainder, $matches)) + { + $Element['attributes']['href'] = $matches[1]; + + if (isset($matches[2])) + { + $Element['attributes']['title'] = substr($matches[2], 1, - 1); + } + + $extent += strlen($matches[0]); + } + else + { + if (preg_match('/^\s*\[(.*?)\]/', $remainder, $matches)) + { + $definition = strlen($matches[1]) ? $matches[1] : $Element['handler']['argument']; + $definition = strtolower($definition); + + $extent += strlen($matches[0]); + } + else + { + $definition = strtolower($Element['handler']['argument']); + } + + if ( ! isset($this->DefinitionData['Reference'][$definition])) + { + return; + } + + $Definition = $this->DefinitionData['Reference'][$definition]; + + $Element['attributes']['href'] = $Definition['url']; + $Element['attributes']['title'] = $Definition['title']; + } + + return array( + 'extent' => $extent, + 'element' => $Element, + ); + } + + protected function inlineMarkup($Excerpt) + { + if ($this->markupEscaped or $this->safeMode or strpos($Excerpt['text'], '>') === false) + { + return; + } + + if ($Excerpt['text'][1] === '/' and preg_match('/^<\/\w[\w-]*+[ ]*+>/s', $Excerpt['text'], $matches)) + { + return array( + 'element' => array('rawHtml' => $matches[0]), + 'extent' => strlen($matches[0]), + ); + } + + if ($Excerpt['text'][1] === '!' and preg_match('/^<!---?[^>-](?:-?+[^-])*-->/s', $Excerpt['text'], $matches)) + { + return array( + 'element' => array('rawHtml' => $matches[0]), + 'extent' => strlen($matches[0]), + ); + } + + if ($Excerpt['text'][1] !== ' ' and preg_match('/^<\w[\w-]*+(?:[ ]*+'.$this->regexHtmlAttribute.')*+[ ]*+\/?>/s', $Excerpt['text'], $matches)) + { + return array( + 'element' => array('rawHtml' => $matches[0]), + 'extent' => strlen($matches[0]), + ); + } + } + + protected function inlineSpecialCharacter($Excerpt) + { + if (substr($Excerpt['text'], 1, 1) !== ' ' and strpos($Excerpt['text'], ';') !== false + and preg_match('/^&(#?+[0-9a-zA-Z]++);/', $Excerpt['text'], $matches) + ) { + return array( + 'element' => array('rawHtml' => '&' . $matches[1] . ';'), + 'extent' => strlen($matches[0]), + ); + } + + return; + } + + protected function inlineStrikethrough($Excerpt) + { + if ( ! isset($Excerpt['text'][1])) + { + return; + } + + if ($Excerpt['text'][1] === '~' and preg_match('/^~~(?=\S)(.+?)(?<=\S)~~/', $Excerpt['text'], $matches)) + { + return array( + 'extent' => strlen($matches[0]), + 'element' => array( + 'name' => 'del', + 'handler' => array( + 'function' => 'lineElements', + 'argument' => $matches[1], + 'destination' => 'elements', + ) + ), + ); + } + } + + protected function inlineUrl($Excerpt) + { + if ($this->urlsLinked !== true or ! isset($Excerpt['text'][2]) or $Excerpt['text'][2] !== '/') + { + return; + } + + if (strpos($Excerpt['context'], 'http') !== false + and preg_match('/\bhttps?+:[\/]{2}[^\s<]+\b\/*+/ui', $Excerpt['context'], $matches, PREG_OFFSET_CAPTURE) + ) { + $url = $matches[0][0]; + + $Inline = array( + 'extent' => strlen($matches[0][0]), + 'position' => $matches[0][1], + 'element' => array( + 'name' => 'a', + 'text' => $url, + 'attributes' => array( + 'href' => $url, + ), + ), + ); + + return $Inline; + } + } + + protected function inlineUrlTag($Excerpt) + { + if (strpos($Excerpt['text'], '>') !== false and preg_match('/^<(\w++:\/{2}[^ >]++)>/i', $Excerpt['text'], $matches)) + { + $url = $matches[1]; + + return array( + 'extent' => strlen($matches[0]), + 'element' => array( + 'name' => 'a', + 'text' => $url, + 'attributes' => array( + 'href' => $url, + ), + ), + ); + } + } + + # ~ + + protected function unmarkedText($text) + { + $Inline = $this->inlineText($text); + return $this->element($Inline['element']); + } + + # + # Handlers + # + + protected function handle(array $Element) + { + if (isset($Element['handler'])) + { + if (!isset($Element['nonNestables'])) + { + $Element['nonNestables'] = array(); + } + + if (is_string($Element['handler'])) + { + $function = $Element['handler']; + $argument = $Element['text']; + unset($Element['text']); + $destination = 'rawHtml'; + } + else + { + $function = $Element['handler']['function']; + $argument = $Element['handler']['argument']; + $destination = $Element['handler']['destination']; + } + + $Element[$destination] = $this->{$function}($argument, $Element['nonNestables']); + + if ($destination === 'handler') + { + $Element = $this->handle($Element); + } + + unset($Element['handler']); + } + + return $Element; + } + + protected function handleElementRecursive(array $Element) + { + return $this->elementApplyRecursive(array($this, 'handle'), $Element); + } + + protected function handleElementsRecursive(array $Elements) + { + return $this->elementsApplyRecursive(array($this, 'handle'), $Elements); + } + + protected function elementApplyRecursive($closure, array $Element) + { + $Element = call_user_func($closure, $Element); + + if (isset($Element['elements'])) + { + $Element['elements'] = $this->elementsApplyRecursive($closure, $Element['elements']); + } + elseif (isset($Element['element'])) + { + $Element['element'] = $this->elementApplyRecursive($closure, $Element['element']); + } + + return $Element; + } + + protected function elementApplyRecursiveDepthFirst($closure, array $Element) + { + if (isset($Element['elements'])) + { + $Element['elements'] = $this->elementsApplyRecursiveDepthFirst($closure, $Element['elements']); + } + elseif (isset($Element['element'])) + { + $Element['element'] = $this->elementsApplyRecursiveDepthFirst($closure, $Element['element']); + } + + $Element = call_user_func($closure, $Element); + + return $Element; + } + + protected function elementsApplyRecursive($closure, array $Elements) + { + foreach ($Elements as &$Element) + { + $Element = $this->elementApplyRecursive($closure, $Element); + } + + return $Elements; + } + + protected function elementsApplyRecursiveDepthFirst($closure, array $Elements) + { + foreach ($Elements as &$Element) + { + $Element = $this->elementApplyRecursiveDepthFirst($closure, $Element); + } + + return $Elements; + } + + protected function element(array $Element) + { + if ($this->safeMode) + { + $Element = $this->sanitiseElement($Element); + } + + # identity map if element has no handler + $Element = $this->handle($Element); + + $hasName = isset($Element['name']); + + $markup = ''; + + if ($hasName) + { + $markup .= '<' . $Element['name']; + + if (isset($Element['attributes'])) + { + foreach ($Element['attributes'] as $name => $value) + { + if ($value === null) + { + continue; + } + + $markup .= " $name=\"".self::escape($value).'"'; + } + } + } + + $permitRawHtml = false; + + if (isset($Element['text'])) + { + $text = $Element['text']; + } + // very strongly consider an alternative if you're writing an + // extension + elseif (isset($Element['rawHtml'])) + { + $text = $Element['rawHtml']; + + $allowRawHtmlInSafeMode = isset($Element['allowRawHtmlInSafeMode']) && $Element['allowRawHtmlInSafeMode']; + $permitRawHtml = !$this->safeMode || $allowRawHtmlInSafeMode; + } + + $hasContent = isset($text) || isset($Element['element']) || isset($Element['elements']); + + if ($hasContent) + { + $markup .= $hasName ? '>' : ''; + + if (isset($Element['elements'])) + { + $markup .= $this->elements($Element['elements']); + } + elseif (isset($Element['element'])) + { + $markup .= $this->element($Element['element']); + } + else + { + if (!$permitRawHtml) + { + $markup .= self::escape($text, true); + } + else + { + $markup .= $text; + } + } + + $markup .= $hasName ? '</' . $Element['name'] . '>' : ''; + } + elseif ($hasName) + { + $markup .= ' />'; + } + + return $markup; + } + + protected function elements(array $Elements) + { + $markup = ''; + + $autoBreak = true; + + foreach ($Elements as $Element) + { + if (empty($Element)) + { + continue; + } + + $autoBreakNext = (isset($Element['autobreak']) + ? $Element['autobreak'] : isset($Element['name']) + ); + // (autobreak === false) covers both sides of an element + $autoBreak = !$autoBreak ? $autoBreak : $autoBreakNext; + + $markup .= ($autoBreak ? "\n" : '') . $this->element($Element); + $autoBreak = $autoBreakNext; + } + + $markup .= $autoBreak ? "\n" : ''; + + return $markup; + } + + # ~ + + protected function li($lines) + { + $Elements = $this->linesElements($lines); + + if ( ! in_array('', $lines) + and isset($Elements[0]) and isset($Elements[0]['name']) + and $Elements[0]['name'] === 'p' + ) { + unset($Elements[0]['name']); + } + + return $Elements; + } + + # + # AST Convenience + # + + /** + * Replace occurrences $regexp with $Elements in $text. Return an array of + * elements representing the replacement. + */ + protected static function pregReplaceElements($regexp, $Elements, $text) + { + $newElements = array(); + + while (preg_match($regexp, $text, $matches, PREG_OFFSET_CAPTURE)) + { + $offset = $matches[0][1]; + $before = substr($text, 0, $offset); + $after = substr($text, $offset + strlen($matches[0][0])); + + $newElements[] = array('text' => $before); + + foreach ($Elements as $Element) + { + $newElements[] = $Element; + } + + $text = $after; + } + + $newElements[] = array('text' => $text); + + return $newElements; + } + + # + # Deprecated Methods + # + + function parse($text) + { + $markup = $this->text($text); + + return $markup; + } + + protected function sanitiseElement(array $Element) + { + static $goodAttribute = '/^[a-zA-Z0-9][a-zA-Z0-9-_]*+$/'; + static $safeUrlNameToAtt = array( + 'a' => 'href', + 'img' => 'src', + ); + + if ( ! isset($Element['name'])) + { + unset($Element['attributes']); + return $Element; + } + + if (isset($safeUrlNameToAtt[$Element['name']])) + { + $Element = $this->filterUnsafeUrlInAttribute($Element, $safeUrlNameToAtt[$Element['name']]); + } + + if ( ! empty($Element['attributes'])) + { + foreach ($Element['attributes'] as $att => $val) + { + # filter out badly parsed attribute + if ( ! preg_match($goodAttribute, $att)) + { + unset($Element['attributes'][$att]); + } + # dump onevent attribute + elseif (self::striAtStart($att, 'on')) + { + unset($Element['attributes'][$att]); + } + } + } + + return $Element; + } + + protected function filterUnsafeUrlInAttribute(array $Element, $attribute) + { + foreach ($this->safeLinksWhitelist as $scheme) + { + if (self::striAtStart($Element['attributes'][$attribute], $scheme)) + { + return $Element; + } + } + + $Element['attributes'][$attribute] = str_replace(':', '%3A', $Element['attributes'][$attribute]); + + return $Element; + } + + # + # Static Methods + # + + protected static function escape($text, $allowQuotes = false) + { + return htmlspecialchars($text, $allowQuotes ? ENT_NOQUOTES : ENT_QUOTES, 'UTF-8'); + } + + protected static function striAtStart($string, $needle) + { + $len = strlen($needle); + + if ($len > strlen($string)) + { + return false; + } + else + { + return strtolower(substr($string, 0, $len)) === strtolower($needle); + } + } + + static function instance($name = 'default') + { + if (isset(self::$instances[$name])) + { + return self::$instances[$name]; + } + + $instance = new static(); + + self::$instances[$name] = $instance; + + return $instance; + } + + private static $instances = array(); + + # + # Fields + # + + protected $DefinitionData; + + # + # Read-Only + + protected $specialCharacters = array( + '\\', '`', '*', '_', '{', '}', '[', ']', '(', ')', '>', '#', '+', '-', '.', '!', '|', '~' + ); + + protected $StrongRegex = array( + '*' => '/^[*]{2}((?:\\\\\*|[^*]|[*][^*]*+[*])+?)[*]{2}(?![*])/s', + '_' => '/^__((?:\\\\_|[^_]|_[^_]*+_)+?)__(?!_)/us', + ); + + protected $EmRegex = array( + '*' => '/^[*]((?:\\\\\*|[^*]|[*][*][^*]+?[*][*])+?)[*](?![*])/s', + '_' => '/^_((?:\\\\_|[^_]|__[^_]*__)+?)_(?!_)\b/us', + ); + + protected $regexHtmlAttribute = '[a-zA-Z_:][\w:.-]*+(?:\s*+=\s*+(?:[^"\'=<>`\s]+|"[^"]*+"|\'[^\']*+\'))?+'; + + protected $voidElements = array( + 'area', 'base', 'br', 'col', 'command', 'embed', 'hr', 'img', 'input', 'link', 'meta', 'param', 'source', + ); + + protected $textLevelElements = array( + 'a', 'br', 'bdo', 'abbr', 'blink', 'nextid', 'acronym', 'basefont', + 'b', 'em', 'big', 'cite', 'small', 'spacer', 'listing', + 'i', 'rp', 'del', 'code', 'strike', 'marquee', + 'q', 'rt', 'ins', 'font', 'strong', + 's', 'tt', 'kbd', 'mark', + 'u', 'xm', 'sub', 'nobr', + 'sup', 'ruby', + 'var', 'span', + 'wbr', 'time', + ); +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/composer.json b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/composer.json new file mode 100644 index 0000000000..cbede149ac --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/composer.json @@ -0,0 +1,131 @@ +{ + "name": "guzzlehttp/guzzle", + "description": "Guzzle is a PHP HTTP client library", + "keywords": [ + "framework", + "http", + "rest", + "web service", + "curl", + "client", + "HTTP client", + "PSR-7", + "PSR-18" + ], + "license": "MIT", + "authors": [ + { + "name": "Graham Campbell", + "email": "hello@gjcampbell.co.uk", + "homepage": "https://github.com/GrahamCampbell" + }, + { + "name": "Michael Dowling", + "email": "mtdowling@gmail.com", + "homepage": "https://github.com/mtdowling" + }, + { + "name": "Jeremy Lindblom", + "email": "jeremeamia@gmail.com", + "homepage": "https://github.com/jeremeamia" + }, + { + "name": "George Mponos", + "email": "gmponos@gmail.com", + "homepage": "https://github.com/gmponos" + }, + { + "name": "Tobias Nyholm", + "email": "tobias.nyholm@gmail.com", + "homepage": "https://github.com/Nyholm" + }, + { + "name": "Márk Sági-Kazár", + "email": "mark.sagikazar@gmail.com", + "homepage": "https://github.com/sagikazarmark" + }, + { + "name": "Tobias Schultze", + "email": "webmaster@tubo-world.de", + "homepage": "https://github.com/Tobion" + } + ], + "repositories": [ + { + "type": "package", + "package": { + "name": "guzzle/client-integration-tests", + "version": "v3.0.2", + "dist": { + "url": "https://codeload.github.com/guzzle/client-integration-tests/zip/2c025848417c1135031fdf9c728ee53d0a7ceaee", + "type": "zip" + }, + "require": { + "php": "^7.2.5 || ^8.0", + "phpunit/phpunit": "^7.5.20 || ^8.5.8 || ^9.3.11", + "php-http/message": "^1.0 || ^2.0", + "guzzlehttp/psr7": "^1.7 || ^2.0", + "th3n3rd/cartesian-product": "^0.3" + }, + "autoload": { + "psr-4": { + "Http\\Client\\Tests\\": "src/" + } + }, + "bin": [ + "bin/http_test_server" + ] + } + } + ], + "require": { + "php": "^7.2.5 || ^8.0", + "ext-json": "*", + "guzzlehttp/promises": "^1.5.3 || ^2.0.3", + "guzzlehttp/psr7": "^2.7.0", + "psr/http-client": "^1.0", + "symfony/deprecation-contracts": "^2.2 || ^3.0" + }, + "provide": { + "psr/http-client-implementation": "1.0" + }, + "require-dev": { + "ext-curl": "*", + "bamarni/composer-bin-plugin": "^1.8.2", + "guzzle/client-integration-tests": "3.0.2", + "php-http/message-factory": "^1.1", + "phpunit/phpunit": "^8.5.39 || ^9.6.20", + "psr/log": "^1.1 || ^2.0 || ^3.0" + }, + "suggest": { + "ext-curl": "Required for CURL handler support", + "ext-intl": "Required for Internationalized Domain Name (IDN) support", + "psr/log": "Required for using the Log middleware" + }, + "config": { + "allow-plugins": { + "bamarni/composer-bin-plugin": true + }, + "preferred-install": "dist", + "sort-packages": true + }, + "extra": { + "bamarni-bin": { + "bin-links": true, + "forward-command": false + } + }, + "autoload": { + "psr-4": { + "GuzzleHttp\\": "src/" + }, + "files": [ + "src/functions_include.php" + ] + }, + "autoload-dev": { + "psr-4": { + "GuzzleHttp\\Tests\\": "tests/" + } + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/BodySummarizer.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/BodySummarizer.php new file mode 100644 index 0000000000..761506dd07 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/BodySummarizer.php @@ -0,0 +1,28 @@ +<?php + +namespace GuzzleHttp; + +use Psr\Http\Message\MessageInterface; + +final class BodySummarizer implements BodySummarizerInterface +{ + /** + * @var int|null + */ + private $truncateAt; + + public function __construct(?int $truncateAt = null) + { + $this->truncateAt = $truncateAt; + } + + /** + * Returns a summarized message body. + */ + public function summarize(MessageInterface $message): ?string + { + return $this->truncateAt === null + ? Psr7\Message::bodySummary($message) + : Psr7\Message::bodySummary($message, $this->truncateAt); + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/Client.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/Client.php new file mode 100644 index 0000000000..c78919a4fc --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/Client.php @@ -0,0 +1,483 @@ +<?php + +namespace GuzzleHttp; + +use GuzzleHttp\Cookie\CookieJar; +use GuzzleHttp\Exception\GuzzleException; +use GuzzleHttp\Exception\InvalidArgumentException; +use GuzzleHttp\Promise as P; +use GuzzleHttp\Promise\PromiseInterface; +use Psr\Http\Message\RequestInterface; +use Psr\Http\Message\ResponseInterface; +use Psr\Http\Message\UriInterface; + +/** + * @final + */ +class Client implements ClientInterface, \Psr\Http\Client\ClientInterface +{ + use ClientTrait; + + /** + * @var array Default request options + */ + private $config; + + /** + * Clients accept an array of constructor parameters. + * + * Here's an example of creating a client using a base_uri and an array of + * default request options to apply to each request: + * + * $client = new Client([ + * 'base_uri' => 'http://www.foo.com/1.0/', + * 'timeout' => 0, + * 'allow_redirects' => false, + * 'proxy' => '192.168.16.1:10' + * ]); + * + * Client configuration settings include the following options: + * + * - handler: (callable) Function that transfers HTTP requests over the + * wire. The function is called with a Psr7\Http\Message\RequestInterface + * and array of transfer options, and must return a + * GuzzleHttp\Promise\PromiseInterface that is fulfilled with a + * Psr7\Http\Message\ResponseInterface on success. + * If no handler is provided, a default handler will be created + * that enables all of the request options below by attaching all of the + * default middleware to the handler. + * - base_uri: (string|UriInterface) Base URI of the client that is merged + * into relative URIs. Can be a string or instance of UriInterface. + * - **: any request option + * + * @param array $config Client configuration settings. + * + * @see RequestOptions for a list of available request options. + */ + public function __construct(array $config = []) + { + if (!isset($config['handler'])) { + $config['handler'] = HandlerStack::create(); + } elseif (!\is_callable($config['handler'])) { + throw new InvalidArgumentException('handler must be a callable'); + } + + // Convert the base_uri to a UriInterface + if (isset($config['base_uri'])) { + $config['base_uri'] = Psr7\Utils::uriFor($config['base_uri']); + } + + $this->configureDefaults($config); + } + + /** + * @param string $method + * @param array $args + * + * @return PromiseInterface|ResponseInterface + * + * @deprecated Client::__call will be removed in guzzlehttp/guzzle:8.0. + */ + public function __call($method, $args) + { + if (\count($args) < 1) { + throw new InvalidArgumentException('Magic request methods require a URI and optional options array'); + } + + $uri = $args[0]; + $opts = $args[1] ?? []; + + return \substr($method, -5) === 'Async' + ? $this->requestAsync(\substr($method, 0, -5), $uri, $opts) + : $this->request($method, $uri, $opts); + } + + /** + * Asynchronously send an HTTP request. + * + * @param array $options Request options to apply to the given + * request and to the transfer. See \GuzzleHttp\RequestOptions. + */ + public function sendAsync(RequestInterface $request, array $options = []): PromiseInterface + { + // Merge the base URI into the request URI if needed. + $options = $this->prepareDefaults($options); + + return $this->transfer( + $request->withUri($this->buildUri($request->getUri(), $options), $request->hasHeader('Host')), + $options + ); + } + + /** + * Send an HTTP request. + * + * @param array $options Request options to apply to the given + * request and to the transfer. See \GuzzleHttp\RequestOptions. + * + * @throws GuzzleException + */ + public function send(RequestInterface $request, array $options = []): ResponseInterface + { + $options[RequestOptions::SYNCHRONOUS] = true; + + return $this->sendAsync($request, $options)->wait(); + } + + /** + * The HttpClient PSR (PSR-18) specify this method. + * + * {@inheritDoc} + */ + public function sendRequest(RequestInterface $request): ResponseInterface + { + $options[RequestOptions::SYNCHRONOUS] = true; + $options[RequestOptions::ALLOW_REDIRECTS] = false; + $options[RequestOptions::HTTP_ERRORS] = false; + + return $this->sendAsync($request, $options)->wait(); + } + + /** + * Create and send an asynchronous HTTP request. + * + * Use an absolute path to override the base path of the client, or a + * relative path to append to the base path of the client. The URL can + * contain the query string as well. Use an array to provide a URL + * template and additional variables to use in the URL template expansion. + * + * @param string $method HTTP method + * @param string|UriInterface $uri URI object or string. + * @param array $options Request options to apply. See \GuzzleHttp\RequestOptions. + */ + public function requestAsync(string $method, $uri = '', array $options = []): PromiseInterface + { + $options = $this->prepareDefaults($options); + // Remove request modifying parameter because it can be done up-front. + $headers = $options['headers'] ?? []; + $body = $options['body'] ?? null; + $version = $options['version'] ?? '1.1'; + // Merge the URI into the base URI. + $uri = $this->buildUri(Psr7\Utils::uriFor($uri), $options); + if (\is_array($body)) { + throw $this->invalidBody(); + } + $request = new Psr7\Request($method, $uri, $headers, $body, $version); + // Remove the option so that they are not doubly-applied. + unset($options['headers'], $options['body'], $options['version']); + + return $this->transfer($request, $options); + } + + /** + * Create and send an HTTP request. + * + * Use an absolute path to override the base path of the client, or a + * relative path to append to the base path of the client. The URL can + * contain the query string as well. + * + * @param string $method HTTP method. + * @param string|UriInterface $uri URI object or string. + * @param array $options Request options to apply. See \GuzzleHttp\RequestOptions. + * + * @throws GuzzleException + */ + public function request(string $method, $uri = '', array $options = []): ResponseInterface + { + $options[RequestOptions::SYNCHRONOUS] = true; + + return $this->requestAsync($method, $uri, $options)->wait(); + } + + /** + * Get a client configuration option. + * + * These options include default request options of the client, a "handler" + * (if utilized by the concrete client), and a "base_uri" if utilized by + * the concrete client. + * + * @param string|null $option The config option to retrieve. + * + * @return mixed + * + * @deprecated Client::getConfig will be removed in guzzlehttp/guzzle:8.0. + */ + public function getConfig(?string $option = null) + { + return $option === null + ? $this->config + : ($this->config[$option] ?? null); + } + + private function buildUri(UriInterface $uri, array $config): UriInterface + { + if (isset($config['base_uri'])) { + $uri = Psr7\UriResolver::resolve(Psr7\Utils::uriFor($config['base_uri']), $uri); + } + + if (isset($config['idn_conversion']) && ($config['idn_conversion'] !== false)) { + $idnOptions = ($config['idn_conversion'] === true) ? \IDNA_DEFAULT : $config['idn_conversion']; + $uri = Utils::idnUriConvert($uri, $idnOptions); + } + + return $uri->getScheme() === '' && $uri->getHost() !== '' ? $uri->withScheme('http') : $uri; + } + + /** + * Configures the default options for a client. + */ + private function configureDefaults(array $config): void + { + $defaults = [ + 'allow_redirects' => RedirectMiddleware::$defaultSettings, + 'http_errors' => true, + 'decode_content' => true, + 'verify' => true, + 'cookies' => false, + 'idn_conversion' => false, + ]; + + // Use the standard Linux HTTP_PROXY and HTTPS_PROXY if set. + + // We can only trust the HTTP_PROXY environment variable in a CLI + // process due to the fact that PHP has no reliable mechanism to + // get environment variables that start with "HTTP_". + if (\PHP_SAPI === 'cli' && ($proxy = Utils::getenv('HTTP_PROXY'))) { + $defaults['proxy']['http'] = $proxy; + } + + if ($proxy = Utils::getenv('HTTPS_PROXY')) { + $defaults['proxy']['https'] = $proxy; + } + + if ($noProxy = Utils::getenv('NO_PROXY')) { + $cleanedNoProxy = \str_replace(' ', '', $noProxy); + $defaults['proxy']['no'] = \explode(',', $cleanedNoProxy); + } + + $this->config = $config + $defaults; + + if (!empty($config['cookies']) && $config['cookies'] === true) { + $this->config['cookies'] = new CookieJar(); + } + + // Add the default user-agent header. + if (!isset($this->config['headers'])) { + $this->config['headers'] = ['User-Agent' => Utils::defaultUserAgent()]; + } else { + // Add the User-Agent header if one was not already set. + foreach (\array_keys($this->config['headers']) as $name) { + if (\strtolower($name) === 'user-agent') { + return; + } + } + $this->config['headers']['User-Agent'] = Utils::defaultUserAgent(); + } + } + + /** + * Merges default options into the array. + * + * @param array $options Options to modify by reference + */ + private function prepareDefaults(array $options): array + { + $defaults = $this->config; + + if (!empty($defaults['headers'])) { + // Default headers are only added if they are not present. + $defaults['_conditional'] = $defaults['headers']; + unset($defaults['headers']); + } + + // Special handling for headers is required as they are added as + // conditional headers and as headers passed to a request ctor. + if (\array_key_exists('headers', $options)) { + // Allows default headers to be unset. + if ($options['headers'] === null) { + $defaults['_conditional'] = []; + unset($options['headers']); + } elseif (!\is_array($options['headers'])) { + throw new InvalidArgumentException('headers must be an array'); + } + } + + // Shallow merge defaults underneath options. + $result = $options + $defaults; + + // Remove null values. + foreach ($result as $k => $v) { + if ($v === null) { + unset($result[$k]); + } + } + + return $result; + } + + /** + * Transfers the given request and applies request options. + * + * The URI of the request is not modified and the request options are used + * as-is without merging in default options. + * + * @param array $options See \GuzzleHttp\RequestOptions. + */ + private function transfer(RequestInterface $request, array $options): PromiseInterface + { + $request = $this->applyOptions($request, $options); + /** @var HandlerStack $handler */ + $handler = $options['handler']; + + try { + return P\Create::promiseFor($handler($request, $options)); + } catch (\Exception $e) { + return P\Create::rejectionFor($e); + } + } + + /** + * Applies the array of request options to a request. + */ + private function applyOptions(RequestInterface $request, array &$options): RequestInterface + { + $modify = [ + 'set_headers' => [], + ]; + + if (isset($options['headers'])) { + if (array_keys($options['headers']) === range(0, count($options['headers']) - 1)) { + throw new InvalidArgumentException('The headers array must have header name as keys.'); + } + $modify['set_headers'] = $options['headers']; + unset($options['headers']); + } + + if (isset($options['form_params'])) { + if (isset($options['multipart'])) { + throw new InvalidArgumentException('You cannot use ' + .'form_params and multipart at the same time. Use the ' + .'form_params option if you want to send application/' + .'x-www-form-urlencoded requests, and the multipart ' + .'option to send multipart/form-data requests.'); + } + $options['body'] = \http_build_query($options['form_params'], '', '&'); + unset($options['form_params']); + // Ensure that we don't have the header in different case and set the new value. + $options['_conditional'] = Psr7\Utils::caselessRemove(['Content-Type'], $options['_conditional']); + $options['_conditional']['Content-Type'] = 'application/x-www-form-urlencoded'; + } + + if (isset($options['multipart'])) { + $options['body'] = new Psr7\MultipartStream($options['multipart']); + unset($options['multipart']); + } + + if (isset($options['json'])) { + $options['body'] = Utils::jsonEncode($options['json']); + unset($options['json']); + // Ensure that we don't have the header in different case and set the new value. + $options['_conditional'] = Psr7\Utils::caselessRemove(['Content-Type'], $options['_conditional']); + $options['_conditional']['Content-Type'] = 'application/json'; + } + + if (!empty($options['decode_content']) + && $options['decode_content'] !== true + ) { + // Ensure that we don't have the header in different case and set the new value. + $options['_conditional'] = Psr7\Utils::caselessRemove(['Accept-Encoding'], $options['_conditional']); + $modify['set_headers']['Accept-Encoding'] = $options['decode_content']; + } + + if (isset($options['body'])) { + if (\is_array($options['body'])) { + throw $this->invalidBody(); + } + $modify['body'] = Psr7\Utils::streamFor($options['body']); + unset($options['body']); + } + + if (!empty($options['auth']) && \is_array($options['auth'])) { + $value = $options['auth']; + $type = isset($value[2]) ? \strtolower($value[2]) : 'basic'; + switch ($type) { + case 'basic': + // Ensure that we don't have the header in different case and set the new value. + $modify['set_headers'] = Psr7\Utils::caselessRemove(['Authorization'], $modify['set_headers']); + $modify['set_headers']['Authorization'] = 'Basic ' + .\base64_encode("$value[0]:$value[1]"); + break; + case 'digest': + // @todo: Do not rely on curl + $options['curl'][\CURLOPT_HTTPAUTH] = \CURLAUTH_DIGEST; + $options['curl'][\CURLOPT_USERPWD] = "$value[0]:$value[1]"; + break; + case 'ntlm': + $options['curl'][\CURLOPT_HTTPAUTH] = \CURLAUTH_NTLM; + $options['curl'][\CURLOPT_USERPWD] = "$value[0]:$value[1]"; + break; + } + } + + if (isset($options['query'])) { + $value = $options['query']; + if (\is_array($value)) { + $value = \http_build_query($value, '', '&', \PHP_QUERY_RFC3986); + } + if (!\is_string($value)) { + throw new InvalidArgumentException('query must be a string or array'); + } + $modify['query'] = $value; + unset($options['query']); + } + + // Ensure that sink is not an invalid value. + if (isset($options['sink'])) { + // TODO: Add more sink validation? + if (\is_bool($options['sink'])) { + throw new InvalidArgumentException('sink must not be a boolean'); + } + } + + if (isset($options['version'])) { + $modify['version'] = $options['version']; + } + + $request = Psr7\Utils::modifyRequest($request, $modify); + if ($request->getBody() instanceof Psr7\MultipartStream) { + // Use a multipart/form-data POST if a Content-Type is not set. + // Ensure that we don't have the header in different case and set the new value. + $options['_conditional'] = Psr7\Utils::caselessRemove(['Content-Type'], $options['_conditional']); + $options['_conditional']['Content-Type'] = 'multipart/form-data; boundary=' + .$request->getBody()->getBoundary(); + } + + // Merge in conditional headers if they are not present. + if (isset($options['_conditional'])) { + // Build up the changes so it's in a single clone of the message. + $modify = []; + foreach ($options['_conditional'] as $k => $v) { + if (!$request->hasHeader($k)) { + $modify['set_headers'][$k] = $v; + } + } + $request = Psr7\Utils::modifyRequest($request, $modify); + // Don't pass this internal value along to middleware/handlers. + unset($options['_conditional']); + } + + return $request; + } + + /** + * Return an InvalidArgumentException with pre-set message. + */ + private function invalidBody(): InvalidArgumentException + { + return new InvalidArgumentException('Passing in the "body" request ' + .'option as an array to send a request is not supported. ' + .'Please use the "form_params" request option to send a ' + .'application/x-www-form-urlencoded request, or the "multipart" ' + .'request option to send a multipart/form-data request.'); + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/ClientInterface.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/ClientInterface.php new file mode 100644 index 0000000000..6aaee61afc --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/ClientInterface.php @@ -0,0 +1,84 @@ +<?php + +namespace GuzzleHttp; + +use GuzzleHttp\Exception\GuzzleException; +use GuzzleHttp\Promise\PromiseInterface; +use Psr\Http\Message\RequestInterface; +use Psr\Http\Message\ResponseInterface; +use Psr\Http\Message\UriInterface; + +/** + * Client interface for sending HTTP requests. + */ +interface ClientInterface +{ + /** + * The Guzzle major version. + */ + public const MAJOR_VERSION = 7; + + /** + * Send an HTTP request. + * + * @param RequestInterface $request Request to send + * @param array $options Request options to apply to the given + * request and to the transfer. + * + * @throws GuzzleException + */ + public function send(RequestInterface $request, array $options = []): ResponseInterface; + + /** + * Asynchronously send an HTTP request. + * + * @param RequestInterface $request Request to send + * @param array $options Request options to apply to the given + * request and to the transfer. + */ + public function sendAsync(RequestInterface $request, array $options = []): PromiseInterface; + + /** + * Create and send an HTTP request. + * + * Use an absolute path to override the base path of the client, or a + * relative path to append to the base path of the client. The URL can + * contain the query string as well. + * + * @param string $method HTTP method. + * @param string|UriInterface $uri URI object or string. + * @param array $options Request options to apply. + * + * @throws GuzzleException + */ + public function request(string $method, $uri, array $options = []): ResponseInterface; + + /** + * Create and send an asynchronous HTTP request. + * + * Use an absolute path to override the base path of the client, or a + * relative path to append to the base path of the client. The URL can + * contain the query string as well. Use an array to provide a URL + * template and additional variables to use in the URL template expansion. + * + * @param string $method HTTP method + * @param string|UriInterface $uri URI object or string. + * @param array $options Request options to apply. + */ + public function requestAsync(string $method, $uri, array $options = []): PromiseInterface; + + /** + * Get a client configuration option. + * + * These options include default request options of the client, a "handler" + * (if utilized by the concrete client), and a "base_uri" if utilized by + * the concrete client. + * + * @param string|null $option The config option to retrieve. + * + * @return mixed + * + * @deprecated ClientInterface::getConfig will be removed in guzzlehttp/guzzle:8.0. + */ + public function getConfig(?string $option = null); +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/Cookie/CookieJar.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/Cookie/CookieJar.php new file mode 100644 index 0000000000..b616cf2ed6 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/Cookie/CookieJar.php @@ -0,0 +1,307 @@ +<?php + +namespace GuzzleHttp\Cookie; + +use Psr\Http\Message\RequestInterface; +use Psr\Http\Message\ResponseInterface; + +/** + * Cookie jar that stores cookies as an array + */ +class CookieJar implements CookieJarInterface +{ + /** + * @var SetCookie[] Loaded cookie data + */ + private $cookies = []; + + /** + * @var bool + */ + private $strictMode; + + /** + * @param bool $strictMode Set to true to throw exceptions when invalid + * cookies are added to the cookie jar. + * @param array $cookieArray Array of SetCookie objects or a hash of + * arrays that can be used with the SetCookie + * constructor + */ + public function __construct(bool $strictMode = false, array $cookieArray = []) + { + $this->strictMode = $strictMode; + + foreach ($cookieArray as $cookie) { + if (!($cookie instanceof SetCookie)) { + $cookie = new SetCookie($cookie); + } + $this->setCookie($cookie); + } + } + + /** + * Create a new Cookie jar from an associative array and domain. + * + * @param array $cookies Cookies to create the jar from + * @param string $domain Domain to set the cookies to + */ + public static function fromArray(array $cookies, string $domain): self + { + $cookieJar = new self(); + foreach ($cookies as $name => $value) { + $cookieJar->setCookie(new SetCookie([ + 'Domain' => $domain, + 'Name' => $name, + 'Value' => $value, + 'Discard' => true, + ])); + } + + return $cookieJar; + } + + /** + * Evaluate if this cookie should be persisted to storage + * that survives between requests. + * + * @param SetCookie $cookie Being evaluated. + * @param bool $allowSessionCookies If we should persist session cookies + */ + public static function shouldPersist(SetCookie $cookie, bool $allowSessionCookies = false): bool + { + if ($cookie->getExpires() || $allowSessionCookies) { + if (!$cookie->getDiscard()) { + return true; + } + } + + return false; + } + + /** + * Finds and returns the cookie based on the name + * + * @param string $name cookie name to search for + * + * @return SetCookie|null cookie that was found or null if not found + */ + public function getCookieByName(string $name): ?SetCookie + { + foreach ($this->cookies as $cookie) { + if ($cookie->getName() !== null && \strcasecmp($cookie->getName(), $name) === 0) { + return $cookie; + } + } + + return null; + } + + public function toArray(): array + { + return \array_map(static function (SetCookie $cookie): array { + return $cookie->toArray(); + }, $this->getIterator()->getArrayCopy()); + } + + public function clear(?string $domain = null, ?string $path = null, ?string $name = null): void + { + if (!$domain) { + $this->cookies = []; + + return; + } elseif (!$path) { + $this->cookies = \array_filter( + $this->cookies, + static function (SetCookie $cookie) use ($domain): bool { + return !$cookie->matchesDomain($domain); + } + ); + } elseif (!$name) { + $this->cookies = \array_filter( + $this->cookies, + static function (SetCookie $cookie) use ($path, $domain): bool { + return !($cookie->matchesPath($path) + && $cookie->matchesDomain($domain)); + } + ); + } else { + $this->cookies = \array_filter( + $this->cookies, + static function (SetCookie $cookie) use ($path, $domain, $name) { + return !($cookie->getName() == $name + && $cookie->matchesPath($path) + && $cookie->matchesDomain($domain)); + } + ); + } + } + + public function clearSessionCookies(): void + { + $this->cookies = \array_filter( + $this->cookies, + static function (SetCookie $cookie): bool { + return !$cookie->getDiscard() && $cookie->getExpires(); + } + ); + } + + public function setCookie(SetCookie $cookie): bool + { + // If the name string is empty (but not 0), ignore the set-cookie + // string entirely. + $name = $cookie->getName(); + if (!$name && $name !== '0') { + return false; + } + + // Only allow cookies with set and valid domain, name, value + $result = $cookie->validate(); + if ($result !== true) { + if ($this->strictMode) { + throw new \RuntimeException('Invalid cookie: '.$result); + } + $this->removeCookieIfEmpty($cookie); + + return false; + } + + // Resolve conflicts with previously set cookies + foreach ($this->cookies as $i => $c) { + // Two cookies are identical, when their path, and domain are + // identical. + if ($c->getPath() != $cookie->getPath() + || $c->getDomain() != $cookie->getDomain() + || $c->getName() != $cookie->getName() + ) { + continue; + } + + // The previously set cookie is a discard cookie and this one is + // not so allow the new cookie to be set + if (!$cookie->getDiscard() && $c->getDiscard()) { + unset($this->cookies[$i]); + continue; + } + + // If the new cookie's expiration is further into the future, then + // replace the old cookie + if ($cookie->getExpires() > $c->getExpires()) { + unset($this->cookies[$i]); + continue; + } + + // If the value has changed, we better change it + if ($cookie->getValue() !== $c->getValue()) { + unset($this->cookies[$i]); + continue; + } + + // The cookie exists, so no need to continue + return false; + } + + $this->cookies[] = $cookie; + + return true; + } + + public function count(): int + { + return \count($this->cookies); + } + + /** + * @return \ArrayIterator<int, SetCookie> + */ + public function getIterator(): \ArrayIterator + { + return new \ArrayIterator(\array_values($this->cookies)); + } + + public function extractCookies(RequestInterface $request, ResponseInterface $response): void + { + if ($cookieHeader = $response->getHeader('Set-Cookie')) { + foreach ($cookieHeader as $cookie) { + $sc = SetCookie::fromString($cookie); + if (!$sc->getDomain()) { + $sc->setDomain($request->getUri()->getHost()); + } + if (0 !== \strpos($sc->getPath(), '/')) { + $sc->setPath($this->getCookiePathFromRequest($request)); + } + if (!$sc->matchesDomain($request->getUri()->getHost())) { + continue; + } + // Note: At this point `$sc->getDomain()` being a public suffix should + // be rejected, but we don't want to pull in the full PSL dependency. + $this->setCookie($sc); + } + } + } + + /** + * Computes cookie path following RFC 6265 section 5.1.4 + * + * @see https://datatracker.ietf.org/doc/html/rfc6265#section-5.1.4 + */ + private function getCookiePathFromRequest(RequestInterface $request): string + { + $uriPath = $request->getUri()->getPath(); + if ('' === $uriPath) { + return '/'; + } + if (0 !== \strpos($uriPath, '/')) { + return '/'; + } + if ('/' === $uriPath) { + return '/'; + } + $lastSlashPos = \strrpos($uriPath, '/'); + if (0 === $lastSlashPos || false === $lastSlashPos) { + return '/'; + } + + return \substr($uriPath, 0, $lastSlashPos); + } + + public function withCookieHeader(RequestInterface $request): RequestInterface + { + $values = []; + $uri = $request->getUri(); + $scheme = $uri->getScheme(); + $host = $uri->getHost(); + $path = $uri->getPath() ?: '/'; + + foreach ($this->cookies as $cookie) { + if ($cookie->matchesPath($path) + && $cookie->matchesDomain($host) + && !$cookie->isExpired() + && (!$cookie->getSecure() || $scheme === 'https') + ) { + $values[] = $cookie->getName().'=' + .$cookie->getValue(); + } + } + + return $values + ? $request->withHeader('Cookie', \implode('; ', $values)) + : $request; + } + + /** + * If a cookie already exists and the server asks to set it again with a + * null value, the cookie must be deleted. + */ + private function removeCookieIfEmpty(SetCookie $cookie): void + { + $cookieValue = $cookie->getValue(); + if ($cookieValue === null || $cookieValue === '') { + $this->clear( + $cookie->getDomain(), + $cookie->getPath(), + $cookie->getName() + ); + } + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/Cookie/CookieJarInterface.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/Cookie/CookieJarInterface.php new file mode 100644 index 0000000000..93ada58d22 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/Cookie/CookieJarInterface.php @@ -0,0 +1,80 @@ +<?php + +namespace GuzzleHttp\Cookie; + +use Psr\Http\Message\RequestInterface; +use Psr\Http\Message\ResponseInterface; + +/** + * Stores HTTP cookies. + * + * It extracts cookies from HTTP requests, and returns them in HTTP responses. + * CookieJarInterface instances automatically expire contained cookies when + * necessary. Subclasses are also responsible for storing and retrieving + * cookies from a file, database, etc. + * + * @see https://docs.python.org/2/library/cookielib.html Inspiration + * + * @extends \IteratorAggregate<SetCookie> + */ +interface CookieJarInterface extends \Countable, \IteratorAggregate +{ + /** + * Create a request with added cookie headers. + * + * If no matching cookies are found in the cookie jar, then no Cookie + * header is added to the request and the same request is returned. + * + * @param RequestInterface $request Request object to modify. + * + * @return RequestInterface returns the modified request. + */ + public function withCookieHeader(RequestInterface $request): RequestInterface; + + /** + * Extract cookies from an HTTP response and store them in the CookieJar. + * + * @param RequestInterface $request Request that was sent + * @param ResponseInterface $response Response that was received + */ + public function extractCookies(RequestInterface $request, ResponseInterface $response): void; + + /** + * Sets a cookie in the cookie jar. + * + * @param SetCookie $cookie Cookie to set. + * + * @return bool Returns true on success or false on failure + */ + public function setCookie(SetCookie $cookie): bool; + + /** + * Remove cookies currently held in the cookie jar. + * + * Invoking this method without arguments will empty the whole cookie jar. + * If given a $domain argument only cookies belonging to that domain will + * be removed. If given a $domain and $path argument, cookies belonging to + * the specified path within that domain are removed. If given all three + * arguments, then the cookie with the specified name, path and domain is + * removed. + * + * @param string|null $domain Clears cookies matching a domain + * @param string|null $path Clears cookies matching a domain and path + * @param string|null $name Clears cookies matching a domain, path, and name + */ + public function clear(?string $domain = null, ?string $path = null, ?string $name = null): void; + + /** + * Discard all sessions cookies. + * + * Removes cookies that don't have an expire field or a have a discard + * field set to true. To be called when the user agent shuts down according + * to RFC 2965. + */ + public function clearSessionCookies(): void; + + /** + * Converts the cookie jar to an array. + */ + public function toArray(): array; +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/Exception/BadResponseException.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/Exception/BadResponseException.php new file mode 100644 index 0000000000..ba67ad498c --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/Exception/BadResponseException.php @@ -0,0 +1,39 @@ +<?php + +namespace GuzzleHttp\Exception; + +use Psr\Http\Message\RequestInterface; +use Psr\Http\Message\ResponseInterface; + +/** + * Exception when an HTTP error occurs (4xx or 5xx error) + */ +class BadResponseException extends RequestException +{ + public function __construct( + string $message, + RequestInterface $request, + ResponseInterface $response, + ?\Throwable $previous = null, + array $handlerContext = [] + ) { + parent::__construct($message, $request, $response, $previous, $handlerContext); + } + + /** + * Current exception and the ones that extend it will always have a response. + */ + public function hasResponse(): bool + { + return true; + } + + /** + * This function narrows the return type from the parent class and does not allow it to be nullable. + */ + public function getResponse(): ResponseInterface + { + /** @var ResponseInterface */ + return parent::getResponse(); + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/Exception/ConnectException.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/Exception/ConnectException.php new file mode 100644 index 0000000000..eab51ca177 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/Exception/ConnectException.php @@ -0,0 +1,56 @@ +<?php + +namespace GuzzleHttp\Exception; + +use Psr\Http\Client\NetworkExceptionInterface; +use Psr\Http\Message\RequestInterface; + +/** + * Exception thrown when a connection cannot be established. + * + * Note that no response is present for a ConnectException + */ +class ConnectException extends TransferException implements NetworkExceptionInterface +{ + /** + * @var RequestInterface + */ + private $request; + + /** + * @var array + */ + private $handlerContext; + + public function __construct( + string $message, + RequestInterface $request, + ?\Throwable $previous = null, + array $handlerContext = [] + ) { + parent::__construct($message, 0, $previous); + $this->request = $request; + $this->handlerContext = $handlerContext; + } + + /** + * Get the request that caused the exception + */ + public function getRequest(): RequestInterface + { + return $this->request; + } + + /** + * Get contextual information about the error from the underlying handler. + * + * The contents of this array will vary depending on which handler you are + * using. It may also be just an empty array. Relying on this data will + * couple you to a specific handler, but can give more debug information + * when needed. + */ + public function getHandlerContext(): array + { + return $this->handlerContext; + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/Exception/RequestException.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/Exception/RequestException.php new file mode 100644 index 0000000000..b42c88abfa --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/Exception/RequestException.php @@ -0,0 +1,150 @@ +<?php + +namespace GuzzleHttp\Exception; + +use GuzzleHttp\BodySummarizer; +use GuzzleHttp\BodySummarizerInterface; +use Psr\Http\Client\RequestExceptionInterface; +use Psr\Http\Message\RequestInterface; +use Psr\Http\Message\ResponseInterface; + +/** + * HTTP Request exception + */ +class RequestException extends TransferException implements RequestExceptionInterface +{ + /** + * @var RequestInterface + */ + private $request; + + /** + * @var ResponseInterface|null + */ + private $response; + + /** + * @var array + */ + private $handlerContext; + + public function __construct( + string $message, + RequestInterface $request, + ?ResponseInterface $response = null, + ?\Throwable $previous = null, + array $handlerContext = [] + ) { + // Set the code of the exception if the response is set and not future. + $code = $response ? $response->getStatusCode() : 0; + parent::__construct($message, $code, $previous); + $this->request = $request; + $this->response = $response; + $this->handlerContext = $handlerContext; + } + + /** + * Wrap non-RequestExceptions with a RequestException + */ + public static function wrapException(RequestInterface $request, \Throwable $e): RequestException + { + return $e instanceof RequestException ? $e : new RequestException($e->getMessage(), $request, null, $e); + } + + /** + * Factory method to create a new exception with a normalized error message + * + * @param RequestInterface $request Request sent + * @param ResponseInterface $response Response received + * @param \Throwable|null $previous Previous exception + * @param array $handlerContext Optional handler context + * @param BodySummarizerInterface|null $bodySummarizer Optional body summarizer + */ + public static function create( + RequestInterface $request, + ?ResponseInterface $response = null, + ?\Throwable $previous = null, + array $handlerContext = [], + ?BodySummarizerInterface $bodySummarizer = null + ): self { + if (!$response) { + return new self( + 'Error completing request', + $request, + null, + $previous, + $handlerContext + ); + } + + $level = (int) \floor($response->getStatusCode() / 100); + if ($level === 4) { + $label = 'Client error'; + $className = ClientException::class; + } elseif ($level === 5) { + $label = 'Server error'; + $className = ServerException::class; + } else { + $label = 'Unsuccessful request'; + $className = __CLASS__; + } + + $uri = \GuzzleHttp\Psr7\Utils::redactUserInfo($request->getUri()); + + // Client Error: `GET /` resulted in a `404 Not Found` response: + // <html> ... (truncated) + $message = \sprintf( + '%s: `%s %s` resulted in a `%s %s` response', + $label, + $request->getMethod(), + $uri->__toString(), + $response->getStatusCode(), + $response->getReasonPhrase() + ); + + $summary = ($bodySummarizer ?? new BodySummarizer())->summarize($response); + + if ($summary !== null) { + $message .= ":\n{$summary}\n"; + } + + return new $className($message, $request, $response, $previous, $handlerContext); + } + + /** + * Get the request that caused the exception + */ + public function getRequest(): RequestInterface + { + return $this->request; + } + + /** + * Get the associated response + */ + public function getResponse(): ?ResponseInterface + { + return $this->response; + } + + /** + * Check if a response was received + */ + public function hasResponse(): bool + { + return $this->response !== null; + } + + /** + * Get contextual information about the error from the underlying handler. + * + * The contents of this array will vary depending on which handler you are + * using. It may also be just an empty array. Relying on this data will + * couple you to a specific handler, but can give more debug information + * when needed. + */ + public function getHandlerContext(): array + { + return $this->handlerContext; + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/Handler/CurlFactory.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/Handler/CurlFactory.php new file mode 100644 index 0000000000..fe36137513 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/Handler/CurlFactory.php @@ -0,0 +1,736 @@ +<?php + +namespace GuzzleHttp\Handler; + +use GuzzleHttp\Exception\ConnectException; +use GuzzleHttp\Exception\RequestException; +use GuzzleHttp\Promise as P; +use GuzzleHttp\Promise\FulfilledPromise; +use GuzzleHttp\Promise\PromiseInterface; +use GuzzleHttp\Psr7\LazyOpenStream; +use GuzzleHttp\TransferStats; +use GuzzleHttp\Utils; +use Psr\Http\Message\RequestInterface; +use Psr\Http\Message\UriInterface; + +/** + * Creates curl resources from a request + * + * @final + */ +class CurlFactory implements CurlFactoryInterface +{ + public const CURL_VERSION_STR = 'curl_version'; + + /** + * @deprecated + */ + public const LOW_CURL_VERSION_NUMBER = '7.21.2'; + + /** + * @var resource[]|\CurlHandle[] + */ + private $handles = []; + + /** + * @var int Total number of idle handles to keep in cache + */ + private $maxHandles; + + /** + * @param int $maxHandles Maximum number of idle handles. + */ + public function __construct(int $maxHandles) + { + $this->maxHandles = $maxHandles; + } + + public function create(RequestInterface $request, array $options): EasyHandle + { + $protocolVersion = $request->getProtocolVersion(); + + if ('2' === $protocolVersion || '2.0' === $protocolVersion) { + if (!self::supportsHttp2()) { + throw new ConnectException('HTTP/2 is supported by the cURL handler, however libcurl is built without HTTP/2 support.', $request); + } + } elseif ('1.0' !== $protocolVersion && '1.1' !== $protocolVersion) { + throw new ConnectException(sprintf('HTTP/%s is not supported by the cURL handler.', $protocolVersion), $request); + } + + if (isset($options['curl']['body_as_string'])) { + $options['_body_as_string'] = $options['curl']['body_as_string']; + unset($options['curl']['body_as_string']); + } + + $easy = new EasyHandle(); + $easy->request = $request; + $easy->options = $options; + $conf = $this->getDefaultConf($easy); + $this->applyMethod($easy, $conf); + $this->applyHandlerOptions($easy, $conf); + $this->applyHeaders($easy, $conf); + unset($conf['_headers']); + + // Add handler options from the request configuration options + if (isset($options['curl'])) { + $conf = \array_replace($conf, $options['curl']); + } + + $conf[\CURLOPT_HEADERFUNCTION] = $this->createHeaderFn($easy); + $easy->handle = $this->handles ? \array_pop($this->handles) : \curl_init(); + curl_setopt_array($easy->handle, $conf); + + return $easy; + } + + private static function supportsHttp2(): bool + { + static $supportsHttp2 = null; + + if (null === $supportsHttp2) { + $supportsHttp2 = self::supportsTls12() + && defined('CURL_VERSION_HTTP2') + && (\CURL_VERSION_HTTP2 & \curl_version()['features']); + } + + return $supportsHttp2; + } + + private static function supportsTls12(): bool + { + static $supportsTls12 = null; + + if (null === $supportsTls12) { + $supportsTls12 = \CURL_SSLVERSION_TLSv1_2 & \curl_version()['features']; + } + + return $supportsTls12; + } + + private static function supportsTls13(): bool + { + static $supportsTls13 = null; + + if (null === $supportsTls13) { + $supportsTls13 = defined('CURL_SSLVERSION_TLSv1_3') + && (\CURL_SSLVERSION_TLSv1_3 & \curl_version()['features']); + } + + return $supportsTls13; + } + + public function release(EasyHandle $easy): void + { + $resource = $easy->handle; + unset($easy->handle); + + if (\count($this->handles) >= $this->maxHandles) { + \curl_close($resource); + } else { + // Remove all callback functions as they can hold onto references + // and are not cleaned up by curl_reset. Using curl_setopt_array + // does not work for some reason, so removing each one + // individually. + \curl_setopt($resource, \CURLOPT_HEADERFUNCTION, null); + \curl_setopt($resource, \CURLOPT_READFUNCTION, null); + \curl_setopt($resource, \CURLOPT_WRITEFUNCTION, null); + \curl_setopt($resource, \CURLOPT_PROGRESSFUNCTION, null); + \curl_reset($resource); + $this->handles[] = $resource; + } + } + + /** + * Completes a cURL transaction, either returning a response promise or a + * rejected promise. + * + * @param callable(RequestInterface, array): PromiseInterface $handler + * @param CurlFactoryInterface $factory Dictates how the handle is released + */ + public static function finish(callable $handler, EasyHandle $easy, CurlFactoryInterface $factory): PromiseInterface + { + if (isset($easy->options['on_stats'])) { + self::invokeStats($easy); + } + + if (!$easy->response || $easy->errno) { + return self::finishError($handler, $easy, $factory); + } + + // Return the response if it is present and there is no error. + $factory->release($easy); + + // Rewind the body of the response if possible. + $body = $easy->response->getBody(); + if ($body->isSeekable()) { + $body->rewind(); + } + + return new FulfilledPromise($easy->response); + } + + private static function invokeStats(EasyHandle $easy): void + { + $curlStats = \curl_getinfo($easy->handle); + $curlStats['appconnect_time'] = \curl_getinfo($easy->handle, \CURLINFO_APPCONNECT_TIME); + $stats = new TransferStats( + $easy->request, + $easy->response, + $curlStats['total_time'], + $easy->errno, + $curlStats + ); + ($easy->options['on_stats'])($stats); + } + + /** + * @param callable(RequestInterface, array): PromiseInterface $handler + */ + private static function finishError(callable $handler, EasyHandle $easy, CurlFactoryInterface $factory): PromiseInterface + { + // Get error information and release the handle to the factory. + $ctx = [ + 'errno' => $easy->errno, + 'error' => \curl_error($easy->handle), + 'appconnect_time' => \curl_getinfo($easy->handle, \CURLINFO_APPCONNECT_TIME), + ] + \curl_getinfo($easy->handle); + $ctx[self::CURL_VERSION_STR] = self::getCurlVersion(); + $factory->release($easy); + + // Retry when nothing is present or when curl failed to rewind. + if (empty($easy->options['_err_message']) && (!$easy->errno || $easy->errno == 65)) { + return self::retryFailedRewind($handler, $easy, $ctx); + } + + return self::createRejection($easy, $ctx); + } + + private static function getCurlVersion(): string + { + static $curlVersion = null; + + if (null === $curlVersion) { + $curlVersion = \curl_version()['version']; + } + + return $curlVersion; + } + + private static function createRejection(EasyHandle $easy, array $ctx): PromiseInterface + { + static $connectionErrors = [ + \CURLE_OPERATION_TIMEOUTED => true, + \CURLE_COULDNT_RESOLVE_HOST => true, + \CURLE_COULDNT_CONNECT => true, + \CURLE_SSL_CONNECT_ERROR => true, + \CURLE_GOT_NOTHING => true, + ]; + + if ($easy->createResponseException) { + return P\Create::rejectionFor( + new RequestException( + 'An error was encountered while creating the response', + $easy->request, + $easy->response, + $easy->createResponseException, + $ctx + ) + ); + } + + // If an exception was encountered during the onHeaders event, then + // return a rejected promise that wraps that exception. + if ($easy->onHeadersException) { + return P\Create::rejectionFor( + new RequestException( + 'An error was encountered during the on_headers event', + $easy->request, + $easy->response, + $easy->onHeadersException, + $ctx + ) + ); + } + + $uri = $easy->request->getUri(); + + $sanitizedError = self::sanitizeCurlError($ctx['error'] ?? '', $uri); + + $message = \sprintf( + 'cURL error %s: %s (%s)', + $ctx['errno'], + $sanitizedError, + 'see https://curl.haxx.se/libcurl/c/libcurl-errors.html' + ); + + if ('' !== $sanitizedError) { + $redactedUriString = \GuzzleHttp\Psr7\Utils::redactUserInfo($uri)->__toString(); + if ($redactedUriString !== '' && false === \strpos($sanitizedError, $redactedUriString)) { + $message .= \sprintf(' for %s', $redactedUriString); + } + } + + // Create a connection exception if it was a specific error code. + $error = isset($connectionErrors[$easy->errno]) + ? new ConnectException($message, $easy->request, null, $ctx) + : new RequestException($message, $easy->request, $easy->response, null, $ctx); + + return P\Create::rejectionFor($error); + } + + private static function sanitizeCurlError(string $error, UriInterface $uri): string + { + if ('' === $error) { + return $error; + } + + $baseUri = $uri->withQuery('')->withFragment(''); + $baseUriString = $baseUri->__toString(); + + if ('' === $baseUriString) { + return $error; + } + + $redactedUriString = \GuzzleHttp\Psr7\Utils::redactUserInfo($baseUri)->__toString(); + + return str_replace($baseUriString, $redactedUriString, $error); + } + + /** + * @return array<int|string, mixed> + */ + private function getDefaultConf(EasyHandle $easy): array + { + $conf = [ + '_headers' => $easy->request->getHeaders(), + \CURLOPT_CUSTOMREQUEST => $easy->request->getMethod(), + \CURLOPT_URL => (string) $easy->request->getUri()->withFragment(''), + \CURLOPT_RETURNTRANSFER => false, + \CURLOPT_HEADER => false, + \CURLOPT_CONNECTTIMEOUT => 300, + ]; + + if (\defined('CURLOPT_PROTOCOLS')) { + $conf[\CURLOPT_PROTOCOLS] = \CURLPROTO_HTTP | \CURLPROTO_HTTPS; + } + + $version = $easy->request->getProtocolVersion(); + + if ('2' === $version || '2.0' === $version) { + $conf[\CURLOPT_HTTP_VERSION] = \CURL_HTTP_VERSION_2_0; + } elseif ('1.1' === $version) { + $conf[\CURLOPT_HTTP_VERSION] = \CURL_HTTP_VERSION_1_1; + } else { + $conf[\CURLOPT_HTTP_VERSION] = \CURL_HTTP_VERSION_1_0; + } + + return $conf; + } + + private function applyMethod(EasyHandle $easy, array &$conf): void + { + $body = $easy->request->getBody(); + $size = $body->getSize(); + + if ($size === null || $size > 0) { + $this->applyBody($easy->request, $easy->options, $conf); + + return; + } + + $method = $easy->request->getMethod(); + if ($method === 'PUT' || $method === 'POST') { + // See https://datatracker.ietf.org/doc/html/rfc7230#section-3.3.2 + if (!$easy->request->hasHeader('Content-Length')) { + $conf[\CURLOPT_HTTPHEADER][] = 'Content-Length: 0'; + } + } elseif ($method === 'HEAD') { + $conf[\CURLOPT_NOBODY] = true; + unset( + $conf[\CURLOPT_WRITEFUNCTION], + $conf[\CURLOPT_READFUNCTION], + $conf[\CURLOPT_FILE], + $conf[\CURLOPT_INFILE] + ); + } + } + + private function applyBody(RequestInterface $request, array $options, array &$conf): void + { + $size = $request->hasHeader('Content-Length') + ? (int) $request->getHeaderLine('Content-Length') + : null; + + // Send the body as a string if the size is less than 1MB OR if the + // [curl][body_as_string] request value is set. + if (($size !== null && $size < 1000000) || !empty($options['_body_as_string'])) { + $conf[\CURLOPT_POSTFIELDS] = (string) $request->getBody(); + // Don't duplicate the Content-Length header + $this->removeHeader('Content-Length', $conf); + $this->removeHeader('Transfer-Encoding', $conf); + } else { + $conf[\CURLOPT_UPLOAD] = true; + if ($size !== null) { + $conf[\CURLOPT_INFILESIZE] = $size; + $this->removeHeader('Content-Length', $conf); + } + $body = $request->getBody(); + if ($body->isSeekable()) { + $body->rewind(); + } + $conf[\CURLOPT_READFUNCTION] = static function ($ch, $fd, $length) use ($body) { + return $body->read($length); + }; + } + + // If the Expect header is not present, prevent curl from adding it + if (!$request->hasHeader('Expect')) { + $conf[\CURLOPT_HTTPHEADER][] = 'Expect:'; + } + + // cURL sometimes adds a content-type by default. Prevent this. + if (!$request->hasHeader('Content-Type')) { + $conf[\CURLOPT_HTTPHEADER][] = 'Content-Type:'; + } + } + + private function applyHeaders(EasyHandle $easy, array &$conf): void + { + foreach ($conf['_headers'] as $name => $values) { + foreach ($values as $value) { + $value = (string) $value; + if ($value === '') { + // cURL requires a special format for empty headers. + // See https://github.com/guzzle/guzzle/issues/1882 for more details. + $conf[\CURLOPT_HTTPHEADER][] = "$name;"; + } else { + $conf[\CURLOPT_HTTPHEADER][] = "$name: $value"; + } + } + } + + // Remove the Accept header if one was not set + if (!$easy->request->hasHeader('Accept')) { + $conf[\CURLOPT_HTTPHEADER][] = 'Accept:'; + } + } + + /** + * Remove a header from the options array. + * + * @param string $name Case-insensitive header to remove + * @param array $options Array of options to modify + */ + private function removeHeader(string $name, array &$options): void + { + foreach (\array_keys($options['_headers']) as $key) { + if (!\strcasecmp($key, $name)) { + unset($options['_headers'][$key]); + + return; + } + } + } + + private function applyHandlerOptions(EasyHandle $easy, array &$conf): void + { + $options = $easy->options; + if (isset($options['verify'])) { + if ($options['verify'] === false) { + unset($conf[\CURLOPT_CAINFO]); + $conf[\CURLOPT_SSL_VERIFYHOST] = 0; + $conf[\CURLOPT_SSL_VERIFYPEER] = false; + } else { + $conf[\CURLOPT_SSL_VERIFYHOST] = 2; + $conf[\CURLOPT_SSL_VERIFYPEER] = true; + if (\is_string($options['verify'])) { + // Throw an error if the file/folder/link path is not valid or doesn't exist. + if (!\file_exists($options['verify'])) { + throw new \InvalidArgumentException("SSL CA bundle not found: {$options['verify']}"); + } + // If it's a directory or a link to a directory use CURLOPT_CAPATH. + // If not, it's probably a file, or a link to a file, so use CURLOPT_CAINFO. + if ( + \is_dir($options['verify']) + || ( + \is_link($options['verify']) === true + && ($verifyLink = \readlink($options['verify'])) !== false + && \is_dir($verifyLink) + ) + ) { + $conf[\CURLOPT_CAPATH] = $options['verify']; + } else { + $conf[\CURLOPT_CAINFO] = $options['verify']; + } + } + } + } + + if (!isset($options['curl'][\CURLOPT_ENCODING]) && !empty($options['decode_content'])) { + $accept = $easy->request->getHeaderLine('Accept-Encoding'); + if ($accept) { + $conf[\CURLOPT_ENCODING] = $accept; + } else { + // The empty string enables all available decoders and implicitly + // sets a matching 'Accept-Encoding' header. + $conf[\CURLOPT_ENCODING] = ''; + // But as the user did not specify any encoding preference, + // let's leave it up to server by preventing curl from sending + // the header, which will be interpreted as 'Accept-Encoding: *'. + // https://www.rfc-editor.org/rfc/rfc9110#field.accept-encoding + $conf[\CURLOPT_HTTPHEADER][] = 'Accept-Encoding:'; + } + } + + if (!isset($options['sink'])) { + // Use a default temp stream if no sink was set. + $options['sink'] = \GuzzleHttp\Psr7\Utils::tryFopen('php://temp', 'w+'); + } + $sink = $options['sink']; + if (!\is_string($sink)) { + $sink = \GuzzleHttp\Psr7\Utils::streamFor($sink); + } elseif (!\is_dir(\dirname($sink))) { + // Ensure that the directory exists before failing in curl. + throw new \RuntimeException(\sprintf('Directory %s does not exist for sink value of %s', \dirname($sink), $sink)); + } else { + $sink = new LazyOpenStream($sink, 'w+'); + } + $easy->sink = $sink; + $conf[\CURLOPT_WRITEFUNCTION] = static function ($ch, $write) use ($sink): int { + return $sink->write($write); + }; + + $timeoutRequiresNoSignal = false; + if (isset($options['timeout'])) { + $timeoutRequiresNoSignal |= $options['timeout'] < 1; + $conf[\CURLOPT_TIMEOUT_MS] = $options['timeout'] * 1000; + } + + // CURL default value is CURL_IPRESOLVE_WHATEVER + if (isset($options['force_ip_resolve'])) { + if ('v4' === $options['force_ip_resolve']) { + $conf[\CURLOPT_IPRESOLVE] = \CURL_IPRESOLVE_V4; + } elseif ('v6' === $options['force_ip_resolve']) { + $conf[\CURLOPT_IPRESOLVE] = \CURL_IPRESOLVE_V6; + } + } + + if (isset($options['connect_timeout'])) { + $timeoutRequiresNoSignal |= $options['connect_timeout'] < 1; + $conf[\CURLOPT_CONNECTTIMEOUT_MS] = $options['connect_timeout'] * 1000; + } + + if ($timeoutRequiresNoSignal && \strtoupper(\substr(\PHP_OS, 0, 3)) !== 'WIN') { + $conf[\CURLOPT_NOSIGNAL] = true; + } + + if (isset($options['proxy'])) { + if (!\is_array($options['proxy'])) { + $conf[\CURLOPT_PROXY] = $options['proxy']; + } else { + $scheme = $easy->request->getUri()->getScheme(); + if (isset($options['proxy'][$scheme])) { + $host = $easy->request->getUri()->getHost(); + if (isset($options['proxy']['no']) && Utils::isHostInNoProxy($host, $options['proxy']['no'])) { + unset($conf[\CURLOPT_PROXY]); + } else { + $conf[\CURLOPT_PROXY] = $options['proxy'][$scheme]; + } + } + } + } + + if (isset($options['crypto_method'])) { + $protocolVersion = $easy->request->getProtocolVersion(); + + // If HTTP/2, upgrade TLS 1.0 and 1.1 to 1.2 + if ('2' === $protocolVersion || '2.0' === $protocolVersion) { + if ( + \STREAM_CRYPTO_METHOD_TLSv1_0_CLIENT === $options['crypto_method'] + || \STREAM_CRYPTO_METHOD_TLSv1_1_CLIENT === $options['crypto_method'] + || \STREAM_CRYPTO_METHOD_TLSv1_2_CLIENT === $options['crypto_method'] + ) { + $conf[\CURLOPT_SSLVERSION] = \CURL_SSLVERSION_TLSv1_2; + } elseif (defined('STREAM_CRYPTO_METHOD_TLSv1_3_CLIENT') && \STREAM_CRYPTO_METHOD_TLSv1_3_CLIENT === $options['crypto_method']) { + if (!self::supportsTls13()) { + throw new \InvalidArgumentException('Invalid crypto_method request option: TLS 1.3 not supported by your version of cURL'); + } + $conf[\CURLOPT_SSLVERSION] = \CURL_SSLVERSION_TLSv1_3; + } else { + throw new \InvalidArgumentException('Invalid crypto_method request option: unknown version provided'); + } + } elseif (\STREAM_CRYPTO_METHOD_TLSv1_0_CLIENT === $options['crypto_method']) { + $conf[\CURLOPT_SSLVERSION] = \CURL_SSLVERSION_TLSv1_0; + } elseif (\STREAM_CRYPTO_METHOD_TLSv1_1_CLIENT === $options['crypto_method']) { + $conf[\CURLOPT_SSLVERSION] = \CURL_SSLVERSION_TLSv1_1; + } elseif (\STREAM_CRYPTO_METHOD_TLSv1_2_CLIENT === $options['crypto_method']) { + if (!self::supportsTls12()) { + throw new \InvalidArgumentException('Invalid crypto_method request option: TLS 1.2 not supported by your version of cURL'); + } + $conf[\CURLOPT_SSLVERSION] = \CURL_SSLVERSION_TLSv1_2; + } elseif (defined('STREAM_CRYPTO_METHOD_TLSv1_3_CLIENT') && \STREAM_CRYPTO_METHOD_TLSv1_3_CLIENT === $options['crypto_method']) { + if (!self::supportsTls13()) { + throw new \InvalidArgumentException('Invalid crypto_method request option: TLS 1.3 not supported by your version of cURL'); + } + $conf[\CURLOPT_SSLVERSION] = \CURL_SSLVERSION_TLSv1_3; + } else { + throw new \InvalidArgumentException('Invalid crypto_method request option: unknown version provided'); + } + } + + if (isset($options['cert'])) { + $cert = $options['cert']; + if (\is_array($cert)) { + $conf[\CURLOPT_SSLCERTPASSWD] = $cert[1]; + $cert = $cert[0]; + } + if (!\file_exists($cert)) { + throw new \InvalidArgumentException("SSL certificate not found: {$cert}"); + } + // OpenSSL (versions 0.9.3 and later) also support "P12" for PKCS#12-encoded files. + // see https://curl.se/libcurl/c/CURLOPT_SSLCERTTYPE.html + $ext = pathinfo($cert, \PATHINFO_EXTENSION); + if (preg_match('#^(der|p12)$#i', $ext)) { + $conf[\CURLOPT_SSLCERTTYPE] = strtoupper($ext); + } + $conf[\CURLOPT_SSLCERT] = $cert; + } + + if (isset($options['ssl_key'])) { + if (\is_array($options['ssl_key'])) { + if (\count($options['ssl_key']) === 2) { + [$sslKey, $conf[\CURLOPT_SSLKEYPASSWD]] = $options['ssl_key']; + } else { + [$sslKey] = $options['ssl_key']; + } + } + + $sslKey = $sslKey ?? $options['ssl_key']; + + if (!\file_exists($sslKey)) { + throw new \InvalidArgumentException("SSL private key not found: {$sslKey}"); + } + $conf[\CURLOPT_SSLKEY] = $sslKey; + } + + if (isset($options['progress'])) { + $progress = $options['progress']; + if (!\is_callable($progress)) { + throw new \InvalidArgumentException('progress client option must be callable'); + } + $conf[\CURLOPT_NOPROGRESS] = false; + $conf[\CURLOPT_PROGRESSFUNCTION] = static function ($resource, int $downloadSize, int $downloaded, int $uploadSize, int $uploaded) use ($progress) { + $progress($downloadSize, $downloaded, $uploadSize, $uploaded); + }; + } + + if (!empty($options['debug'])) { + $conf[\CURLOPT_STDERR] = Utils::debugResource($options['debug']); + $conf[\CURLOPT_VERBOSE] = true; + } + } + + /** + * This function ensures that a response was set on a transaction. If one + * was not set, then the request is retried if possible. This error + * typically means you are sending a payload, curl encountered a + * "Connection died, retrying a fresh connect" error, tried to rewind the + * stream, and then encountered a "necessary data rewind wasn't possible" + * error, causing the request to be sent through curl_multi_info_read() + * without an error status. + * + * @param callable(RequestInterface, array): PromiseInterface $handler + */ + private static function retryFailedRewind(callable $handler, EasyHandle $easy, array $ctx): PromiseInterface + { + try { + // Only rewind if the body has been read from. + $body = $easy->request->getBody(); + if ($body->tell() > 0) { + $body->rewind(); + } + } catch (\RuntimeException $e) { + $ctx['error'] = 'The connection unexpectedly failed without ' + .'providing an error. The request would have been retried, ' + .'but attempting to rewind the request body failed. ' + .'Exception: '.$e; + + return self::createRejection($easy, $ctx); + } + + // Retry no more than 3 times before giving up. + if (!isset($easy->options['_curl_retries'])) { + $easy->options['_curl_retries'] = 1; + } elseif ($easy->options['_curl_retries'] == 2) { + $ctx['error'] = 'The cURL request was retried 3 times ' + .'and did not succeed. The most likely reason for the failure ' + .'is that cURL was unable to rewind the body of the request ' + .'and subsequent retries resulted in the same error. Turn on ' + .'the debug option to see what went wrong. See ' + .'https://bugs.php.net/bug.php?id=47204 for more information.'; + + return self::createRejection($easy, $ctx); + } else { + ++$easy->options['_curl_retries']; + } + + return $handler($easy->request, $easy->options); + } + + private function createHeaderFn(EasyHandle $easy): callable + { + if (isset($easy->options['on_headers'])) { + $onHeaders = $easy->options['on_headers']; + + if (!\is_callable($onHeaders)) { + throw new \InvalidArgumentException('on_headers must be callable'); + } + } else { + $onHeaders = null; + } + + return static function ($ch, $h) use ( + $onHeaders, + $easy, + &$startingResponse + ) { + $value = \trim($h); + if ($value === '') { + $startingResponse = true; + try { + $easy->createResponse(); + } catch (\Exception $e) { + $easy->createResponseException = $e; + + return -1; + } + if ($onHeaders !== null) { + try { + $onHeaders($easy->response); + } catch (\Exception $e) { + // Associate the exception with the handle and trigger + // a curl header write error by returning 0. + $easy->onHeadersException = $e; + + return -1; + } + } + } elseif ($startingResponse) { + $startingResponse = false; + $easy->headers = [$value]; + } else { + $easy->headers[] = $value; + } + + return \strlen($h); + }; + } + + public function __destruct() + { + foreach ($this->handles as $id => $handle) { + \curl_close($handle); + unset($this->handles[$id]); + } + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/Handler/CurlMultiHandler.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/Handler/CurlMultiHandler.php new file mode 100644 index 0000000000..73a6abe333 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/Handler/CurlMultiHandler.php @@ -0,0 +1,284 @@ +<?php + +namespace GuzzleHttp\Handler; + +use Closure; +use GuzzleHttp\Promise as P; +use GuzzleHttp\Promise\Promise; +use GuzzleHttp\Promise\PromiseInterface; +use GuzzleHttp\Utils; +use Psr\Http\Message\RequestInterface; + +/** + * Returns an asynchronous response using curl_multi_* functions. + * + * When using the CurlMultiHandler, custom curl options can be specified as an + * associative array of curl option constants mapping to values in the + * **curl** key of the provided request options. + * + * @final + */ +class CurlMultiHandler +{ + /** + * @var CurlFactoryInterface + */ + private $factory; + + /** + * @var int + */ + private $selectTimeout; + + /** + * @var int Will be higher than 0 when `curl_multi_exec` is still running. + */ + private $active = 0; + + /** + * @var array Request entry handles, indexed by handle id in `addRequest`. + * + * @see CurlMultiHandler::addRequest + */ + private $handles = []; + + /** + * @var array<int, float> An array of delay times, indexed by handle id in `addRequest`. + * + * @see CurlMultiHandler::addRequest + */ + private $delays = []; + + /** + * @var array<mixed> An associative array of CURLMOPT_* options and corresponding values for curl_multi_setopt() + */ + private $options = []; + + /** @var resource|\CurlMultiHandle */ + private $_mh; + + /** + * This handler accepts the following options: + * + * - handle_factory: An optional factory used to create curl handles + * - select_timeout: Optional timeout (in seconds) to block before timing + * out while selecting curl handles. Defaults to 1 second. + * - options: An associative array of CURLMOPT_* options and + * corresponding values for curl_multi_setopt() + */ + public function __construct(array $options = []) + { + $this->factory = $options['handle_factory'] ?? new CurlFactory(50); + + if (isset($options['select_timeout'])) { + $this->selectTimeout = $options['select_timeout']; + } elseif ($selectTimeout = Utils::getenv('GUZZLE_CURL_SELECT_TIMEOUT')) { + @trigger_error('Since guzzlehttp/guzzle 7.2.0: Using environment variable GUZZLE_CURL_SELECT_TIMEOUT is deprecated. Use option "select_timeout" instead.', \E_USER_DEPRECATED); + $this->selectTimeout = (int) $selectTimeout; + } else { + $this->selectTimeout = 1; + } + + $this->options = $options['options'] ?? []; + + // unsetting the property forces the first access to go through + // __get(). + unset($this->_mh); + } + + /** + * @param string $name + * + * @return resource|\CurlMultiHandle + * + * @throws \BadMethodCallException when another field as `_mh` will be gotten + * @throws \RuntimeException when curl can not initialize a multi handle + */ + public function __get($name) + { + if ($name !== '_mh') { + throw new \BadMethodCallException("Can not get other property as '_mh'."); + } + + $multiHandle = \curl_multi_init(); + + if (false === $multiHandle) { + throw new \RuntimeException('Can not initialize curl multi handle.'); + } + + $this->_mh = $multiHandle; + + foreach ($this->options as $option => $value) { + // A warning is raised in case of a wrong option. + curl_multi_setopt($this->_mh, $option, $value); + } + + return $this->_mh; + } + + public function __destruct() + { + if (isset($this->_mh)) { + \curl_multi_close($this->_mh); + unset($this->_mh); + } + } + + public function __invoke(RequestInterface $request, array $options): PromiseInterface + { + $easy = $this->factory->create($request, $options); + $id = (int) $easy->handle; + + $promise = new Promise( + [$this, 'execute'], + function () use ($id) { + return $this->cancel($id); + } + ); + + $this->addRequest(['easy' => $easy, 'deferred' => $promise]); + + return $promise; + } + + /** + * Ticks the curl event loop. + */ + public function tick(): void + { + // Add any delayed handles if needed. + if ($this->delays) { + $currentTime = Utils::currentTime(); + foreach ($this->delays as $id => $delay) { + if ($currentTime >= $delay) { + unset($this->delays[$id]); + \curl_multi_add_handle( + $this->_mh, + $this->handles[$id]['easy']->handle + ); + } + } + } + + // Run curl_multi_exec in the queue to enable other async tasks to run + P\Utils::queue()->add(Closure::fromCallable([$this, 'tickInQueue'])); + + // Step through the task queue which may add additional requests. + P\Utils::queue()->run(); + + if ($this->active && \curl_multi_select($this->_mh, $this->selectTimeout) === -1) { + // Perform a usleep if a select returns -1. + // See: https://bugs.php.net/bug.php?id=61141 + \usleep(250); + } + + while (\curl_multi_exec($this->_mh, $this->active) === \CURLM_CALL_MULTI_PERFORM) { + // Prevent busy looping for slow HTTP requests. + \curl_multi_select($this->_mh, $this->selectTimeout); + } + + $this->processMessages(); + } + + /** + * Runs \curl_multi_exec() inside the event loop, to prevent busy looping + */ + private function tickInQueue(): void + { + if (\curl_multi_exec($this->_mh, $this->active) === \CURLM_CALL_MULTI_PERFORM) { + \curl_multi_select($this->_mh, 0); + P\Utils::queue()->add(Closure::fromCallable([$this, 'tickInQueue'])); + } + } + + /** + * Runs until all outstanding connections have completed. + */ + public function execute(): void + { + $queue = P\Utils::queue(); + + while ($this->handles || !$queue->isEmpty()) { + // If there are no transfers, then sleep for the next delay + if (!$this->active && $this->delays) { + \usleep($this->timeToNext()); + } + $this->tick(); + } + } + + private function addRequest(array $entry): void + { + $easy = $entry['easy']; + $id = (int) $easy->handle; + $this->handles[$id] = $entry; + if (empty($easy->options['delay'])) { + \curl_multi_add_handle($this->_mh, $easy->handle); + } else { + $this->delays[$id] = Utils::currentTime() + ($easy->options['delay'] / 1000); + } + } + + /** + * Cancels a handle from sending and removes references to it. + * + * @param int $id Handle ID to cancel and remove. + * + * @return bool True on success, false on failure. + */ + private function cancel($id): bool + { + if (!is_int($id)) { + trigger_deprecation('guzzlehttp/guzzle', '7.4', 'Not passing an integer to %s::%s() is deprecated and will cause an error in 8.0.', __CLASS__, __FUNCTION__); + } + + // Cannot cancel if it has been processed. + if (!isset($this->handles[$id])) { + return false; + } + + $handle = $this->handles[$id]['easy']->handle; + unset($this->delays[$id], $this->handles[$id]); + \curl_multi_remove_handle($this->_mh, $handle); + \curl_close($handle); + + return true; + } + + private function processMessages(): void + { + while ($done = \curl_multi_info_read($this->_mh)) { + if ($done['msg'] !== \CURLMSG_DONE) { + // if it's not done, then it would be premature to remove the handle. ref https://github.com/guzzle/guzzle/pull/2892#issuecomment-945150216 + continue; + } + $id = (int) $done['handle']; + \curl_multi_remove_handle($this->_mh, $done['handle']); + + if (!isset($this->handles[$id])) { + // Probably was cancelled. + continue; + } + + $entry = $this->handles[$id]; + unset($this->handles[$id], $this->delays[$id]); + $entry['easy']->errno = $done['result']; + $entry['deferred']->resolve( + CurlFactory::finish($this, $entry['easy'], $this->factory) + ); + } + } + + private function timeToNext(): int + { + $currentTime = Utils::currentTime(); + $nextTime = \PHP_INT_MAX; + foreach ($this->delays as $time) { + if ($time < $nextTime) { + $nextTime = $time; + } + } + + return ((int) \max(0, $nextTime - $currentTime)) * 1000000; + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/Handler/MockHandler.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/Handler/MockHandler.php new file mode 100644 index 0000000000..3ecd5964de --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/Handler/MockHandler.php @@ -0,0 +1,212 @@ +<?php + +namespace GuzzleHttp\Handler; + +use GuzzleHttp\Exception\RequestException; +use GuzzleHttp\HandlerStack; +use GuzzleHttp\Promise as P; +use GuzzleHttp\Promise\PromiseInterface; +use GuzzleHttp\TransferStats; +use GuzzleHttp\Utils; +use Psr\Http\Message\RequestInterface; +use Psr\Http\Message\ResponseInterface; +use Psr\Http\Message\StreamInterface; + +/** + * Handler that returns responses or throw exceptions from a queue. + * + * @final + */ +class MockHandler implements \Countable +{ + /** + * @var array + */ + private $queue = []; + + /** + * @var RequestInterface|null + */ + private $lastRequest; + + /** + * @var array + */ + private $lastOptions = []; + + /** + * @var callable|null + */ + private $onFulfilled; + + /** + * @var callable|null + */ + private $onRejected; + + /** + * Creates a new MockHandler that uses the default handler stack list of + * middlewares. + * + * @param array|null $queue Array of responses, callables, or exceptions. + * @param callable|null $onFulfilled Callback to invoke when the return value is fulfilled. + * @param callable|null $onRejected Callback to invoke when the return value is rejected. + */ + public static function createWithMiddleware(?array $queue = null, ?callable $onFulfilled = null, ?callable $onRejected = null): HandlerStack + { + return HandlerStack::create(new self($queue, $onFulfilled, $onRejected)); + } + + /** + * The passed in value must be an array of + * {@see ResponseInterface} objects, Exceptions, + * callables, or Promises. + * + * @param array<int, mixed>|null $queue The parameters to be passed to the append function, as an indexed array. + * @param callable|null $onFulfilled Callback to invoke when the return value is fulfilled. + * @param callable|null $onRejected Callback to invoke when the return value is rejected. + */ + public function __construct(?array $queue = null, ?callable $onFulfilled = null, ?callable $onRejected = null) + { + $this->onFulfilled = $onFulfilled; + $this->onRejected = $onRejected; + + if ($queue) { + // array_values included for BC + $this->append(...array_values($queue)); + } + } + + public function __invoke(RequestInterface $request, array $options): PromiseInterface + { + if (!$this->queue) { + throw new \OutOfBoundsException('Mock queue is empty'); + } + + if (isset($options['delay']) && \is_numeric($options['delay'])) { + \usleep((int) $options['delay'] * 1000); + } + + $this->lastRequest = $request; + $this->lastOptions = $options; + $response = \array_shift($this->queue); + + if (isset($options['on_headers'])) { + if (!\is_callable($options['on_headers'])) { + throw new \InvalidArgumentException('on_headers must be callable'); + } + try { + $options['on_headers']($response); + } catch (\Exception $e) { + $msg = 'An error was encountered during the on_headers event'; + $response = new RequestException($msg, $request, $response, $e); + } + } + + if (\is_callable($response)) { + $response = $response($request, $options); + } + + $response = $response instanceof \Throwable + ? P\Create::rejectionFor($response) + : P\Create::promiseFor($response); + + return $response->then( + function (?ResponseInterface $value) use ($request, $options) { + $this->invokeStats($request, $options, $value); + if ($this->onFulfilled) { + ($this->onFulfilled)($value); + } + + if ($value !== null && isset($options['sink'])) { + $contents = (string) $value->getBody(); + $sink = $options['sink']; + + if (\is_resource($sink)) { + \fwrite($sink, $contents); + } elseif (\is_string($sink)) { + \file_put_contents($sink, $contents); + } elseif ($sink instanceof StreamInterface) { + $sink->write($contents); + } + } + + return $value; + }, + function ($reason) use ($request, $options) { + $this->invokeStats($request, $options, null, $reason); + if ($this->onRejected) { + ($this->onRejected)($reason); + } + + return P\Create::rejectionFor($reason); + } + ); + } + + /** + * Adds one or more variadic requests, exceptions, callables, or promises + * to the queue. + * + * @param mixed ...$values + */ + public function append(...$values): void + { + foreach ($values as $value) { + if ($value instanceof ResponseInterface + || $value instanceof \Throwable + || $value instanceof PromiseInterface + || \is_callable($value) + ) { + $this->queue[] = $value; + } else { + throw new \TypeError('Expected a Response, Promise, Throwable or callable. Found '.Utils::describeType($value)); + } + } + } + + /** + * Get the last received request. + */ + public function getLastRequest(): ?RequestInterface + { + return $this->lastRequest; + } + + /** + * Get the last received request options. + */ + public function getLastOptions(): array + { + return $this->lastOptions; + } + + /** + * Returns the number of remaining items in the queue. + */ + public function count(): int + { + return \count($this->queue); + } + + public function reset(): void + { + $this->queue = []; + } + + /** + * @param mixed $reason Promise or reason. + */ + private function invokeStats( + RequestInterface $request, + array $options, + ?ResponseInterface $response = null, + $reason = null + ): void { + if (isset($options['on_stats'])) { + $transferTime = $options['transfer_time'] ?? 0; + $stats = new TransferStats($request, $response, $transferTime, $reason); + ($options['on_stats'])($stats); + } + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/Handler/StreamHandler.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/Handler/StreamHandler.php new file mode 100644 index 0000000000..1d89a8fbc8 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/Handler/StreamHandler.php @@ -0,0 +1,621 @@ +<?php + +namespace GuzzleHttp\Handler; + +use GuzzleHttp\Exception\ConnectException; +use GuzzleHttp\Exception\RequestException; +use GuzzleHttp\Promise as P; +use GuzzleHttp\Promise\FulfilledPromise; +use GuzzleHttp\Promise\PromiseInterface; +use GuzzleHttp\Psr7; +use GuzzleHttp\TransferStats; +use GuzzleHttp\Utils; +use Psr\Http\Message\RequestInterface; +use Psr\Http\Message\ResponseInterface; +use Psr\Http\Message\StreamInterface; +use Psr\Http\Message\UriInterface; + +/** + * HTTP handler that uses PHP's HTTP stream wrapper. + * + * @final + */ +class StreamHandler +{ + /** + * @var array + */ + private $lastHeaders = []; + + /** + * Sends an HTTP request. + * + * @param RequestInterface $request Request to send. + * @param array $options Request transfer options. + */ + public function __invoke(RequestInterface $request, array $options): PromiseInterface + { + // Sleep if there is a delay specified. + if (isset($options['delay'])) { + \usleep($options['delay'] * 1000); + } + + $protocolVersion = $request->getProtocolVersion(); + + if ('1.0' !== $protocolVersion && '1.1' !== $protocolVersion) { + throw new ConnectException(sprintf('HTTP/%s is not supported by the stream handler.', $protocolVersion), $request); + } + + $startTime = isset($options['on_stats']) ? Utils::currentTime() : null; + + try { + // Does not support the expect header. + $request = $request->withoutHeader('Expect'); + + // Append a content-length header if body size is zero to match + // cURL's behavior. + if (0 === $request->getBody()->getSize()) { + $request = $request->withHeader('Content-Length', '0'); + } + + return $this->createResponse( + $request, + $options, + $this->createStream($request, $options), + $startTime + ); + } catch (\InvalidArgumentException $e) { + throw $e; + } catch (\Exception $e) { + // Determine if the error was a networking error. + $message = $e->getMessage(); + // This list can probably get more comprehensive. + if (false !== \strpos($message, 'getaddrinfo') // DNS lookup failed + || false !== \strpos($message, 'Connection refused') + || false !== \strpos($message, "couldn't connect to host") // error on HHVM + || false !== \strpos($message, 'connection attempt failed') + ) { + $e = new ConnectException($e->getMessage(), $request, $e); + } else { + $e = RequestException::wrapException($request, $e); + } + $this->invokeStats($options, $request, $startTime, null, $e); + + return P\Create::rejectionFor($e); + } + } + + private function invokeStats( + array $options, + RequestInterface $request, + ?float $startTime, + ?ResponseInterface $response = null, + ?\Throwable $error = null + ): void { + if (isset($options['on_stats'])) { + $stats = new TransferStats($request, $response, Utils::currentTime() - $startTime, $error, []); + ($options['on_stats'])($stats); + } + } + + /** + * @param resource $stream + */ + private function createResponse(RequestInterface $request, array $options, $stream, ?float $startTime): PromiseInterface + { + $hdrs = $this->lastHeaders; + $this->lastHeaders = []; + + try { + [$ver, $status, $reason, $headers] = HeaderProcessor::parseHeaders($hdrs); + } catch (\Exception $e) { + return P\Create::rejectionFor( + new RequestException('An error was encountered while creating the response', $request, null, $e) + ); + } + + [$stream, $headers] = $this->checkDecode($options, $headers, $stream); + $stream = Psr7\Utils::streamFor($stream); + $sink = $stream; + + if (\strcasecmp('HEAD', $request->getMethod())) { + $sink = $this->createSink($stream, $options); + } + + try { + $response = new Psr7\Response($status, $headers, $sink, $ver, $reason); + } catch (\Exception $e) { + return P\Create::rejectionFor( + new RequestException('An error was encountered while creating the response', $request, null, $e) + ); + } + + if (isset($options['on_headers'])) { + try { + $options['on_headers']($response); + } catch (\Exception $e) { + return P\Create::rejectionFor( + new RequestException('An error was encountered during the on_headers event', $request, $response, $e) + ); + } + } + + // Do not drain when the request is a HEAD request because they have + // no body. + if ($sink !== $stream) { + $this->drain($stream, $sink, $response->getHeaderLine('Content-Length')); + } + + $this->invokeStats($options, $request, $startTime, $response, null); + + return new FulfilledPromise($response); + } + + private function createSink(StreamInterface $stream, array $options): StreamInterface + { + if (!empty($options['stream'])) { + return $stream; + } + + $sink = $options['sink'] ?? Psr7\Utils::tryFopen('php://temp', 'r+'); + + return \is_string($sink) ? new Psr7\LazyOpenStream($sink, 'w+') : Psr7\Utils::streamFor($sink); + } + + /** + * @param resource $stream + */ + private function checkDecode(array $options, array $headers, $stream): array + { + // Automatically decode responses when instructed. + if (!empty($options['decode_content'])) { + $normalizedKeys = Utils::normalizeHeaderKeys($headers); + if (isset($normalizedKeys['content-encoding'])) { + $encoding = $headers[$normalizedKeys['content-encoding']]; + if ($encoding[0] === 'gzip' || $encoding[0] === 'deflate') { + $stream = new Psr7\InflateStream(Psr7\Utils::streamFor($stream)); + $headers['x-encoded-content-encoding'] = $headers[$normalizedKeys['content-encoding']]; + + // Remove content-encoding header + unset($headers[$normalizedKeys['content-encoding']]); + + // Fix content-length header + if (isset($normalizedKeys['content-length'])) { + $headers['x-encoded-content-length'] = $headers[$normalizedKeys['content-length']]; + $length = (int) $stream->getSize(); + if ($length === 0) { + unset($headers[$normalizedKeys['content-length']]); + } else { + $headers[$normalizedKeys['content-length']] = [$length]; + } + } + } + } + } + + return [$stream, $headers]; + } + + /** + * Drains the source stream into the "sink" client option. + * + * @param string $contentLength Header specifying the amount of + * data to read. + * + * @throws \RuntimeException when the sink option is invalid. + */ + private function drain(StreamInterface $source, StreamInterface $sink, string $contentLength): StreamInterface + { + // If a content-length header is provided, then stop reading once + // that number of bytes has been read. This can prevent infinitely + // reading from a stream when dealing with servers that do not honor + // Connection: Close headers. + Psr7\Utils::copyToStream( + $source, + $sink, + (\strlen($contentLength) > 0 && (int) $contentLength > 0) ? (int) $contentLength : -1 + ); + + $sink->seek(0); + $source->close(); + + return $sink; + } + + /** + * Create a resource and check to ensure it was created successfully + * + * @param callable $callback Callable that returns stream resource + * + * @return resource + * + * @throws \RuntimeException on error + */ + private function createResource(callable $callback) + { + $errors = []; + \set_error_handler(static function ($_, $msg, $file, $line) use (&$errors): bool { + $errors[] = [ + 'message' => $msg, + 'file' => $file, + 'line' => $line, + ]; + + return true; + }); + + try { + $resource = $callback(); + } finally { + \restore_error_handler(); + } + + if (!$resource) { + $message = 'Error creating resource: '; + foreach ($errors as $err) { + foreach ($err as $key => $value) { + $message .= "[$key] $value".\PHP_EOL; + } + } + throw new \RuntimeException(\trim($message)); + } + + return $resource; + } + + /** + * @return resource + */ + private function createStream(RequestInterface $request, array $options) + { + static $methods; + if (!$methods) { + $methods = \array_flip(\get_class_methods(__CLASS__)); + } + + if (!\in_array($request->getUri()->getScheme(), ['http', 'https'])) { + throw new RequestException(\sprintf("The scheme '%s' is not supported.", $request->getUri()->getScheme()), $request); + } + + // HTTP/1.1 streams using the PHP stream wrapper require a + // Connection: close header + if ($request->getProtocolVersion() === '1.1' + && !$request->hasHeader('Connection') + ) { + $request = $request->withHeader('Connection', 'close'); + } + + // Ensure SSL is verified by default + if (!isset($options['verify'])) { + $options['verify'] = true; + } + + $params = []; + $context = $this->getDefaultContext($request); + + if (isset($options['on_headers']) && !\is_callable($options['on_headers'])) { + throw new \InvalidArgumentException('on_headers must be callable'); + } + + if (!empty($options)) { + foreach ($options as $key => $value) { + $method = "add_{$key}"; + if (isset($methods[$method])) { + $this->{$method}($request, $context, $value, $params); + } + } + } + + if (isset($options['stream_context'])) { + if (!\is_array($options['stream_context'])) { + throw new \InvalidArgumentException('stream_context must be an array'); + } + $context = \array_replace_recursive($context, $options['stream_context']); + } + + // Microsoft NTLM authentication only supported with curl handler + if (isset($options['auth'][2]) && 'ntlm' === $options['auth'][2]) { + throw new \InvalidArgumentException('Microsoft NTLM authentication only supported with curl handler'); + } + + $uri = $this->resolveHost($request, $options); + + $contextResource = $this->createResource( + static function () use ($context, $params) { + return \stream_context_create($context, $params); + } + ); + + return $this->createResource( + function () use ($uri, &$http_response_header, $contextResource, $context, $options, $request) { + $resource = @\fopen((string) $uri, 'r', false, $contextResource); + $this->lastHeaders = $http_response_header ?? []; + + if (false === $resource) { + throw new ConnectException(sprintf('Connection refused for URI %s', $uri), $request, null, $context); + } + + if (isset($options['read_timeout'])) { + $readTimeout = $options['read_timeout']; + $sec = (int) $readTimeout; + $usec = ($readTimeout - $sec) * 100000; + \stream_set_timeout($resource, $sec, $usec); + } + + return $resource; + } + ); + } + + private function resolveHost(RequestInterface $request, array $options): UriInterface + { + $uri = $request->getUri(); + + if (isset($options['force_ip_resolve']) && !\filter_var($uri->getHost(), \FILTER_VALIDATE_IP)) { + if ('v4' === $options['force_ip_resolve']) { + $records = \dns_get_record($uri->getHost(), \DNS_A); + if (false === $records || !isset($records[0]['ip'])) { + throw new ConnectException(\sprintf("Could not resolve IPv4 address for host '%s'", $uri->getHost()), $request); + } + + return $uri->withHost($records[0]['ip']); + } + if ('v6' === $options['force_ip_resolve']) { + $records = \dns_get_record($uri->getHost(), \DNS_AAAA); + if (false === $records || !isset($records[0]['ipv6'])) { + throw new ConnectException(\sprintf("Could not resolve IPv6 address for host '%s'", $uri->getHost()), $request); + } + + return $uri->withHost('['.$records[0]['ipv6'].']'); + } + } + + return $uri; + } + + private function getDefaultContext(RequestInterface $request): array + { + $headers = ''; + foreach ($request->getHeaders() as $name => $value) { + foreach ($value as $val) { + $headers .= "$name: $val\r\n"; + } + } + + $context = [ + 'http' => [ + 'method' => $request->getMethod(), + 'header' => $headers, + 'protocol_version' => $request->getProtocolVersion(), + 'ignore_errors' => true, + 'follow_location' => 0, + ], + 'ssl' => [ + 'peer_name' => $request->getUri()->getHost(), + ], + ]; + + $body = (string) $request->getBody(); + + if ('' !== $body) { + $context['http']['content'] = $body; + // Prevent the HTTP handler from adding a Content-Type header. + if (!$request->hasHeader('Content-Type')) { + $context['http']['header'] .= "Content-Type:\r\n"; + } + } + + $context['http']['header'] = \rtrim($context['http']['header']); + + return $context; + } + + /** + * @param mixed $value as passed via Request transfer options. + */ + private function add_proxy(RequestInterface $request, array &$options, $value, array &$params): void + { + $uri = null; + + if (!\is_array($value)) { + $uri = $value; + } else { + $scheme = $request->getUri()->getScheme(); + if (isset($value[$scheme])) { + if (!isset($value['no']) || !Utils::isHostInNoProxy($request->getUri()->getHost(), $value['no'])) { + $uri = $value[$scheme]; + } + } + } + + if (!$uri) { + return; + } + + $parsed = $this->parse_proxy($uri); + $options['http']['proxy'] = $parsed['proxy']; + + if ($parsed['auth']) { + if (!isset($options['http']['header'])) { + $options['http']['header'] = []; + } + $options['http']['header'] .= "\r\nProxy-Authorization: {$parsed['auth']}"; + } + } + + /** + * Parses the given proxy URL to make it compatible with the format PHP's stream context expects. + */ + private function parse_proxy(string $url): array + { + $parsed = \parse_url($url); + + if ($parsed !== false && isset($parsed['scheme']) && $parsed['scheme'] === 'http') { + if (isset($parsed['host']) && isset($parsed['port'])) { + $auth = null; + if (isset($parsed['user']) && isset($parsed['pass'])) { + $auth = \base64_encode("{$parsed['user']}:{$parsed['pass']}"); + } + + return [ + 'proxy' => "tcp://{$parsed['host']}:{$parsed['port']}", + 'auth' => $auth ? "Basic {$auth}" : null, + ]; + } + } + + // Return proxy as-is. + return [ + 'proxy' => $url, + 'auth' => null, + ]; + } + + /** + * @param mixed $value as passed via Request transfer options. + */ + private function add_timeout(RequestInterface $request, array &$options, $value, array &$params): void + { + if ($value > 0) { + $options['http']['timeout'] = $value; + } + } + + /** + * @param mixed $value as passed via Request transfer options. + */ + private function add_crypto_method(RequestInterface $request, array &$options, $value, array &$params): void + { + if ( + $value === \STREAM_CRYPTO_METHOD_TLSv1_0_CLIENT + || $value === \STREAM_CRYPTO_METHOD_TLSv1_1_CLIENT + || $value === \STREAM_CRYPTO_METHOD_TLSv1_2_CLIENT + || (defined('STREAM_CRYPTO_METHOD_TLSv1_3_CLIENT') && $value === \STREAM_CRYPTO_METHOD_TLSv1_3_CLIENT) + ) { + $options['http']['crypto_method'] = $value; + + return; + } + + throw new \InvalidArgumentException('Invalid crypto_method request option: unknown version provided'); + } + + /** + * @param mixed $value as passed via Request transfer options. + */ + private function add_verify(RequestInterface $request, array &$options, $value, array &$params): void + { + if ($value === false) { + $options['ssl']['verify_peer'] = false; + $options['ssl']['verify_peer_name'] = false; + + return; + } + + if (\is_string($value)) { + $options['ssl']['cafile'] = $value; + if (!\file_exists($value)) { + throw new \RuntimeException("SSL CA bundle not found: $value"); + } + } elseif ($value !== true) { + throw new \InvalidArgumentException('Invalid verify request option'); + } + + $options['ssl']['verify_peer'] = true; + $options['ssl']['verify_peer_name'] = true; + $options['ssl']['allow_self_signed'] = false; + } + + /** + * @param mixed $value as passed via Request transfer options. + */ + private function add_cert(RequestInterface $request, array &$options, $value, array &$params): void + { + if (\is_array($value)) { + $options['ssl']['passphrase'] = $value[1]; + $value = $value[0]; + } + + if (!\file_exists($value)) { + throw new \RuntimeException("SSL certificate not found: {$value}"); + } + + $options['ssl']['local_cert'] = $value; + } + + /** + * @param mixed $value as passed via Request transfer options. + */ + private function add_progress(RequestInterface $request, array &$options, $value, array &$params): void + { + self::addNotification( + $params, + static function ($code, $a, $b, $c, $transferred, $total) use ($value) { + if ($code == \STREAM_NOTIFY_PROGRESS) { + // The upload progress cannot be determined. Use 0 for cURL compatibility: + // https://curl.se/libcurl/c/CURLOPT_PROGRESSFUNCTION.html + $value($total, $transferred, 0, 0); + } + } + ); + } + + /** + * @param mixed $value as passed via Request transfer options. + */ + private function add_debug(RequestInterface $request, array &$options, $value, array &$params): void + { + if ($value === false) { + return; + } + + static $map = [ + \STREAM_NOTIFY_CONNECT => 'CONNECT', + \STREAM_NOTIFY_AUTH_REQUIRED => 'AUTH_REQUIRED', + \STREAM_NOTIFY_AUTH_RESULT => 'AUTH_RESULT', + \STREAM_NOTIFY_MIME_TYPE_IS => 'MIME_TYPE_IS', + \STREAM_NOTIFY_FILE_SIZE_IS => 'FILE_SIZE_IS', + \STREAM_NOTIFY_REDIRECTED => 'REDIRECTED', + \STREAM_NOTIFY_PROGRESS => 'PROGRESS', + \STREAM_NOTIFY_FAILURE => 'FAILURE', + \STREAM_NOTIFY_COMPLETED => 'COMPLETED', + \STREAM_NOTIFY_RESOLVE => 'RESOLVE', + ]; + static $args = ['severity', 'message', 'message_code', 'bytes_transferred', 'bytes_max']; + + $value = Utils::debugResource($value); + $ident = $request->getMethod().' '.$request->getUri()->withFragment(''); + self::addNotification( + $params, + static function (int $code, ...$passed) use ($ident, $value, $map, $args): void { + \fprintf($value, '<%s> [%s] ', $ident, $map[$code]); + foreach (\array_filter($passed) as $i => $v) { + \fwrite($value, $args[$i].': "'.$v.'" '); + } + \fwrite($value, "\n"); + } + ); + } + + private static function addNotification(array &$params, callable $notify): void + { + // Wrap the existing function if needed. + if (!isset($params['notification'])) { + $params['notification'] = $notify; + } else { + $params['notification'] = self::callArray([ + $params['notification'], + $notify, + ]); + } + } + + private static function callArray(array $functions): callable + { + return static function (...$args) use ($functions) { + foreach ($functions as $fn) { + $fn(...$args); + } + }; + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/HandlerStack.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/HandlerStack.php new file mode 100644 index 0000000000..03f9a18ffd --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/HandlerStack.php @@ -0,0 +1,275 @@ +<?php + +namespace GuzzleHttp; + +use GuzzleHttp\Promise\PromiseInterface; +use Psr\Http\Message\RequestInterface; +use Psr\Http\Message\ResponseInterface; + +/** + * Creates a composed Guzzle handler function by stacking middlewares on top of + * an HTTP handler function. + * + * @final + */ +class HandlerStack +{ + /** + * @var (callable(RequestInterface, array): PromiseInterface)|null + */ + private $handler; + + /** + * @var array{(callable(callable(RequestInterface, array): PromiseInterface): callable), (string|null)}[] + */ + private $stack = []; + + /** + * @var (callable(RequestInterface, array): PromiseInterface)|null + */ + private $cached; + + /** + * Creates a default handler stack that can be used by clients. + * + * The returned handler will wrap the provided handler or use the most + * appropriate default handler for your system. The returned HandlerStack has + * support for cookies, redirects, HTTP error exceptions, and preparing a body + * before sending. + * + * The returned handler stack can be passed to a client in the "handler" + * option. + * + * @param (callable(RequestInterface, array): PromiseInterface)|null $handler HTTP handler function to use with the stack. If no + * handler is provided, the best handler for your + * system will be utilized. + */ + public static function create(?callable $handler = null): self + { + $stack = new self($handler ?: Utils::chooseHandler()); + $stack->push(Middleware::httpErrors(), 'http_errors'); + $stack->push(Middleware::redirect(), 'allow_redirects'); + $stack->push(Middleware::cookies(), 'cookies'); + $stack->push(Middleware::prepareBody(), 'prepare_body'); + + return $stack; + } + + /** + * @param (callable(RequestInterface, array): PromiseInterface)|null $handler Underlying HTTP handler. + */ + public function __construct(?callable $handler = null) + { + $this->handler = $handler; + } + + /** + * Invokes the handler stack as a composed handler + * + * @return ResponseInterface|PromiseInterface + */ + public function __invoke(RequestInterface $request, array $options) + { + $handler = $this->resolve(); + + return $handler($request, $options); + } + + /** + * Dumps a string representation of the stack. + * + * @return string + */ + public function __toString() + { + $depth = 0; + $stack = []; + + if ($this->handler !== null) { + $stack[] = '0) Handler: '.$this->debugCallable($this->handler); + } + + $result = ''; + foreach (\array_reverse($this->stack) as $tuple) { + ++$depth; + $str = "{$depth}) Name: '{$tuple[1]}', "; + $str .= 'Function: '.$this->debugCallable($tuple[0]); + $result = "> {$str}\n{$result}"; + $stack[] = $str; + } + + foreach (\array_keys($stack) as $k) { + $result .= "< {$stack[$k]}\n"; + } + + return $result; + } + + /** + * Set the HTTP handler that actually returns a promise. + * + * @param callable(RequestInterface, array): PromiseInterface $handler Accepts a request and array of options and + * returns a Promise. + */ + public function setHandler(callable $handler): void + { + $this->handler = $handler; + $this->cached = null; + } + + /** + * Returns true if the builder has a handler. + */ + public function hasHandler(): bool + { + return $this->handler !== null; + } + + /** + * Unshift a middleware to the bottom of the stack. + * + * @param callable(callable): callable $middleware Middleware function + * @param string $name Name to register for this middleware. + */ + public function unshift(callable $middleware, ?string $name = null): void + { + \array_unshift($this->stack, [$middleware, $name]); + $this->cached = null; + } + + /** + * Push a middleware to the top of the stack. + * + * @param callable(callable): callable $middleware Middleware function + * @param string $name Name to register for this middleware. + */ + public function push(callable $middleware, string $name = ''): void + { + $this->stack[] = [$middleware, $name]; + $this->cached = null; + } + + /** + * Add a middleware before another middleware by name. + * + * @param string $findName Middleware to find + * @param callable(callable): callable $middleware Middleware function + * @param string $withName Name to register for this middleware. + */ + public function before(string $findName, callable $middleware, string $withName = ''): void + { + $this->splice($findName, $withName, $middleware, true); + } + + /** + * Add a middleware after another middleware by name. + * + * @param string $findName Middleware to find + * @param callable(callable): callable $middleware Middleware function + * @param string $withName Name to register for this middleware. + */ + public function after(string $findName, callable $middleware, string $withName = ''): void + { + $this->splice($findName, $withName, $middleware, false); + } + + /** + * Remove a middleware by instance or name from the stack. + * + * @param callable|string $remove Middleware to remove by instance or name. + */ + public function remove($remove): void + { + if (!is_string($remove) && !is_callable($remove)) { + trigger_deprecation('guzzlehttp/guzzle', '7.4', 'Not passing a callable or string to %s::%s() is deprecated and will cause an error in 8.0.', __CLASS__, __FUNCTION__); + } + + $this->cached = null; + $idx = \is_callable($remove) ? 0 : 1; + $this->stack = \array_values(\array_filter( + $this->stack, + static function ($tuple) use ($idx, $remove) { + return $tuple[$idx] !== $remove; + } + )); + } + + /** + * Compose the middleware and handler into a single callable function. + * + * @return callable(RequestInterface, array): PromiseInterface + */ + public function resolve(): callable + { + if ($this->cached === null) { + if (($prev = $this->handler) === null) { + throw new \LogicException('No handler has been specified'); + } + + foreach (\array_reverse($this->stack) as $fn) { + /** @var callable(RequestInterface, array): PromiseInterface $prev */ + $prev = $fn[0]($prev); + } + + $this->cached = $prev; + } + + return $this->cached; + } + + private function findByName(string $name): int + { + foreach ($this->stack as $k => $v) { + if ($v[1] === $name) { + return $k; + } + } + + throw new \InvalidArgumentException("Middleware not found: $name"); + } + + /** + * Splices a function into the middleware list at a specific position. + */ + private function splice(string $findName, string $withName, callable $middleware, bool $before): void + { + $this->cached = null; + $idx = $this->findByName($findName); + $tuple = [$middleware, $withName]; + + if ($before) { + if ($idx === 0) { + \array_unshift($this->stack, $tuple); + } else { + $replacement = [$tuple, $this->stack[$idx]]; + \array_splice($this->stack, $idx, 1, $replacement); + } + } elseif ($idx === \count($this->stack) - 1) { + $this->stack[] = $tuple; + } else { + $replacement = [$this->stack[$idx], $tuple]; + \array_splice($this->stack, $idx, 1, $replacement); + } + } + + /** + * Provides a debug string for a given callable. + * + * @param callable|string $fn Function to write as a string. + */ + private function debugCallable($fn): string + { + if (\is_string($fn)) { + return "callable({$fn})"; + } + + if (\is_array($fn)) { + return \is_string($fn[0]) + ? "callable({$fn[0]}::{$fn[1]})" + : "callable(['".\get_class($fn[0])."', '{$fn[1]}'])"; + } + + /** @var object $fn */ + return 'callable('.\spl_object_hash($fn).')'; + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/MessageFormatter.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/MessageFormatter.php new file mode 100644 index 0000000000..9b77eee832 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/MessageFormatter.php @@ -0,0 +1,199 @@ +<?php + +namespace GuzzleHttp; + +use Psr\Http\Message\MessageInterface; +use Psr\Http\Message\RequestInterface; +use Psr\Http\Message\ResponseInterface; + +/** + * Formats log messages using variable substitutions for requests, responses, + * and other transactional data. + * + * The following variable substitutions are supported: + * + * - {request}: Full HTTP request message + * - {response}: Full HTTP response message + * - {ts}: ISO 8601 date in GMT + * - {date_iso_8601} ISO 8601 date in GMT + * - {date_common_log} Apache common log date using the configured timezone. + * - {host}: Host of the request + * - {method}: Method of the request + * - {uri}: URI of the request + * - {version}: Protocol version + * - {target}: Request target of the request (path + query + fragment) + * - {hostname}: Hostname of the machine that sent the request + * - {code}: Status code of the response (if available) + * - {phrase}: Reason phrase of the response (if available) + * - {error}: Any error messages (if available) + * - {req_header_*}: Replace `*` with the lowercased name of a request header to add to the message + * - {res_header_*}: Replace `*` with the lowercased name of a response header to add to the message + * - {req_headers}: Request headers + * - {res_headers}: Response headers + * - {req_body}: Request body + * - {res_body}: Response body + * + * @final + */ +class MessageFormatter implements MessageFormatterInterface +{ + /** + * Apache Common Log Format. + * + * @see https://httpd.apache.org/docs/2.4/logs.html#common + * + * @var string + */ + public const CLF = '{hostname} {req_header_User-Agent} - [{date_common_log}] "{method} {target} HTTP/{version}" {code} {res_header_Content-Length}'; + public const DEBUG = ">>>>>>>>\n{request}\n<<<<<<<<\n{response}\n--------\n{error}"; + public const SHORT = '[{ts}] "{method} {target} HTTP/{version}" {code}'; + + /** + * @var string Template used to format log messages + */ + private $template; + + /** + * @param string $template Log message template + */ + public function __construct(?string $template = self::CLF) + { + $this->template = $template ?: self::CLF; + } + + /** + * Returns a formatted message string. + * + * @param RequestInterface $request Request that was sent + * @param ResponseInterface|null $response Response that was received + * @param \Throwable|null $error Exception that was received + */ + public function format(RequestInterface $request, ?ResponseInterface $response = null, ?\Throwable $error = null): string + { + $cache = []; + + /** @var string */ + return \preg_replace_callback( + '/{\s*([A-Za-z_\-\.0-9]+)\s*}/', + function (array $matches) use ($request, $response, $error, &$cache) { + if (isset($cache[$matches[1]])) { + return $cache[$matches[1]]; + } + + $result = ''; + switch ($matches[1]) { + case 'request': + $result = Psr7\Message::toString($request); + break; + case 'response': + $result = $response ? Psr7\Message::toString($response) : ''; + break; + case 'req_headers': + $result = \trim($request->getMethod() + .' '.$request->getRequestTarget()) + .' HTTP/'.$request->getProtocolVersion()."\r\n" + .$this->headers($request); + break; + case 'res_headers': + $result = $response ? + \sprintf( + 'HTTP/%s %d %s', + $response->getProtocolVersion(), + $response->getStatusCode(), + $response->getReasonPhrase() + )."\r\n".$this->headers($response) + : 'NULL'; + break; + case 'req_body': + $result = $request->getBody()->__toString(); + break; + case 'res_body': + if (!$response instanceof ResponseInterface) { + $result = 'NULL'; + break; + } + + $body = $response->getBody(); + + if (!$body->isSeekable()) { + $result = 'RESPONSE_NOT_LOGGEABLE'; + break; + } + + $result = $response->getBody()->__toString(); + break; + case 'ts': + case 'date_iso_8601': + $result = \gmdate('c'); + break; + case 'date_common_log': + $result = \date('d/M/Y:H:i:s O'); + break; + case 'method': + $result = $request->getMethod(); + break; + case 'version': + $result = $request->getProtocolVersion(); + break; + case 'uri': + case 'url': + $result = $request->getUri()->__toString(); + break; + case 'target': + $result = $request->getRequestTarget(); + break; + case 'req_version': + $result = $request->getProtocolVersion(); + break; + case 'res_version': + $result = $response + ? $response->getProtocolVersion() + : 'NULL'; + break; + case 'host': + $result = $request->getHeaderLine('Host'); + break; + case 'hostname': + $result = \gethostname(); + break; + case 'code': + $result = $response ? $response->getStatusCode() : 'NULL'; + break; + case 'phrase': + $result = $response ? $response->getReasonPhrase() : 'NULL'; + break; + case 'error': + $result = $error ? $error->getMessage() : 'NULL'; + break; + default: + // handle prefixed dynamic headers + if (\strpos($matches[1], 'req_header_') === 0) { + $result = $request->getHeaderLine(\substr($matches[1], 11)); + } elseif (\strpos($matches[1], 'res_header_') === 0) { + $result = $response + ? $response->getHeaderLine(\substr($matches[1], 11)) + : 'NULL'; + } + } + + $cache[$matches[1]] = $result; + + return $result; + }, + $this->template + ); + } + + /** + * Get headers from message as string + */ + private function headers(MessageInterface $message): string + { + $result = ''; + foreach ($message->getHeaders() as $name => $values) { + $result .= $name.': '.\implode(', ', $values)."\r\n"; + } + + return \trim($result); + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/MessageFormatterInterface.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/MessageFormatterInterface.php new file mode 100644 index 0000000000..a39ac248ee --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/MessageFormatterInterface.php @@ -0,0 +1,18 @@ +<?php + +namespace GuzzleHttp; + +use Psr\Http\Message\RequestInterface; +use Psr\Http\Message\ResponseInterface; + +interface MessageFormatterInterface +{ + /** + * Returns a formatted message string. + * + * @param RequestInterface $request Request that was sent + * @param ResponseInterface|null $response Response that was received + * @param \Throwable|null $error Exception that was received + */ + public function format(RequestInterface $request, ?ResponseInterface $response = null, ?\Throwable $error = null): string; +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/Middleware.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/Middleware.php new file mode 100644 index 0000000000..6edbb3fe4f --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/Middleware.php @@ -0,0 +1,268 @@ +<?php + +namespace GuzzleHttp; + +use GuzzleHttp\Cookie\CookieJarInterface; +use GuzzleHttp\Exception\RequestException; +use GuzzleHttp\Promise as P; +use GuzzleHttp\Promise\PromiseInterface; +use Psr\Http\Message\RequestInterface; +use Psr\Http\Message\ResponseInterface; +use Psr\Log\LoggerInterface; + +/** + * Functions used to create and wrap handlers with handler middleware. + */ +final class Middleware +{ + /** + * Middleware that adds cookies to requests. + * + * The options array must be set to a CookieJarInterface in order to use + * cookies. This is typically handled for you by a client. + * + * @return callable Returns a function that accepts the next handler. + */ + public static function cookies(): callable + { + return static function (callable $handler): callable { + return static function ($request, array $options) use ($handler) { + if (empty($options['cookies'])) { + return $handler($request, $options); + } elseif (!($options['cookies'] instanceof CookieJarInterface)) { + throw new \InvalidArgumentException('cookies must be an instance of GuzzleHttp\Cookie\CookieJarInterface'); + } + $cookieJar = $options['cookies']; + $request = $cookieJar->withCookieHeader($request); + + return $handler($request, $options) + ->then( + static function (ResponseInterface $response) use ($cookieJar, $request): ResponseInterface { + $cookieJar->extractCookies($request, $response); + + return $response; + } + ); + }; + }; + } + + /** + * Middleware that throws exceptions for 4xx or 5xx responses when the + * "http_errors" request option is set to true. + * + * @param BodySummarizerInterface|null $bodySummarizer The body summarizer to use in exception messages. + * + * @return callable(callable): callable Returns a function that accepts the next handler. + */ + public static function httpErrors(?BodySummarizerInterface $bodySummarizer = null): callable + { + return static function (callable $handler) use ($bodySummarizer): callable { + return static function ($request, array $options) use ($handler, $bodySummarizer) { + if (empty($options['http_errors'])) { + return $handler($request, $options); + } + + return $handler($request, $options)->then( + static function (ResponseInterface $response) use ($request, $bodySummarizer) { + $code = $response->getStatusCode(); + if ($code < 400) { + return $response; + } + throw RequestException::create($request, $response, null, [], $bodySummarizer); + } + ); + }; + }; + } + + /** + * Middleware that pushes history data to an ArrayAccess container. + * + * @param array|\ArrayAccess<int, array> $container Container to hold the history (by reference). + * + * @return callable(callable): callable Returns a function that accepts the next handler. + * + * @throws \InvalidArgumentException if container is not an array or ArrayAccess. + */ + public static function history(&$container): callable + { + if (!\is_array($container) && !$container instanceof \ArrayAccess) { + throw new \InvalidArgumentException('history container must be an array or object implementing ArrayAccess'); + } + + return static function (callable $handler) use (&$container): callable { + return static function (RequestInterface $request, array $options) use ($handler, &$container) { + return $handler($request, $options)->then( + static function ($value) use ($request, &$container, $options) { + $container[] = [ + 'request' => $request, + 'response' => $value, + 'error' => null, + 'options' => $options, + ]; + + return $value; + }, + static function ($reason) use ($request, &$container, $options) { + $container[] = [ + 'request' => $request, + 'response' => null, + 'error' => $reason, + 'options' => $options, + ]; + + return P\Create::rejectionFor($reason); + } + ); + }; + }; + } + + /** + * Middleware that invokes a callback before and after sending a request. + * + * The provided listener cannot modify or alter the response. It simply + * "taps" into the chain to be notified before returning the promise. The + * before listener accepts a request and options array, and the after + * listener accepts a request, options array, and response promise. + * + * @param callable $before Function to invoke before forwarding the request. + * @param callable $after Function invoked after forwarding. + * + * @return callable Returns a function that accepts the next handler. + */ + public static function tap(?callable $before = null, ?callable $after = null): callable + { + return static function (callable $handler) use ($before, $after): callable { + return static function (RequestInterface $request, array $options) use ($handler, $before, $after) { + if ($before) { + $before($request, $options); + } + $response = $handler($request, $options); + if ($after) { + $after($request, $options, $response); + } + + return $response; + }; + }; + } + + /** + * Middleware that handles request redirects. + * + * @return callable Returns a function that accepts the next handler. + */ + public static function redirect(): callable + { + return static function (callable $handler): RedirectMiddleware { + return new RedirectMiddleware($handler); + }; + } + + /** + * Middleware that retries requests based on the boolean result of + * invoking the provided "decider" function. + * + * If no delay function is provided, a simple implementation of exponential + * backoff will be utilized. + * + * @param callable $decider Function that accepts the number of retries, + * a request, [response], and [exception] and + * returns true if the request is to be retried. + * @param callable $delay Function that accepts the number of retries and + * returns the number of milliseconds to delay. + * + * @return callable Returns a function that accepts the next handler. + */ + public static function retry(callable $decider, ?callable $delay = null): callable + { + return static function (callable $handler) use ($decider, $delay): RetryMiddleware { + return new RetryMiddleware($decider, $handler, $delay); + }; + } + + /** + * Middleware that logs requests, responses, and errors using a message + * formatter. + * + * @phpstan-param \Psr\Log\LogLevel::* $logLevel Level at which to log requests. + * + * @param LoggerInterface $logger Logs messages. + * @param MessageFormatterInterface|MessageFormatter $formatter Formatter used to create message strings. + * @param string $logLevel Level at which to log requests. + * + * @return callable Returns a function that accepts the next handler. + */ + public static function log(LoggerInterface $logger, $formatter, string $logLevel = 'info'): callable + { + // To be compatible with Guzzle 7.1.x we need to allow users to pass a MessageFormatter + if (!$formatter instanceof MessageFormatter && !$formatter instanceof MessageFormatterInterface) { + throw new \LogicException(sprintf('Argument 2 to %s::log() must be of type %s', self::class, MessageFormatterInterface::class)); + } + + return static function (callable $handler) use ($logger, $formatter, $logLevel): callable { + return static function (RequestInterface $request, array $options = []) use ($handler, $logger, $formatter, $logLevel) { + return $handler($request, $options)->then( + static function ($response) use ($logger, $request, $formatter, $logLevel): ResponseInterface { + $message = $formatter->format($request, $response); + $logger->log($logLevel, $message); + + return $response; + }, + static function ($reason) use ($logger, $request, $formatter): PromiseInterface { + $response = $reason instanceof RequestException ? $reason->getResponse() : null; + $message = $formatter->format($request, $response, P\Create::exceptionFor($reason)); + $logger->error($message); + + return P\Create::rejectionFor($reason); + } + ); + }; + }; + } + + /** + * This middleware adds a default content-type if possible, a default + * content-length or transfer-encoding header, and the expect header. + */ + public static function prepareBody(): callable + { + return static function (callable $handler): PrepareBodyMiddleware { + return new PrepareBodyMiddleware($handler); + }; + } + + /** + * Middleware that applies a map function to the request before passing to + * the next handler. + * + * @param callable $fn Function that accepts a RequestInterface and returns + * a RequestInterface. + */ + public static function mapRequest(callable $fn): callable + { + return static function (callable $handler) use ($fn): callable { + return static function (RequestInterface $request, array $options) use ($handler, $fn) { + return $handler($fn($request), $options); + }; + }; + } + + /** + * Middleware that applies a map function to the resolved promise's + * response. + * + * @param callable $fn Function that accepts a ResponseInterface and + * returns a ResponseInterface. + */ + public static function mapResponse(callable $fn): callable + { + return static function (callable $handler) use ($fn): callable { + return static function (RequestInterface $request, array $options) use ($handler, $fn) { + return $handler($request, $options)->then($fn); + }; + }; + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/PrepareBodyMiddleware.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/PrepareBodyMiddleware.php new file mode 100644 index 0000000000..7dde6c5f46 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/PrepareBodyMiddleware.php @@ -0,0 +1,105 @@ +<?php + +namespace GuzzleHttp; + +use GuzzleHttp\Promise\PromiseInterface; +use Psr\Http\Message\RequestInterface; + +/** + * Prepares requests that contain a body, adding the Content-Length, + * Content-Type, and Expect headers. + * + * @final + */ +class PrepareBodyMiddleware +{ + /** + * @var callable(RequestInterface, array): PromiseInterface + */ + private $nextHandler; + + /** + * @param callable(RequestInterface, array): PromiseInterface $nextHandler Next handler to invoke. + */ + public function __construct(callable $nextHandler) + { + $this->nextHandler = $nextHandler; + } + + public function __invoke(RequestInterface $request, array $options): PromiseInterface + { + $fn = $this->nextHandler; + + // Don't do anything if the request has no body. + if ($request->getBody()->getSize() === 0) { + return $fn($request, $options); + } + + $modify = []; + + // Add a default content-type if possible. + if (!$request->hasHeader('Content-Type')) { + if ($uri = $request->getBody()->getMetadata('uri')) { + if (is_string($uri) && $type = Psr7\MimeType::fromFilename($uri)) { + $modify['set_headers']['Content-Type'] = $type; + } + } + } + + // Add a default content-length or transfer-encoding header. + if (!$request->hasHeader('Content-Length') + && !$request->hasHeader('Transfer-Encoding') + ) { + $size = $request->getBody()->getSize(); + if ($size !== null) { + $modify['set_headers']['Content-Length'] = $size; + } else { + $modify['set_headers']['Transfer-Encoding'] = 'chunked'; + } + } + + // Add the expect header if needed. + $this->addExpectHeader($request, $options, $modify); + + return $fn(Psr7\Utils::modifyRequest($request, $modify), $options); + } + + /** + * Add expect header + */ + private function addExpectHeader(RequestInterface $request, array $options, array &$modify): void + { + // Determine if the Expect header should be used + if ($request->hasHeader('Expect')) { + return; + } + + $expect = $options['expect'] ?? null; + + // Return if disabled or using HTTP/1.0 + if ($expect === false || $request->getProtocolVersion() === '1.0') { + return; + } + + // The expect header is unconditionally enabled + if ($expect === true) { + $modify['set_headers']['Expect'] = '100-Continue'; + + return; + } + + // By default, send the expect header when the payload is > 1mb + if ($expect === null) { + $expect = 1048576; + } + + // Always add if the body cannot be rewound, the size cannot be + // determined, or the size is greater than the cutoff threshold + $body = $request->getBody(); + $size = $body->getSize(); + + if ($size === null || $size >= (int) $expect || !$body->isSeekable()) { + $modify['set_headers']['Expect'] = '100-Continue'; + } + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/RequestOptions.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/RequestOptions.php new file mode 100644 index 0000000000..84a3500e44 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/RequestOptions.php @@ -0,0 +1,274 @@ +<?php + +namespace GuzzleHttp; + +/** + * This class contains a list of built-in Guzzle request options. + * + * @see https://docs.guzzlephp.org/en/latest/request-options.html + */ +final class RequestOptions +{ + /** + * allow_redirects: (bool|array) Controls redirect behavior. Pass false + * to disable redirects, pass true to enable redirects, pass an + * associative to provide custom redirect settings. Defaults to "false". + * This option only works if your handler has the RedirectMiddleware. When + * passing an associative array, you can provide the following key value + * pairs: + * + * - max: (int, default=5) maximum number of allowed redirects. + * - strict: (bool, default=false) Set to true to use strict redirects + * meaning redirect POST requests with POST requests vs. doing what most + * browsers do which is redirect POST requests with GET requests + * - referer: (bool, default=false) Set to true to enable the Referer + * header. + * - protocols: (array, default=['http', 'https']) Allowed redirect + * protocols. + * - on_redirect: (callable) PHP callable that is invoked when a redirect + * is encountered. The callable is invoked with the request, the redirect + * response that was received, and the effective URI. Any return value + * from the on_redirect function is ignored. + */ + public const ALLOW_REDIRECTS = 'allow_redirects'; + + /** + * auth: (array) Pass an array of HTTP authentication parameters to use + * with the request. The array must contain the username in index [0], + * the password in index [1], and you can optionally provide a built-in + * authentication type in index [2]. Pass null to disable authentication + * for a request. + */ + public const AUTH = 'auth'; + + /** + * body: (resource|string|null|int|float|StreamInterface|callable|\Iterator) + * Body to send in the request. + */ + public const BODY = 'body'; + + /** + * cert: (string|array) Set to a string to specify the path to a file + * containing a PEM formatted SSL client side certificate. If a password + * is required, then set cert to an array containing the path to the PEM + * file in the first array element followed by the certificate password + * in the second array element. + */ + public const CERT = 'cert'; + + /** + * cookies: (bool|GuzzleHttp\Cookie\CookieJarInterface, default=false) + * Specifies whether or not cookies are used in a request or what cookie + * jar to use or what cookies to send. This option only works if your + * handler has the `cookie` middleware. Valid values are `false` and + * an instance of {@see Cookie\CookieJarInterface}. + */ + public const COOKIES = 'cookies'; + + /** + * connect_timeout: (float, default=0) Float describing the number of + * seconds to wait while trying to connect to a server. Use 0 to wait + * 300 seconds (the default behavior). + */ + public const CONNECT_TIMEOUT = 'connect_timeout'; + + /** + * crypto_method: (int) A value describing the minimum TLS protocol + * version to use. + * + * This setting must be set to one of the + * ``STREAM_CRYPTO_METHOD_TLS*_CLIENT`` constants. PHP 7.4 or higher is + * required in order to use TLS 1.3, and cURL 7.34.0 or higher is required + * in order to specify a crypto method, with cURL 7.52.0 or higher being + * required to use TLS 1.3. + */ + public const CRYPTO_METHOD = 'crypto_method'; + + /** + * debug: (bool|resource) Set to true or set to a PHP stream returned by + * fopen() enable debug output with the HTTP handler used to send a + * request. + */ + public const DEBUG = 'debug'; + + /** + * decode_content: (bool, default=true) Specify whether or not + * Content-Encoding responses (gzip, deflate, etc.) are automatically + * decoded. + */ + public const DECODE_CONTENT = 'decode_content'; + + /** + * delay: (int) The amount of time to delay before sending in milliseconds. + */ + public const DELAY = 'delay'; + + /** + * expect: (bool|integer) Controls the behavior of the + * "Expect: 100-Continue" header. + * + * Set to `true` to enable the "Expect: 100-Continue" header for all + * requests that sends a body. Set to `false` to disable the + * "Expect: 100-Continue" header for all requests. Set to a number so that + * the size of the payload must be greater than the number in order to send + * the Expect header. Setting to a number will send the Expect header for + * all requests in which the size of the payload cannot be determined or + * where the body is not rewindable. + * + * By default, Guzzle will add the "Expect: 100-Continue" header when the + * size of the body of a request is greater than 1 MB and a request is + * using HTTP/1.1. + */ + public const EXPECT = 'expect'; + + /** + * form_params: (array) Associative array of form field names to values + * where each value is a string or array of strings. Sets the Content-Type + * header to application/x-www-form-urlencoded when no Content-Type header + * is already present. + */ + public const FORM_PARAMS = 'form_params'; + + /** + * headers: (array) Associative array of HTTP headers. Each value MUST be + * a string or array of strings. + */ + public const HEADERS = 'headers'; + + /** + * http_errors: (bool, default=true) Set to false to disable exceptions + * when a non- successful HTTP response is received. By default, + * exceptions will be thrown for 4xx and 5xx responses. This option only + * works if your handler has the `httpErrors` middleware. + */ + public const HTTP_ERRORS = 'http_errors'; + + /** + * idn: (bool|int, default=true) A combination of IDNA_* constants for + * idn_to_ascii() PHP's function (see "options" parameter). Set to false to + * disable IDN support completely, or to true to use the default + * configuration (IDNA_DEFAULT constant). + */ + public const IDN_CONVERSION = 'idn_conversion'; + + /** + * json: (mixed) Adds JSON data to a request. The provided value is JSON + * encoded and a Content-Type header of application/json will be added to + * the request if no Content-Type header is already present. + */ + public const JSON = 'json'; + + /** + * multipart: (array) Array of associative arrays, each containing a + * required "name" key mapping to the form field, name, a required + * "contents" key mapping to a StreamInterface|resource|string, an + * optional "headers" associative array of custom headers, and an + * optional "filename" key mapping to a string to send as the filename in + * the part. If no "filename" key is present, then no "filename" attribute + * will be added to the part. + */ + public const MULTIPART = 'multipart'; + + /** + * on_headers: (callable) A callable that is invoked when the HTTP headers + * of the response have been received but the body has not yet begun to + * download. + */ + public const ON_HEADERS = 'on_headers'; + + /** + * on_stats: (callable) allows you to get access to transfer statistics of + * a request and access the lower level transfer details of the handler + * associated with your client. ``on_stats`` is a callable that is invoked + * when a handler has finished sending a request. The callback is invoked + * with transfer statistics about the request, the response received, or + * the error encountered. Included in the data is the total amount of time + * taken to send the request. + */ + public const ON_STATS = 'on_stats'; + + /** + * progress: (callable) Defines a function to invoke when transfer + * progress is made. The function accepts the following positional + * arguments: the total number of bytes expected to be downloaded, the + * number of bytes downloaded so far, the number of bytes expected to be + * uploaded, the number of bytes uploaded so far. + */ + public const PROGRESS = 'progress'; + + /** + * proxy: (string|array) Pass a string to specify an HTTP proxy, or an + * array to specify different proxies for different protocols (where the + * key is the protocol and the value is a proxy string). + */ + public const PROXY = 'proxy'; + + /** + * query: (array|string) Associative array of query string values to add + * to the request. This option uses PHP's http_build_query() to create + * the string representation. Pass a string value if you need more + * control than what this method provides + */ + public const QUERY = 'query'; + + /** + * sink: (resource|string|StreamInterface) Where the data of the + * response is written to. Defaults to a PHP temp stream. Providing a + * string will write data to a file by the given name. + */ + public const SINK = 'sink'; + + /** + * synchronous: (bool) Set to true to inform HTTP handlers that you intend + * on waiting on the response. This can be useful for optimizations. Note + * that a promise is still returned if you are using one of the async + * client methods. + */ + public const SYNCHRONOUS = 'synchronous'; + + /** + * ssl_key: (array|string) Specify the path to a file containing a private + * SSL key in PEM format. If a password is required, then set to an array + * containing the path to the SSL key in the first array element followed + * by the password required for the certificate in the second element. + */ + public const SSL_KEY = 'ssl_key'; + + /** + * stream: Set to true to attempt to stream a response rather than + * download it all up-front. + */ + public const STREAM = 'stream'; + + /** + * verify: (bool|string, default=true) Describes the SSL certificate + * verification behavior of a request. Set to true to enable SSL + * certificate verification using the system CA bundle when available + * (the default). Set to false to disable certificate verification (this + * is insecure!). Set to a string to provide the path to a CA bundle on + * disk to enable verification using a custom certificate. + */ + public const VERIFY = 'verify'; + + /** + * timeout: (float, default=0) Float describing the timeout of the + * request in seconds. Use 0 to wait indefinitely (the default behavior). + */ + public const TIMEOUT = 'timeout'; + + /** + * read_timeout: (float, default=default_socket_timeout ini setting) Float describing + * the body read timeout, for stream requests. + */ + public const READ_TIMEOUT = 'read_timeout'; + + /** + * version: (float) Specifies the HTTP protocol version to attempt to use. + */ + public const VERSION = 'version'; + + /** + * force_ip_resolve: (bool) Force client to use only ipv4 or ipv6 protocol + */ + public const FORCE_IP_RESOLVE = 'force_ip_resolve'; +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/RetryMiddleware.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/RetryMiddleware.php new file mode 100644 index 0000000000..65f49cb759 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/RetryMiddleware.php @@ -0,0 +1,119 @@ +<?php + +namespace GuzzleHttp; + +use GuzzleHttp\Promise as P; +use GuzzleHttp\Promise\PromiseInterface; +use Psr\Http\Message\RequestInterface; +use Psr\Http\Message\ResponseInterface; + +/** + * Middleware that retries requests based on the boolean result of + * invoking the provided "decider" function. + * + * @final + */ +class RetryMiddleware +{ + /** + * @var callable(RequestInterface, array): PromiseInterface + */ + private $nextHandler; + + /** + * @var callable + */ + private $decider; + + /** + * @var callable(int) + */ + private $delay; + + /** + * @param callable $decider Function that accepts the number of retries, + * a request, [response], and [exception] and + * returns true if the request is to be + * retried. + * @param callable(RequestInterface, array): PromiseInterface $nextHandler Next handler to invoke. + * @param (callable(int): int)|null $delay Function that accepts the number of retries + * and returns the number of + * milliseconds to delay. + */ + public function __construct(callable $decider, callable $nextHandler, ?callable $delay = null) + { + $this->decider = $decider; + $this->nextHandler = $nextHandler; + $this->delay = $delay ?: __CLASS__.'::exponentialDelay'; + } + + /** + * Default exponential backoff delay function. + * + * @return int milliseconds. + */ + public static function exponentialDelay(int $retries): int + { + return (int) 2 ** ($retries - 1) * 1000; + } + + public function __invoke(RequestInterface $request, array $options): PromiseInterface + { + if (!isset($options['retries'])) { + $options['retries'] = 0; + } + + $fn = $this->nextHandler; + + return $fn($request, $options) + ->then( + $this->onFulfilled($request, $options), + $this->onRejected($request, $options) + ); + } + + /** + * Execute fulfilled closure + */ + private function onFulfilled(RequestInterface $request, array $options): callable + { + return function ($value) use ($request, $options) { + if (!($this->decider)( + $options['retries'], + $request, + $value, + null + )) { + return $value; + } + + return $this->doRetry($request, $options, $value); + }; + } + + /** + * Execute rejected closure + */ + private function onRejected(RequestInterface $req, array $options): callable + { + return function ($reason) use ($req, $options) { + if (!($this->decider)( + $options['retries'], + $req, + null, + $reason + )) { + return P\Create::rejectionFor($reason); + } + + return $this->doRetry($req, $options); + }; + } + + private function doRetry(RequestInterface $request, array $options, ?ResponseInterface $response = null): PromiseInterface + { + $options['delay'] = ($this->delay)(++$options['retries'], $response, $request); + + return $this($request, $options); + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/TransferStats.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/TransferStats.php new file mode 100644 index 0000000000..93fa334c8d --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/TransferStats.php @@ -0,0 +1,133 @@ +<?php + +namespace GuzzleHttp; + +use Psr\Http\Message\RequestInterface; +use Psr\Http\Message\ResponseInterface; +use Psr\Http\Message\UriInterface; + +/** + * Represents data at the point after it was transferred either successfully + * or after a network error. + */ +final class TransferStats +{ + /** + * @var RequestInterface + */ + private $request; + + /** + * @var ResponseInterface|null + */ + private $response; + + /** + * @var float|null + */ + private $transferTime; + + /** + * @var array + */ + private $handlerStats; + + /** + * @var mixed|null + */ + private $handlerErrorData; + + /** + * @param RequestInterface $request Request that was sent. + * @param ResponseInterface|null $response Response received (if any) + * @param float|null $transferTime Total handler transfer time. + * @param mixed $handlerErrorData Handler error data. + * @param array $handlerStats Handler specific stats. + */ + public function __construct( + RequestInterface $request, + ?ResponseInterface $response = null, + ?float $transferTime = null, + $handlerErrorData = null, + array $handlerStats = [] + ) { + $this->request = $request; + $this->response = $response; + $this->transferTime = $transferTime; + $this->handlerErrorData = $handlerErrorData; + $this->handlerStats = $handlerStats; + } + + public function getRequest(): RequestInterface + { + return $this->request; + } + + /** + * Returns the response that was received (if any). + */ + public function getResponse(): ?ResponseInterface + { + return $this->response; + } + + /** + * Returns true if a response was received. + */ + public function hasResponse(): bool + { + return $this->response !== null; + } + + /** + * Gets handler specific error data. + * + * This might be an exception, a integer representing an error code, or + * anything else. Relying on this value assumes that you know what handler + * you are using. + * + * @return mixed + */ + public function getHandlerErrorData() + { + return $this->handlerErrorData; + } + + /** + * Get the effective URI the request was sent to. + */ + public function getEffectiveUri(): UriInterface + { + return $this->request->getUri(); + } + + /** + * Get the estimated time the request was being transferred by the handler. + * + * @return float|null Time in seconds. + */ + public function getTransferTime(): ?float + { + return $this->transferTime; + } + + /** + * Gets an array of all of the handler specific transfer data. + */ + public function getHandlerStats(): array + { + return $this->handlerStats; + } + + /** + * Get a specific handler statistic from the handler by name. + * + * @param string $stat Handler specific transfer stat to retrieve. + * + * @return mixed|null + */ + public function getHandlerStat(string $stat) + { + return $this->handlerStats[$stat] ?? null; + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/Utils.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/Utils.php new file mode 100644 index 0000000000..df529270e1 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/guzzle/src/Utils.php @@ -0,0 +1,384 @@ +<?php + +namespace GuzzleHttp; + +use GuzzleHttp\Exception\InvalidArgumentException; +use GuzzleHttp\Handler\CurlHandler; +use GuzzleHttp\Handler\CurlMultiHandler; +use GuzzleHttp\Handler\Proxy; +use GuzzleHttp\Handler\StreamHandler; +use Psr\Http\Message\UriInterface; + +final class Utils +{ + /** + * Debug function used to describe the provided value type and class. + * + * @param mixed $input + * + * @return string Returns a string containing the type of the variable and + * if a class is provided, the class name. + */ + public static function describeType($input): string + { + switch (\gettype($input)) { + case 'object': + return 'object('.\get_class($input).')'; + case 'array': + return 'array('.\count($input).')'; + default: + \ob_start(); + \var_dump($input); + // normalize float vs double + /** @var string $varDumpContent */ + $varDumpContent = \ob_get_clean(); + + return \str_replace('double(', 'float(', \rtrim($varDumpContent)); + } + } + + /** + * Parses an array of header lines into an associative array of headers. + * + * @param iterable $lines Header lines array of strings in the following + * format: "Name: Value" + */ + public static function headersFromLines(iterable $lines): array + { + $headers = []; + + foreach ($lines as $line) { + $parts = \explode(':', $line, 2); + $headers[\trim($parts[0])][] = isset($parts[1]) ? \trim($parts[1]) : null; + } + + return $headers; + } + + /** + * Returns a debug stream based on the provided variable. + * + * @param mixed $value Optional value + * + * @return resource + */ + public static function debugResource($value = null) + { + if (\is_resource($value)) { + return $value; + } + if (\defined('STDOUT')) { + return \STDOUT; + } + + return Psr7\Utils::tryFopen('php://output', 'w'); + } + + /** + * Chooses and creates a default handler to use based on the environment. + * + * The returned handler is not wrapped by any default middlewares. + * + * @return callable(\Psr\Http\Message\RequestInterface, array): \GuzzleHttp\Promise\PromiseInterface Returns the best handler for the given system. + * + * @throws \RuntimeException if no viable Handler is available. + */ + public static function chooseHandler(): callable + { + $handler = null; + + if (\defined('CURLOPT_CUSTOMREQUEST') && \function_exists('curl_version') && version_compare(curl_version()['version'], '7.21.2') >= 0) { + if (\function_exists('curl_multi_exec') && \function_exists('curl_exec')) { + $handler = Proxy::wrapSync(new CurlMultiHandler(), new CurlHandler()); + } elseif (\function_exists('curl_exec')) { + $handler = new CurlHandler(); + } elseif (\function_exists('curl_multi_exec')) { + $handler = new CurlMultiHandler(); + } + } + + if (\ini_get('allow_url_fopen')) { + $handler = $handler + ? Proxy::wrapStreaming($handler, new StreamHandler()) + : new StreamHandler(); + } elseif (!$handler) { + throw new \RuntimeException('GuzzleHttp requires cURL, the allow_url_fopen ini setting, or a custom HTTP handler.'); + } + + return $handler; + } + + /** + * Get the default User-Agent string to use with Guzzle. + */ + public static function defaultUserAgent(): string + { + return sprintf('GuzzleHttp/%d', ClientInterface::MAJOR_VERSION); + } + + /** + * Returns the default cacert bundle for the current system. + * + * First, the openssl.cafile and curl.cainfo php.ini settings are checked. + * If those settings are not configured, then the common locations for + * bundles found on Red Hat, CentOS, Fedora, Ubuntu, Debian, FreeBSD, OS X + * and Windows are checked. If any of these file locations are found on + * disk, they will be utilized. + * + * Note: the result of this function is cached for subsequent calls. + * + * @throws \RuntimeException if no bundle can be found. + * + * @deprecated Utils::defaultCaBundle will be removed in guzzlehttp/guzzle:8.0. This method is not needed in PHP 5.6+. + */ + public static function defaultCaBundle(): string + { + static $cached = null; + static $cafiles = [ + // Red Hat, CentOS, Fedora (provided by the ca-certificates package) + '/etc/pki/tls/certs/ca-bundle.crt', + // Ubuntu, Debian (provided by the ca-certificates package) + '/etc/ssl/certs/ca-certificates.crt', + // FreeBSD (provided by the ca_root_nss package) + '/usr/local/share/certs/ca-root-nss.crt', + // SLES 12 (provided by the ca-certificates package) + '/var/lib/ca-certificates/ca-bundle.pem', + // OS X provided by homebrew (using the default path) + '/usr/local/etc/openssl/cert.pem', + // Google app engine + '/etc/ca-certificates.crt', + // Windows? + 'C:\\windows\\system32\\curl-ca-bundle.crt', + 'C:\\windows\\curl-ca-bundle.crt', + ]; + + if ($cached) { + return $cached; + } + + if ($ca = \ini_get('openssl.cafile')) { + return $cached = $ca; + } + + if ($ca = \ini_get('curl.cainfo')) { + return $cached = $ca; + } + + foreach ($cafiles as $filename) { + if (\file_exists($filename)) { + return $cached = $filename; + } + } + + throw new \RuntimeException( + <<< EOT +No system CA bundle could be found in any of the the common system locations. +PHP versions earlier than 5.6 are not properly configured to use the system's +CA bundle by default. In order to verify peer certificates, you will need to +supply the path on disk to a certificate bundle to the 'verify' request +option: https://docs.guzzlephp.org/en/latest/request-options.html#verify. If +you do not need a specific certificate bundle, then Mozilla provides a commonly +used CA bundle which can be downloaded here (provided by the maintainer of +cURL): https://curl.haxx.se/ca/cacert.pem. Once you have a CA bundle available +on disk, you can set the 'openssl.cafile' PHP ini setting to point to the path +to the file, allowing you to omit the 'verify' request option. See +https://curl.haxx.se/docs/sslcerts.html for more information. +EOT + ); + } + + /** + * Creates an associative array of lowercase header names to the actual + * header casing. + */ + public static function normalizeHeaderKeys(array $headers): array + { + $result = []; + foreach (\array_keys($headers) as $key) { + $result[\strtolower($key)] = $key; + } + + return $result; + } + + /** + * Returns true if the provided host matches any of the no proxy areas. + * + * This method will strip a port from the host if it is present. Each pattern + * can be matched with an exact match (e.g., "foo.com" == "foo.com") or a + * partial match: (e.g., "foo.com" == "baz.foo.com" and ".foo.com" == + * "baz.foo.com", but ".foo.com" != "foo.com"). + * + * Areas are matched in the following cases: + * 1. "*" (without quotes) always matches any hosts. + * 2. An exact match. + * 3. The area starts with "." and the area is the last part of the host. e.g. + * '.mit.edu' will match any host that ends with '.mit.edu'. + * + * @param string $host Host to check against the patterns. + * @param string[] $noProxyArray An array of host patterns. + * + * @throws InvalidArgumentException + */ + public static function isHostInNoProxy(string $host, array $noProxyArray): bool + { + if (\strlen($host) === 0) { + throw new InvalidArgumentException('Empty host provided'); + } + + // Strip port if present. + [$host] = \explode(':', $host, 2); + + foreach ($noProxyArray as $area) { + // Always match on wildcards. + if ($area === '*') { + return true; + } + + if (empty($area)) { + // Don't match on empty values. + continue; + } + + if ($area === $host) { + // Exact matches. + return true; + } + // Special match if the area when prefixed with ".". Remove any + // existing leading "." and add a new leading ".". + $area = '.'.\ltrim($area, '.'); + if (\substr($host, -\strlen($area)) === $area) { + return true; + } + } + + return false; + } + + /** + * Wrapper for json_decode that throws when an error occurs. + * + * @param string $json JSON data to parse + * @param bool $assoc When true, returned objects will be converted + * into associative arrays. + * @param int $depth User specified recursion depth. + * @param int $options Bitmask of JSON decode options. + * + * @return object|array|string|int|float|bool|null + * + * @throws InvalidArgumentException if the JSON cannot be decoded. + * + * @see https://www.php.net/manual/en/function.json-decode.php + */ + public static function jsonDecode(string $json, bool $assoc = false, int $depth = 512, int $options = 0) + { + $data = \json_decode($json, $assoc, $depth, $options); + if (\JSON_ERROR_NONE !== \json_last_error()) { + throw new InvalidArgumentException('json_decode error: '.\json_last_error_msg()); + } + + return $data; + } + + /** + * Wrapper for JSON encoding that throws when an error occurs. + * + * @param mixed $value The value being encoded + * @param int $options JSON encode option bitmask + * @param int $depth Set the maximum depth. Must be greater than zero. + * + * @throws InvalidArgumentException if the JSON cannot be encoded. + * + * @see https://www.php.net/manual/en/function.json-encode.php + */ + public static function jsonEncode($value, int $options = 0, int $depth = 512): string + { + $json = \json_encode($value, $options, $depth); + if (\JSON_ERROR_NONE !== \json_last_error()) { + throw new InvalidArgumentException('json_encode error: '.\json_last_error_msg()); + } + + /** @var string */ + return $json; + } + + /** + * Wrapper for the hrtime() or microtime() functions + * (depending on the PHP version, one of the two is used) + * + * @return float UNIX timestamp + * + * @internal + */ + public static function currentTime(): float + { + return (float) \function_exists('hrtime') ? \hrtime(true) / 1e9 : \microtime(true); + } + + /** + * @throws InvalidArgumentException + * + * @internal + */ + public static function idnUriConvert(UriInterface $uri, int $options = 0): UriInterface + { + if ($uri->getHost()) { + $asciiHost = self::idnToAsci($uri->getHost(), $options, $info); + if ($asciiHost === false) { + $errorBitSet = $info['errors'] ?? 0; + + $errorConstants = array_filter(array_keys(get_defined_constants()), static function (string $name): bool { + return substr($name, 0, 11) === 'IDNA_ERROR_'; + }); + + $errors = []; + foreach ($errorConstants as $errorConstant) { + if ($errorBitSet & constant($errorConstant)) { + $errors[] = $errorConstant; + } + } + + $errorMessage = 'IDN conversion failed'; + if ($errors) { + $errorMessage .= ' (errors: '.implode(', ', $errors).')'; + } + + throw new InvalidArgumentException($errorMessage); + } + if ($uri->getHost() !== $asciiHost) { + // Replace URI only if the ASCII version is different + $uri = $uri->withHost($asciiHost); + } + } + + return $uri; + } + + /** + * @internal + */ + public static function getenv(string $name): ?string + { + if (isset($_SERVER[$name])) { + return (string) $_SERVER[$name]; + } + + if (\PHP_SAPI === 'cli' && ($value = \getenv($name)) !== false && $value !== null) { + return (string) $value; + } + + return null; + } + + /** + * @return string|false + */ + private static function idnToAsci(string $domain, int $options, ?array &$info = []) + { + if (\function_exists('idn_to_ascii') && \defined('INTL_IDNA_VARIANT_UTS46')) { + return \idn_to_ascii($domain, $options, \INTL_IDNA_VARIANT_UTS46, $info); + } + + throw new \Error('ext-idn or symfony/polyfill-intl-idn not loaded or too old'); + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/promises/composer.json b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/promises/composer.json new file mode 100644 index 0000000000..f64ed7714e --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/promises/composer.json @@ -0,0 +1,58 @@ +{ + "name": "guzzlehttp/promises", + "description": "Guzzle promises library", + "keywords": ["promise"], + "license": "MIT", + "authors": [ + { + "name": "Graham Campbell", + "email": "hello@gjcampbell.co.uk", + "homepage": "https://github.com/GrahamCampbell" + }, + { + "name": "Michael Dowling", + "email": "mtdowling@gmail.com", + "homepage": "https://github.com/mtdowling" + }, + { + "name": "Tobias Nyholm", + "email": "tobias.nyholm@gmail.com", + "homepage": "https://github.com/Nyholm" + }, + { + "name": "Tobias Schultze", + "email": "webmaster@tubo-world.de", + "homepage": "https://github.com/Tobion" + } + ], + "require": { + "php": "^7.2.5 || ^8.0" + }, + "require-dev": { + "bamarni/composer-bin-plugin": "^1.8.2", + "phpunit/phpunit": "^8.5.39 || ^9.6.20" + }, + "autoload": { + "psr-4": { + "GuzzleHttp\\Promise\\": "src/" + } + }, + "autoload-dev": { + "psr-4": { + "GuzzleHttp\\Promise\\Tests\\": "tests/" + } + }, + "extra": { + "bamarni-bin": { + "bin-links": true, + "forward-command": false + } + }, + "config": { + "allow-plugins": { + "bamarni/composer-bin-plugin": true + }, + "preferred-install": "dist", + "sort-packages": true + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/promises/src/Coroutine.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/promises/src/Coroutine.php new file mode 100644 index 0000000000..0da0228344 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/promises/src/Coroutine.php @@ -0,0 +1,162 @@ +<?php + +declare(strict_types=1); + +namespace GuzzleHttp\Promise; + +use Generator; +use Throwable; + +/** + * Creates a promise that is resolved using a generator that yields values or + * promises (somewhat similar to C#'s async keyword). + * + * When called, the Coroutine::of method will start an instance of the generator + * and returns a promise that is fulfilled with its final yielded value. + * + * Control is returned back to the generator when the yielded promise settles. + * This can lead to less verbose code when doing lots of sequential async calls + * with minimal processing in between. + * + * use GuzzleHttp\Promise; + * + * function createPromise($value) { + * return new Promise\FulfilledPromise($value); + * } + * + * $promise = Promise\Coroutine::of(function () { + * $value = (yield createPromise('a')); + * try { + * $value = (yield createPromise($value . 'b')); + * } catch (\Throwable $e) { + * // The promise was rejected. + * } + * yield $value . 'c'; + * }); + * + * // Outputs "abc" + * $promise->then(function ($v) { echo $v; }); + * + * @param callable $generatorFn Generator function to wrap into a promise. + * + * @return Promise + * + * @see https://github.com/petkaantonov/bluebird/blob/master/API.md#generators inspiration + */ +final class Coroutine implements PromiseInterface +{ + /** + * @var PromiseInterface|null + */ + private $currentPromise; + + /** + * @var Generator + */ + private $generator; + + /** + * @var Promise + */ + private $result; + + public function __construct(callable $generatorFn) + { + $this->generator = $generatorFn(); + $this->result = new Promise(function (): void { + while (isset($this->currentPromise)) { + $this->currentPromise->wait(); + } + }); + try { + $this->nextCoroutine($this->generator->current()); + } catch (Throwable $throwable) { + $this->result->reject($throwable); + } + } + + /** + * Create a new coroutine. + */ + public static function of(callable $generatorFn): self + { + return new self($generatorFn); + } + + public function then( + ?callable $onFulfilled = null, + ?callable $onRejected = null + ): PromiseInterface { + return $this->result->then($onFulfilled, $onRejected); + } + + public function otherwise(callable $onRejected): PromiseInterface + { + return $this->result->otherwise($onRejected); + } + + public function wait(bool $unwrap = true) + { + return $this->result->wait($unwrap); + } + + public function getState(): string + { + return $this->result->getState(); + } + + public function resolve($value): void + { + $this->result->resolve($value); + } + + public function reject($reason): void + { + $this->result->reject($reason); + } + + public function cancel(): void + { + $this->currentPromise->cancel(); + $this->result->cancel(); + } + + private function nextCoroutine($yielded): void + { + $this->currentPromise = Create::promiseFor($yielded) + ->then([$this, '_handleSuccess'], [$this, '_handleFailure']); + } + + /** + * @internal + */ + public function _handleSuccess($value): void + { + unset($this->currentPromise); + try { + $next = $this->generator->send($value); + if ($this->generator->valid()) { + $this->nextCoroutine($next); + } else { + $this->result->resolve($value); + } + } catch (Throwable $throwable) { + $this->result->reject($throwable); + } + } + + /** + * @internal + */ + public function _handleFailure($reason): void + { + unset($this->currentPromise); + try { + $nextYield = $this->generator->throw(Create::exceptionFor($reason)); + // The throw was caught, so keep iterating on the coroutine + $this->nextCoroutine($nextYield); + } catch (Throwable $throwable) { + $this->result->reject($throwable); + } + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/promises/src/Each.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/promises/src/Each.php new file mode 100644 index 0000000000..dd72c8310b --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/promises/src/Each.php @@ -0,0 +1,81 @@ +<?php + +declare(strict_types=1); + +namespace GuzzleHttp\Promise; + +final class Each +{ + /** + * Given an iterator that yields promises or values, returns a promise that + * is fulfilled with a null value when the iterator has been consumed or + * the aggregate promise has been fulfilled or rejected. + * + * $onFulfilled is a function that accepts the fulfilled value, iterator + * index, and the aggregate promise. The callback can invoke any necessary + * side effects and choose to resolve or reject the aggregate if needed. + * + * $onRejected is a function that accepts the rejection reason, iterator + * index, and the aggregate promise. The callback can invoke any necessary + * side effects and choose to resolve or reject the aggregate if needed. + * + * @param mixed $iterable Iterator or array to iterate over. + */ + public static function of( + $iterable, + ?callable $onFulfilled = null, + ?callable $onRejected = null + ): PromiseInterface { + return (new EachPromise($iterable, [ + 'fulfilled' => $onFulfilled, + 'rejected' => $onRejected, + ]))->promise(); + } + + /** + * Like of, but only allows a certain number of outstanding promises at any + * given time. + * + * $concurrency may be an integer or a function that accepts the number of + * pending promises and returns a numeric concurrency limit value to allow + * for dynamic a concurrency size. + * + * @param mixed $iterable + * @param int|callable $concurrency + */ + public static function ofLimit( + $iterable, + $concurrency, + ?callable $onFulfilled = null, + ?callable $onRejected = null + ): PromiseInterface { + return (new EachPromise($iterable, [ + 'fulfilled' => $onFulfilled, + 'rejected' => $onRejected, + 'concurrency' => $concurrency, + ]))->promise(); + } + + /** + * Like limit, but ensures that no promise in the given $iterable argument + * is rejected. If any promise is rejected, then the aggregate promise is + * rejected with the encountered rejection. + * + * @param mixed $iterable + * @param int|callable $concurrency + */ + public static function ofLimitAll( + $iterable, + $concurrency, + ?callable $onFulfilled = null + ): PromiseInterface { + return self::ofLimit( + $iterable, + $concurrency, + $onFulfilled, + function ($reason, $idx, PromiseInterface $aggregate): void { + $aggregate->reject($reason); + } + ); + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/promises/src/FulfilledPromise.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/promises/src/FulfilledPromise.php new file mode 100644 index 0000000000..727ec315c4 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/promises/src/FulfilledPromise.php @@ -0,0 +1,89 @@ +<?php + +declare(strict_types=1); + +namespace GuzzleHttp\Promise; + +/** + * A promise that has been fulfilled. + * + * Thenning off of this promise will invoke the onFulfilled callback + * immediately and ignore other callbacks. + * + * @final + */ +class FulfilledPromise implements PromiseInterface +{ + private $value; + + /** + * @param mixed $value + */ + public function __construct($value) + { + if (is_object($value) && method_exists($value, 'then')) { + throw new \InvalidArgumentException( + 'You cannot create a FulfilledPromise with a promise.' + ); + } + + $this->value = $value; + } + + public function then( + ?callable $onFulfilled = null, + ?callable $onRejected = null + ): PromiseInterface { + // Return itself if there is no onFulfilled function. + if (!$onFulfilled) { + return $this; + } + + $queue = Utils::queue(); + $p = new Promise([$queue, 'run']); + $value = $this->value; + $queue->add(static function () use ($p, $value, $onFulfilled): void { + if (Is::pending($p)) { + try { + $p->resolve($onFulfilled($value)); + } catch (\Throwable $e) { + $p->reject($e); + } + } + }); + + return $p; + } + + public function otherwise(callable $onRejected): PromiseInterface + { + return $this->then(null, $onRejected); + } + + public function wait(bool $unwrap = true) + { + return $unwrap ? $this->value : null; + } + + public function getState(): string + { + return self::FULFILLED; + } + + public function resolve($value): void + { + if ($value !== $this->value) { + throw new \LogicException('Cannot resolve a fulfilled promise'); + } + } + + public function reject($reason): void + { + throw new \LogicException('Cannot reject a fulfilled promise'); + } + + public function cancel(): void + { + // pass + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/promises/src/Promise.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/promises/src/Promise.php new file mode 100644 index 0000000000..c0c5be2c09 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/promises/src/Promise.php @@ -0,0 +1,281 @@ +<?php + +declare(strict_types=1); + +namespace GuzzleHttp\Promise; + +/** + * Promises/A+ implementation that avoids recursion when possible. + * + * @see https://promisesaplus.com/ + * + * @final + */ +class Promise implements PromiseInterface +{ + private $state = self::PENDING; + private $result; + private $cancelFn; + private $waitFn; + private $waitList; + private $handlers = []; + + /** + * @param callable $waitFn Fn that when invoked resolves the promise. + * @param callable $cancelFn Fn that when invoked cancels the promise. + */ + public function __construct( + ?callable $waitFn = null, + ?callable $cancelFn = null + ) { + $this->waitFn = $waitFn; + $this->cancelFn = $cancelFn; + } + + public function then( + ?callable $onFulfilled = null, + ?callable $onRejected = null + ): PromiseInterface { + if ($this->state === self::PENDING) { + $p = new Promise(null, [$this, 'cancel']); + $this->handlers[] = [$p, $onFulfilled, $onRejected]; + $p->waitList = $this->waitList; + $p->waitList[] = $this; + + return $p; + } + + // Return a fulfilled promise and immediately invoke any callbacks. + if ($this->state === self::FULFILLED) { + $promise = Create::promiseFor($this->result); + + return $onFulfilled ? $promise->then($onFulfilled) : $promise; + } + + // It's either cancelled or rejected, so return a rejected promise + // and immediately invoke any callbacks. + $rejection = Create::rejectionFor($this->result); + + return $onRejected ? $rejection->then(null, $onRejected) : $rejection; + } + + public function otherwise(callable $onRejected): PromiseInterface + { + return $this->then(null, $onRejected); + } + + public function wait(bool $unwrap = true) + { + $this->waitIfPending(); + + if ($this->result instanceof PromiseInterface) { + return $this->result->wait($unwrap); + } + if ($unwrap) { + if ($this->state === self::FULFILLED) { + return $this->result; + } + // It's rejected so "unwrap" and throw an exception. + throw Create::exceptionFor($this->result); + } + } + + public function getState(): string + { + return $this->state; + } + + public function cancel(): void + { + if ($this->state !== self::PENDING) { + return; + } + + $this->waitFn = $this->waitList = null; + + if ($this->cancelFn) { + $fn = $this->cancelFn; + $this->cancelFn = null; + try { + $fn(); + } catch (\Throwable $e) { + $this->reject($e); + } + } + + // Reject the promise only if it wasn't rejected in a then callback. + /** @psalm-suppress RedundantCondition */ + if ($this->state === self::PENDING) { + $this->reject(new CancellationException('Promise has been cancelled')); + } + } + + public function resolve($value): void + { + $this->settle(self::FULFILLED, $value); + } + + public function reject($reason): void + { + $this->settle(self::REJECTED, $reason); + } + + private function settle(string $state, $value): void + { + if ($this->state !== self::PENDING) { + // Ignore calls with the same resolution. + if ($state === $this->state && $value === $this->result) { + return; + } + throw $this->state === $state + ? new \LogicException("The promise is already {$state}.") + : new \LogicException("Cannot change a {$this->state} promise to {$state}"); + } + + if ($value === $this) { + throw new \LogicException('Cannot fulfill or reject a promise with itself'); + } + + // Clear out the state of the promise but stash the handlers. + $this->state = $state; + $this->result = $value; + $handlers = $this->handlers; + $this->handlers = null; + $this->waitList = $this->waitFn = null; + $this->cancelFn = null; + + if (!$handlers) { + return; + } + + // If the value was not a settled promise or a thenable, then resolve + // it in the task queue using the correct ID. + if (!is_object($value) || !method_exists($value, 'then')) { + $id = $state === self::FULFILLED ? 1 : 2; + // It's a success, so resolve the handlers in the queue. + Utils::queue()->add(static function () use ($id, $value, $handlers): void { + foreach ($handlers as $handler) { + self::callHandler($id, $value, $handler); + } + }); + } elseif ($value instanceof Promise && Is::pending($value)) { + // We can just merge our handlers onto the next promise. + $value->handlers = array_merge($value->handlers, $handlers); + } else { + // Resolve the handlers when the forwarded promise is resolved. + $value->then( + static function ($value) use ($handlers): void { + foreach ($handlers as $handler) { + self::callHandler(1, $value, $handler); + } + }, + static function ($reason) use ($handlers): void { + foreach ($handlers as $handler) { + self::callHandler(2, $reason, $handler); + } + } + ); + } + } + + /** + * Call a stack of handlers using a specific callback index and value. + * + * @param int $index 1 (resolve) or 2 (reject). + * @param mixed $value Value to pass to the callback. + * @param array $handler Array of handler data (promise and callbacks). + */ + private static function callHandler(int $index, $value, array $handler): void + { + /** @var PromiseInterface $promise */ + $promise = $handler[0]; + + // The promise may have been cancelled or resolved before placing + // this thunk in the queue. + if (Is::settled($promise)) { + return; + } + + try { + if (isset($handler[$index])) { + /* + * If $f throws an exception, then $handler will be in the exception + * stack trace. Since $handler contains a reference to the callable + * itself we get a circular reference. We clear the $handler + * here to avoid that memory leak. + */ + $f = $handler[$index]; + unset($handler); + $promise->resolve($f($value)); + } elseif ($index === 1) { + // Forward resolution values as-is. + $promise->resolve($value); + } else { + // Forward rejections down the chain. + $promise->reject($value); + } + } catch (\Throwable $reason) { + $promise->reject($reason); + } + } + + private function waitIfPending(): void + { + if ($this->state !== self::PENDING) { + return; + } elseif ($this->waitFn) { + $this->invokeWaitFn(); + } elseif ($this->waitList) { + $this->invokeWaitList(); + } else { + // If there's no wait function, then reject the promise. + $this->reject('Cannot wait on a promise that has ' + .'no internal wait function. You must provide a wait ' + .'function when constructing the promise to be able to ' + .'wait on a promise.'); + } + + Utils::queue()->run(); + + /** @psalm-suppress RedundantCondition */ + if ($this->state === self::PENDING) { + $this->reject('Invoking the wait callback did not resolve the promise'); + } + } + + private function invokeWaitFn(): void + { + try { + $wfn = $this->waitFn; + $this->waitFn = null; + $wfn(true); + } catch (\Throwable $reason) { + if ($this->state === self::PENDING) { + // The promise has not been resolved yet, so reject the promise + // with the exception. + $this->reject($reason); + } else { + // The promise was already resolved, so there's a problem in + // the application. + throw $reason; + } + } + } + + private function invokeWaitList(): void + { + $waitList = $this->waitList; + $this->waitList = null; + + foreach ($waitList as $result) { + do { + $result->waitIfPending(); + $result = $result->result; + } while ($result instanceof Promise); + + if ($result instanceof PromiseInterface) { + $result->wait(false); + } + } + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/promises/src/PromiseInterface.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/promises/src/PromiseInterface.php new file mode 100644 index 0000000000..c11721e4d9 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/promises/src/PromiseInterface.php @@ -0,0 +1,91 @@ +<?php + +declare(strict_types=1); + +namespace GuzzleHttp\Promise; + +/** + * A promise represents the eventual result of an asynchronous operation. + * + * The primary way of interacting with a promise is through its then method, + * which registers callbacks to receive either a promise’s eventual value or + * the reason why the promise cannot be fulfilled. + * + * @see https://promisesaplus.com/ + */ +interface PromiseInterface +{ + public const PENDING = 'pending'; + public const FULFILLED = 'fulfilled'; + public const REJECTED = 'rejected'; + + /** + * Appends fulfillment and rejection handlers to the promise, and returns + * a new promise resolving to the return value of the called handler. + * + * @param callable $onFulfilled Invoked when the promise fulfills. + * @param callable $onRejected Invoked when the promise is rejected. + */ + public function then( + ?callable $onFulfilled = null, + ?callable $onRejected = null + ): PromiseInterface; + + /** + * Appends a rejection handler callback to the promise, and returns a new + * promise resolving to the return value of the callback if it is called, + * or to its original fulfillment value if the promise is instead + * fulfilled. + * + * @param callable $onRejected Invoked when the promise is rejected. + */ + public function otherwise(callable $onRejected): PromiseInterface; + + /** + * Get the state of the promise ("pending", "rejected", or "fulfilled"). + * + * The three states can be checked against the constants defined on + * PromiseInterface: PENDING, FULFILLED, and REJECTED. + */ + public function getState(): string; + + /** + * Resolve the promise with the given value. + * + * @param mixed $value + * + * @throws \RuntimeException if the promise is already resolved. + */ + public function resolve($value): void; + + /** + * Reject the promise with the given reason. + * + * @param mixed $reason + * + * @throws \RuntimeException if the promise is already resolved. + */ + public function reject($reason): void; + + /** + * Cancels the promise if possible. + * + * @see https://github.com/promises-aplus/cancellation-spec/issues/7 + */ + public function cancel(): void; + + /** + * Waits until the promise completes if possible. + * + * Pass $unwrap as true to unwrap the result of the promise, either + * returning the resolved value or throwing the rejected exception. + * + * If the promise cannot be waited on, then the promise will be rejected. + * + * @return mixed + * + * @throws \LogicException if the promise has no wait function or if the + * promise does not settle after waiting. + */ + public function wait(bool $unwrap = true); +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/promises/src/RejectedPromise.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/promises/src/RejectedPromise.php new file mode 100644 index 0000000000..1ebf0b2a62 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/promises/src/RejectedPromise.php @@ -0,0 +1,95 @@ +<?php + +declare(strict_types=1); + +namespace GuzzleHttp\Promise; + +/** + * A promise that has been rejected. + * + * Thenning off of this promise will invoke the onRejected callback + * immediately and ignore other callbacks. + * + * @final + */ +class RejectedPromise implements PromiseInterface +{ + private $reason; + + /** + * @param mixed $reason + */ + public function __construct($reason) + { + if (is_object($reason) && method_exists($reason, 'then')) { + throw new \InvalidArgumentException( + 'You cannot create a RejectedPromise with a promise.' + ); + } + + $this->reason = $reason; + } + + public function then( + ?callable $onFulfilled = null, + ?callable $onRejected = null + ): PromiseInterface { + // If there's no onRejected callback then just return self. + if (!$onRejected) { + return $this; + } + + $queue = Utils::queue(); + $reason = $this->reason; + $p = new Promise([$queue, 'run']); + $queue->add(static function () use ($p, $reason, $onRejected): void { + if (Is::pending($p)) { + try { + // Return a resolved promise if onRejected does not throw. + $p->resolve($onRejected($reason)); + } catch (\Throwable $e) { + // onRejected threw, so return a rejected promise. + $p->reject($e); + } + } + }); + + return $p; + } + + public function otherwise(callable $onRejected): PromiseInterface + { + return $this->then(null, $onRejected); + } + + public function wait(bool $unwrap = true) + { + if ($unwrap) { + throw Create::exceptionFor($this->reason); + } + + return null; + } + + public function getState(): string + { + return self::REJECTED; + } + + public function resolve($value): void + { + throw new \LogicException('Cannot resolve a rejected promise'); + } + + public function reject($reason): void + { + if ($reason !== $this->reason) { + throw new \LogicException('Cannot reject a rejected promise'); + } + } + + public function cancel(): void + { + // pass + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/promises/src/RejectionException.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/promises/src/RejectionException.php new file mode 100644 index 0000000000..47dca86248 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/promises/src/RejectionException.php @@ -0,0 +1,49 @@ +<?php + +declare(strict_types=1); + +namespace GuzzleHttp\Promise; + +/** + * A special exception that is thrown when waiting on a rejected promise. + * + * The reason value is available via the getReason() method. + */ +class RejectionException extends \RuntimeException +{ + /** @var mixed Rejection reason. */ + private $reason; + + /** + * @param mixed $reason Rejection reason. + * @param string|null $description Optional description. + */ + public function __construct($reason, ?string $description = null) + { + $this->reason = $reason; + + $message = 'The promise was rejected'; + + if ($description) { + $message .= ' with reason: '.$description; + } elseif (is_string($reason) + || (is_object($reason) && method_exists($reason, '__toString')) + ) { + $message .= ' with reason: '.$this->reason; + } elseif ($reason instanceof \JsonSerializable) { + $message .= ' with reason: '.json_encode($this->reason, JSON_PRETTY_PRINT); + } + + parent::__construct($message); + } + + /** + * Returns the rejection reason. + * + * @return mixed + */ + public function getReason() + { + return $this->reason; + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/promises/src/Utils.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/promises/src/Utils.php new file mode 100644 index 0000000000..45b0893fcc --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/promises/src/Utils.php @@ -0,0 +1,259 @@ +<?php + +declare(strict_types=1); + +namespace GuzzleHttp\Promise; + +final class Utils +{ + /** + * Get the global task queue used for promise resolution. + * + * This task queue MUST be run in an event loop in order for promises to be + * settled asynchronously. It will be automatically run when synchronously + * waiting on a promise. + * + * <code> + * while ($eventLoop->isRunning()) { + * GuzzleHttp\Promise\Utils::queue()->run(); + * } + * </code> + * + * @param TaskQueueInterface|null $assign Optionally specify a new queue instance. + */ + public static function queue(?TaskQueueInterface $assign = null): TaskQueueInterface + { + static $queue; + + if ($assign) { + $queue = $assign; + } elseif (!$queue) { + $queue = new TaskQueue(); + } + + return $queue; + } + + /** + * Adds a function to run in the task queue when it is next `run()` and + * returns a promise that is fulfilled or rejected with the result. + * + * @param callable $task Task function to run. + */ + public static function task(callable $task): PromiseInterface + { + $queue = self::queue(); + $promise = new Promise([$queue, 'run']); + $queue->add(function () use ($task, $promise): void { + try { + if (Is::pending($promise)) { + $promise->resolve($task()); + } + } catch (\Throwable $e) { + $promise->reject($e); + } + }); + + return $promise; + } + + /** + * Synchronously waits on a promise to resolve and returns an inspection + * state array. + * + * Returns a state associative array containing a "state" key mapping to a + * valid promise state. If the state of the promise is "fulfilled", the + * array will contain a "value" key mapping to the fulfilled value of the + * promise. If the promise is rejected, the array will contain a "reason" + * key mapping to the rejection reason of the promise. + * + * @param PromiseInterface $promise Promise or value. + */ + public static function inspect(PromiseInterface $promise): array + { + try { + return [ + 'state' => PromiseInterface::FULFILLED, + 'value' => $promise->wait(), + ]; + } catch (RejectionException $e) { + return ['state' => PromiseInterface::REJECTED, 'reason' => $e->getReason()]; + } catch (\Throwable $e) { + return ['state' => PromiseInterface::REJECTED, 'reason' => $e]; + } + } + + /** + * Waits on all of the provided promises, but does not unwrap rejected + * promises as thrown exception. + * + * Returns an array of inspection state arrays. + * + * @see inspect for the inspection state array format. + * + * @param PromiseInterface[] $promises Traversable of promises to wait upon. + */ + public static function inspectAll($promises): array + { + $results = []; + foreach ($promises as $key => $promise) { + $results[$key] = self::inspect($promise); + } + + return $results; + } + + /** + * Waits on all of the provided promises and returns the fulfilled values. + * + * Returns an array that contains the value of each promise (in the same + * order the promises were provided). An exception is thrown if any of the + * promises are rejected. + * + * @param iterable<PromiseInterface> $promises Iterable of PromiseInterface objects to wait on. + * + * @throws \Throwable on error + */ + public static function unwrap($promises): array + { + $results = []; + foreach ($promises as $key => $promise) { + $results[$key] = $promise->wait(); + } + + return $results; + } + + /** + * Given an array of promises, return a promise that is fulfilled when all + * the items in the array are fulfilled. + * + * The promise's fulfillment value is an array with fulfillment values at + * respective positions to the original array. If any promise in the array + * rejects, the returned promise is rejected with the rejection reason. + * + * @param mixed $promises Promises or values. + * @param bool $recursive If true, resolves new promises that might have been added to the stack during its own resolution. + */ + public static function all($promises, bool $recursive = false): PromiseInterface + { + $results = []; + $promise = Each::of( + $promises, + function ($value, $idx) use (&$results): void { + $results[$idx] = $value; + }, + function ($reason, $idx, Promise $aggregate): void { + $aggregate->reject($reason); + } + )->then(function () use (&$results) { + ksort($results); + + return $results; + }); + + if (true === $recursive) { + $promise = $promise->then(function ($results) use ($recursive, &$promises) { + foreach ($promises as $promise) { + if (Is::pending($promise)) { + return self::all($promises, $recursive); + } + } + + return $results; + }); + } + + return $promise; + } + + /** + * Initiate a competitive race between multiple promises or values (values + * will become immediately fulfilled promises). + * + * When count amount of promises have been fulfilled, the returned promise + * is fulfilled with an array that contains the fulfillment values of the + * winners in order of resolution. + * + * This promise is rejected with a {@see AggregateException} if the number + * of fulfilled promises is less than the desired $count. + * + * @param int $count Total number of promises. + * @param mixed $promises Promises or values. + */ + public static function some(int $count, $promises): PromiseInterface + { + $results = []; + $rejections = []; + + return Each::of( + $promises, + function ($value, $idx, PromiseInterface $p) use (&$results, $count): void { + if (Is::settled($p)) { + return; + } + $results[$idx] = $value; + if (count($results) >= $count) { + $p->resolve(null); + } + }, + function ($reason) use (&$rejections): void { + $rejections[] = $reason; + } + )->then( + function () use (&$results, &$rejections, $count) { + if (count($results) !== $count) { + throw new AggregateException( + 'Not enough promises to fulfill count', + $rejections + ); + } + ksort($results); + + return array_values($results); + } + ); + } + + /** + * Like some(), with 1 as count. However, if the promise fulfills, the + * fulfillment value is not an array of 1 but the value directly. + * + * @param mixed $promises Promises or values. + */ + public static function any($promises): PromiseInterface + { + return self::some(1, $promises)->then(function ($values) { + return $values[0]; + }); + } + + /** + * Returns a promise that is fulfilled when all of the provided promises have + * been fulfilled or rejected. + * + * The returned promise is fulfilled with an array of inspection state arrays. + * + * @see inspect for the inspection state array format. + * + * @param mixed $promises Promises or values. + */ + public static function settle($promises): PromiseInterface + { + $results = []; + + return Each::of( + $promises, + function ($value, $idx) use (&$results): void { + $results[$idx] = ['state' => PromiseInterface::FULFILLED, 'value' => $value]; + }, + function ($reason, $idx) use (&$results): void { + $results[$idx] = ['state' => PromiseInterface::REJECTED, 'reason' => $reason]; + } + )->then(function () use (&$results) { + ksort($results); + + return $results; + }); + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/psr7/composer.json b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/psr7/composer.json new file mode 100644 index 0000000000..28d15f5714 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/psr7/composer.json @@ -0,0 +1,93 @@ +{ + "name": "guzzlehttp/psr7", + "description": "PSR-7 message implementation that also provides common utility methods", + "keywords": [ + "request", + "response", + "message", + "stream", + "http", + "uri", + "url", + "psr-7" + ], + "license": "MIT", + "authors": [ + { + "name": "Graham Campbell", + "email": "hello@gjcampbell.co.uk", + "homepage": "https://github.com/GrahamCampbell" + }, + { + "name": "Michael Dowling", + "email": "mtdowling@gmail.com", + "homepage": "https://github.com/mtdowling" + }, + { + "name": "George Mponos", + "email": "gmponos@gmail.com", + "homepage": "https://github.com/gmponos" + }, + { + "name": "Tobias Nyholm", + "email": "tobias.nyholm@gmail.com", + "homepage": "https://github.com/Nyholm" + }, + { + "name": "Márk Sági-Kazár", + "email": "mark.sagikazar@gmail.com", + "homepage": "https://github.com/sagikazarmark" + }, + { + "name": "Tobias Schultze", + "email": "webmaster@tubo-world.de", + "homepage": "https://github.com/Tobion" + }, + { + "name": "Márk Sági-Kazár", + "email": "mark.sagikazar@gmail.com", + "homepage": "https://sagikazarmark.hu" + } + ], + "require": { + "php": "^7.2.5 || ^8.0", + "psr/http-factory": "^1.0", + "psr/http-message": "^1.1 || ^2.0", + "ralouphie/getallheaders": "^3.0" + }, + "provide": { + "psr/http-factory-implementation": "1.0", + "psr/http-message-implementation": "1.0" + }, + "require-dev": { + "bamarni/composer-bin-plugin": "^1.8.2", + "http-interop/http-factory-tests": "0.9.0", + "phpunit/phpunit": "^8.5.39 || ^9.6.20" + }, + "suggest": { + "laminas/laminas-httphandlerrunner": "Emit PSR-7 responses" + }, + "autoload": { + "psr-4": { + "GuzzleHttp\\Psr7\\": "src/" + } + }, + "autoload-dev": { + "psr-4": { + "GuzzleHttp\\Tests\\Psr7\\": "tests/" + } + }, + "extra": { + "bamarni-bin": { + "bin-links": true, + "forward-command": false + } + }, + "config": { + "allow-plugins": { + "bamarni/composer-bin-plugin": true + }, + "preferred-install": "dist", + "sort-packages": true + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/psr7/src/CachingStream.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/psr7/src/CachingStream.php new file mode 100644 index 0000000000..7e4554d5c7 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/psr7/src/CachingStream.php @@ -0,0 +1,153 @@ +<?php + +declare(strict_types=1); + +namespace GuzzleHttp\Psr7; + +use Psr\Http\Message\StreamInterface; + +/** + * Stream decorator that can cache previously read bytes from a sequentially + * read stream. + */ +final class CachingStream implements StreamInterface +{ + use StreamDecoratorTrait; + + /** @var StreamInterface Stream being wrapped */ + private $remoteStream; + + /** @var int Number of bytes to skip reading due to a write on the buffer */ + private $skipReadBytes = 0; + + /** + * @var StreamInterface + */ + private $stream; + + /** + * We will treat the buffer object as the body of the stream + * + * @param StreamInterface $stream Stream to cache. The cursor is assumed to be at the beginning of the stream. + * @param StreamInterface $target Optionally specify where data is cached + */ + public function __construct( + StreamInterface $stream, + ?StreamInterface $target = null + ) { + $this->remoteStream = $stream; + $this->stream = $target ?: new Stream(Utils::tryFopen('php://temp', 'r+')); + } + + public function getSize(): ?int + { + $remoteSize = $this->remoteStream->getSize(); + + if (null === $remoteSize) { + return null; + } + + return max($this->stream->getSize(), $remoteSize); + } + + public function rewind(): void + { + $this->seek(0); + } + + public function seek($offset, $whence = SEEK_SET): void + { + if ($whence === SEEK_SET) { + $byte = $offset; + } elseif ($whence === SEEK_CUR) { + $byte = $offset + $this->tell(); + } elseif ($whence === SEEK_END) { + $size = $this->remoteStream->getSize(); + if ($size === null) { + $size = $this->cacheEntireStream(); + } + $byte = $size + $offset; + } else { + throw new \InvalidArgumentException('Invalid whence'); + } + + $diff = $byte - $this->stream->getSize(); + + if ($diff > 0) { + // Read the remoteStream until we have read in at least the amount + // of bytes requested, or we reach the end of the file. + while ($diff > 0 && !$this->remoteStream->eof()) { + $this->read($diff); + $diff = $byte - $this->stream->getSize(); + } + } else { + // We can just do a normal seek since we've already seen this byte. + $this->stream->seek($byte); + } + } + + public function read($length): string + { + // Perform a regular read on any previously read data from the buffer + $data = $this->stream->read($length); + $remaining = $length - strlen($data); + + // More data was requested so read from the remote stream + if ($remaining) { + // If data was written to the buffer in a position that would have + // been filled from the remote stream, then we must skip bytes on + // the remote stream to emulate overwriting bytes from that + // position. This mimics the behavior of other PHP stream wrappers. + $remoteData = $this->remoteStream->read( + $remaining + $this->skipReadBytes + ); + + if ($this->skipReadBytes) { + $len = strlen($remoteData); + $remoteData = substr($remoteData, $this->skipReadBytes); + $this->skipReadBytes = max(0, $this->skipReadBytes - $len); + } + + $data .= $remoteData; + $this->stream->write($remoteData); + } + + return $data; + } + + public function write($string): int + { + // When appending to the end of the currently read stream, you'll want + // to skip bytes from being read from the remote stream to emulate + // other stream wrappers. Basically replacing bytes of data of a fixed + // length. + $overflow = (strlen($string) + $this->tell()) - $this->remoteStream->tell(); + if ($overflow > 0) { + $this->skipReadBytes += $overflow; + } + + return $this->stream->write($string); + } + + public function eof(): bool + { + return $this->stream->eof() && $this->remoteStream->eof(); + } + + /** + * Close both the remote stream and buffer stream + */ + public function close(): void + { + $this->remoteStream->close(); + $this->stream->close(); + } + + private function cacheEntireStream(): int + { + $target = new FnStream(['write' => 'strlen']); + Utils::copyToStream($this, $target); + + return $this->tell(); + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/psr7/src/HttpFactory.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/psr7/src/HttpFactory.php new file mode 100644 index 0000000000..3ef15103a7 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/psr7/src/HttpFactory.php @@ -0,0 +1,94 @@ +<?php + +declare(strict_types=1); + +namespace GuzzleHttp\Psr7; + +use Psr\Http\Message\RequestFactoryInterface; +use Psr\Http\Message\RequestInterface; +use Psr\Http\Message\ResponseFactoryInterface; +use Psr\Http\Message\ResponseInterface; +use Psr\Http\Message\ServerRequestFactoryInterface; +use Psr\Http\Message\ServerRequestInterface; +use Psr\Http\Message\StreamFactoryInterface; +use Psr\Http\Message\StreamInterface; +use Psr\Http\Message\UploadedFileFactoryInterface; +use Psr\Http\Message\UploadedFileInterface; +use Psr\Http\Message\UriFactoryInterface; +use Psr\Http\Message\UriInterface; + +/** + * Implements all of the PSR-17 interfaces. + * + * Note: in consuming code it is recommended to require the implemented interfaces + * and inject the instance of this class multiple times. + */ +final class HttpFactory implements RequestFactoryInterface, ResponseFactoryInterface, ServerRequestFactoryInterface, StreamFactoryInterface, UploadedFileFactoryInterface, UriFactoryInterface +{ + public function createUploadedFile( + StreamInterface $stream, + ?int $size = null, + int $error = \UPLOAD_ERR_OK, + ?string $clientFilename = null, + ?string $clientMediaType = null + ): UploadedFileInterface { + if ($size === null) { + $size = $stream->getSize(); + } + + return new UploadedFile($stream, $size, $error, $clientFilename, $clientMediaType); + } + + public function createStream(string $content = ''): StreamInterface + { + return Utils::streamFor($content); + } + + public function createStreamFromFile(string $file, string $mode = 'r'): StreamInterface + { + try { + $resource = Utils::tryFopen($file, $mode); + } catch (\RuntimeException $e) { + if ('' === $mode || false === \in_array($mode[0], ['r', 'w', 'a', 'x', 'c'], true)) { + throw new \InvalidArgumentException(sprintf('Invalid file opening mode "%s"', $mode), 0, $e); + } + + throw $e; + } + + return Utils::streamFor($resource); + } + + public function createStreamFromResource($resource): StreamInterface + { + return Utils::streamFor($resource); + } + + public function createServerRequest(string $method, $uri, array $serverParams = []): ServerRequestInterface + { + if (empty($method)) { + if (!empty($serverParams['REQUEST_METHOD'])) { + $method = $serverParams['REQUEST_METHOD']; + } else { + throw new \InvalidArgumentException('Cannot determine HTTP method'); + } + } + + return new ServerRequest($method, $uri, [], null, '1.1', $serverParams); + } + + public function createResponse(int $code = 200, string $reasonPhrase = ''): ResponseInterface + { + return new Response($code, [], null, '1.1', $reasonPhrase); + } + + public function createRequest(string $method, $uri): RequestInterface + { + return new Request($method, $uri); + } + + public function createUri(string $uri = ''): UriInterface + { + return new Uri($uri); + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/psr7/src/MultipartStream.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/psr7/src/MultipartStream.php new file mode 100644 index 0000000000..43d718f658 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/psr7/src/MultipartStream.php @@ -0,0 +1,165 @@ +<?php + +declare(strict_types=1); + +namespace GuzzleHttp\Psr7; + +use Psr\Http\Message\StreamInterface; + +/** + * Stream that when read returns bytes for a streaming multipart or + * multipart/form-data stream. + */ +final class MultipartStream implements StreamInterface +{ + use StreamDecoratorTrait; + + /** @var string */ + private $boundary; + + /** @var StreamInterface */ + private $stream; + + /** + * @param array $elements Array of associative arrays, each containing a + * required "name" key mapping to the form field, + * name, a required "contents" key mapping to a + * StreamInterface/resource/string, an optional + * "headers" associative array of custom headers, + * and an optional "filename" key mapping to a + * string to send as the filename in the part. + * @param string $boundary You can optionally provide a specific boundary + * + * @throws \InvalidArgumentException + */ + public function __construct(array $elements = [], ?string $boundary = null) + { + $this->boundary = $boundary ?: bin2hex(random_bytes(20)); + $this->stream = $this->createStream($elements); + } + + public function getBoundary(): string + { + return $this->boundary; + } + + public function isWritable(): bool + { + return false; + } + + /** + * Get the headers needed before transferring the content of a POST file + * + * @param string[] $headers + */ + private function getHeaders(array $headers): string + { + $str = ''; + foreach ($headers as $key => $value) { + $str .= "{$key}: {$value}\r\n"; + } + + return "--{$this->boundary}\r\n".trim($str)."\r\n\r\n"; + } + + /** + * Create the aggregate stream that will be used to upload the POST data + */ + protected function createStream(array $elements = []): StreamInterface + { + $stream = new AppendStream(); + + foreach ($elements as $element) { + if (!is_array($element)) { + throw new \UnexpectedValueException('An array is expected'); + } + $this->addElement($stream, $element); + } + + // Add the trailing boundary with CRLF + $stream->addStream(Utils::streamFor("--{$this->boundary}--\r\n")); + + return $stream; + } + + private function addElement(AppendStream $stream, array $element): void + { + foreach (['contents', 'name'] as $key) { + if (!array_key_exists($key, $element)) { + throw new \InvalidArgumentException("A '{$key}' key is required"); + } + } + + $element['contents'] = Utils::streamFor($element['contents']); + + if (empty($element['filename'])) { + $uri = $element['contents']->getMetadata('uri'); + if ($uri && \is_string($uri) && \substr($uri, 0, 6) !== 'php://' && \substr($uri, 0, 7) !== 'data://') { + $element['filename'] = $uri; + } + } + + [$body, $headers] = $this->createElement( + $element['name'], + $element['contents'], + $element['filename'] ?? null, + $element['headers'] ?? [] + ); + + $stream->addStream(Utils::streamFor($this->getHeaders($headers))); + $stream->addStream($body); + $stream->addStream(Utils::streamFor("\r\n")); + } + + /** + * @param string[] $headers + * + * @return array{0: StreamInterface, 1: string[]} + */ + private function createElement(string $name, StreamInterface $stream, ?string $filename, array $headers): array + { + // Set a default content-disposition header if one was no provided + $disposition = self::getHeader($headers, 'content-disposition'); + if (!$disposition) { + $headers['Content-Disposition'] = ($filename === '0' || $filename) + ? sprintf( + 'form-data; name="%s"; filename="%s"', + $name, + basename($filename) + ) + : "form-data; name=\"{$name}\""; + } + + // Set a default content-length header if one was no provided + $length = self::getHeader($headers, 'content-length'); + if (!$length) { + if ($length = $stream->getSize()) { + $headers['Content-Length'] = (string) $length; + } + } + + // Set a default Content-Type if one was not supplied + $type = self::getHeader($headers, 'content-type'); + if (!$type && ($filename === '0' || $filename)) { + $headers['Content-Type'] = MimeType::fromFilename($filename) ?? 'application/octet-stream'; + } + + return [$stream, $headers]; + } + + /** + * @param string[] $headers + */ + private static function getHeader(array $headers, string $key): ?string + { + $lowercaseHeader = strtolower($key); + foreach ($headers as $k => $v) { + if (strtolower((string) $k) === $lowercaseHeader) { + return $v; + } + } + + return null; + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/psr7/src/Query.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/psr7/src/Query.php new file mode 100644 index 0000000000..ccf867a0bd --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/psr7/src/Query.php @@ -0,0 +1,118 @@ +<?php + +declare(strict_types=1); + +namespace GuzzleHttp\Psr7; + +final class Query +{ + /** + * Parse a query string into an associative array. + * + * If multiple values are found for the same key, the value of that key + * value pair will become an array. This function does not parse nested + * PHP style arrays into an associative array (e.g., `foo[a]=1&foo[b]=2` + * will be parsed into `['foo[a]' => '1', 'foo[b]' => '2'])`. + * + * @param string $str Query string to parse + * @param int|bool $urlEncoding How the query string is encoded + */ + public static function parse(string $str, $urlEncoding = true): array + { + $result = []; + + if ($str === '') { + return $result; + } + + if ($urlEncoding === true) { + $decoder = function ($value) { + return rawurldecode(str_replace('+', ' ', (string) $value)); + }; + } elseif ($urlEncoding === PHP_QUERY_RFC3986) { + $decoder = 'rawurldecode'; + } elseif ($urlEncoding === PHP_QUERY_RFC1738) { + $decoder = 'urldecode'; + } else { + $decoder = function ($str) { + return $str; + }; + } + + foreach (explode('&', $str) as $kvp) { + $parts = explode('=', $kvp, 2); + $key = $decoder($parts[0]); + $value = isset($parts[1]) ? $decoder($parts[1]) : null; + if (!array_key_exists($key, $result)) { + $result[$key] = $value; + } else { + if (!is_array($result[$key])) { + $result[$key] = [$result[$key]]; + } + $result[$key][] = $value; + } + } + + return $result; + } + + /** + * Build a query string from an array of key value pairs. + * + * This function can use the return value of `parse()` to build a query + * string. This function does not modify the provided keys when an array is + * encountered (like `http_build_query()` would). + * + * @param array $params Query string parameters. + * @param int|false $encoding Set to false to not encode, + * PHP_QUERY_RFC3986 to encode using + * RFC3986, or PHP_QUERY_RFC1738 to + * encode using RFC1738. + * @param bool $treatBoolsAsInts Set to true to encode as 0/1, and + * false as false/true. + */ + public static function build(array $params, $encoding = PHP_QUERY_RFC3986, bool $treatBoolsAsInts = true): string + { + if (!$params) { + return ''; + } + + if ($encoding === false) { + $encoder = function (string $str): string { + return $str; + }; + } elseif ($encoding === PHP_QUERY_RFC3986) { + $encoder = 'rawurlencode'; + } elseif ($encoding === PHP_QUERY_RFC1738) { + $encoder = 'urlencode'; + } else { + throw new \InvalidArgumentException('Invalid type'); + } + + $castBool = $treatBoolsAsInts ? static function ($v) { return (int) $v; } : static function ($v) { return $v ? 'true' : 'false'; }; + + $qs = ''; + foreach ($params as $k => $v) { + $k = $encoder((string) $k); + if (!is_array($v)) { + $qs .= $k; + $v = is_bool($v) ? $castBool($v) : $v; + if ($v !== null) { + $qs .= '='.$encoder((string) $v); + } + $qs .= '&'; + } else { + foreach ($v as $vv) { + $qs .= $k; + $vv = is_bool($vv) ? $castBool($vv) : $vv; + if ($vv !== null) { + $qs .= '='.$encoder((string) $vv); + } + $qs .= '&'; + } + } + } + + return $qs ? (string) substr($qs, 0, -1) : ''; + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/psr7/src/Response.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/psr7/src/Response.php new file mode 100644 index 0000000000..34e612fda5 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/psr7/src/Response.php @@ -0,0 +1,161 @@ +<?php + +declare(strict_types=1); + +namespace GuzzleHttp\Psr7; + +use Psr\Http\Message\ResponseInterface; +use Psr\Http\Message\StreamInterface; + +/** + * PSR-7 response implementation. + */ +class Response implements ResponseInterface +{ + use MessageTrait; + + /** Map of standard HTTP status code/reason phrases */ + private const PHRASES = [ + 100 => 'Continue', + 101 => 'Switching Protocols', + 102 => 'Processing', + 200 => 'OK', + 201 => 'Created', + 202 => 'Accepted', + 203 => 'Non-Authoritative Information', + 204 => 'No Content', + 205 => 'Reset Content', + 206 => 'Partial Content', + 207 => 'Multi-status', + 208 => 'Already Reported', + 300 => 'Multiple Choices', + 301 => 'Moved Permanently', + 302 => 'Found', + 303 => 'See Other', + 304 => 'Not Modified', + 305 => 'Use Proxy', + 306 => 'Switch Proxy', + 307 => 'Temporary Redirect', + 308 => 'Permanent Redirect', + 400 => 'Bad Request', + 401 => 'Unauthorized', + 402 => 'Payment Required', + 403 => 'Forbidden', + 404 => 'Not Found', + 405 => 'Method Not Allowed', + 406 => 'Not Acceptable', + 407 => 'Proxy Authentication Required', + 408 => 'Request Time-out', + 409 => 'Conflict', + 410 => 'Gone', + 411 => 'Length Required', + 412 => 'Precondition Failed', + 413 => 'Request Entity Too Large', + 414 => 'Request-URI Too Large', + 415 => 'Unsupported Media Type', + 416 => 'Requested range not satisfiable', + 417 => 'Expectation Failed', + 418 => 'I\'m a teapot', + 422 => 'Unprocessable Entity', + 423 => 'Locked', + 424 => 'Failed Dependency', + 425 => 'Unordered Collection', + 426 => 'Upgrade Required', + 428 => 'Precondition Required', + 429 => 'Too Many Requests', + 431 => 'Request Header Fields Too Large', + 451 => 'Unavailable For Legal Reasons', + 500 => 'Internal Server Error', + 501 => 'Not Implemented', + 502 => 'Bad Gateway', + 503 => 'Service Unavailable', + 504 => 'Gateway Time-out', + 505 => 'HTTP Version not supported', + 506 => 'Variant Also Negotiates', + 507 => 'Insufficient Storage', + 508 => 'Loop Detected', + 510 => 'Not Extended', + 511 => 'Network Authentication Required', + ]; + + /** @var string */ + private $reasonPhrase; + + /** @var int */ + private $statusCode; + + /** + * @param int $status Status code + * @param (string|string[])[] $headers Response headers + * @param string|resource|StreamInterface|null $body Response body + * @param string $version Protocol version + * @param string|null $reason Reason phrase (when empty a default will be used based on the status code) + */ + public function __construct( + int $status = 200, + array $headers = [], + $body = null, + string $version = '1.1', + ?string $reason = null + ) { + $this->assertStatusCodeRange($status); + + $this->statusCode = $status; + + if ($body !== '' && $body !== null) { + $this->stream = Utils::streamFor($body); + } + + $this->setHeaders($headers); + if ($reason == '' && isset(self::PHRASES[$this->statusCode])) { + $this->reasonPhrase = self::PHRASES[$this->statusCode]; + } else { + $this->reasonPhrase = (string) $reason; + } + + $this->protocol = $version; + } + + public function getStatusCode(): int + { + return $this->statusCode; + } + + public function getReasonPhrase(): string + { + return $this->reasonPhrase; + } + + public function withStatus($code, $reasonPhrase = ''): ResponseInterface + { + $this->assertStatusCodeIsInteger($code); + $code = (int) $code; + $this->assertStatusCodeRange($code); + + $new = clone $this; + $new->statusCode = $code; + if ($reasonPhrase == '' && isset(self::PHRASES[$new->statusCode])) { + $reasonPhrase = self::PHRASES[$new->statusCode]; + } + $new->reasonPhrase = (string) $reasonPhrase; + + return $new; + } + + /** + * @param mixed $statusCode + */ + private function assertStatusCodeIsInteger($statusCode): void + { + if (filter_var($statusCode, FILTER_VALIDATE_INT) === false) { + throw new \InvalidArgumentException('Status code must be an integer value.'); + } + } + + private function assertStatusCodeRange(int $statusCode): void + { + if ($statusCode < 100 || $statusCode >= 600) { + throw new \InvalidArgumentException('Status code must be an integer value between 1xx and 5xx.'); + } + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/psr7/src/StreamWrapper.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/psr7/src/StreamWrapper.php new file mode 100644 index 0000000000..77b04d7471 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/psr7/src/StreamWrapper.php @@ -0,0 +1,207 @@ +<?php + +declare(strict_types=1); + +namespace GuzzleHttp\Psr7; + +use Psr\Http\Message\StreamInterface; + +/** + * Converts Guzzle streams into PHP stream resources. + * + * @see https://www.php.net/streamwrapper + */ +final class StreamWrapper +{ + /** @var resource */ + public $context; + + /** @var StreamInterface */ + private $stream; + + /** @var string r, r+, or w */ + private $mode; + + /** + * Returns a resource representing the stream. + * + * @param StreamInterface $stream The stream to get a resource for + * + * @return resource + * + * @throws \InvalidArgumentException if stream is not readable or writable + */ + public static function getResource(StreamInterface $stream) + { + self::register(); + + if ($stream->isReadable()) { + $mode = $stream->isWritable() ? 'r+' : 'r'; + } elseif ($stream->isWritable()) { + $mode = 'w'; + } else { + throw new \InvalidArgumentException('The stream must be readable, ' + .'writable, or both.'); + } + + return fopen('guzzle://stream', $mode, false, self::createStreamContext($stream)); + } + + /** + * Creates a stream context that can be used to open a stream as a php stream resource. + * + * @return resource + */ + public static function createStreamContext(StreamInterface $stream) + { + return stream_context_create([ + 'guzzle' => ['stream' => $stream], + ]); + } + + /** + * Registers the stream wrapper if needed + */ + public static function register(): void + { + if (!in_array('guzzle', stream_get_wrappers())) { + stream_wrapper_register('guzzle', __CLASS__); + } + } + + public function stream_open(string $path, string $mode, int $options, ?string &$opened_path = null): bool + { + $options = stream_context_get_options($this->context); + + if (!isset($options['guzzle']['stream'])) { + return false; + } + + $this->mode = $mode; + $this->stream = $options['guzzle']['stream']; + + return true; + } + + public function stream_read(int $count): string + { + return $this->stream->read($count); + } + + public function stream_write(string $data): int + { + return $this->stream->write($data); + } + + public function stream_tell(): int + { + return $this->stream->tell(); + } + + public function stream_eof(): bool + { + return $this->stream->eof(); + } + + public function stream_seek(int $offset, int $whence): bool + { + $this->stream->seek($offset, $whence); + + return true; + } + + /** + * @return resource|false + */ + public function stream_cast(int $cast_as) + { + $stream = clone $this->stream; + $resource = $stream->detach(); + + return $resource ?? false; + } + + /** + * @return array{ + * dev: int, + * ino: int, + * mode: int, + * nlink: int, + * uid: int, + * gid: int, + * rdev: int, + * size: int, + * atime: int, + * mtime: int, + * ctime: int, + * blksize: int, + * blocks: int + * }|false + */ + public function stream_stat() + { + if ($this->stream->getSize() === null) { + return false; + } + + static $modeMap = [ + 'r' => 33060, + 'rb' => 33060, + 'r+' => 33206, + 'w' => 33188, + 'wb' => 33188, + ]; + + return [ + 'dev' => 0, + 'ino' => 0, + 'mode' => $modeMap[$this->mode], + 'nlink' => 0, + 'uid' => 0, + 'gid' => 0, + 'rdev' => 0, + 'size' => $this->stream->getSize() ?: 0, + 'atime' => 0, + 'mtime' => 0, + 'ctime' => 0, + 'blksize' => 0, + 'blocks' => 0, + ]; + } + + /** + * @return array{ + * dev: int, + * ino: int, + * mode: int, + * nlink: int, + * uid: int, + * gid: int, + * rdev: int, + * size: int, + * atime: int, + * mtime: int, + * ctime: int, + * blksize: int, + * blocks: int + * } + */ + public function url_stat(string $path, int $flags): array + { + return [ + 'dev' => 0, + 'ino' => 0, + 'mode' => 0, + 'nlink' => 0, + 'uid' => 0, + 'gid' => 0, + 'rdev' => 0, + 'size' => 0, + 'atime' => 0, + 'mtime' => 0, + 'ctime' => 0, + 'blksize' => 0, + 'blocks' => 0, + ]; + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/psr7/src/UploadedFile.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/psr7/src/UploadedFile.php new file mode 100644 index 0000000000..9c9ea49fbd --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/psr7/src/UploadedFile.php @@ -0,0 +1,211 @@ +<?php + +declare(strict_types=1); + +namespace GuzzleHttp\Psr7; + +use InvalidArgumentException; +use Psr\Http\Message\StreamInterface; +use Psr\Http\Message\UploadedFileInterface; +use RuntimeException; + +class UploadedFile implements UploadedFileInterface +{ + private const ERRORS = [ + UPLOAD_ERR_OK, + UPLOAD_ERR_INI_SIZE, + UPLOAD_ERR_FORM_SIZE, + UPLOAD_ERR_PARTIAL, + UPLOAD_ERR_NO_FILE, + UPLOAD_ERR_NO_TMP_DIR, + UPLOAD_ERR_CANT_WRITE, + UPLOAD_ERR_EXTENSION, + ]; + + /** + * @var string|null + */ + private $clientFilename; + + /** + * @var string|null + */ + private $clientMediaType; + + /** + * @var int + */ + private $error; + + /** + * @var string|null + */ + private $file; + + /** + * @var bool + */ + private $moved = false; + + /** + * @var int|null + */ + private $size; + + /** + * @var StreamInterface|null + */ + private $stream; + + /** + * @param StreamInterface|string|resource $streamOrFile + */ + public function __construct( + $streamOrFile, + ?int $size, + int $errorStatus, + ?string $clientFilename = null, + ?string $clientMediaType = null + ) { + $this->setError($errorStatus); + $this->size = $size; + $this->clientFilename = $clientFilename; + $this->clientMediaType = $clientMediaType; + + if ($this->isOk()) { + $this->setStreamOrFile($streamOrFile); + } + } + + /** + * Depending on the value set file or stream variable + * + * @param StreamInterface|string|resource $streamOrFile + * + * @throws InvalidArgumentException + */ + private function setStreamOrFile($streamOrFile): void + { + if (is_string($streamOrFile)) { + $this->file = $streamOrFile; + } elseif (is_resource($streamOrFile)) { + $this->stream = new Stream($streamOrFile); + } elseif ($streamOrFile instanceof StreamInterface) { + $this->stream = $streamOrFile; + } else { + throw new InvalidArgumentException( + 'Invalid stream or file provided for UploadedFile' + ); + } + } + + /** + * @throws InvalidArgumentException + */ + private function setError(int $error): void + { + if (false === in_array($error, UploadedFile::ERRORS, true)) { + throw new InvalidArgumentException( + 'Invalid error status for UploadedFile' + ); + } + + $this->error = $error; + } + + private static function isStringNotEmpty($param): bool + { + return is_string($param) && false === empty($param); + } + + /** + * Return true if there is no upload error + */ + private function isOk(): bool + { + return $this->error === UPLOAD_ERR_OK; + } + + public function isMoved(): bool + { + return $this->moved; + } + + /** + * @throws RuntimeException if is moved or not ok + */ + private function validateActive(): void + { + if (false === $this->isOk()) { + throw new RuntimeException('Cannot retrieve stream due to upload error'); + } + + if ($this->isMoved()) { + throw new RuntimeException('Cannot retrieve stream after it has already been moved'); + } + } + + public function getStream(): StreamInterface + { + $this->validateActive(); + + if ($this->stream instanceof StreamInterface) { + return $this->stream; + } + + /** @var string $file */ + $file = $this->file; + + return new LazyOpenStream($file, 'r+'); + } + + public function moveTo($targetPath): void + { + $this->validateActive(); + + if (false === self::isStringNotEmpty($targetPath)) { + throw new InvalidArgumentException( + 'Invalid path provided for move operation; must be a non-empty string' + ); + } + + if ($this->file) { + $this->moved = PHP_SAPI === 'cli' + ? rename($this->file, $targetPath) + : move_uploaded_file($this->file, $targetPath); + } else { + Utils::copyToStream( + $this->getStream(), + new LazyOpenStream($targetPath, 'w') + ); + + $this->moved = true; + } + + if (false === $this->moved) { + throw new RuntimeException( + sprintf('Uploaded file could not be moved to %s', $targetPath) + ); + } + } + + public function getSize(): ?int + { + return $this->size; + } + + public function getError(): int + { + return $this->error; + } + + public function getClientFilename(): ?string + { + return $this->clientFilename; + } + + public function getClientMediaType(): ?string + { + return $this->clientMediaType; + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/psr7/src/Uri.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/psr7/src/Uri.php new file mode 100644 index 0000000000..481dfca946 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/psr7/src/Uri.php @@ -0,0 +1,743 @@ +<?php + +declare(strict_types=1); + +namespace GuzzleHttp\Psr7; + +use GuzzleHttp\Psr7\Exception\MalformedUriException; +use Psr\Http\Message\UriInterface; + +/** + * PSR-7 URI implementation. + * + * @author Michael Dowling + * @author Tobias Schultze + * @author Matthew Weier O'Phinney + */ +class Uri implements UriInterface, \JsonSerializable +{ + /** + * Absolute http and https URIs require a host per RFC 7230 Section 2.7 + * but in generic URIs the host can be empty. So for http(s) URIs + * we apply this default host when no host is given yet to form a + * valid URI. + */ + private const HTTP_DEFAULT_HOST = 'localhost'; + + private const DEFAULT_PORTS = [ + 'http' => 80, + 'https' => 443, + 'ftp' => 21, + 'gopher' => 70, + 'nntp' => 119, + 'news' => 119, + 'telnet' => 23, + 'tn3270' => 23, + 'imap' => 143, + 'pop' => 110, + 'ldap' => 389, + ]; + + /** + * Unreserved characters for use in a regex. + * + * @see https://datatracker.ietf.org/doc/html/rfc3986#section-2.3 + */ + private const CHAR_UNRESERVED = 'a-zA-Z0-9_\-\.~'; + + /** + * Sub-delims for use in a regex. + * + * @see https://datatracker.ietf.org/doc/html/rfc3986#section-2.2 + */ + private const CHAR_SUB_DELIMS = '!\$&\'\(\)\*\+,;='; + private const QUERY_SEPARATORS_REPLACEMENT = ['=' => '%3D', '&' => '%26']; + + /** @var string Uri scheme. */ + private $scheme = ''; + + /** @var string Uri user info. */ + private $userInfo = ''; + + /** @var string Uri host. */ + private $host = ''; + + /** @var int|null Uri port. */ + private $port; + + /** @var string Uri path. */ + private $path = ''; + + /** @var string Uri query string. */ + private $query = ''; + + /** @var string Uri fragment. */ + private $fragment = ''; + + /** @var string|null String representation */ + private $composedComponents; + + public function __construct(string $uri = '') + { + if ($uri !== '') { + $parts = self::parse($uri); + if ($parts === false) { + throw new MalformedUriException("Unable to parse URI: $uri"); + } + $this->applyParts($parts); + } + } + + /** + * UTF-8 aware \parse_url() replacement. + * + * The internal function produces broken output for non ASCII domain names + * (IDN) when used with locales other than "C". + * + * On the other hand, cURL understands IDN correctly only when UTF-8 locale + * is configured ("C.UTF-8", "en_US.UTF-8", etc.). + * + * @see https://bugs.php.net/bug.php?id=52923 + * @see https://www.php.net/manual/en/function.parse-url.php#114817 + * @see https://curl.haxx.se/libcurl/c/CURLOPT_URL.html#ENCODING + * + * @return array|false + */ + private static function parse(string $url) + { + // If IPv6 + $prefix = ''; + if (preg_match('%^(.*://\[[0-9:a-f]+\])(.*?)$%', $url, $matches)) { + /** @var array{0:string, 1:string, 2:string} $matches */ + $prefix = $matches[1]; + $url = $matches[2]; + } + + /** @var string */ + $encodedUrl = preg_replace_callback( + '%[^:/@?&=#]+%usD', + static function ($matches) { + return urlencode($matches[0]); + }, + $url + ); + + $result = parse_url($prefix.$encodedUrl); + + if ($result === false) { + return false; + } + + return array_map('urldecode', $result); + } + + public function __toString(): string + { + if ($this->composedComponents === null) { + $this->composedComponents = self::composeComponents( + $this->scheme, + $this->getAuthority(), + $this->path, + $this->query, + $this->fragment + ); + } + + return $this->composedComponents; + } + + /** + * Composes a URI reference string from its various components. + * + * Usually this method does not need to be called manually but instead is used indirectly via + * `Psr\Http\Message\UriInterface::__toString`. + * + * PSR-7 UriInterface treats an empty component the same as a missing component as + * getQuery(), getFragment() etc. always return a string. This explains the slight + * difference to RFC 3986 Section 5.3. + * + * Another adjustment is that the authority separator is added even when the authority is missing/empty + * for the "file" scheme. This is because PHP stream functions like `file_get_contents` only work with + * `file:///myfile` but not with `file:/myfile` although they are equivalent according to RFC 3986. But + * `file:///` is the more common syntax for the file scheme anyway (Chrome for example redirects to + * that format). + * + * @see https://datatracker.ietf.org/doc/html/rfc3986#section-5.3 + */ + public static function composeComponents(?string $scheme, ?string $authority, string $path, ?string $query, ?string $fragment): string + { + $uri = ''; + + // weak type checks to also accept null until we can add scalar type hints + if ($scheme != '') { + $uri .= $scheme.':'; + } + + if ($authority != '' || $scheme === 'file') { + $uri .= '//'.$authority; + } + + if ($authority != '' && $path != '' && $path[0] != '/') { + $path = '/'.$path; + } + + $uri .= $path; + + if ($query != '') { + $uri .= '?'.$query; + } + + if ($fragment != '') { + $uri .= '#'.$fragment; + } + + return $uri; + } + + /** + * Whether the URI has the default port of the current scheme. + * + * `Psr\Http\Message\UriInterface::getPort` may return null or the standard port. This method can be used + * independently of the implementation. + */ + public static function isDefaultPort(UriInterface $uri): bool + { + return $uri->getPort() === null + || (isset(self::DEFAULT_PORTS[$uri->getScheme()]) && $uri->getPort() === self::DEFAULT_PORTS[$uri->getScheme()]); + } + + /** + * Whether the URI is absolute, i.e. it has a scheme. + * + * An instance of UriInterface can either be an absolute URI or a relative reference. This method returns true + * if it is the former. An absolute URI has a scheme. A relative reference is used to express a URI relative + * to another URI, the base URI. Relative references can be divided into several forms: + * - network-path references, e.g. '//example.com/path' + * - absolute-path references, e.g. '/path' + * - relative-path references, e.g. 'subpath' + * + * @see Uri::isNetworkPathReference + * @see Uri::isAbsolutePathReference + * @see Uri::isRelativePathReference + * @see https://datatracker.ietf.org/doc/html/rfc3986#section-4 + */ + public static function isAbsolute(UriInterface $uri): bool + { + return $uri->getScheme() !== ''; + } + + /** + * Whether the URI is a network-path reference. + * + * A relative reference that begins with two slash characters is termed an network-path reference. + * + * @see https://datatracker.ietf.org/doc/html/rfc3986#section-4.2 + */ + public static function isNetworkPathReference(UriInterface $uri): bool + { + return $uri->getScheme() === '' && $uri->getAuthority() !== ''; + } + + /** + * Whether the URI is a absolute-path reference. + * + * A relative reference that begins with a single slash character is termed an absolute-path reference. + * + * @see https://datatracker.ietf.org/doc/html/rfc3986#section-4.2 + */ + public static function isAbsolutePathReference(UriInterface $uri): bool + { + return $uri->getScheme() === '' + && $uri->getAuthority() === '' + && isset($uri->getPath()[0]) + && $uri->getPath()[0] === '/'; + } + + /** + * Whether the URI is a relative-path reference. + * + * A relative reference that does not begin with a slash character is termed a relative-path reference. + * + * @see https://datatracker.ietf.org/doc/html/rfc3986#section-4.2 + */ + public static function isRelativePathReference(UriInterface $uri): bool + { + return $uri->getScheme() === '' + && $uri->getAuthority() === '' + && (!isset($uri->getPath()[0]) || $uri->getPath()[0] !== '/'); + } + + /** + * Whether the URI is a same-document reference. + * + * A same-document reference refers to a URI that is, aside from its fragment + * component, identical to the base URI. When no base URI is given, only an empty + * URI reference (apart from its fragment) is considered a same-document reference. + * + * @param UriInterface $uri The URI to check + * @param UriInterface|null $base An optional base URI to compare against + * + * @see https://datatracker.ietf.org/doc/html/rfc3986#section-4.4 + */ + public static function isSameDocumentReference(UriInterface $uri, ?UriInterface $base = null): bool + { + if ($base !== null) { + $uri = UriResolver::resolve($base, $uri); + + return ($uri->getScheme() === $base->getScheme()) + && ($uri->getAuthority() === $base->getAuthority()) + && ($uri->getPath() === $base->getPath()) + && ($uri->getQuery() === $base->getQuery()); + } + + return $uri->getScheme() === '' && $uri->getAuthority() === '' && $uri->getPath() === '' && $uri->getQuery() === ''; + } + + /** + * Creates a new URI with a specific query string value removed. + * + * Any existing query string values that exactly match the provided key are + * removed. + * + * @param UriInterface $uri URI to use as a base. + * @param string $key Query string key to remove. + */ + public static function withoutQueryValue(UriInterface $uri, string $key): UriInterface + { + $result = self::getFilteredQueryString($uri, [$key]); + + return $uri->withQuery(implode('&', $result)); + } + + /** + * Creates a new URI with a specific query string value. + * + * Any existing query string values that exactly match the provided key are + * removed and replaced with the given key value pair. + * + * A value of null will set the query string key without a value, e.g. "key" + * instead of "key=value". + * + * @param UriInterface $uri URI to use as a base. + * @param string $key Key to set. + * @param string|null $value Value to set + */ + public static function withQueryValue(UriInterface $uri, string $key, ?string $value): UriInterface + { + $result = self::getFilteredQueryString($uri, [$key]); + + $result[] = self::generateQueryString($key, $value); + + return $uri->withQuery(implode('&', $result)); + } + + /** + * Creates a new URI with multiple specific query string values. + * + * It has the same behavior as withQueryValue() but for an associative array of key => value. + * + * @param UriInterface $uri URI to use as a base. + * @param (string|null)[] $keyValueArray Associative array of key and values + */ + public static function withQueryValues(UriInterface $uri, array $keyValueArray): UriInterface + { + $result = self::getFilteredQueryString($uri, array_keys($keyValueArray)); + + foreach ($keyValueArray as $key => $value) { + $result[] = self::generateQueryString((string) $key, $value !== null ? (string) $value : null); + } + + return $uri->withQuery(implode('&', $result)); + } + + /** + * Creates a URI from a hash of `parse_url` components. + * + * @see https://www.php.net/manual/en/function.parse-url.php + * + * @throws MalformedUriException If the components do not form a valid URI. + */ + public static function fromParts(array $parts): UriInterface + { + $uri = new self(); + $uri->applyParts($parts); + $uri->validateState(); + + return $uri; + } + + public function getScheme(): string + { + return $this->scheme; + } + + public function getAuthority(): string + { + $authority = $this->host; + if ($this->userInfo !== '') { + $authority = $this->userInfo.'@'.$authority; + } + + if ($this->port !== null) { + $authority .= ':'.$this->port; + } + + return $authority; + } + + public function getUserInfo(): string + { + return $this->userInfo; + } + + public function getHost(): string + { + return $this->host; + } + + public function getPort(): ?int + { + return $this->port; + } + + public function getPath(): string + { + return $this->path; + } + + public function getQuery(): string + { + return $this->query; + } + + public function getFragment(): string + { + return $this->fragment; + } + + public function withScheme($scheme): UriInterface + { + $scheme = $this->filterScheme($scheme); + + if ($this->scheme === $scheme) { + return $this; + } + + $new = clone $this; + $new->scheme = $scheme; + $new->composedComponents = null; + $new->removeDefaultPort(); + $new->validateState(); + + return $new; + } + + public function withUserInfo($user, $password = null): UriInterface + { + $info = $this->filterUserInfoComponent($user); + if ($password !== null) { + $info .= ':'.$this->filterUserInfoComponent($password); + } + + if ($this->userInfo === $info) { + return $this; + } + + $new = clone $this; + $new->userInfo = $info; + $new->composedComponents = null; + $new->validateState(); + + return $new; + } + + public function withHost($host): UriInterface + { + $host = $this->filterHost($host); + + if ($this->host === $host) { + return $this; + } + + $new = clone $this; + $new->host = $host; + $new->composedComponents = null; + $new->validateState(); + + return $new; + } + + public function withPort($port): UriInterface + { + $port = $this->filterPort($port); + + if ($this->port === $port) { + return $this; + } + + $new = clone $this; + $new->port = $port; + $new->composedComponents = null; + $new->removeDefaultPort(); + $new->validateState(); + + return $new; + } + + public function withPath($path): UriInterface + { + $path = $this->filterPath($path); + + if ($this->path === $path) { + return $this; + } + + $new = clone $this; + $new->path = $path; + $new->composedComponents = null; + $new->validateState(); + + return $new; + } + + public function withQuery($query): UriInterface + { + $query = $this->filterQueryAndFragment($query); + + if ($this->query === $query) { + return $this; + } + + $new = clone $this; + $new->query = $query; + $new->composedComponents = null; + + return $new; + } + + public function withFragment($fragment): UriInterface + { + $fragment = $this->filterQueryAndFragment($fragment); + + if ($this->fragment === $fragment) { + return $this; + } + + $new = clone $this; + $new->fragment = $fragment; + $new->composedComponents = null; + + return $new; + } + + public function jsonSerialize(): string + { + return $this->__toString(); + } + + /** + * Apply parse_url parts to a URI. + * + * @param array $parts Array of parse_url parts to apply. + */ + private function applyParts(array $parts): void + { + $this->scheme = isset($parts['scheme']) + ? $this->filterScheme($parts['scheme']) + : ''; + $this->userInfo = isset($parts['user']) + ? $this->filterUserInfoComponent($parts['user']) + : ''; + $this->host = isset($parts['host']) + ? $this->filterHost($parts['host']) + : ''; + $this->port = isset($parts['port']) + ? $this->filterPort($parts['port']) + : null; + $this->path = isset($parts['path']) + ? $this->filterPath($parts['path']) + : ''; + $this->query = isset($parts['query']) + ? $this->filterQueryAndFragment($parts['query']) + : ''; + $this->fragment = isset($parts['fragment']) + ? $this->filterQueryAndFragment($parts['fragment']) + : ''; + if (isset($parts['pass'])) { + $this->userInfo .= ':'.$this->filterUserInfoComponent($parts['pass']); + } + + $this->removeDefaultPort(); + } + + /** + * @param mixed $scheme + * + * @throws \InvalidArgumentException If the scheme is invalid. + */ + private function filterScheme($scheme): string + { + if (!is_string($scheme)) { + throw new \InvalidArgumentException('Scheme must be a string'); + } + + return \strtr($scheme, 'ABCDEFGHIJKLMNOPQRSTUVWXYZ', 'abcdefghijklmnopqrstuvwxyz'); + } + + /** + * @param mixed $component + * + * @throws \InvalidArgumentException If the user info is invalid. + */ + private function filterUserInfoComponent($component): string + { + if (!is_string($component)) { + throw new \InvalidArgumentException('User info must be a string'); + } + + return preg_replace_callback( + '/(?:[^%'.self::CHAR_UNRESERVED.self::CHAR_SUB_DELIMS.']+|%(?![A-Fa-f0-9]{2}))/', + [$this, 'rawurlencodeMatchZero'], + $component + ); + } + + /** + * @param mixed $host + * + * @throws \InvalidArgumentException If the host is invalid. + */ + private function filterHost($host): string + { + if (!is_string($host)) { + throw new \InvalidArgumentException('Host must be a string'); + } + + return \strtr($host, 'ABCDEFGHIJKLMNOPQRSTUVWXYZ', 'abcdefghijklmnopqrstuvwxyz'); + } + + /** + * @param mixed $port + * + * @throws \InvalidArgumentException If the port is invalid. + */ + private function filterPort($port): ?int + { + if ($port === null) { + return null; + } + + $port = (int) $port; + if (0 > $port || 0xFFFF < $port) { + throw new \InvalidArgumentException( + sprintf('Invalid port: %d. Must be between 0 and 65535', $port) + ); + } + + return $port; + } + + /** + * @param (string|int)[] $keys + * + * @return string[] + */ + private static function getFilteredQueryString(UriInterface $uri, array $keys): array + { + $current = $uri->getQuery(); + + if ($current === '') { + return []; + } + + $decodedKeys = array_map(function ($k): string { + return rawurldecode((string) $k); + }, $keys); + + return array_filter(explode('&', $current), function ($part) use ($decodedKeys) { + return !in_array(rawurldecode(explode('=', $part)[0]), $decodedKeys, true); + }); + } + + private static function generateQueryString(string $key, ?string $value): string + { + // Query string separators ("=", "&") within the key or value need to be encoded + // (while preventing double-encoding) before setting the query string. All other + // chars that need percent-encoding will be encoded by withQuery(). + $queryString = strtr($key, self::QUERY_SEPARATORS_REPLACEMENT); + + if ($value !== null) { + $queryString .= '='.strtr($value, self::QUERY_SEPARATORS_REPLACEMENT); + } + + return $queryString; + } + + private function removeDefaultPort(): void + { + if ($this->port !== null && self::isDefaultPort($this)) { + $this->port = null; + } + } + + /** + * Filters the path of a URI + * + * @param mixed $path + * + * @throws \InvalidArgumentException If the path is invalid. + */ + private function filterPath($path): string + { + if (!is_string($path)) { + throw new \InvalidArgumentException('Path must be a string'); + } + + return preg_replace_callback( + '/(?:[^'.self::CHAR_UNRESERVED.self::CHAR_SUB_DELIMS.'%:@\/]++|%(?![A-Fa-f0-9]{2}))/', + [$this, 'rawurlencodeMatchZero'], + $path + ); + } + + /** + * Filters the query string or fragment of a URI. + * + * @param mixed $str + * + * @throws \InvalidArgumentException If the query or fragment is invalid. + */ + private function filterQueryAndFragment($str): string + { + if (!is_string($str)) { + throw new \InvalidArgumentException('Query and fragment must be a string'); + } + + return preg_replace_callback( + '/(?:[^'.self::CHAR_UNRESERVED.self::CHAR_SUB_DELIMS.'%:@\/\?]++|%(?![A-Fa-f0-9]{2}))/', + [$this, 'rawurlencodeMatchZero'], + $str + ); + } + + private function rawurlencodeMatchZero(array $match): string + { + return rawurlencode($match[0]); + } + + private function validateState(): void + { + if ($this->host === '' && ($this->scheme === 'http' || $this->scheme === 'https')) { + $this->host = self::HTTP_DEFAULT_HOST; + } + + if ($this->getAuthority() === '') { + if (0 === strpos($this->path, '//')) { + throw new MalformedUriException('The path of a URI without an authority must not start with two slashes "//"'); + } + if ($this->scheme === '' && false !== strpos(explode('/', $this->path, 2)[0], ':')) { + throw new MalformedUriException('A relative URI must not have a path beginning with a segment containing a colon'); + } + } + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/psr7/src/Utils.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/psr7/src/Utils.php new file mode 100644 index 0000000000..7682d2cdc7 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/guzzlehttp/psr7/src/Utils.php @@ -0,0 +1,477 @@ +<?php + +declare(strict_types=1); + +namespace GuzzleHttp\Psr7; + +use Psr\Http\Message\RequestInterface; +use Psr\Http\Message\ServerRequestInterface; +use Psr\Http\Message\StreamInterface; +use Psr\Http\Message\UriInterface; + +final class Utils +{ + /** + * Remove the items given by the keys, case insensitively from the data. + * + * @param (string|int)[] $keys + */ + public static function caselessRemove(array $keys, array $data): array + { + $result = []; + + foreach ($keys as &$key) { + $key = strtolower((string) $key); + } + + foreach ($data as $k => $v) { + if (!in_array(strtolower((string) $k), $keys)) { + $result[$k] = $v; + } + } + + return $result; + } + + /** + * Copy the contents of a stream into another stream until the given number + * of bytes have been read. + * + * @param StreamInterface $source Stream to read from + * @param StreamInterface $dest Stream to write to + * @param int $maxLen Maximum number of bytes to read. Pass -1 + * to read the entire stream. + * + * @throws \RuntimeException on error. + */ + public static function copyToStream(StreamInterface $source, StreamInterface $dest, int $maxLen = -1): void + { + $bufferSize = 8192; + + if ($maxLen === -1) { + while (!$source->eof()) { + if (!$dest->write($source->read($bufferSize))) { + break; + } + } + } else { + $remaining = $maxLen; + while ($remaining > 0 && !$source->eof()) { + $buf = $source->read(min($bufferSize, $remaining)); + $len = strlen($buf); + if (!$len) { + break; + } + $remaining -= $len; + $dest->write($buf); + } + } + } + + /** + * Copy the contents of a stream into a string until the given number of + * bytes have been read. + * + * @param StreamInterface $stream Stream to read + * @param int $maxLen Maximum number of bytes to read. Pass -1 + * to read the entire stream. + * + * @throws \RuntimeException on error. + */ + public static function copyToString(StreamInterface $stream, int $maxLen = -1): string + { + $buffer = ''; + + if ($maxLen === -1) { + while (!$stream->eof()) { + $buf = $stream->read(1048576); + if ($buf === '') { + break; + } + $buffer .= $buf; + } + + return $buffer; + } + + $len = 0; + while (!$stream->eof() && $len < $maxLen) { + $buf = $stream->read($maxLen - $len); + if ($buf === '') { + break; + } + $buffer .= $buf; + $len = strlen($buffer); + } + + return $buffer; + } + + /** + * Calculate a hash of a stream. + * + * This method reads the entire stream to calculate a rolling hash, based + * on PHP's `hash_init` functions. + * + * @param StreamInterface $stream Stream to calculate the hash for + * @param string $algo Hash algorithm (e.g. md5, crc32, etc) + * @param bool $rawOutput Whether or not to use raw output + * + * @throws \RuntimeException on error. + */ + public static function hash(StreamInterface $stream, string $algo, bool $rawOutput = false): string + { + $pos = $stream->tell(); + + if ($pos > 0) { + $stream->rewind(); + } + + $ctx = hash_init($algo); + while (!$stream->eof()) { + hash_update($ctx, $stream->read(1048576)); + } + + $out = hash_final($ctx, $rawOutput); + $stream->seek($pos); + + return $out; + } + + /** + * Clone and modify a request with the given changes. + * + * This method is useful for reducing the number of clones needed to mutate + * a message. + * + * The changes can be one of: + * - method: (string) Changes the HTTP method. + * - set_headers: (array) Sets the given headers. + * - remove_headers: (array) Remove the given headers. + * - body: (mixed) Sets the given body. + * - uri: (UriInterface) Set the URI. + * - query: (string) Set the query string value of the URI. + * - version: (string) Set the protocol version. + * + * @param RequestInterface $request Request to clone and modify. + * @param array $changes Changes to apply. + */ + public static function modifyRequest(RequestInterface $request, array $changes): RequestInterface + { + if (!$changes) { + return $request; + } + + $headers = $request->getHeaders(); + + if (!isset($changes['uri'])) { + $uri = $request->getUri(); + } else { + // Remove the host header if one is on the URI + if ($host = $changes['uri']->getHost()) { + $changes['set_headers']['Host'] = $host; + + if ($port = $changes['uri']->getPort()) { + $standardPorts = ['http' => 80, 'https' => 443]; + $scheme = $changes['uri']->getScheme(); + if (isset($standardPorts[$scheme]) && $port != $standardPorts[$scheme]) { + $changes['set_headers']['Host'] .= ':'.$port; + } + } + } + $uri = $changes['uri']; + } + + if (!empty($changes['remove_headers'])) { + $headers = self::caselessRemove($changes['remove_headers'], $headers); + } + + if (!empty($changes['set_headers'])) { + $headers = self::caselessRemove(array_keys($changes['set_headers']), $headers); + $headers = $changes['set_headers'] + $headers; + } + + if (isset($changes['query'])) { + $uri = $uri->withQuery($changes['query']); + } + + if ($request instanceof ServerRequestInterface) { + $new = (new ServerRequest( + $changes['method'] ?? $request->getMethod(), + $uri, + $headers, + $changes['body'] ?? $request->getBody(), + $changes['version'] ?? $request->getProtocolVersion(), + $request->getServerParams() + )) + ->withParsedBody($request->getParsedBody()) + ->withQueryParams($request->getQueryParams()) + ->withCookieParams($request->getCookieParams()) + ->withUploadedFiles($request->getUploadedFiles()); + + foreach ($request->getAttributes() as $key => $value) { + $new = $new->withAttribute($key, $value); + } + + return $new; + } + + return new Request( + $changes['method'] ?? $request->getMethod(), + $uri, + $headers, + $changes['body'] ?? $request->getBody(), + $changes['version'] ?? $request->getProtocolVersion() + ); + } + + /** + * Read a line from the stream up to the maximum allowed buffer length. + * + * @param StreamInterface $stream Stream to read from + * @param int|null $maxLength Maximum buffer length + */ + public static function readLine(StreamInterface $stream, ?int $maxLength = null): string + { + $buffer = ''; + $size = 0; + + while (!$stream->eof()) { + if ('' === ($byte = $stream->read(1))) { + return $buffer; + } + $buffer .= $byte; + // Break when a new line is found or the max length - 1 is reached + if ($byte === "\n" || ++$size === $maxLength - 1) { + break; + } + } + + return $buffer; + } + + /** + * Redact the password in the user info part of a URI. + */ + public static function redactUserInfo(UriInterface $uri): UriInterface + { + $userInfo = $uri->getUserInfo(); + + if (false !== ($pos = \strpos($userInfo, ':'))) { + return $uri->withUserInfo(\substr($userInfo, 0, $pos), '***'); + } + + return $uri; + } + + /** + * Create a new stream based on the input type. + * + * Options is an associative array that can contain the following keys: + * - metadata: Array of custom metadata. + * - size: Size of the stream. + * + * This method accepts the following `$resource` types: + * - `Psr\Http\Message\StreamInterface`: Returns the value as-is. + * - `string`: Creates a stream object that uses the given string as the contents. + * - `resource`: Creates a stream object that wraps the given PHP stream resource. + * - `Iterator`: If the provided value implements `Iterator`, then a read-only + * stream object will be created that wraps the given iterable. Each time the + * stream is read from, data from the iterator will fill a buffer and will be + * continuously called until the buffer is equal to the requested read size. + * Subsequent read calls will first read from the buffer and then call `next` + * on the underlying iterator until it is exhausted. + * - `object` with `__toString()`: If the object has the `__toString()` method, + * the object will be cast to a string and then a stream will be returned that + * uses the string value. + * - `NULL`: When `null` is passed, an empty stream object is returned. + * - `callable` When a callable is passed, a read-only stream object will be + * created that invokes the given callable. The callable is invoked with the + * number of suggested bytes to read. The callable can return any number of + * bytes, but MUST return `false` when there is no more data to return. The + * stream object that wraps the callable will invoke the callable until the + * number of requested bytes are available. Any additional bytes will be + * buffered and used in subsequent reads. + * + * @param resource|string|int|float|bool|StreamInterface|callable|\Iterator|null $resource Entity body data + * @param array{size?: int, metadata?: array} $options Additional options + * + * @throws \InvalidArgumentException if the $resource arg is not valid. + */ + public static function streamFor($resource = '', array $options = []): StreamInterface + { + if (is_scalar($resource)) { + $stream = self::tryFopen('php://temp', 'r+'); + if ($resource !== '') { + fwrite($stream, (string) $resource); + fseek($stream, 0); + } + + return new Stream($stream, $options); + } + + switch (gettype($resource)) { + case 'resource': + /* + * The 'php://input' is a special stream with quirks and inconsistencies. + * We avoid using that stream by reading it into php://temp + */ + + /** @var resource $resource */ + if ((\stream_get_meta_data($resource)['uri'] ?? '') === 'php://input') { + $stream = self::tryFopen('php://temp', 'w+'); + stream_copy_to_stream($resource, $stream); + fseek($stream, 0); + $resource = $stream; + } + + return new Stream($resource, $options); + case 'object': + /** @var object $resource */ + if ($resource instanceof StreamInterface) { + return $resource; + } elseif ($resource instanceof \Iterator) { + return new PumpStream(function () use ($resource) { + if (!$resource->valid()) { + return false; + } + $result = $resource->current(); + $resource->next(); + + return $result; + }, $options); + } elseif (method_exists($resource, '__toString')) { + return self::streamFor((string) $resource, $options); + } + break; + case 'NULL': + return new Stream(self::tryFopen('php://temp', 'r+'), $options); + } + + if (is_callable($resource)) { + return new PumpStream($resource, $options); + } + + throw new \InvalidArgumentException('Invalid resource type: '.gettype($resource)); + } + + /** + * Safely opens a PHP stream resource using a filename. + * + * When fopen fails, PHP normally raises a warning. This function adds an + * error handler that checks for errors and throws an exception instead. + * + * @param string $filename File to open + * @param string $mode Mode used to open the file + * + * @return resource + * + * @throws \RuntimeException if the file cannot be opened + */ + public static function tryFopen(string $filename, string $mode) + { + $ex = null; + set_error_handler(static function (int $errno, string $errstr) use ($filename, $mode, &$ex): bool { + $ex = new \RuntimeException(sprintf( + 'Unable to open "%s" using mode "%s": %s', + $filename, + $mode, + $errstr + )); + + return true; + }); + + try { + /** @var resource $handle */ + $handle = fopen($filename, $mode); + } catch (\Throwable $e) { + $ex = new \RuntimeException(sprintf( + 'Unable to open "%s" using mode "%s": %s', + $filename, + $mode, + $e->getMessage() + ), 0, $e); + } + + restore_error_handler(); + + if ($ex) { + /** @var $ex \RuntimeException */ + throw $ex; + } + + return $handle; + } + + /** + * Safely gets the contents of a given stream. + * + * When stream_get_contents fails, PHP normally raises a warning. This + * function adds an error handler that checks for errors and throws an + * exception instead. + * + * @param resource $stream + * + * @throws \RuntimeException if the stream cannot be read + */ + public static function tryGetContents($stream): string + { + $ex = null; + set_error_handler(static function (int $errno, string $errstr) use (&$ex): bool { + $ex = new \RuntimeException(sprintf( + 'Unable to read stream contents: %s', + $errstr + )); + + return true; + }); + + try { + /** @var string|false $contents */ + $contents = stream_get_contents($stream); + + if ($contents === false) { + $ex = new \RuntimeException('Unable to read stream contents'); + } + } catch (\Throwable $e) { + $ex = new \RuntimeException(sprintf( + 'Unable to read stream contents: %s', + $e->getMessage() + ), 0, $e); + } + + restore_error_handler(); + + if ($ex) { + /** @var $ex \RuntimeException */ + throw $ex; + } + + return $contents; + } + + /** + * Returns a UriInterface for the given value. + * + * This function accepts a string or UriInterface and returns a + * UriInterface for the given value. If the value is already a + * UriInterface, it is returned as-is. + * + * @param string|UriInterface $uri + * + * @throws \InvalidArgumentException + */ + public static function uriFor($uri): UriInterface + { + if ($uri instanceof UriInterface) { + return $uri; + } + + if (is_string($uri)) { + return new Uri($uri); + } + + throw new \InvalidArgumentException('URI must be a string or UriInterface'); + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/matthiasmullie/minify/src/CSS.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/matthiasmullie/minify/src/CSS.php new file mode 100644 index 0000000000..4f56320c47 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/matthiasmullie/minify/src/CSS.php @@ -0,0 +1,870 @@ +<?php + +/** + * CSS Minifier. + * + * Please report bugs on https://github.com/matthiasmullie/minify/issues + * + * @author Matthias Mullie <minify@mullie.eu> + * @copyright Copyright (c) 2012, Matthias Mullie. All rights reserved + * @license MIT License + */ + +namespace MatthiasMullie\Minify; + +use MatthiasMullie\Minify\Exceptions\FileImportException; +use MatthiasMullie\PathConverter\Converter; +use MatthiasMullie\PathConverter\ConverterInterface; + +/** + * CSS minifier. + * + * Please report bugs on https://github.com/matthiasmullie/minify/issues + * + * @author Matthias Mullie <minify@mullie.eu> + * @author Tijs Verkoyen <minify@verkoyen.eu> + * @copyright Copyright (c) 2012, Matthias Mullie. All rights reserved + * @license MIT License + */ +class CSS extends Minify +{ + /** + * @var int maximum inport size in kB + */ + protected $maxImportSize = 5; + + /** + * @var string[] valid import extensions + */ + protected $importExtensions = array( + 'gif' => 'data:image/gif', + 'png' => 'data:image/png', + 'jpe' => 'data:image/jpeg', + 'jpg' => 'data:image/jpeg', + 'jpeg' => 'data:image/jpeg', + 'svg' => 'data:image/svg+xml', + 'woff' => 'data:application/x-font-woff', + 'woff2' => 'data:application/x-font-woff2', + 'avif' => 'data:image/avif', + 'apng' => 'data:image/apng', + 'webp' => 'data:image/webp', + 'tif' => 'image/tiff', + 'tiff' => 'image/tiff', + 'xbm' => 'image/x-xbitmap', + ); + + /** + * Set the maximum size if files to be imported. + * + * Files larger than this size (in kB) will not be imported into the CSS. + * Importing files into the CSS as data-uri will save you some connections, + * but we should only import relatively small decorative images so that our + * CSS file doesn't get too bulky. + * + * @param int $size Size in kB + */ + public function setMaxImportSize($size) + { + $this->maxImportSize = $size; + } + + /** + * Set the type of extensions to be imported into the CSS (to save network + * connections). + * Keys of the array should be the file extensions & respective values + * should be the data type. + * + * @param string[] $extensions Array of file extensions + */ + public function setImportExtensions(array $extensions) + { + $this->importExtensions = $extensions; + } + + /** + * Move any import statements to the top. + * + * @param string $content Nearly finished CSS content + * + * @return string + */ + protected function moveImportsToTop($content) + { + if (preg_match_all('/(;?)(@import (?<url>url\()?(?P<quotes>["\']?).+?(?P=quotes)(?(url)\)));?/', $content, $matches)) { + // remove from content + foreach ($matches[0] as $import) { + $content = str_replace($import, '', $content); + } + + // add to top + $content = implode(';', $matches[2]) . ';' . trim($content, ';'); + } + + return $content; + } + + /** + * Combine CSS from import statements. + * + * \@import's will be loaded and their content merged into the original file, + * to save HTTP requests. + * + * @param string $source The file to combine imports for + * @param string $content The CSS content to combine imports for + * @param string[] $parents Parent paths, for circular reference checks + * + * @return string + * + * @throws FileImportException + */ + protected function combineImports($source, $content, $parents) + { + $importRegexes = array( + // @import url(xxx) + '/ + # import statement + @import + + # whitespace + \s+ + + # open url() + url\( + + # (optional) open path enclosure + (?P<quotes>["\']?) + + # fetch path + (?P<path>.+?) + + # (optional) close path enclosure + (?P=quotes) + + # close url() + \) + + # (optional) trailing whitespace + \s* + + # (optional) media statement(s) + (?P<media>[^;]*) + + # (optional) trailing whitespace + \s* + + # (optional) closing semi-colon + ;? + + /ix', + + // @import 'xxx' + '/ + + # import statement + @import + + # whitespace + \s+ + + # open path enclosure + (?P<quotes>["\']) + + # fetch path + (?P<path>.+?) + + # close path enclosure + (?P=quotes) + + # (optional) trailing whitespace + \s* + + # (optional) media statement(s) + (?P<media>[^;]*) + + # (optional) trailing whitespace + \s* + + # (optional) closing semi-colon + ;? + + /ix', + ); + + // find all relative imports in css + $matches = array(); + foreach ($importRegexes as $importRegex) { + if (preg_match_all($importRegex, $content, $regexMatches, PREG_SET_ORDER)) { + $matches = array_merge($matches, $regexMatches); + } + } + + $search = array(); + $replace = array(); + + // loop the matches + foreach ($matches as $match) { + // get the path for the file that will be imported + $importPath = dirname($source) . '/' . $match['path']; + + // only replace the import with the content if we can grab the + // content of the file + if (!$this->canImportByPath($match['path']) || !$this->canImportFile($importPath)) { + continue; + } + + // check if current file was not imported previously in the same + // import chain. + if (in_array($importPath, $parents)) { + throw new FileImportException('Failed to import file "' . $importPath . '": circular reference detected.'); + } + + // grab referenced file & minify it (which may include importing + // yet other @import statements recursively) + $minifier = new self($importPath); + $minifier->setMaxImportSize($this->maxImportSize); + $minifier->setImportExtensions($this->importExtensions); + $importContent = $minifier->execute($source, $parents); + + // check if this is only valid for certain media + if (!empty($match['media'])) { + $importContent = '@media ' . $match['media'] . '{' . $importContent . '}'; + } + + // add to replacement array + $search[] = $match[0]; + $replace[] = $importContent; + } + + // replace the import statements + return str_replace($search, $replace, $content); + } + + /** + * Import files into the CSS, base64-ized. + * + * @url(image.jpg) images will be loaded and their content merged into the + * original file, to save HTTP requests. + * + * @param string $source The file to import files for + * @param string $content The CSS content to import files for + * + * @return string + */ + protected function importFiles($source, $content) + { + $regex = '/url\((["\']?)(.+?)\\1\)/i'; + if ($this->importExtensions && preg_match_all($regex, $content, $matches, PREG_SET_ORDER)) { + $search = array(); + $replace = array(); + + // loop the matches + foreach ($matches as $match) { + $extension = substr(strrchr($match[2], '.'), 1); + if ($extension && !array_key_exists($extension, $this->importExtensions)) { + continue; + } + + // get the path for the file that will be imported + $path = $match[2]; + $path = dirname($source) . '/' . $path; + + // only replace the import with the content if we're able to get + // the content of the file, and it's relatively small + if ($this->canImportFile($path) && $this->canImportBySize($path)) { + // grab content && base64-ize + $importContent = $this->load($path); + $importContent = base64_encode($importContent); + + // build replacement + $search[] = $match[0]; + $replace[] = 'url(' . $this->importExtensions[$extension] . ';base64,' . $importContent . ')'; + } + } + + // replace the import statements + $content = str_replace($search, $replace, $content); + } + + return $content; + } + + /** + * Minify the data. + * Perform CSS optimizations. + * + * @param string[optional] $path Path to write the data to + * @param string[] $parents Parent paths, for circular reference checks + * + * @return string The minified data + */ + public function execute($path = null, $parents = array()) + { + $content = ''; + + // loop CSS data (raw data and files) + foreach ($this->data as $source => $css) { + /* + * Let's first take out strings & comments, since we can't just + * remove whitespace anywhere. If whitespace occurs inside a string, + * we should leave it alone. E.g.: + * p { content: "a test" } + */ + $this->extractStrings(); + $this->stripComments(); + $this->extractMath(); + $this->extractCustomProperties(); + $css = $this->replace($css); + + $css = $this->stripWhitespace($css); + $css = $this->convertLegacyColors($css); + $css = $this->cleanupModernColors($css); + $css = $this->shortenHEXColors($css); + $css = $this->shortenZeroes($css); + $css = $this->shortenFontWeights($css); + $css = $this->stripEmptyTags($css); + + // restore the string we've extracted earlier + $css = $this->restoreExtractedData($css); + + $source = is_int($source) ? '' : $source; + $parents = $source ? array_merge($parents, array($source)) : $parents; + $css = $this->combineImports($source, $css, $parents); + $css = $this->importFiles($source, $css); + + /* + * If we'll save to a new path, we'll have to fix the relative paths + * to be relative no longer to the source file, but to the new path. + * If we don't write to a file, fall back to same path so no + * conversion happens (because we still want it to go through most + * of the move code, which also addresses url() & @import syntax...) + */ + $converter = $this->getPathConverter($source, $path ?: $source); + $css = $this->move($converter, $css); + + // combine css + $content .= $css; + } + + $content = $this->moveImportsToTop($content); + + return $content; + } + + /** + * Moving a css file should update all relative urls. + * Relative references (e.g. ../images/image.gif) in a certain css file, + * will have to be updated when a file is being saved at another location + * (e.g. ../../images/image.gif, if the new CSS file is 1 folder deeper). + * + * @param ConverterInterface $converter Relative path converter + * @param string $content The CSS content to update relative urls for + * + * @return string + */ + protected function move(ConverterInterface $converter, $content) + { + /* + * Relative path references will usually be enclosed by url(). @import + * is an exception, where url() is not necessary around the path (but is + * allowed). + * This *could* be 1 regular expression, where both regular expressions + * in this array are on different sides of a |. But we're using named + * patterns in both regexes, the same name on both regexes. This is only + * possible with a (?J) modifier, but that only works after a fairly + * recent PCRE version. That's why I'm doing 2 separate regular + * expressions & combining the matches after executing of both. + */ + $relativeRegexes = array( + // url(xxx) + '/ + # open url() + url\( + + \s* + + # open path enclosure + (?P<quotes>["\'])? + + # fetch path + (?P<path>.+?) + + # close path enclosure + (?(quotes)(?P=quotes)) + + \s* + + # close url() + \) + + /ix', + + // @import "xxx" + '/ + # import statement + @import + + # whitespace + \s+ + + # we don\'t have to check for @import url(), because the + # condition above will already catch these + + # open path enclosure + (?P<quotes>["\']) + + # fetch path + (?P<path>.+?) + + # close path enclosure + (?P=quotes) + + /ix', + ); + + // find all relative urls in css + $matches = array(); + foreach ($relativeRegexes as $relativeRegex) { + if (preg_match_all($relativeRegex, $content, $regexMatches, PREG_SET_ORDER)) { + $matches = array_merge($matches, $regexMatches); + } + } + + $search = array(); + $replace = array(); + + // loop all urls + foreach ($matches as $match) { + // determine if it's a url() or an @import match + $type = (strpos($match[0], '@import') === 0 ? 'import' : 'url'); + + $url = $match['path']; + if ($this->canImportByPath($url)) { + // attempting to interpret GET-params makes no sense, so let's discard them for awhile + $params = strrchr($url, '?'); + $url = $params ? substr($url, 0, -strlen($params)) : $url; + + // fix relative url + $url = $converter->convert($url); + + // now that the path has been converted, re-apply GET-params + $url .= $params; + } + + /* + * Urls with control characters above 0x7e should be quoted. + * According to Mozilla's parser, whitespace is only allowed at the + * end of unquoted urls. + * Urls with `)` (as could happen with data: uris) should also be + * quoted to avoid being confused for the url() closing parentheses. + * And urls with a # have also been reported to cause issues. + * Urls with quotes inside should also remain escaped. + * + * @see https://developer.mozilla.org/nl/docs/Web/CSS/url#The_url()_functional_notation + * @see https://hg.mozilla.org/mozilla-central/rev/14abca4e7378 + * @see https://github.com/matthiasmullie/minify/issues/193 + */ + $url = trim($url); + if (preg_match('/[\s\)\'"#\x{7f}-\x{9f}]/u', $url)) { + $url = $match['quotes'] . $url . $match['quotes']; + } + + // build replacement + $search[] = $match[0]; + if ($type === 'url') { + $replace[] = 'url(' . $url . ')'; + } elseif ($type === 'import') { + $replace[] = '@import "' . $url . '"'; + } + } + + // replace urls + return str_replace($search, $replace, $content); + } + + /** + * Shorthand HEX color codes. + * #FF0000FF -> #f00 -> red + * #FF00FF00 -> transparent. + * + * @param string $content The CSS content to shorten the HEX color codes for + * + * @return string + */ + protected function shortenHexColors($content) + { + // shorten repeating patterns within HEX .. + $content = preg_replace('/(?<=[: ])#([0-9a-f])\\1([0-9a-f])\\2([0-9a-f])\\3(?:([0-9a-f])\\4)?(?=[; }])/i', '#$1$2$3$4', $content); + + // remove alpha channel if it's pointless .. + $content = preg_replace('/(?<=[: ])#([0-9a-f]{6})ff(?=[; }])/i', '#$1', $content); + $content = preg_replace('/(?<=[: ])#([0-9a-f]{3})f(?=[; }])/i', '#$1', $content); + + // replace `transparent` with shortcut .. + $content = preg_replace('/(?<=[: ])#[0-9a-f]{6}00(?=[; }])/i', '#fff0', $content); + + $colors = array( + // make these more readable + '#00f' => 'blue', + '#dc143c' => 'crimson', + '#0ff' => 'cyan', + '#8b0000' => 'darkred', + '#696969' => 'dimgray', + '#ff69b4' => 'hotpink', + '#0f0' => 'lime', + '#fdf5e6' => 'oldlace', + '#87ceeb' => 'skyblue', + '#d8bfd8' => 'thistle', + // we can shorten some even more by replacing them with their color name + '#f0ffff' => 'azure', + '#f5f5dc' => 'beige', + '#ffe4c4' => 'bisque', + '#a52a2a' => 'brown', + '#ff7f50' => 'coral', + '#ffd700' => 'gold', + '#808080' => 'gray', + '#008000' => 'green', + '#4b0082' => 'indigo', + '#fffff0' => 'ivory', + '#f0e68c' => 'khaki', + '#faf0e6' => 'linen', + '#800000' => 'maroon', + '#000080' => 'navy', + '#808000' => 'olive', + '#ffa500' => 'orange', + '#da70d6' => 'orchid', + '#cd853f' => 'peru', + '#ffc0cb' => 'pink', + '#dda0dd' => 'plum', + '#800080' => 'purple', + '#f00' => 'red', + '#fa8072' => 'salmon', + '#a0522d' => 'sienna', + '#c0c0c0' => 'silver', + '#fffafa' => 'snow', + '#d2b48c' => 'tan', + '#008080' => 'teal', + '#ff6347' => 'tomato', + '#ee82ee' => 'violet', + '#f5deb3' => 'wheat', + // or the other way around + 'black' => '#000', + 'fuchsia' => '#f0f', + 'magenta' => '#f0f', + 'white' => '#fff', + 'yellow' => '#ff0', + // and also `transparent` + 'transparent' => '#fff0', + ); + + return preg_replace_callback( + '/(?<=[: ])(' . implode('|', array_keys($colors)) . ')(?=[; }])/i', + function ($match) use ($colors) { + return $colors[strtolower($match[0])]; + }, + $content + ); + } + + /** + * Convert RGB|HSL color codes. + * rgb(255,0,0,.5) -> rgb(255 0 0 / .5). + * rgb(255,0,0) -> #f00. + * + * @param string $content The CSS content to shorten the RGB color codes for + * + * @return string + */ + protected function convertLegacyColors($content) + { + /* + https://drafts.csswg.org/css-color/#color-syntax-legacy + https://developer.mozilla.org/en-US/docs/Web/CSS/color_value/rgb + https://developer.mozilla.org/en-US/docs/Web/CSS/color_value/hsl + */ + + // convert legacy color syntax + $content = preg_replace('/(rgb)a?\(\s*([0-9]{1,3}%?)\s*,\s*([0-9]{1,3}%?)\s*,\s*([0-9]{1,3}%?)\s*,\s*([0,1]?(?:\.[0-9]*)?)\s*\)/i', '$1($2 $3 $4 / $5)', $content); + $content = preg_replace('/(rgb)a?\(\s*([0-9]{1,3}%?)\s*,\s*([0-9]{1,3}%?)\s*,\s*([0-9]{1,3}%?)\s*\)/i', '$1($2 $3 $4)', $content); + $content = preg_replace('/(hsl)a?\(\s*([0-9]+(?:deg|grad|rad|turn)?)\s*,\s*([0-9]{1,3}%)\s*,\s*([0-9]{1,3}%)\s*,\s*([0,1]?(?:\.[0-9]*)?)\s*\)/i', '$1($2 $3 $4 / $5)', $content); + $content = preg_replace('/(hsl)a?\(\s*([0-9]+(?:deg|grad|rad|turn)?)\s*,\s*([0-9]{1,3}%)\s*,\s*([0-9]{1,3}%)\s*\)/i', '$1($2 $3 $4)', $content); + + // convert `rgb` to `hex` + $dec = '([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])'; + return preg_replace_callback( + "/rgb\($dec $dec $dec\)/i", + function ($match) { + return sprintf('#%02x%02x%02x', $match[1], $match[2], $match[3]); + }, + $content + ); + } + + /** + * Cleanup RGB|HSL|HWB|LCH|LAB + * rgb(255 0 0 / 1) -> rgb(255 0 0). + * rgb(255 0 0 / 0) -> transparent. + * + * @param string $content The CSS content to cleanup HSL|HWB|LCH|LAB + * + * @return string + */ + protected function cleanupModernColors($content) + { + /* + https://drafts.csswg.org/css-color/#color-syntax-modern + https://developer.mozilla.org/en-US/docs/Web/CSS/color_value/hwb + https://developer.mozilla.org/en-US/docs/Web/CSS/color_value/lch + https://developer.mozilla.org/en-US/docs/Web/CSS/color_value/lab + https://developer.mozilla.org/en-US/docs/Web/CSS/color_value/oklch + https://developer.mozilla.org/en-US/docs/Web/CSS/color_value/oklab + */ + $tag = '(rgb|hsl|hwb|(?:(?:ok)?(?:lch|lab)))'; + + // remove alpha channel if it's pointless .. + $content = preg_replace('/' . $tag . '\(\s*([^\s]+)\s+([^\s]+)\s+([^\s]+)\s+\/\s+1(?:(?:\.\d?)*|00%)?\s*\)/i', '$1($2 $3 $4)', $content); + + // replace `transparent` with shortcut .. + $content = preg_replace('/' . $tag . '\(\s*[^\s]+\s+[^\s]+\s+[^\s]+\s+\/\s+0(?:[\.0%]*)?\s*\)/i', '#fff0', $content); + + return $content; + } + + /** + * Shorten CSS font weights. + * + * @param string $content The CSS content to shorten the font weights for + * + * @return string + */ + protected function shortenFontWeights($content) + { + $weights = array( + 'normal' => 400, + 'bold' => 700, + ); + + $callback = function ($match) use ($weights) { + return $match[1] . $weights[$match[2]]; + }; + + return preg_replace_callback('/(font-weight\s*:\s*)(' . implode('|', array_keys($weights)) . ')(?=[;}])/', $callback, $content); + } + + /** + * Shorthand 0 values to plain 0, instead of e.g. -0em. + * + * @param string $content The CSS content to shorten the zero values for + * + * @return string + */ + protected function shortenZeroes($content) + { + // we don't want to strip units in `calc()` expressions: + // `5px - 0px` is valid, but `5px - 0` is not + // `10px * 0` is valid (equates to 0), and so is `10 * 0px`, but + // `10 * 0` is invalid + // we've extracted calcs earlier, so we don't need to worry about this + + // reusable bits of code throughout these regexes: + // before & after are used to make sure we don't match lose unintended + // 0-like values (e.g. in #000, or in http://url/1.0) + // units can be stripped from 0 values, or used to recognize non 0 + // values (where wa may be able to strip a .0 suffix) + $before = '(?<=[:(, ])'; + $after = '(?=[ ,);}])'; + $units = '(em|ex|%|px|cm|mm|in|pt|pc|ch|rem|vh|vw|vmin|vmax|vm)'; + + // strip units after zeroes (0px -> 0) + // NOTE: it should be safe to remove all units for a 0 value, but in + // practice, Webkit (especially Safari) seems to stumble over at least + // 0%, potentially other units as well. Only stripping 'px' for now. + // @see https://github.com/matthiasmullie/minify/issues/60 + $content = preg_replace('/' . $before . '(-?0*(\.0+)?)(?<=0)px' . $after . '/', '\\1', $content); + + // strip 0-digits (.0 -> 0) + $content = preg_replace('/' . $before . '\.0+' . $units . '?' . $after . '/', '0\\1', $content); + // strip trailing 0: 50.10 -> 50.1, 50.10px -> 50.1px + $content = preg_replace('/' . $before . '(-?[0-9]+\.[0-9]+)0+' . $units . '?' . $after . '/', '\\1\\2', $content); + // strip trailing 0: 50.00 -> 50, 50.00px -> 50px + $content = preg_replace('/' . $before . '(-?[0-9]+)\.0+' . $units . '?' . $after . '/', '\\1\\2', $content); + // strip leading 0: 0.1 -> .1, 01.1 -> 1.1 + $content = preg_replace('/' . $before . '(-?)0+([0-9]*\.[0-9]+)' . $units . '?' . $after . '/', '\\1\\2\\3', $content); + + // strip negative zeroes (-0 -> 0) & truncate zeroes (00 -> 0) + $content = preg_replace('/' . $before . '-?0+' . $units . '?' . $after . '/', '0\\1', $content); + + // IE doesn't seem to understand a unitless flex-basis value (correct - + // it goes against the spec), so let's add it in again (make it `%`, + // which is only 1 char: 0%, 0px, 0 anything, it's all just the same) + // @see https://developer.mozilla.org/nl/docs/Web/CSS/flex + $content = preg_replace('/flex:([0-9]+\s[0-9]+\s)0([;\}])/', 'flex:${1}0%${2}', $content); + $content = preg_replace('/flex-basis:0([;\}])/', 'flex-basis:0%${1}', $content); + + return $content; + } + + /** + * Strip empty tags from source code. + * + * @param string $content + * + * @return string + */ + protected function stripEmptyTags($content) + { + $content = preg_replace('/(?<=^)[^\{\};]+\{\s*\}/', '', $content); + $content = preg_replace('/(?<=(\}|;))[^\{\};]+\{\s*\}/', '', $content); + + return $content; + } + + /** + * Strip comments from source code. + */ + protected function stripComments() + { + $this->stripMultilineComments(); + } + + /** + * Strip whitespace. + * + * @param string $content The CSS content to strip the whitespace for + * + * @return string + */ + protected function stripWhitespace($content) + { + // remove leading & trailing whitespace + $content = preg_replace('/^\s*/m', '', $content); + $content = preg_replace('/\s*$/m', '', $content); + + // replace newlines with a single space + $content = preg_replace('/\s+/', ' ', $content); + + // remove whitespace around meta characters + // inspired by stackoverflow.com/questions/15195750/minify-compress-css-with-regex + $content = preg_replace('/\s*([\*$~^|]?+=|[{};,>~]|!important\b)\s*/', '$1', $content); + $content = preg_replace('/([\[(:>\+])\s+/', '$1', $content); + $content = preg_replace('/\s+([\]\)>\+])/', '$1', $content); + $content = preg_replace('/\s+(:)(?![^\}]*\{)/', '$1', $content); + + // whitespace around + and - can only be stripped inside some pseudo- + // classes, like `:nth-child(3+2n)` + // not in things like `calc(3px + 2px)`, shorthands like `3px -2px`, or + // selectors like `div.weird- p` + $pseudos = array('nth-child', 'nth-last-child', 'nth-last-of-type', 'nth-of-type'); + $content = preg_replace('/:(' . implode('|', $pseudos) . ')\(\s*([+-]?)\s*(.+?)\s*([+-]?)\s*(.*?)\s*\)/', ':$1($2$3$4$5)', $content); + + // remove semicolon/whitespace followed by closing bracket + $content = str_replace(';}', '}', $content); + + return trim($content); + } + + /** + * Replace all occurrences of functions that may contain math, where + * whitespace around operators needs to be preserved (e.g. calc, clamp). + */ + protected function extractMath() + { + $functions = array('calc', 'clamp', 'min', 'max'); + $pattern = '/\b(' . implode('|', $functions) . ')(\(.+?)(?=$|;|})/m'; + + // PHP only supports $this inside anonymous functions since 5.4 + $minifier = $this; + $callback = function ($match) use ($minifier, $pattern, &$callback) { + $function = $match[1]; + $length = strlen($match[2]); + $expr = ''; + $opened = 0; + + // the regular expression for extracting math has 1 significant problem: + // it can't determine the correct closing parenthesis... + // instead, it'll match a larger portion of code to where it's certain that + // the calc() musts have ended, and we'll figure out which is the correct + // closing parenthesis here, by counting how many have opened + for ($i = 0; $i < $length; ++$i) { + $char = $match[2][$i]; + $expr .= $char; + if ($char === '(') { + ++$opened; + } elseif ($char === ')' && --$opened === 0) { + break; + } + } + + // now that we've figured out where the calc() starts and ends, extract it + $count = count($minifier->extracted); + $placeholder = 'math(' . $count . ')'; + $minifier->extracted[$placeholder] = $function . '(' . trim(substr($expr, 1, -1)) . ')'; + + // and since we've captured more code than required, we may have some leftover + // calc() in here too - go recursive on the remaining but of code to go figure + // that out and extract what is needed + $rest = $minifier->str_replace_first($function . $expr, '', $match[0]); + $rest = preg_replace_callback($pattern, $callback, $rest); + + return $placeholder . $rest; + }; + + $this->registerPattern($pattern, $callback); + } + + /** + * Replace custom properties, whose values may be used in scenarios where + * we wouldn't want them to be minified (e.g. inside calc). + */ + protected function extractCustomProperties() + { + // PHP only supports $this inside anonymous functions since 5.4 + $minifier = $this; + $this->registerPattern( + '/(?<=^|[;}{])\s*(--[^:;{}"\'\s]+)\s*:([^;{}]+)/m', + function ($match) use ($minifier) { + $placeholder = '--custom-' . count($minifier->extracted) . ':0'; + $minifier->extracted[$placeholder] = $match[1] . ':' . trim($match[2]); + + return $placeholder; + } + ); + } + + /** + * Check if file is small enough to be imported. + * + * @param string $path The path to the file + * + * @return bool + */ + protected function canImportBySize($path) + { + return ($size = @filesize($path)) && $size <= $this->maxImportSize * 1024; + } + + /** + * Check if file a file can be imported, going by the path. + * + * @param string $path + * + * @return bool + */ + protected function canImportByPath($path) + { + return preg_match('/^(data:|https?:|\\/)/', $path) === 0; + } + + /** + * Return a converter to update relative paths to be relative to the new + * destination. + * + * @param string $source + * @param string $target + * + * @return ConverterInterface + */ + protected function getPathConverter($source, $target) + { + return new Converter($source, $target); + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/matthiasmullie/minify/src/JS.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/matthiasmullie/minify/src/JS.php new file mode 100644 index 0000000000..9cf43a2e74 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/matthiasmullie/minify/src/JS.php @@ -0,0 +1,618 @@ +<?php + +/** + * JavaScript minifier. + * + * Please report bugs on https://github.com/matthiasmullie/minify/issues + * + * @author Matthias Mullie <minify@mullie.eu> + * @copyright Copyright (c) 2012, Matthias Mullie. All rights reserved + * @license MIT License + */ + +namespace MatthiasMullie\Minify; + +/** + * JavaScript Minifier Class. + * + * Please report bugs on https://github.com/matthiasmullie/minify/issues + * + * @author Matthias Mullie <minify@mullie.eu> + * @author Tijs Verkoyen <minify@verkoyen.eu> + * @copyright Copyright (c) 2012, Matthias Mullie. All rights reserved + * @license MIT License + */ +class JS extends Minify +{ + /** + * Var-matching regex based on http://stackoverflow.com/a/9337047/802993. + * + * Note that regular expressions using that bit must have the PCRE_UTF8 + * pattern modifier (/u) set. + * + * @internal + * + * @var string + */ + const REGEX_VARIABLE = '\b[$A-Z\_a-z\xaa\xb5\xba\xc0-\xd6\xd8-\xf6\xf8-\x{02c1}\x{02c6}-\x{02d1}\x{02e0}-\x{02e4}\x{02ec}\x{02ee}\x{0370}-\x{0374}\x{0376}\x{0377}\x{037a}-\x{037d}\x{0386}\x{0388}-\x{038a}\x{038c}\x{038e}-\x{03a1}\x{03a3}-\x{03f5}\x{03f7}-\x{0481}\x{048a}-\x{0527}\x{0531}-\x{0556}\x{0559}\x{0561}-\x{0587}\x{05d0}-\x{05ea}\x{05f0}-\x{05f2}\x{0620}-\x{064a}\x{066e}\x{066f}\x{0671}-\x{06d3}\x{06d5}\x{06e5}\x{06e6}\x{06ee}\x{06ef}\x{06fa}-\x{06fc}\x{06ff}\x{0710}\x{0712}-\x{072f}\x{074d}-\x{07a5}\x{07b1}\x{07ca}-\x{07ea}\x{07f4}\x{07f5}\x{07fa}\x{0800}-\x{0815}\x{081a}\x{0824}\x{0828}\x{0840}-\x{0858}\x{08a0}\x{08a2}-\x{08ac}\x{0904}-\x{0939}\x{093d}\x{0950}\x{0958}-\x{0961}\x{0971}-\x{0977}\x{0979}-\x{097f}\x{0985}-\x{098c}\x{098f}\x{0990}\x{0993}-\x{09a8}\x{09aa}-\x{09b0}\x{09b2}\x{09b6}-\x{09b9}\x{09bd}\x{09ce}\x{09dc}\x{09dd}\x{09df}-\x{09e1}\x{09f0}\x{09f1}\x{0a05}-\x{0a0a}\x{0a0f}\x{0a10}\x{0a13}-\x{0a28}\x{0a2a}-\x{0a30}\x{0a32}\x{0a33}\x{0a35}\x{0a36}\x{0a38}\x{0a39}\x{0a59}-\x{0a5c}\x{0a5e}\x{0a72}-\x{0a74}\x{0a85}-\x{0a8d}\x{0a8f}-\x{0a91}\x{0a93}-\x{0aa8}\x{0aaa}-\x{0ab0}\x{0ab2}\x{0ab3}\x{0ab5}-\x{0ab9}\x{0abd}\x{0ad0}\x{0ae0}\x{0ae1}\x{0b05}-\x{0b0c}\x{0b0f}\x{0b10}\x{0b13}-\x{0b28}\x{0b2a}-\x{0b30}\x{0b32}\x{0b33}\x{0b35}-\x{0b39}\x{0b3d}\x{0b5c}\x{0b5d}\x{0b5f}-\x{0b61}\x{0b71}\x{0b83}\x{0b85}-\x{0b8a}\x{0b8e}-\x{0b90}\x{0b92}-\x{0b95}\x{0b99}\x{0b9a}\x{0b9c}\x{0b9e}\x{0b9f}\x{0ba3}\x{0ba4}\x{0ba8}-\x{0baa}\x{0bae}-\x{0bb9}\x{0bd0}\x{0c05}-\x{0c0c}\x{0c0e}-\x{0c10}\x{0c12}-\x{0c28}\x{0c2a}-\x{0c33}\x{0c35}-\x{0c39}\x{0c3d}\x{0c58}\x{0c59}\x{0c60}\x{0c61}\x{0c85}-\x{0c8c}\x{0c8e}-\x{0c90}\x{0c92}-\x{0ca8}\x{0caa}-\x{0cb3}\x{0cb5}-\x{0cb9}\x{0cbd}\x{0cde}\x{0ce0}\x{0ce1}\x{0cf1}\x{0cf2}\x{0d05}-\x{0d0c}\x{0d0e}-\x{0d10}\x{0d12}-\x{0d3a}\x{0d3d}\x{0d4e}\x{0d60}\x{0d61}\x{0d7a}-\x{0d7f}\x{0d85}-\x{0d96}\x{0d9a}-\x{0db1}\x{0db3}-\x{0dbb}\x{0dbd}\x{0dc0}-\x{0dc6}\x{0e01}-\x{0e30}\x{0e32}\x{0e33}\x{0e40}-\x{0e46}\x{0e81}\x{0e82}\x{0e84}\x{0e87}\x{0e88}\x{0e8a}\x{0e8d}\x{0e94}-\x{0e97}\x{0e99}-\x{0e9f}\x{0ea1}-\x{0ea3}\x{0ea5}\x{0ea7}\x{0eaa}\x{0eab}\x{0ead}-\x{0eb0}\x{0eb2}\x{0eb3}\x{0ebd}\x{0ec0}-\x{0ec4}\x{0ec6}\x{0edc}-\x{0edf}\x{0f00}\x{0f40}-\x{0f47}\x{0f49}-\x{0f6c}\x{0f88}-\x{0f8c}\x{1000}-\x{102a}\x{103f}\x{1050}-\x{1055}\x{105a}-\x{105d}\x{1061}\x{1065}\x{1066}\x{106e}-\x{1070}\x{1075}-\x{1081}\x{108e}\x{10a0}-\x{10c5}\x{10c7}\x{10cd}\x{10d0}-\x{10fa}\x{10fc}-\x{1248}\x{124a}-\x{124d}\x{1250}-\x{1256}\x{1258}\x{125a}-\x{125d}\x{1260}-\x{1288}\x{128a}-\x{128d}\x{1290}-\x{12b0}\x{12b2}-\x{12b5}\x{12b8}-\x{12be}\x{12c0}\x{12c2}-\x{12c5}\x{12c8}-\x{12d6}\x{12d8}-\x{1310}\x{1312}-\x{1315}\x{1318}-\x{135a}\x{1380}-\x{138f}\x{13a0}-\x{13f4}\x{1401}-\x{166c}\x{166f}-\x{167f}\x{1681}-\x{169a}\x{16a0}-\x{16ea}\x{16ee}-\x{16f0}\x{1700}-\x{170c}\x{170e}-\x{1711}\x{1720}-\x{1731}\x{1740}-\x{1751}\x{1760}-\x{176c}\x{176e}-\x{1770}\x{1780}-\x{17b3}\x{17d7}\x{17dc}\x{1820}-\x{1877}\x{1880}-\x{18a8}\x{18aa}\x{18b0}-\x{18f5}\x{1900}-\x{191c}\x{1950}-\x{196d}\x{1970}-\x{1974}\x{1980}-\x{19ab}\x{19c1}-\x{19c7}\x{1a00}-\x{1a16}\x{1a20}-\x{1a54}\x{1aa7}\x{1b05}-\x{1b33}\x{1b45}-\x{1b4b}\x{1b83}-\x{1ba0}\x{1bae}\x{1baf}\x{1bba}-\x{1be5}\x{1c00}-\x{1c23}\x{1c4d}-\x{1c4f}\x{1c5a}-\x{1c7d}\x{1ce9}-\x{1cec}\x{1cee}-\x{1cf1}\x{1cf5}\x{1cf6}\x{1d00}-\x{1dbf}\x{1e00}-\x{1f15}\x{1f18}-\x{1f1d}\x{1f20}-\x{1f45}\x{1f48}-\x{1f4d}\x{1f50}-\x{1f57}\x{1f59}\x{1f5b}\x{1f5d}\x{1f5f}-\x{1f7d}\x{1f80}-\x{1fb4}\x{1fb6}-\x{1fbc}\x{1fbe}\x{1fc2}-\x{1fc4}\x{1fc6}-\x{1fcc}\x{1fd0}-\x{1fd3}\x{1fd6}-\x{1fdb}\x{1fe0}-\x{1fec}\x{1ff2}-\x{1ff4}\x{1ff6}-\x{1ffc}\x{2071}\x{207f}\x{2090}-\x{209c}\x{2102}\x{2107}\x{210a}-\x{2113}\x{2115}\x{2119}-\x{211d}\x{2124}\x{2126}\x{2128}\x{212a}-\x{212d}\x{212f}-\x{2139}\x{213c}-\x{213f}\x{2145}-\x{2149}\x{214e}\x{2160}-\x{2188}\x{2c00}-\x{2c2e}\x{2c30}-\x{2c5e}\x{2c60}-\x{2ce4}\x{2ceb}-\x{2cee}\x{2cf2}\x{2cf3}\x{2d00}-\x{2d25}\x{2d27}\x{2d2d}\x{2d30}-\x{2d67}\x{2d6f}\x{2d80}-\x{2d96}\x{2da0}-\x{2da6}\x{2da8}-\x{2dae}\x{2db0}-\x{2db6}\x{2db8}-\x{2dbe}\x{2dc0}-\x{2dc6}\x{2dc8}-\x{2dce}\x{2dd0}-\x{2dd6}\x{2dd8}-\x{2dde}\x{2e2f}\x{3005}-\x{3007}\x{3021}-\x{3029}\x{3031}-\x{3035}\x{3038}-\x{303c}\x{3041}-\x{3096}\x{309d}-\x{309f}\x{30a1}-\x{30fa}\x{30fc}-\x{30ff}\x{3105}-\x{312d}\x{3131}-\x{318e}\x{31a0}-\x{31ba}\x{31f0}-\x{31ff}\x{3400}-\x{4db5}\x{4e00}-\x{9fcc}\x{a000}-\x{a48c}\x{a4d0}-\x{a4fd}\x{a500}-\x{a60c}\x{a610}-\x{a61f}\x{a62a}\x{a62b}\x{a640}-\x{a66e}\x{a67f}-\x{a697}\x{a6a0}-\x{a6ef}\x{a717}-\x{a71f}\x{a722}-\x{a788}\x{a78b}-\x{a78e}\x{a790}-\x{a793}\x{a7a0}-\x{a7aa}\x{a7f8}-\x{a801}\x{a803}-\x{a805}\x{a807}-\x{a80a}\x{a80c}-\x{a822}\x{a840}-\x{a873}\x{a882}-\x{a8b3}\x{a8f2}-\x{a8f7}\x{a8fb}\x{a90a}-\x{a925}\x{a930}-\x{a946}\x{a960}-\x{a97c}\x{a984}-\x{a9b2}\x{a9cf}\x{aa00}-\x{aa28}\x{aa40}-\x{aa42}\x{aa44}-\x{aa4b}\x{aa60}-\x{aa76}\x{aa7a}\x{aa80}-\x{aaaf}\x{aab1}\x{aab5}\x{aab6}\x{aab9}-\x{aabd}\x{aac0}\x{aac2}\x{aadb}-\x{aadd}\x{aae0}-\x{aaea}\x{aaf2}-\x{aaf4}\x{ab01}-\x{ab06}\x{ab09}-\x{ab0e}\x{ab11}-\x{ab16}\x{ab20}-\x{ab26}\x{ab28}-\x{ab2e}\x{abc0}-\x{abe2}\x{ac00}-\x{d7a3}\x{d7b0}-\x{d7c6}\x{d7cb}-\x{d7fb}\x{f900}-\x{fa6d}\x{fa70}-\x{fad9}\x{fb00}-\x{fb06}\x{fb13}-\x{fb17}\x{fb1d}\x{fb1f}-\x{fb28}\x{fb2a}-\x{fb36}\x{fb38}-\x{fb3c}\x{fb3e}\x{fb40}\x{fb41}\x{fb43}\x{fb44}\x{fb46}-\x{fbb1}\x{fbd3}-\x{fd3d}\x{fd50}-\x{fd8f}\x{fd92}-\x{fdc7}\x{fdf0}-\x{fdfb}\x{fe70}-\x{fe74}\x{fe76}-\x{fefc}\x{ff21}-\x{ff3a}\x{ff41}-\x{ff5a}\x{ff66}-\x{ffbe}\x{ffc2}-\x{ffc7}\x{ffca}-\x{ffcf}\x{ffd2}-\x{ffd7}\x{ffda}-\x{ffdc}][$A-Z\_a-z\xaa\xb5\xba\xc0-\xd6\xd8-\xf6\xf8-\x{02c1}\x{02c6}-\x{02d1}\x{02e0}-\x{02e4}\x{02ec}\x{02ee}\x{0370}-\x{0374}\x{0376}\x{0377}\x{037a}-\x{037d}\x{0386}\x{0388}-\x{038a}\x{038c}\x{038e}-\x{03a1}\x{03a3}-\x{03f5}\x{03f7}-\x{0481}\x{048a}-\x{0527}\x{0531}-\x{0556}\x{0559}\x{0561}-\x{0587}\x{05d0}-\x{05ea}\x{05f0}-\x{05f2}\x{0620}-\x{064a}\x{066e}\x{066f}\x{0671}-\x{06d3}\x{06d5}\x{06e5}\x{06e6}\x{06ee}\x{06ef}\x{06fa}-\x{06fc}\x{06ff}\x{0710}\x{0712}-\x{072f}\x{074d}-\x{07a5}\x{07b1}\x{07ca}-\x{07ea}\x{07f4}\x{07f5}\x{07fa}\x{0800}-\x{0815}\x{081a}\x{0824}\x{0828}\x{0840}-\x{0858}\x{08a0}\x{08a2}-\x{08ac}\x{0904}-\x{0939}\x{093d}\x{0950}\x{0958}-\x{0961}\x{0971}-\x{0977}\x{0979}-\x{097f}\x{0985}-\x{098c}\x{098f}\x{0990}\x{0993}-\x{09a8}\x{09aa}-\x{09b0}\x{09b2}\x{09b6}-\x{09b9}\x{09bd}\x{09ce}\x{09dc}\x{09dd}\x{09df}-\x{09e1}\x{09f0}\x{09f1}\x{0a05}-\x{0a0a}\x{0a0f}\x{0a10}\x{0a13}-\x{0a28}\x{0a2a}-\x{0a30}\x{0a32}\x{0a33}\x{0a35}\x{0a36}\x{0a38}\x{0a39}\x{0a59}-\x{0a5c}\x{0a5e}\x{0a72}-\x{0a74}\x{0a85}-\x{0a8d}\x{0a8f}-\x{0a91}\x{0a93}-\x{0aa8}\x{0aaa}-\x{0ab0}\x{0ab2}\x{0ab3}\x{0ab5}-\x{0ab9}\x{0abd}\x{0ad0}\x{0ae0}\x{0ae1}\x{0b05}-\x{0b0c}\x{0b0f}\x{0b10}\x{0b13}-\x{0b28}\x{0b2a}-\x{0b30}\x{0b32}\x{0b33}\x{0b35}-\x{0b39}\x{0b3d}\x{0b5c}\x{0b5d}\x{0b5f}-\x{0b61}\x{0b71}\x{0b83}\x{0b85}-\x{0b8a}\x{0b8e}-\x{0b90}\x{0b92}-\x{0b95}\x{0b99}\x{0b9a}\x{0b9c}\x{0b9e}\x{0b9f}\x{0ba3}\x{0ba4}\x{0ba8}-\x{0baa}\x{0bae}-\x{0bb9}\x{0bd0}\x{0c05}-\x{0c0c}\x{0c0e}-\x{0c10}\x{0c12}-\x{0c28}\x{0c2a}-\x{0c33}\x{0c35}-\x{0c39}\x{0c3d}\x{0c58}\x{0c59}\x{0c60}\x{0c61}\x{0c85}-\x{0c8c}\x{0c8e}-\x{0c90}\x{0c92}-\x{0ca8}\x{0caa}-\x{0cb3}\x{0cb5}-\x{0cb9}\x{0cbd}\x{0cde}\x{0ce0}\x{0ce1}\x{0cf1}\x{0cf2}\x{0d05}-\x{0d0c}\x{0d0e}-\x{0d10}\x{0d12}-\x{0d3a}\x{0d3d}\x{0d4e}\x{0d60}\x{0d61}\x{0d7a}-\x{0d7f}\x{0d85}-\x{0d96}\x{0d9a}-\x{0db1}\x{0db3}-\x{0dbb}\x{0dbd}\x{0dc0}-\x{0dc6}\x{0e01}-\x{0e30}\x{0e32}\x{0e33}\x{0e40}-\x{0e46}\x{0e81}\x{0e82}\x{0e84}\x{0e87}\x{0e88}\x{0e8a}\x{0e8d}\x{0e94}-\x{0e97}\x{0e99}-\x{0e9f}\x{0ea1}-\x{0ea3}\x{0ea5}\x{0ea7}\x{0eaa}\x{0eab}\x{0ead}-\x{0eb0}\x{0eb2}\x{0eb3}\x{0ebd}\x{0ec0}-\x{0ec4}\x{0ec6}\x{0edc}-\x{0edf}\x{0f00}\x{0f40}-\x{0f47}\x{0f49}-\x{0f6c}\x{0f88}-\x{0f8c}\x{1000}-\x{102a}\x{103f}\x{1050}-\x{1055}\x{105a}-\x{105d}\x{1061}\x{1065}\x{1066}\x{106e}-\x{1070}\x{1075}-\x{1081}\x{108e}\x{10a0}-\x{10c5}\x{10c7}\x{10cd}\x{10d0}-\x{10fa}\x{10fc}-\x{1248}\x{124a}-\x{124d}\x{1250}-\x{1256}\x{1258}\x{125a}-\x{125d}\x{1260}-\x{1288}\x{128a}-\x{128d}\x{1290}-\x{12b0}\x{12b2}-\x{12b5}\x{12b8}-\x{12be}\x{12c0}\x{12c2}-\x{12c5}\x{12c8}-\x{12d6}\x{12d8}-\x{1310}\x{1312}-\x{1315}\x{1318}-\x{135a}\x{1380}-\x{138f}\x{13a0}-\x{13f4}\x{1401}-\x{166c}\x{166f}-\x{167f}\x{1681}-\x{169a}\x{16a0}-\x{16ea}\x{16ee}-\x{16f0}\x{1700}-\x{170c}\x{170e}-\x{1711}\x{1720}-\x{1731}\x{1740}-\x{1751}\x{1760}-\x{176c}\x{176e}-\x{1770}\x{1780}-\x{17b3}\x{17d7}\x{17dc}\x{1820}-\x{1877}\x{1880}-\x{18a8}\x{18aa}\x{18b0}-\x{18f5}\x{1900}-\x{191c}\x{1950}-\x{196d}\x{1970}-\x{1974}\x{1980}-\x{19ab}\x{19c1}-\x{19c7}\x{1a00}-\x{1a16}\x{1a20}-\x{1a54}\x{1aa7}\x{1b05}-\x{1b33}\x{1b45}-\x{1b4b}\x{1b83}-\x{1ba0}\x{1bae}\x{1baf}\x{1bba}-\x{1be5}\x{1c00}-\x{1c23}\x{1c4d}-\x{1c4f}\x{1c5a}-\x{1c7d}\x{1ce9}-\x{1cec}\x{1cee}-\x{1cf1}\x{1cf5}\x{1cf6}\x{1d00}-\x{1dbf}\x{1e00}-\x{1f15}\x{1f18}-\x{1f1d}\x{1f20}-\x{1f45}\x{1f48}-\x{1f4d}\x{1f50}-\x{1f57}\x{1f59}\x{1f5b}\x{1f5d}\x{1f5f}-\x{1f7d}\x{1f80}-\x{1fb4}\x{1fb6}-\x{1fbc}\x{1fbe}\x{1fc2}-\x{1fc4}\x{1fc6}-\x{1fcc}\x{1fd0}-\x{1fd3}\x{1fd6}-\x{1fdb}\x{1fe0}-\x{1fec}\x{1ff2}-\x{1ff4}\x{1ff6}-\x{1ffc}\x{2071}\x{207f}\x{2090}-\x{209c}\x{2102}\x{2107}\x{210a}-\x{2113}\x{2115}\x{2119}-\x{211d}\x{2124}\x{2126}\x{2128}\x{212a}-\x{212d}\x{212f}-\x{2139}\x{213c}-\x{213f}\x{2145}-\x{2149}\x{214e}\x{2160}-\x{2188}\x{2c00}-\x{2c2e}\x{2c30}-\x{2c5e}\x{2c60}-\x{2ce4}\x{2ceb}-\x{2cee}\x{2cf2}\x{2cf3}\x{2d00}-\x{2d25}\x{2d27}\x{2d2d}\x{2d30}-\x{2d67}\x{2d6f}\x{2d80}-\x{2d96}\x{2da0}-\x{2da6}\x{2da8}-\x{2dae}\x{2db0}-\x{2db6}\x{2db8}-\x{2dbe}\x{2dc0}-\x{2dc6}\x{2dc8}-\x{2dce}\x{2dd0}-\x{2dd6}\x{2dd8}-\x{2dde}\x{2e2f}\x{3005}-\x{3007}\x{3021}-\x{3029}\x{3031}-\x{3035}\x{3038}-\x{303c}\x{3041}-\x{3096}\x{309d}-\x{309f}\x{30a1}-\x{30fa}\x{30fc}-\x{30ff}\x{3105}-\x{312d}\x{3131}-\x{318e}\x{31a0}-\x{31ba}\x{31f0}-\x{31ff}\x{3400}-\x{4db5}\x{4e00}-\x{9fcc}\x{a000}-\x{a48c}\x{a4d0}-\x{a4fd}\x{a500}-\x{a60c}\x{a610}-\x{a61f}\x{a62a}\x{a62b}\x{a640}-\x{a66e}\x{a67f}-\x{a697}\x{a6a0}-\x{a6ef}\x{a717}-\x{a71f}\x{a722}-\x{a788}\x{a78b}-\x{a78e}\x{a790}-\x{a793}\x{a7a0}-\x{a7aa}\x{a7f8}-\x{a801}\x{a803}-\x{a805}\x{a807}-\x{a80a}\x{a80c}-\x{a822}\x{a840}-\x{a873}\x{a882}-\x{a8b3}\x{a8f2}-\x{a8f7}\x{a8fb}\x{a90a}-\x{a925}\x{a930}-\x{a946}\x{a960}-\x{a97c}\x{a984}-\x{a9b2}\x{a9cf}\x{aa00}-\x{aa28}\x{aa40}-\x{aa42}\x{aa44}-\x{aa4b}\x{aa60}-\x{aa76}\x{aa7a}\x{aa80}-\x{aaaf}\x{aab1}\x{aab5}\x{aab6}\x{aab9}-\x{aabd}\x{aac0}\x{aac2}\x{aadb}-\x{aadd}\x{aae0}-\x{aaea}\x{aaf2}-\x{aaf4}\x{ab01}-\x{ab06}\x{ab09}-\x{ab0e}\x{ab11}-\x{ab16}\x{ab20}-\x{ab26}\x{ab28}-\x{ab2e}\x{abc0}-\x{abe2}\x{ac00}-\x{d7a3}\x{d7b0}-\x{d7c6}\x{d7cb}-\x{d7fb}\x{f900}-\x{fa6d}\x{fa70}-\x{fad9}\x{fb00}-\x{fb06}\x{fb13}-\x{fb17}\x{fb1d}\x{fb1f}-\x{fb28}\x{fb2a}-\x{fb36}\x{fb38}-\x{fb3c}\x{fb3e}\x{fb40}\x{fb41}\x{fb43}\x{fb44}\x{fb46}-\x{fbb1}\x{fbd3}-\x{fd3d}\x{fd50}-\x{fd8f}\x{fd92}-\x{fdc7}\x{fdf0}-\x{fdfb}\x{fe70}-\x{fe74}\x{fe76}-\x{fefc}\x{ff21}-\x{ff3a}\x{ff41}-\x{ff5a}\x{ff66}-\x{ffbe}\x{ffc2}-\x{ffc7}\x{ffca}-\x{ffcf}\x{ffd2}-\x{ffd7}\x{ffda}-\x{ffdc}0-9\x{0300}-\x{036f}\x{0483}-\x{0487}\x{0591}-\x{05bd}\x{05bf}\x{05c1}\x{05c2}\x{05c4}\x{05c5}\x{05c7}\x{0610}-\x{061a}\x{064b}-\x{0669}\x{0670}\x{06d6}-\x{06dc}\x{06df}-\x{06e4}\x{06e7}\x{06e8}\x{06ea}-\x{06ed}\x{06f0}-\x{06f9}\x{0711}\x{0730}-\x{074a}\x{07a6}-\x{07b0}\x{07c0}-\x{07c9}\x{07eb}-\x{07f3}\x{0816}-\x{0819}\x{081b}-\x{0823}\x{0825}-\x{0827}\x{0829}-\x{082d}\x{0859}-\x{085b}\x{08e4}-\x{08fe}\x{0900}-\x{0903}\x{093a}-\x{093c}\x{093e}-\x{094f}\x{0951}-\x{0957}\x{0962}\x{0963}\x{0966}-\x{096f}\x{0981}-\x{0983}\x{09bc}\x{09be}-\x{09c4}\x{09c7}\x{09c8}\x{09cb}-\x{09cd}\x{09d7}\x{09e2}\x{09e3}\x{09e6}-\x{09ef}\x{0a01}-\x{0a03}\x{0a3c}\x{0a3e}-\x{0a42}\x{0a47}\x{0a48}\x{0a4b}-\x{0a4d}\x{0a51}\x{0a66}-\x{0a71}\x{0a75}\x{0a81}-\x{0a83}\x{0abc}\x{0abe}-\x{0ac5}\x{0ac7}-\x{0ac9}\x{0acb}-\x{0acd}\x{0ae2}\x{0ae3}\x{0ae6}-\x{0aef}\x{0b01}-\x{0b03}\x{0b3c}\x{0b3e}-\x{0b44}\x{0b47}\x{0b48}\x{0b4b}-\x{0b4d}\x{0b56}\x{0b57}\x{0b62}\x{0b63}\x{0b66}-\x{0b6f}\x{0b82}\x{0bbe}-\x{0bc2}\x{0bc6}-\x{0bc8}\x{0bca}-\x{0bcd}\x{0bd7}\x{0be6}-\x{0bef}\x{0c01}-\x{0c03}\x{0c3e}-\x{0c44}\x{0c46}-\x{0c48}\x{0c4a}-\x{0c4d}\x{0c55}\x{0c56}\x{0c62}\x{0c63}\x{0c66}-\x{0c6f}\x{0c82}\x{0c83}\x{0cbc}\x{0cbe}-\x{0cc4}\x{0cc6}-\x{0cc8}\x{0cca}-\x{0ccd}\x{0cd5}\x{0cd6}\x{0ce2}\x{0ce3}\x{0ce6}-\x{0cef}\x{0d02}\x{0d03}\x{0d3e}-\x{0d44}\x{0d46}-\x{0d48}\x{0d4a}-\x{0d4d}\x{0d57}\x{0d62}\x{0d63}\x{0d66}-\x{0d6f}\x{0d82}\x{0d83}\x{0dca}\x{0dcf}-\x{0dd4}\x{0dd6}\x{0dd8}-\x{0ddf}\x{0df2}\x{0df3}\x{0e31}\x{0e34}-\x{0e3a}\x{0e47}-\x{0e4e}\x{0e50}-\x{0e59}\x{0eb1}\x{0eb4}-\x{0eb9}\x{0ebb}\x{0ebc}\x{0ec8}-\x{0ecd}\x{0ed0}-\x{0ed9}\x{0f18}\x{0f19}\x{0f20}-\x{0f29}\x{0f35}\x{0f37}\x{0f39}\x{0f3e}\x{0f3f}\x{0f71}-\x{0f84}\x{0f86}\x{0f87}\x{0f8d}-\x{0f97}\x{0f99}-\x{0fbc}\x{0fc6}\x{102b}-\x{103e}\x{1040}-\x{1049}\x{1056}-\x{1059}\x{105e}-\x{1060}\x{1062}-\x{1064}\x{1067}-\x{106d}\x{1071}-\x{1074}\x{1082}-\x{108d}\x{108f}-\x{109d}\x{135d}-\x{135f}\x{1712}-\x{1714}\x{1732}-\x{1734}\x{1752}\x{1753}\x{1772}\x{1773}\x{17b4}-\x{17d3}\x{17dd}\x{17e0}-\x{17e9}\x{180b}-\x{180d}\x{1810}-\x{1819}\x{18a9}\x{1920}-\x{192b}\x{1930}-\x{193b}\x{1946}-\x{194f}\x{19b0}-\x{19c0}\x{19c8}\x{19c9}\x{19d0}-\x{19d9}\x{1a17}-\x{1a1b}\x{1a55}-\x{1a5e}\x{1a60}-\x{1a7c}\x{1a7f}-\x{1a89}\x{1a90}-\x{1a99}\x{1b00}-\x{1b04}\x{1b34}-\x{1b44}\x{1b50}-\x{1b59}\x{1b6b}-\x{1b73}\x{1b80}-\x{1b82}\x{1ba1}-\x{1bad}\x{1bb0}-\x{1bb9}\x{1be6}-\x{1bf3}\x{1c24}-\x{1c37}\x{1c40}-\x{1c49}\x{1c50}-\x{1c59}\x{1cd0}-\x{1cd2}\x{1cd4}-\x{1ce8}\x{1ced}\x{1cf2}-\x{1cf4}\x{1dc0}-\x{1de6}\x{1dfc}-\x{1dff}\x{200c}\x{200d}\x{203f}\x{2040}\x{2054}\x{20d0}-\x{20dc}\x{20e1}\x{20e5}-\x{20f0}\x{2cef}-\x{2cf1}\x{2d7f}\x{2de0}-\x{2dff}\x{302a}-\x{302f}\x{3099}\x{309a}\x{a620}-\x{a629}\x{a66f}\x{a674}-\x{a67d}\x{a69f}\x{a6f0}\x{a6f1}\x{a802}\x{a806}\x{a80b}\x{a823}-\x{a827}\x{a880}\x{a881}\x{a8b4}-\x{a8c4}\x{a8d0}-\x{a8d9}\x{a8e0}-\x{a8f1}\x{a900}-\x{a909}\x{a926}-\x{a92d}\x{a947}-\x{a953}\x{a980}-\x{a983}\x{a9b3}-\x{a9c0}\x{a9d0}-\x{a9d9}\x{aa29}-\x{aa36}\x{aa43}\x{aa4c}\x{aa4d}\x{aa50}-\x{aa59}\x{aa7b}\x{aab0}\x{aab2}-\x{aab4}\x{aab7}\x{aab8}\x{aabe}\x{aabf}\x{aac1}\x{aaeb}-\x{aaef}\x{aaf5}\x{aaf6}\x{abe3}-\x{abea}\x{abec}\x{abed}\x{abf0}-\x{abf9}\x{fb1e}\x{fe00}-\x{fe0f}\x{fe20}-\x{fe26}\x{fe33}\x{fe34}\x{fe4d}-\x{fe4f}\x{ff10}-\x{ff19}\x{ff3f}]*\b'; + + /** + * Full list of JavaScript reserved words. + * Will be loaded from /data/js/keywords_reserved.txt. + * + * @see https://mathiasbynens.be/notes/reserved-keywords + * + * @var string[] + */ + protected $keywordsReserved = array(); + + /** + * List of JavaScript reserved words that accept a <variable, value, ...> + * after them. Some end of lines are not the end of a statement, like with + * these keywords. + * + * E.g.: we shouldn't insert a ; after this else + * else + * console.log('this is quite fine') + * + * Will be loaded from /data/js/keywords_before.txt + * + * @var string[] + */ + protected $keywordsBefore = array(); + + /** + * List of JavaScript reserved words that accept a <variable, value, ...> + * before them. Some end of lines are not the end of a statement, like when + * continued by one of these keywords on the newline. + * + * E.g.: we shouldn't insert a ; before this instanceof + * variable + * instanceof String + * + * Will be loaded from /data/js/keywords_after.txt + * + * @var string[] + */ + protected $keywordsAfter = array(); + + /** + * List of all JavaScript operators. + * + * Will be loaded from /data/js/operators.txt + * + * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Expressions_and_Operators + * + * @var string[] + */ + protected $operators = array(); + + /** + * List of JavaScript operators that accept a <variable, value, ...> after + * them. Some end of lines are not the end of a statement, like with these + * operators. + * + * Note: Most operators are fine, we've only removed ++ and --. + * ++ & -- have to be joined with the value they're in-/decrementing. + * + * Will be loaded from /data/js/operators_before.txt + * + * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Expressions_and_Operators + * + * @var string[] + */ + protected $operatorsBefore = array(); + + /** + * List of JavaScript operators that accept a <variable, value, ...> before + * them. Some end of lines are not the end of a statement, like when + * continued by one of these operators on the newline. + * + * Note: Most operators are fine, we've only removed ), ], ++, --, ! and ~. + * There can't be a newline separating ! or ~ and whatever it is negating. + * ++ & -- have to be joined with the value they're in-/decrementing. + * ) & ] are "special" in that they have lots or usecases. () for example + * is used for function calls, for grouping, in if () and for (), ... + * + * Will be loaded from /data/js/operators_after.txt + * + * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Expressions_and_Operators + * + * @var string[] + */ + protected $operatorsAfter = array(); + + public function __construct() + { + call_user_func_array(array('\\MatthiasMullie\Minify\\Minify', '__construct'), func_get_args()); + + $dataDir = __DIR__ . '/../data/js/'; + $options = FILE_IGNORE_NEW_LINES | FILE_SKIP_EMPTY_LINES; + $this->keywordsReserved = file($dataDir . 'keywords_reserved.txt', $options); + $this->keywordsBefore = file($dataDir . 'keywords_before.txt', $options); + $this->keywordsAfter = file($dataDir . 'keywords_after.txt', $options); + $this->operators = file($dataDir . 'operators.txt', $options); + $this->operatorsBefore = file($dataDir . 'operators_before.txt', $options); + $this->operatorsAfter = file($dataDir . 'operators_after.txt', $options); + } + + /** + * Minify the data. + * Perform JS optimizations. + * + * @param string[optional] $path Path to write the data to + * + * @return string The minified data + */ + public function execute($path = null) + { + $content = ''; + + /* + * Let's first take out strings, comments and regular expressions. + * All of these can contain JS code-like characters, and we should make + * sure any further magic ignores anything inside of these. + * + * Consider this example, where we should not strip any whitespace: + * var str = "a test"; + * + * Comments will be removed altogether, strings and regular expressions + * will be replaced by placeholder text, which we'll restore later. + */ + $this->extractStrings('\'"`'); + $this->stripComments(); + $this->extractRegex(); + + // loop files + foreach ($this->data as $source => $js) { + // take out strings, comments & regex (for which we've registered + // the regexes just a few lines earlier) + $js = $this->replace($js); + + $js = $this->propertyNotation($js); + $js = $this->shortenBools($js); + $js = $this->stripWhitespace($js); + + // combine js: separating the scripts by a ; + $content .= $js . ';'; + } + + // clean up leftover `;`s from the combination of multiple scripts + $content = ltrim($content, ';'); + $content = (string) substr($content, 0, -1); + + /* + * Earlier, we extracted strings & regular expressions and replaced them + * with placeholder text. This will restore them. + */ + $content = $this->restoreExtractedData($content); + + return $content; + } + + /** + * Strip comments from source code. + */ + protected function stripComments() + { + $this->stripMultilineComments(); + + // single-line comments + $this->registerPattern('/\/\/.*$/m', ''); + } + + /** + * JS can have /-delimited regular expressions, like: /ab+c/.match(string). + * + * The content inside the regex can contain characters that may be confused + * for JS code: e.g. it could contain whitespace it needs to match & we + * don't want to strip whitespace in there. + * + * The regex can be pretty simple: we don't have to care about comments, + * (which also use slashes) because stripComments() will have stripped those + * already. + * + * This method will replace all string content with simple REGEX# + * placeholder text, so we've rid all regular expressions from characters + * that may be misinterpreted. Original regex content will be saved in + * $this->extracted and after doing all other minifying, we can restore the + * original content via restoreRegex() + */ + protected function extractRegex() + { + // PHP only supports $this inside anonymous functions since 5.4 + $minifier = $this; + $callback = function ($match) use ($minifier) { + $count = count($minifier->extracted); + $placeholder = '"' . $count . '"'; + $minifier->extracted[$placeholder] = $match[0]; + + return $placeholder; + }; + + // match all chars except `/` and `\` + // `\` is allowed though, along with whatever char follows (which is the + // one being escaped) + // this should allow all chars, except for an unescaped `/` (= the one + // closing the regex) + // then also ignore bare `/` inside `[]`, where they don't need to be + // escaped: anything inside `[]` can be ignored safely + $pattern = '\\/(?!\*)(?:[^\\[\\/\\\\\n\r]++|(?:\\\\.)++|(?:\\[(?:[^\\]\\\\\n\r]++|(?:\\\\.)++)++\\])++)++\\/[gimuy]*'; + + // a regular expression can only be followed by a few operators or some + // of the RegExp methods (a `\` followed by a variable or value is + // likely part of a division, not a regex) + $keywords = array('do', 'in', 'new', 'else', 'throw', 'yield', 'delete', 'return', 'typeof'); + $before = '(^|[=:,;\+\-\*\?\/\}\(\{\[&\|!]|' . implode('|', $keywords) . ')\s*'; + $propertiesAndMethods = array( + // https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp#Properties_2 + 'constructor', + 'flags', + 'global', + 'ignoreCase', + 'multiline', + 'source', + 'sticky', + 'unicode', + // https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp#Methods_2 + 'compile(', + 'exec(', + 'test(', + 'toSource(', + 'toString(', + ); + $delimiters = array_fill(0, count($propertiesAndMethods), '/'); + $propertiesAndMethods = array_map('preg_quote', $propertiesAndMethods, $delimiters); + $after = '(?=\s*([\.,;:\)\}&\|+]|\/\/|$|\.(' . implode('|', $propertiesAndMethods) . ')))'; + $this->registerPattern('/' . $before . '\K' . $pattern . $after . '/', $callback); + + // regular expressions following a `)` are rather annoying to detect... + // quite often, `/` after `)` is a division operator & if it happens to + // be followed by another one (or a comment), it is likely to be + // confused for a regular expression + // however, it's perfectly possible for a regex to follow a `)`: after + // a single-line `if()`, `while()`, ... statement, for example + // since, when they occur like that, they're always the start of a + // statement, there's only a limited amount of ways they can be useful: + // by calling the regex methods directly + // if a regex following `)` is not followed by `.<property or method>`, + // it's quite likely not a regex + $before = '\)\s*'; + $after = '(?=\s*\.(' . implode('|', $propertiesAndMethods) . '))'; + $this->registerPattern('/' . $before . '\K' . $pattern . $after . '/', $callback); + + // 1 more edge case: a regex can be followed by a lot more operators or + // keywords if there's a newline (ASI) in between, where the operator + // actually starts a new statement + // (https://github.com/matthiasmullie/minify/issues/56) + $operators = $this->getOperatorsForRegex($this->operatorsBefore, '/'); + $operators += $this->getOperatorsForRegex($this->keywordsReserved, '/'); + $after = '(?=\s*\n\s*(' . implode('|', $operators) . '))'; + $this->registerPattern('/' . $pattern . $after . '/', $callback); + } + + /** + * Strip whitespace. + * + * We won't strip *all* whitespace, but as much as possible. The thing that + * we'll preserve are newlines we're unsure about. + * JavaScript doesn't require statements to be terminated with a semicolon. + * It will automatically fix missing semicolons with ASI (automatic semi- + * colon insertion) at the end of line causing errors (without semicolon.) + * + * Because it's sometimes hard to tell if a newline is part of a statement + * that should be terminated or not, we'll just leave some of them alone. + * + * @param string $content The content to strip the whitespace for + * + * @return string + */ + protected function stripWhitespace($content) + { + // uniform line endings, make them all line feed + $content = str_replace(array("\r\n", "\r"), "\n", $content); + + // collapse all non-line feed whitespace into a single space + $content = preg_replace('/[^\S\n]+/', ' ', $content); + + // strip leading & trailing whitespace + $content = str_replace(array(" \n", "\n "), "\n", $content); + + // collapse consecutive line feeds into just 1 + $content = preg_replace('/\n+/', "\n", $content); + + $operatorsBefore = $this->getOperatorsForRegex($this->operatorsBefore, '/'); + $operatorsAfter = $this->getOperatorsForRegex($this->operatorsAfter, '/'); + $operators = $this->getOperatorsForRegex($this->operators, '/'); + $keywordsBefore = $this->getKeywordsForRegex($this->keywordsBefore, '/'); + $keywordsAfter = $this->getKeywordsForRegex($this->keywordsAfter, '/'); + + // strip whitespace that ends in (or next line begin with) an operator + // that allows statements to be broken up over multiple lines + unset($operatorsBefore['+'], $operatorsBefore['-'], $operatorsAfter['+'], $operatorsAfter['-']); + $content = preg_replace( + array( + '/(' . implode('|', $operatorsBefore) . ')\s+/', + '/\s+(' . implode('|', $operatorsAfter) . ')/', + ), + '\\1', + $content + ); + + // make sure + and - can't be mistaken for, or joined into ++ and -- + $content = preg_replace( + array( + '/(?<![\+\-])\s*([\+\-])(?![\+\-])/', + '/(?<![\+\-])([\+\-])\s*(?![\+\-])/', + ), + '\\1', + $content + ); + + // collapse whitespace around reserved words into single space + $content = preg_replace('/(^|[;\}\s])\K(' . implode('|', $keywordsBefore) . ')\s+/', '\\2 ', $content); + $content = preg_replace('/\s+(' . implode('|', $keywordsAfter) . ')(?=([;\{\s]|$))/', ' \\1', $content); + + /* + * We didn't strip whitespace after a couple of operators because they + * could be used in different contexts and we can't be sure it's ok to + * strip the newlines. However, we can safely strip any non-line feed + * whitespace that follows them. + */ + $operatorsDiffBefore = array_diff($operators, $operatorsBefore); + $operatorsDiffAfter = array_diff($operators, $operatorsAfter); + $content = preg_replace('/(' . implode('|', $operatorsDiffBefore) . ')[^\S\n]+/', '\\1', $content); + $content = preg_replace('/[^\S\n]+(' . implode('|', $operatorsDiffAfter) . ')/', '\\1', $content); + + /* + * Whitespace after `return` can be omitted in a few occasions + * (such as when followed by a string or regex) + * Same for whitespace in between `)` and `{`, or between `{` and some + * keywords. + */ + $content = preg_replace('/\breturn\s+(["\'\/\+\-])/', 'return$1', $content); + $content = preg_replace('/\)\s+\{/', '){', $content); + $content = preg_replace('/}\n(else|catch|finally)\b/', '}$1', $content); + + /* + * Get rid of double semicolons, except where they can be used like: + * "for(v=1,_=b;;)", "for(v=1;;v++)" or "for(;;ja||(ja=true))". + * I'll safeguard these double semicolons inside for-loops by + * temporarily replacing them with an invalid condition: they won't have + * a double semicolon and will be easy to spot to restore afterwards. + */ + $content = preg_replace('/\bfor\(([^;]*);;([^;]*)\)/', 'for(\\1;-;\\2)', $content); + $content = preg_replace('/;+/', ';', $content); + $content = preg_replace('/\bfor\(([^;]*);-;([^;]*)\)/', 'for(\\1;;\\2)', $content); + + /* + * Next, we'll be removing all semicolons where ASI kicks in. + * for-loops however, can have an empty body (ending in only a + * semicolon), like: `for(i=1;i<3;i++);`, of `for(i in list);` + * Here, nothing happens during the loop; it's just used to keep + * increasing `i`. With that ; omitted, the next line would be expected + * to be the for-loop's body... Same goes for while loops. + * I'm going to double that semicolon (if any) so after the next line, + * which strips semicolons here & there, we're still left with this one. + * Note the special recursive construct in the three inner parts of the for: + * (\{([^\{\}]*(?-2))*[^\{\}]*\})? - it is intended to match inline + * functions bodies, e.g.: i<arr.map(function(e){return e}).length. + * Also note that the construct is applied only once and multiplied + * for each part of the for, otherwise it risks a catastrophic backtracking. + * The limitation is that it will not allow closures in more than one + * of the three parts for a specific for() case. + * REGEX throwing catastrophic backtracking: $content = preg_replace('/(for\([^;\{]*(\{([^\{\}]*(?-2))*[^\{\}]*\})?[^;\{]*;[^;\{]*(\{([^\{\}]*(?-2))*[^\{\}]*\})?[^;\{]*;[^;\{]*(\{([^\{\}]*(?-2))*[^\{\}]*\})?[^;\{]*\));(\}|$)/s', '\\1;;\\8', $content); + */ + $content = preg_replace('/(for\((?:[^;\{]*|[^;\{]*function[^;\{]*(\{([^\{\}]*(?-2))*[^\{\}]*\})?[^;\{]*);[^;\{]*;[^;\{]*\));(\}|$)/s', '\\1;;\\4', $content); + $content = preg_replace('/(for\([^;\{]*;(?:[^;\{]*|[^;\{]*function[^;\{]*(\{([^\{\}]*(?-2))*[^\{\}]*\})?[^;\{]*);[^;\{]*\));(\}|$)/s', '\\1;;\\4', $content); + $content = preg_replace('/(for\([^;\{]*;[^;\{]*;(?:[^;\{]*|[^;\{]*function[^;\{]*(\{([^\{\}]*(?-2))*[^\{\}]*\})?[^;\{]*)\));(\}|$)/s', '\\1;;\\4', $content); + + $content = preg_replace('/(for\([^;\{]+\s+in\s+[^;\{]+\));(\}|$)/s', '\\1;;\\2', $content); + + /* + * Do the same for the if's that don't have a body but are followed by ;} + */ + $content = preg_replace('/(\bif\s*\([^{;]*\));\}/s', '\\1;;}', $content); + + /* + * Below will also keep `;` after a `do{}while();` along with `while();` + * While these could be stripped after do-while, detecting this + * distinction is cumbersome, so I'll play it safe and make sure `;` + * after any kind of `while` is kept. + */ + $content = preg_replace('/(while\([^;\{]+\));(\}|$)/s', '\\1;;\\2', $content); + + /* + * We also can't strip empty else-statements. Even though they're + * useless and probably shouldn't be in the code in the first place, we + * shouldn't be stripping the `;` that follows it as it breaks the code. + * We can just remove those useless else-statements completely. + * + * @see https://github.com/matthiasmullie/minify/issues/91 + */ + $content = preg_replace('/else;/s', '', $content); + + /* + * We also don't really want to terminate statements followed by closing + * curly braces (which we've ignored completely up until now) or end-of- + * script: ASI will kick in here & we're all about minifying. + * Semicolons at beginning of the file don't make any sense either. + */ + $content = preg_replace('/;(\}|$)/s', '\\1', $content); + $content = ltrim($content, ';'); + + // get rid of remaining whitespace af beginning/end + return trim($content); + } + + /** + * We'll strip whitespace around certain operators with regular expressions. + * This will prepare the given array by escaping all characters. + * + * @param string[] $operators + * @param string $delimiter + * + * @return string[] + */ + protected function getOperatorsForRegex(array $operators, $delimiter = '/') + { + // escape operators for use in regex + $delimiters = array_fill(0, count($operators), $delimiter); + $escaped = array_map('preg_quote', $operators, $delimiters); + + $operators = array_combine($operators, $escaped); + + // ignore + & - for now, they'll get special treatment + unset($operators['+'], $operators['-']); + + // dot can not just immediately follow a number; it can be confused for + // decimal point, or calling a method on it, e.g. 42 .toString() + $operators['.'] = '(?<![0-9]\s)\.'; + + // don't confuse = with other assignment shortcuts (e.g. +=) + $chars = preg_quote('+-*\=<>%&|', $delimiter); + $operators['='] = '(?<![' . $chars . '])\='; + + return $operators; + } + + /** + * We'll strip whitespace around certain keywords with regular expressions. + * This will prepare the given array by escaping all characters. + * + * @param string[] $keywords + * @param string $delimiter + * + * @return string[] + */ + protected function getKeywordsForRegex(array $keywords, $delimiter = '/') + { + // escape keywords for use in regex + $delimiter = array_fill(0, count($keywords), $delimiter); + $escaped = array_map('preg_quote', $keywords, $delimiter); + + // add word boundaries + array_walk($keywords, function ($value) { + return '\b' . $value . '\b'; + }); + + $keywords = array_combine($keywords, $escaped); + + return $keywords; + } + + /** + * Replaces all occurrences of array['key'] by array.key. + * + * @param string $content + * + * @return string + */ + protected function propertyNotation($content) + { + // PHP only supports $this inside anonymous functions since 5.4 + $minifier = $this; + $keywords = $this->keywordsReserved; + $callback = function ($match) use ($minifier, $keywords) { + $property = trim($minifier->extracted[$match[1]], '\'"'); + + /* + * Check if the property is a reserved keyword. In this context (as + * property of an object literal/array) it shouldn't matter, but IE8 + * freaks out with "Expected identifier". + */ + if (in_array($property, $keywords)) { + return $match[0]; + } + + /* + * See if the property is in a variable-like format (e.g. + * array['key-here'] can't be replaced by array.key-here since '-' + * is not a valid character there. + */ + if (!preg_match('/^' . $minifier::REGEX_VARIABLE . '$/u', $property)) { + return $match[0]; + } + + return '.' . $property; + }; + + /* + * Figure out if previous character is a variable name (of the array + * we want to use property notation on) - this is to make sure + * standalone ['value'] arrays aren't confused for keys-of-an-array. + * We can (and only have to) check the last character, because PHP's + * regex implementation doesn't allow unfixed-length look-behind + * assertions. + */ + preg_match('/(\[[^\]]+\])[^\]]*$/', static::REGEX_VARIABLE, $previousChar); + $previousChar = $previousChar[1]; + + /* + * Make sure word preceding the ['value'] is not a keyword, e.g. + * return['x']. Because -again- PHP's regex implementation doesn't allow + * unfixed-length look-behind assertions, I'm just going to do a lot of + * separate look-behind assertions, one for each keyword. + */ + $keywords = $this->getKeywordsForRegex($keywords); + $keywords = '(?<!' . implode(')(?<!', $keywords) . ')'; + + return preg_replace_callback('/(?<=' . $previousChar . '|\])' . $keywords . '\[\s*(([\'"])[0-9]+\\2)\s*\]/u', $callback, $content); + } + + /** + * Replaces true & false by !0 and !1. + * + * @param string $content + * + * @return string + */ + protected function shortenBools($content) + { + /* + * 'true' or 'false' could be used as property names (which may be + * followed by whitespace) - we must not replace those! + * Since PHP doesn't allow variable-length (to account for the + * whitespace) lookbehind assertions, I need to capture the leading + * character and check if it's a `.` + */ + $callback = function ($match) { + if (trim($match[1]) === '.') { + return $match[0]; + } + + return $match[1] . ($match[2] === 'true' ? '!0' : '!1'); + }; + $content = preg_replace_callback('/(^|.\s*)\b(true|false)\b(?!:)/', $callback, $content); + + // for(;;) is exactly the same as while(true), but shorter :) + $content = preg_replace('/\bwhile\(!0\){/', 'for(;;){', $content); + + // now make sure we didn't turn any do ... while(true) into do ... for(;;) + preg_match_all('/\bdo\b/', $content, $dos, PREG_OFFSET_CAPTURE | PREG_SET_ORDER); + + // go backward to make sure positional offsets aren't altered when $content changes + $dos = array_reverse($dos); + foreach ($dos as $do) { + $offsetDo = $do[0][1]; + + // find all `while` (now `for`) following `do`: one of those must be + // associated with the `do` and be turned back into `while` + preg_match_all('/\bfor\(;;\)/', $content, $whiles, PREG_OFFSET_CAPTURE | PREG_SET_ORDER, $offsetDo); + foreach ($whiles as $while) { + $offsetWhile = $while[0][1]; + + $open = substr_count($content, '{', $offsetDo, $offsetWhile - $offsetDo); + $close = substr_count($content, '}', $offsetDo, $offsetWhile - $offsetDo); + if ($open === $close) { + // only restore `while` if amount of `{` and `}` are the same; + // otherwise, that `for` isn't associated with this `do` + $content = substr_replace($content, 'while(!0)', $offsetWhile, strlen('for(;;)')); + break; + } + } + } + + return $content; + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/matthiasmullie/minify/src/Minify.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/matthiasmullie/minify/src/Minify.php new file mode 100644 index 0000000000..29e6eb8c00 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/matthiasmullie/minify/src/Minify.php @@ -0,0 +1,560 @@ +<?php + +/** + * Abstract minifier class. + * + * Please report bugs on https://github.com/matthiasmullie/minify/issues + * + * @author Matthias Mullie <minify@mullie.eu> + * @copyright Copyright (c) 2012, Matthias Mullie. All rights reserved + * @license MIT License + */ + +namespace MatthiasMullie\Minify; + +use MatthiasMullie\Minify\Exceptions\IOException; +use Psr\Cache\CacheItemInterface; + +/** + * Abstract minifier class. + * + * Please report bugs on https://github.com/matthiasmullie/minify/issues + * + * @author Matthias Mullie <minify@mullie.eu> + * @copyright Copyright (c) 2012, Matthias Mullie. All rights reserved + * @license MIT License + */ +abstract class Minify +{ + /** + * The data to be minified. + * + * @var string[] + */ + protected $data = array(); + + /** + * Array of patterns to match. + * + * @var string[] + */ + protected $patterns = array(); + + /** + * This array will hold content of strings and regular expressions that have + * been extracted from the JS source code, so we can reliably match "code", + * without having to worry about potential "code-like" characters inside. + * + * @internal + * + * @var string[] + */ + public $extracted = array(); + + /** + * Init the minify class - optionally, code may be passed along already. + */ + public function __construct(/* $data = null, ... */) + { + // it's possible to add the source through the constructor as well ;) + if (func_num_args()) { + call_user_func_array(array($this, 'add'), func_get_args()); + } + } + + /** + * Add a file or straight-up code to be minified. + * + * @param string|string[] $data + * + * @return static + */ + public function add($data /* $data = null, ... */) + { + // bogus "usage" of parameter $data: scrutinizer warns this variable is + // not used (we're using func_get_args instead to support overloading), + // but it still needs to be defined because it makes no sense to have + // this function without argument :) + $args = array($data) + func_get_args(); + + // this method can be overloaded + foreach ($args as $data) { + if (is_array($data)) { + call_user_func_array(array($this, 'add'), $data); + continue; + } + + // redefine var + $data = (string) $data; + + // load data + $value = $this->load($data); + $key = ($data != $value) ? $data : count($this->data); + + // replace CR linefeeds etc. + // @see https://github.com/matthiasmullie/minify/pull/139 + $value = str_replace(array("\r\n", "\r"), "\n", $value); + + // store data + $this->data[$key] = $value; + } + + return $this; + } + + /** + * Add a file to be minified. + * + * @param string|string[] $data + * + * @return static + * + * @throws IOException + */ + public function addFile($data /* $data = null, ... */) + { + // bogus "usage" of parameter $data: scrutinizer warns this variable is + // not used (we're using func_get_args instead to support overloading), + // but it still needs to be defined because it makes no sense to have + // this function without argument :) + $args = array($data) + func_get_args(); + + // this method can be overloaded + foreach ($args as $path) { + if (is_array($path)) { + call_user_func_array(array($this, 'addFile'), $path); + continue; + } + + // redefine var + $path = (string) $path; + + // check if we can read the file + if (!$this->canImportFile($path)) { + throw new IOException('The file "' . $path . '" could not be opened for reading. Check if PHP has enough permissions.'); + } + + $this->add($path); + } + + return $this; + } + + /** + * Minify the data & (optionally) saves it to a file. + * + * @param string[optional] $path Path to write the data to + * + * @return string The minified data + */ + public function minify($path = null) + { + $content = $this->execute($path); + + // save to path + if ($path !== null) { + $this->save($content, $path); + } + + return $content; + } + + /** + * Minify & gzip the data & (optionally) saves it to a file. + * + * @param string[optional] $path Path to write the data to + * @param int[optional] $level Compression level, from 0 to 9 + * + * @return string The minified & gzipped data + */ + public function gzip($path = null, $level = 9) + { + $content = $this->execute($path); + $content = gzencode($content, $level, FORCE_GZIP); + + // save to path + if ($path !== null) { + $this->save($content, $path); + } + + return $content; + } + + /** + * Minify the data & write it to a CacheItemInterface object. + * + * @param CacheItemInterface $item Cache item to write the data to + * + * @return CacheItemInterface Cache item with the minifier data + */ + public function cache(CacheItemInterface $item) + { + $content = $this->execute(); + $item->set($content); + + return $item; + } + + /** + * Minify the data. + * + * @param string[optional] $path Path to write the data to + * + * @return string The minified data + */ + abstract public function execute($path = null); + + /** + * Load data. + * + * @param string $data Either a path to a file or the content itself + * + * @return string + */ + protected function load($data) + { + // check if the data is a file + if ($this->canImportFile($data)) { + $data = file_get_contents($data); + + // strip BOM, if any + if (substr($data, 0, 3) == "\xef\xbb\xbf") { + $data = substr($data, 3); + } + } + + return $data; + } + + /** + * Save to file. + * + * @param string $content The minified data + * @param string $path The path to save the minified data to + * + * @throws IOException + */ + protected function save($content, $path) + { + $handler = $this->openFileForWriting($path); + + $this->writeToFile($handler, $content); + + @fclose($handler); + } + + /** + * Register a pattern to execute against the source content. + * + * If $replacement is a string, it must be plain text. Placeholders like $1 or \2 don't work. + * If you need that functionality, use a callback instead. + * + * @param string $pattern PCRE pattern + * @param string|callable $replacement Replacement value for matched pattern + */ + protected function registerPattern($pattern, $replacement = '') + { + // study the pattern, we'll execute it more than once + $pattern .= 'S'; + + $this->patterns[] = array($pattern, $replacement); + } + + /** + * Both JS and CSS use the same form of multi-line comment, so putting the common code here. + */ + protected function stripMultilineComments() + { + // First extract comments we want to keep, so they can be restored later + // PHP only supports $this inside anonymous functions since 5.4 + $minifier = $this; + $callback = function ($match) use ($minifier) { + $count = count($minifier->extracted); + $placeholder = '/*' . $count . '*/'; + $minifier->extracted[$placeholder] = $match[0]; + + return $placeholder; + }; + $this->registerPattern('/ + # optional newline + \n? + + # start comment + \/\* + + # comment content + (?: + # either starts with an ! + ! + | + # or, after some number of characters which do not end the comment + (?:(?!\*\/).)*? + + # there is either a @license or @preserve tag + @(?:license|preserve) + ) + + # then match to the end of the comment + .*?\*\/\n? + + /ixs', $callback); + + // Then strip all other comments + $this->registerPattern('/\/\*.*?\*\//s', ''); + } + + /** + * We can't "just" run some regular expressions against JavaScript: it's a + * complex language. E.g. having an occurrence of // xyz would be a comment, + * unless it's used within a string. Of you could have something that looks + * like a 'string', but inside a comment. + * The only way to accurately replace these pieces is to traverse the JS one + * character at a time and try to find whatever starts first. + * + * @param string $content The content to replace patterns in + * + * @return string The (manipulated) content + */ + protected function replace($content) + { + $contentLength = strlen($content); + $output = ''; + $processedOffset = 0; + $positions = array_fill(0, count($this->patterns), -1); + $matches = array(); + + while ($processedOffset < $contentLength) { + // find first match for all patterns + foreach ($this->patterns as $i => $pattern) { + list($pattern, $replacement) = $pattern; + + // we can safely ignore patterns for positions we've unset earlier, + // because we know these won't show up anymore + if (array_key_exists($i, $positions) == false) { + continue; + } + + // no need to re-run matches that are still in the part of the + // content that hasn't been processed + if ($positions[$i] >= $processedOffset) { + continue; + } + + $match = null; + if (preg_match($pattern, $content, $match, PREG_OFFSET_CAPTURE, $processedOffset)) { + $matches[$i] = $match; + + // we'll store the match position as well; that way, we + // don't have to redo all preg_matches after changing only + // the first (we'll still know where those others are) + $positions[$i] = $match[0][1]; + } else { + // if the pattern couldn't be matched, there's no point in + // executing it again in later runs on this same content; + // ignore this one until we reach end of content + unset($matches[$i], $positions[$i]); + } + } + + // no more matches to find: everything's been processed, break out + if (!$matches) { + // output the remaining content + $output .= substr($content, $processedOffset); + break; + } + + // see which of the patterns actually found the first thing (we'll + // only want to execute that one, since we're unsure if what the + // other found was not inside what the first found) + $matchOffset = min($positions); + $firstPattern = array_search($matchOffset, $positions); + $match = $matches[$firstPattern]; + + // execute the pattern that matches earliest in the content string + list(, $replacement) = $this->patterns[$firstPattern]; + + // add the part of the input between $processedOffset and the first match; + // that content wasn't matched by anything + $output .= substr($content, $processedOffset, $matchOffset - $processedOffset); + // add the replacement for the match + $output .= $this->executeReplacement($replacement, $match); + // advance $processedOffset past the match + $processedOffset = $matchOffset + strlen($match[0][0]); + } + + return $output; + } + + /** + * If $replacement is a callback, execute it, passing in the match data. + * If it's a string, just pass it through. + * + * @param string|callable $replacement Replacement value + * @param array $match Match data, in PREG_OFFSET_CAPTURE form + * + * @return string + */ + protected function executeReplacement($replacement, $match) + { + if (!is_callable($replacement)) { + return $replacement; + } + // convert $match from the PREG_OFFSET_CAPTURE form to the form the callback expects + foreach ($match as &$matchItem) { + $matchItem = $matchItem[0]; + } + + return $replacement($match); + } + + /** + * Strings are a pattern we need to match, in order to ignore potential + * code-like content inside them, but we just want all of the string + * content to remain untouched. + * + * This method will replace all string content with simple STRING# + * placeholder text, so we've rid all strings from characters that may be + * misinterpreted. Original string content will be saved in $this->extracted + * and after doing all other minifying, we can restore the original content + * via restoreStrings(). + * + * @param string[optional] $chars + * @param string[optional] $placeholderPrefix + */ + protected function extractStrings($chars = '\'"', $placeholderPrefix = '') + { + // PHP only supports $this inside anonymous functions since 5.4 + $minifier = $this; + $callback = function ($match) use ($minifier, $placeholderPrefix) { + // check the second index here, because the first always contains a quote + if ($match[2] === '') { + /* + * Empty strings need no placeholder; they can't be confused for + * anything else anyway. + * But we still needed to match them, for the extraction routine + * to skip over this particular string. + */ + return $match[0]; + } + + $count = count($minifier->extracted); + $placeholder = $match[1] . $placeholderPrefix . $count . $match[1]; + $minifier->extracted[$placeholder] = $match[1] . $match[2] . $match[1]; + + return $placeholder; + }; + + /* + * The \\ messiness explained: + * * Don't count ' or " as end-of-string if it's escaped (has backslash + * in front of it) + * * Unless... that backslash itself is escaped (another leading slash), + * in which case it's no longer escaping the ' or " + * * So there can be either no backslash, or an even number + * * multiply all of that times 4, to account for the escaping that has + * to be done to pass the backslash into the PHP string without it being + * considered as escape-char (times 2) and to get it in the regex, + * escaped (times 2) + */ + $this->registerPattern('/([' . $chars . '])(.*?(?<!\\\\)(\\\\\\\\)*+)\\1/s', $callback); + } + + /** + * This method will restore all extracted data (strings, regexes) that were + * replaced with placeholder text in extract*(). The original content was + * saved in $this->extracted. + * + * @param string $content + * + * @return string + */ + protected function restoreExtractedData($content) + { + if (!$this->extracted) { + // nothing was extracted, nothing to restore + return $content; + } + + $content = strtr($content, $this->extracted); + + $this->extracted = array(); + + return $content; + } + + /** + * Check if the path is a regular file and can be read. + * + * @param string $path + * + * @return bool + */ + protected function canImportFile($path) + { + $parsed = parse_url($path); + if ( + // file is elsewhere + isset($parsed['host']) + // file responds to queries (may change, or need to bypass cache) + || isset($parsed['query']) + ) { + return false; + } + + try { + return strlen($path) < PHP_MAXPATHLEN && @is_file($path) && is_readable($path); + } + // catch openbasedir exceptions which are not caught by @ on is_file() + catch (\Exception $e) { + return false; + } + } + + /** + * Attempts to open file specified by $path for writing. + * + * @param string $path The path to the file + * + * @return resource Specifier for the target file + * + * @throws IOException + */ + protected function openFileForWriting($path) + { + if ($path === '' || ($handler = @fopen($path, 'w')) === false) { + throw new IOException('The file "' . $path . '" could not be opened for writing. Check if PHP has enough permissions.'); + } + + return $handler; + } + + /** + * Attempts to write $content to the file specified by $handler. $path is used for printing exceptions. + * + * @param resource $handler The resource to write to + * @param string $content The content to write + * @param string $path The path to the file (for exception printing only) + * + * @throws IOException + */ + protected function writeToFile($handler, $content, $path = '') + { + if ( + !is_resource($handler) + || ($result = @fwrite($handler, $content)) === false + || ($result < strlen($content)) + ) { + throw new IOException('The file "' . $path . '" could not be written to. Check your disk space and file permissions.'); + } + } + + protected static function str_replace_first($search, $replace, $subject) + { + $pos = strpos($subject, $search); + if ($pos !== false) { + return substr_replace($subject, $replace, $pos, strlen($search)); + } + + return $subject; + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/mpratt/embera/src/Embera/Embera.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/mpratt/embera/src/Embera/Embera.php new file mode 100755 index 0000000000..7211b649b4 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/mpratt/embera/src/Embera/Embera.php @@ -0,0 +1,221 @@ +<?php +/** + * Embera.php + * + * @package Embera + * @author Michael Pratt <yo@michael-pratt.com> + * @link http://www.michael-pratt.com/ + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ + +namespace Embera; + +use Embera\Http\HttpClient; +use Embera\Http\OembedClient; +use Embera\Http\HttpClientInterface; +use Embera\Html\IgnoreTags; +use Embera\Html\ResponsiveEmbeds; +use Embera\ProviderCollection\ProviderCollectionInterface; +use Embera\ProviderCollection\DefaultProviderCollection; + +/** + * Embera + * The Main Class of this library. + */ +class Embera +{ + /** @var string Current Library Version */ + const VERSION = '2.0.41'; + + /** + * Constants describing how the library is + * going to handle fake responses. + * + * ALLOW_FAKE_RESPONSES is the default value. + */ + const ALLOW_FAKE_RESPONSES = 1; + const DISABLE_FAKE_RESPONSES = 2; + const ONLY_FAKE_RESPONSES = 3; + + /** @var array Configuration settings */ + protected $config = []; + + /** @var array Logged errors */ + protected $errors = []; + + /** @var array Closures to be used on oembed responses */ + protected $filters = []; + + /** @var ProviderCollectionInterface */ + protected $providerCollection; + + /** @var HttpClientInterface */ + protected $httpClient; + + /** + * Constructor + * + * @param array $config + * @param ProviderCollectionInterface $collection + * @param HttpClientInterface $httpClient + * @return void + */ + public function __construct(array $config = [], ProviderCollectionInterface $collection = null, HttpClientInterface $httpClient = null) + { + $this->config = array_merge([ + 'https_only' => false, + 'fake_responses' => self::ALLOW_FAKE_RESPONSES, + 'ignore_tags' => [ 'pre', 'code', 'a', 'img', 'iframe', 'oembed' ], + 'responsive' => false, + 'width' => 0, + 'height' => 0, + 'maxheight' => 0, + 'maxwidth' => 0, + 'referer' => '', + 'curl_params' => [], + 'file_get_contents_params' => [], + ], $config); + + $this->config['maxwidth'] = max($this->config['width'], $this->config['maxwidth']); + $this->config['maxheight'] = max($this->config['height'], $this->config['maxheight']); + unset($this->config['height'], $this->config['width']); + + $this->providerCollection = $collection; + if (!$collection) { + $this->providerCollection = new DefaultProviderCollection($this->config); + } + + $this->httpClient = $httpClient; + if (!$httpClient) { + $this->httpClient = new HttpClient($this->config); + } + + // Set the config just in case. + $this->providerCollection->setConfig($this->config); + $this->httpClient->setConfig($this->config); + } + + /** + * Embeds known/available services into the given text. + * + * @param mixed $text + * @return string + */ + public function autoEmbed($text) + { + if (is_string($text)) { + $table = []; + $providers = $this->getUrlData($text); + foreach ($providers as $url => $response) { + if (!empty($response['html'])) { + $table[$url] = $response['html']; + } + } + + if (!empty($table)) { + + if (!empty($this->config['ignore_tags']) && strpos($text, '>') !== false) { + $ignoreTags = new IgnoreTags($this->config['ignore_tags']); + return $ignoreTags->replace($text, $table); + } + + return strtr($text, $table); + } + + } else { + $this->errors[] = 'For auto-embedding purposes, the input must be a string'; + } + + return $text; + } + + /** + * Returns the oembed response from the given data. + * + * @param array|string $urls An array with urls or a string with urls. + * @return array + */ + public function getUrlData($urls) + { + $return = []; + foreach ($this->providerCollection->findProviders($urls) as $url => $provider) { + try { + + $oembedClient = new OembedClient($this->config, $this->httpClient); + $response = $oembedClient->getResponseFrom($provider); + + if ($this->config['responsive'] && !$provider->hasResponsiveSupport()) { + $responsive = new ResponsiveEmbeds(); + $response = $responsive->transform($response); + } + + $return[$url] = $this->applyFilters($response); + + } catch (\Exception $e) { + $this->errors[] = $e->getMessage(); + } + } + + return array_filter($return); + } + + /** + * Adds a filter to the oembed response + * + * @param callable $closure + * @return void + */ + public function addFilter(callable $closure) + { + $this->filters[] = $closure; + } + + /** + * Applies registered filters/closures + * to the oembed response. + * + * @param array $response + * @return array + */ + protected function applyFilters(array $response) + { + foreach ($this->filters as $closure) { + $response = $closure($response); + } + + return $response; + } + + /** + * Gets the last error found + * + * @return string + */ + public function getLastError() + { + return end($this->errors); + } + + /** + * Returns an array with all the errors + * + * @return array + */ + public function getErrors() + { + return $this->errors; + } + + /** + * Checks if there were errors + * + * @return bool + */ + public function hasErrors() + { + return (!empty($this->errors)); + } + +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/mpratt/embera/src/Embera/Provider/Biqnetwork.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/mpratt/embera/src/Embera/Provider/Biqnetwork.php new file mode 100644 index 0000000000..95397dbecf --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/mpratt/embera/src/Embera/Provider/Biqnetwork.php @@ -0,0 +1,56 @@ +<?php +/** + * Biqnetwork.php + * + * @package Embera + * @author Michael Pratt <yo@michael-pratt.com> + * @link http://www.michael-pratt.com/ + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ + +namespace Embera\Provider; + +use Embera\Url; + +/** + * Biqnetwork Provider + * + * @link https://cloud.biqapp.com + */ +class Biqnetwork extends ProviderAdapter implements ProviderInterface +{ + /** inline {@inheritdoc} */ + protected $endpoint = 'https://biqapp.com/api/v1/video/oembed'; + + /** inline {@inheritdoc} */ + protected static $hosts = [ + 'cloud.biqapp.com' + ]; + + /** inline {@inheritdoc} */ + protected $allowedParams = [ 'maxwidth', 'maxheight' ]; + + /** inline {@inheritdoc} */ + protected $httpsSupport = true; + + /** inline {@inheritdoc} */ + protected $responsiveSupport = false; + + /** inline {@inheritdoc} */ + public function validateUrl(Url $url) + { + return (bool) (preg_match('~cloud\.biqapp\.com/([^/]+)~i', (string) $url)); + } + + /** inline {@inheritdoc} */ + public function normalizeUrl(Url $url) + { + $url->convertToHttps(); + $url->removeQueryString(); + $url->removeLastSlash(); + + return $url; + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/mpratt/embera/src/Embera/Provider/BlueskySocial.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/mpratt/embera/src/Embera/Provider/BlueskySocial.php new file mode 100644 index 0000000000..deac3374ea --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/mpratt/embera/src/Embera/Provider/BlueskySocial.php @@ -0,0 +1,56 @@ +<?php +/** + * BlueskySocial.php + * + * @package Embera + * @author Michael Pratt <yo@michael-pratt.com> + * @link http://www.michael-pratt.com/ + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ + +namespace Embera\Provider; + +use Embera\Url; + +/** + * BlueskySocial Provider + * + * @link https://bsky.app + */ +class BlueskySocial extends ProviderAdapter implements ProviderInterface +{ + /** inline {@inheritdoc} */ + protected $endpoint = 'https://embed.bsky.app/oembed'; + + /** inline {@inheritdoc} */ + protected static $hosts = [ + 'bsky.app' + ]; + + /** inline {@inheritdoc} */ + protected $allowedParams = [ 'maxwidth', 'maxheight' ]; + + /** inline {@inheritdoc} */ + protected $httpsSupport = true; + + /** inline {@inheritdoc} */ + protected $responsiveSupport = true; + + /** inline {@inheritdoc} */ + public function validateUrl(Url $url) + { + return (bool) (preg_match('~bsky\.app/profile/([^/]+)/post/([^/]+)~i', (string) $url)); + } + + /** inline {@inheritdoc} */ + public function normalizeUrl(Url $url) + { + $url->convertToHttps(); + $url->removeQueryString(); + $url->removeLastSlash(); + + return $url; + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/mpratt/embera/src/Embera/Provider/Bunny.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/mpratt/embera/src/Embera/Provider/Bunny.php new file mode 100644 index 0000000000..fce55ee683 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/mpratt/embera/src/Embera/Provider/Bunny.php @@ -0,0 +1,88 @@ +<?php +/** + * Bunny.php + * + * @package Embera + * @author Michael Pratt <yo@michael-pratt.com> + * @link http://www.michael-pratt.com/ + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ + +namespace Embera\Provider; + +use Embera\Url; + +/** + * Bunny Provider + * + * @link https://iframe.mediadelivery.net|iframe.mediadelivery.net|video.bunnycdn.com|video.bunnycdn.com + */ +class Bunny extends ProviderAdapter implements ProviderInterface +{ + /** inline {@inheritdoc} */ + protected $endpoint = 'https://video.bunnycdn.com/OEmbed'; + + /** inline {@inheritdoc} */ + protected static $hosts = [ + '*.mediadelivery.net', + '*.bunnycdn.com' + ]; + + /** inline {@inheritdoc} */ + protected $allowedParams = [ 'maxwidth', 'maxheight' ]; + + /** inline {@inheritdoc} */ + protected $httpsSupport = true; + + /** inline {@inheritdoc} */ + protected $responsiveSupport = false; + + /** inline {@inheritdoc} */ + public function validateUrl(Url $url) + { + return (bool) (preg_match('~(mediadelivery\.net|bunnycdn\.com)/([^/]+)~i', (string) $url)); + } + + /** inline {@inheritdoc} */ + public function normalizeUrl(Url $url) + { + $url->convertToHttps(); + $url->removeQueryString(); + $url->removeLastSlash(); + + return $url; + } + + /** inline {@inheritdoc} */ + public function modifyResponse(array $response = []) + { + return $response; + } + + /** inline {@inheritdoc} */ + public function getFakeResponse() + { + preg_match('~v=([a-z0-9_\-]+)~i', (string) $this->url, $matches); + + $embedUrl = ''; + + $attr = []; + $attr[] = 'width="{width}"'; + $attr[] = 'height="{height}"'; + $attr[] = 'src="' . $embedUrl . '"'; + $attr[] = 'frameborder="0"'; + $attr[] = 'allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture"'; + $attr[] = 'allowfullscreen'; + + return [ + 'type' => '', + 'provider_name' => 'Bunny', + 'provider_url' => 'https://iframe.mediadelivery.net|iframe.mediadelivery.net|video.bunnycdn.com|video.bunnycdn.com', + 'title' => 'Unknown title', + 'html' => '<iframe ' . implode(' ', $attr). '>', + ]; + } + +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/mpratt/embera/src/Embera/Provider/Buttondown.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/mpratt/embera/src/Embera/Provider/Buttondown.php new file mode 100755 index 0000000000..d561c7a434 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/mpratt/embera/src/Embera/Provider/Buttondown.php @@ -0,0 +1,76 @@ + + * @link http://www.michael-pratt.com/ + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ + +namespace Embera\Provider; + +use Embera\Url; + +/** + * Buttondown Provider + * Buttondown is a small, elegant tool for producing newsletters. + * + * @link https://buttondown.email + * + */ +class Buttondown extends ProviderAdapter implements ProviderInterface +{ + /** inline {@inheritdoc} */ + protected $endpoint = 'https://buttondown.email/embed?format=json'; + + /** inline {@inheritdoc} */ + protected static $hosts = [ + 'buttondown.email', + 'buttondown.com' + ]; + + /** inline {@inheritdoc} */ + protected $httpsSupport = true; + + /** inline {@inheritdoc} */ + protected $responsiveSupport = true; + + /** inline {@inheritdoc} */ + public function validateUrl(Url $url) + { + return (bool) (preg_match('~buttondown\.(email|com)/([^/]+)$~i', (string) $url)); + } + + /** inline {@inheritdoc} */ + public function normalizeUrl(Url $url) + { + $url->convertToHttps(); + $url->removeWWW(); + $url->removeLastSlash(); + $url->removeQueryString(); + + return $url; + } + + /** inline {@inheritdoc} */ + public function getFakeResponse() + { + $embedUrl = $this->url . '?as_embed=true'; + + $attr = []; + $attr[] = 'scrolling="no"'; + $attr[] = 'style="width:100%!important;height:200px;position:relative;"'; + $attr[] = 'src="' . $embedUrl . '"'; + + return [ + 'type' => 'rich', + 'provider_name' => 'Buttondown', + 'provider_url' => 'https://buttondown.email', + 'title' => 'Unknown title', + 'html' => '', + ]; + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/mpratt/embera/src/Embera/Provider/Celero.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/mpratt/embera/src/Embera/Provider/Celero.php new file mode 100644 index 0000000000..9932f6aa6c --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/mpratt/embera/src/Embera/Provider/Celero.php @@ -0,0 +1,56 @@ + + * @link http://www.michael-pratt.com/ + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ + +namespace Embera\Provider; + +use Embera\Url; + +/** + * Celero Provider + * + * @link https://embeds.celero.io + */ +class Celero extends ProviderAdapter implements ProviderInterface +{ + /** inline {@inheritdoc} */ + protected $endpoint = 'https://api.celero.io/api/oembed'; + + /** inline {@inheritdoc} */ + protected static $hosts = [ + 'embeds.celero.io' + ]; + + /** inline {@inheritdoc} */ + protected $allowedParams = [ 'maxwidth', 'maxheight' ]; + + /** inline {@inheritdoc} */ + protected $httpsSupport = true; + + /** inline {@inheritdoc} */ + protected $responsiveSupport = true; + + /** inline {@inheritdoc} */ + public function validateUrl(Url $url) + { + return (bool) (preg_match('~embeds\.celero\.io/([^/]+)/([^/]+)~i', (string) $url)); + } + + /** inline {@inheritdoc} */ + public function normalizeUrl(Url $url) + { + $url->convertToHttps(); + $url->removeQueryString(); + $url->removeLastSlash(); + + return $url; + } +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/mpratt/embera/src/Embera/Provider/DailyMotion.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/mpratt/embera/src/Embera/Provider/DailyMotion.php new file mode 100755 index 0000000000..dd01932d97 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/mpratt/embera/src/Embera/Provider/DailyMotion.php @@ -0,0 +1,89 @@ + + * @link http://www.michael-pratt.com/ + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ + +namespace Embera\Provider; + +use Embera\Url; + +/** + * dailymotion.com Provider + * The latest news, sports, music and entertainment videos on Dailymotion. + * + * @link https://dailymotion.com + * @see https://developer.dailymotion.com/player/#player-oembed + */ +class DailyMotion extends ProviderAdapter implements ProviderInterface +{ + /** inline {@inheritdoc} */ + protected $endpoint = 'https://www.dailymotion.com/services/oembed?format=json'; + + /** inline {@inheritdoc} */ + protected $allowedParams = [ 'maxwidth', 'maxheight', 'callback', 'autoplay', 'syndication' ]; + + /** inline {@inheritdoc} */ + protected static $hosts = [ + '*.dailymotion.com', 'dai.ly' + ]; + + /** inline {@inheritdoc} */ + protected $httpsSupport = true; + + /** inline {@inheritdoc} */ + public function validateUrl(Url $url) + { + return (preg_match('~dailymotion\.com/video/(?:[^/]+)/?~i', (string) $url)); + } + + /** inline {@inheritdoc} */ + public function normalizeUrl(Url $url) + { + $url->convertToHttps(); + $url->addWWW(); + $url->removeLastSlash(); + $url->removeQueryString(); + + if (preg_match('~dailymotion\.com/(?:embed/)?(?:video|live)/([^/]+)/?~i', (string) $url, $matches)) { + $url->overwrite('https://www.dailymotion.com/video/' . $matches['1']); + } else if (preg_match('~dai\.ly/([^/]+)/?~i', (string) $url, $matches)) { + $url->overwrite('https://www.dailymotion.com/video/' . $matches['1']); + } + + return $url; + } + + /** inline {@inheritdoc} */ + public function getFakeResponse() + { + preg_match('~/video/([^/]+)~i', (string) $this->url, $matches); + @list($videoId, $videoTitle) = explode('_', $matches['1'], 2); + + + $embedUrl = 'http://www.dailymotion.com/embed/video/' . $videoId; + + $attr = []; + $attr[] = 'frameborder="0"'; + $attr[] = 'width="{width}"'; + $attr[] = 'height="{height}"'; + $attr[] = 'src="' . $embedUrl . '"'; + $attr[] = 'allowfullscreen'; + $attr[] = 'allow="autoplay; fullscreen; picture-in-picture; web-share"'; + + return [ + 'type' => 'video', + 'provider_name' => 'Dailymotion', + 'provider_url' => 'http://www.dailymotion.com', + 'title' => (!empty($videoTitle) ? str_replace(array('-', '_'), ' ', $videoTitle) : 'Unknown Title'), + 'html' => '', + ]; + } + +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/mpratt/embera/src/Embera/Provider/FITE.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/mpratt/embera/src/Embera/Provider/FITE.php new file mode 100644 index 0000000000..8f1c0067a2 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/plugins/mpratt/embera/src/Embera/Provider/FITE.php @@ -0,0 +1,69 @@ + + * @link http://www.michael-pratt.com/ + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ + +namespace Embera\Provider; + +use Embera\Url; + +/** + * FITE Provider + * Stream all the action to your big-screen TV! + * + * @link https://fite.tv + */ +class FITE extends ProviderAdapter implements ProviderInterface +{ + /** inline {@inheritdoc} */ + protected $endpoint = 'https://www.fite.tv/oembed?format=json'; + + /** inline {@inheritdoc} */ + protected static $hosts = [ + 'fite.tv', + 'triller.tv', + 'trillertv.com' + ]; + + /** inline {@inheritdoc} */ + protected $httpsSupport = true; + + /** inline {@inheritdoc} */ + public function validateUrl(Url $url) + { + return (bool) (preg_match('~(trillertv|triller|fite)\.(tv|com)/watch/(?:[^/]+)/([^/]+)/?~i', (string) $url)); + } + + /** inline {@inheritdoc} */ + public function normalizeUrl(Url $url) + { + $url->convertToHttps(); + $url->removeQueryString(); + + return $url; + } + + /** inline {@inheritdoc} */ + public function getFakeResponse() + { + preg_match('~(trillertv|triller|fite)\.(tv|com)/watch/(?:[^/]+)/([^/]+)/?~i', (string) $this->url, $matches); + + $html = ' + setErrorReporting(); + + $aRet = array (); + $aMessages = array (); + + $this->$sFunc(false, $aMessages); + + foreach ($aMessages as $sName => $r) + if ($sType == $r['type']) + $aRet[] = "$sName = " . $this->format_output($r['params']['real_val'], isset($this->aPhpSettings[$sName]) ? $this->aPhpSettings[$sName] : '') . " - " . $this->getMsgHTML($sName, $r); + + $this->restoreErrorReporting(); + + return $aRet; + } + + public function typeToTitle ($sType) + { + return $this->aType2Title[$sType]; + } + + protected function requirements() + { + echo '' . _t('_sys_audit_header_requirements') . ''; + $this->requirementsPHP(); + if (!defined('BX_DOL_INSTALL')) + $this->requirementsMySQL(); + $this->requirementsWebServer(); + $this->requirementsOS(); + $this->requirementsHardware(); + } + + protected function requirementsPHP($bEcho = true, &$aOutputMessages = null) + { + $sHttpCode = null; + $s = bx_file_get_contents('http://php.net/releases/index.php?serialize=1', array(), 'get', array(), $sHttpCode, array(), 20, array(CURLOPT_IPRESOLVE => CURL_IPRESOLVE_V4)); + $sLatestPhpVersion = $s && ($a = unserialize($s)) ? $a[5]['version'] : ''; + + if (version_compare(phpversion(), "5.4", ">=") == 1) + unset($this->aPhpSettings['short_open_tag']); + + $aMessages = array (); + + $sPhpVer = PHP_VERSION; + if (empty($sLatestPhpVersion)) + $aVer = array('type' => BX_DOL_AUDIT_UNDEF, 'msg' => _t('_sys_audit_msg_value_checking_failed'), 'params' => array ('real_val' => $sPhpVer)); + elseif (version_compare($sPhpVer, $this->sMinPhpVer, '<')) + $aVer = array('type' => BX_DOL_AUDIT_FAIL, 'msg' => _t('_sys_audit_msg_version_is_incompatible', $this->sMinPhpVer), 'params' => array ('real_val' => $sPhpVer)); + elseif (version_compare($sPhpVer, '5.3.0', '>=') && version_compare($sPhpVer, '5.4.0', '<')) + $aVer = array('type' => BX_DOL_AUDIT_WARN, 'msg' => _t('_sys_audit_msg_version_is_outdated', $sLatestPhpVersion), 'params' => array ('real_val' => $sPhpVer)); + else + $aVer = array('type' => BX_DOL_AUDIT_OK, 'params' => array ('real_val' => $sPhpVer)); + + $aMessages[_t('_sys_audit_version')] = $aVer; + + foreach ($this->aPhpSettings as $sName => $r) { + $a = $this->checkPhpSetting($sName, $r); + if ($a['res']) + $aMessages[$sName] = array('type' => BX_DOL_AUDIT_OK, 'params' => $a); + elseif (isset($r['warn']) && $r['warn']) + $aMessages[$sName] = array('type' => BX_DOL_AUDIT_WARN, 'msg' => _t('_sys_audit_msg_should_be', $r['op'], $this->format_output($r['val'], $r)), 'params' => $a); + else + $aMessages[$sName] = array('type' => BX_DOL_AUDIT_FAIL, 'msg' => _t('_sys_audit_msg_must_be', $r['op'], $this->format_output($r['val'], $r)), 'params' => $a); + } + + if (null !== $aOutputMessages) + $aOutputMessages = $aMessages; + + if ($bEcho) { + $s = ''; + foreach ($aMessages as $sName => $r) { + $s .= $this->getBlock($sName, $this->format_output($r['params']['real_val'], isset($this->aPhpSettings[$sName]) ? $this->aPhpSettings[$sName] : ''), $this->getMsgHTML($sName, $r)); + } + echo $this->getSection('PHP', '', $s); + } + } + + protected function requirementsMySQL($bEcho = true, &$aOutputMessages = null) + { + $sMysqlVer = BxDolDb::getInstance()->getServerInfo(); + if (preg_match ('/^(\d+)\.(\d+)\.(\d+)/', $sMysqlVer, $m)) { + $sMysqlVer = "{$m[1]}.{$m[2]}.{$m[3]}"; + if (version_compare($sMysqlVer, $this->sMinMysqlVer, '<')) + $aMessage = array('type' => BX_DOL_AUDIT_FAIL, 'msg' => _t('_sys_audit_msg_version_is_incompatible', $this->sMinMysqlVer)); + else + $aMessage = array('type' => BX_DOL_AUDIT_OK); + } else { + $aMessage = array('type' => BX_DOL_AUDIT_UNDEF, 'msg' => _t('_sys_audit_msg_value_checking_failed')); + } + + if (null !== $aOutputMessages) + $aOutputMessages['mysql'] = array($aMessage); + + if ($bEcho) { + $s = $this->getBlock(_t('_sys_audit_version'), $sMysqlVer, $this->getMsgHTML(_t('_sys_audit_version'), $aMessage)); + echo $this->getSection('MySQL', '', $s); + } + } + + protected function requirementsWebServer($bEcho = true, &$aOutputMessages = null) + { + $aMessages = array(); + foreach ($this->aRequiredApacheModules as $sName => $sNameCompiledName) + $aMessages[$sName] = $this->checkApacheModule($sName, $sNameCompiledName); + + if (null !== $aOutputMessages) + $aOutputMessages = $aMessages; + + if ($bEcho) { + $s = ''; + foreach ($aMessages as $sName => $r) { + $s .= $this->getBlock($sName, '', $this->getBlock('', '', $this->getMsgHTML($sName, $r), false)); + } + echo $this->getSection(_t('_sys_audit_section_webserver'), $_SERVER['SERVER_SOFTWARE'], $s); + } + } + + protected function requirementsOS() + { + $s = $this->getBlock(php_uname()); + echo $this->getSection(_t('_sys_audit_section_os'), '', $s); + } + + protected function requirementsHardware() + { + $s = $this->getBlock(_t('_sys_audit_msg_hardware_requirements')); + echo $this->getSection(_t('_sys_audit_section_hardware'), '', $s); + } + + protected function siteSetup() + { + $sFfmpegPath = defined('BX_SYSTEM_FFMPEG') ? BX_SYSTEM_FFMPEG : BX_DIRECTORY_PATH_PLUGINS . 'ffmpeg/ffmpeg.exe'; + + $sEmailToCkeckMailSending = class_exists('BxDolDb') && BxDolDb::getInstance() ? BxDolDb::getInstance()->getParam('site_email') : ''; + + $oUpgrader = new BxDolUpgrader(); + if (!($sLatestVer = $oUpgrader->getLatestVersionNumber())) + $sLatestVer = 'undefined'; + + $sVer = bx_get_ver(); + $aMessage = array('type' => BX_DOL_AUDIT_OK); + if (!version_compare($sVer, $sLatestVer, '>=')) + $aMessage = array('type' => BX_DOL_AUDIT_WARN, 'msg' => _t('_sys_audit_msg_version_is_outdated', $sLatestVer)); + + $s = $this->getBlock(_t('_sys_audit_version_script'), $sVer, $this->getMsgHTML(_t('_sys_audit_version_script'), $aMessage)); + + $s .= $this->getBlock(_t('_sys_audit_permissions'), '', _t('_sys_audit_msg_permissions')); + + $s .= $this->getBlock('ffmpeg', '', _t('_sys_audit_msg_ffmpeg', `{$sFfmpegPath} 2>&1`)); + + $s .= $this->getBlock(_t('_sys_audit_mail_sending'), '', _t('_sys_audit_msg_mail_sending')); + + $s .= $this->getBlock(_t('_sys_audit_cron_jobs'), '', _t('_sys_audit_msg_cron_jobs', `crontab -l 2>&1`)); + + $iCronTime = getParam('sys_cron_time'); + $s .= $this->getBlock(_t('_sys_audit_cron_jobs_exec_time'), '', !empty($iCronTime) ? bx_time_js($iCronTime, BX_FORMAT_DATE_TIME, true) : _t('_None')); + + echo '' . _t('_sys_audit_header_site_setup') . ''; + echo "$s"; + } + + protected function optimization() + { + echo '' . _t('_sys_audit_header_site_optimization') . ''; + + $this->optimizationPhp(); + + if (!defined('BX_DOL_INSTALL')) + $this->optimizationMySQL(); + + $this->optimizationWebServer(); + + if (!defined('BX_DOL_INSTALL')) + $this->optimizationScript(); + } + + protected function optimizationPhp() + { + $s = ''; + $aMessage = array(); + + $sAccel = $this->getPhpAccelerator(); + if (!$sAccel) + $aMessage = array('type' => BX_DOL_AUDIT_WARN, 'msg' => _t('_sys_audit_msg_php_accelerator_missing')); + else + $aMessage = array('type' => BX_DOL_AUDIT_OK); + $s .= $this->getBlock(_t('_sys_audit_php_accelerator'), $sAccel, $this->getMsgHTML(_t('_sys_audit_php_accelerator'), $aMessage)); + + $sSapi = php_sapi_name(); + if (0 === strcasecmp('cgi', $sSapi)) + $aMessage = array('type' => BX_DOL_AUDIT_WARN, 'msg' => _t('_sys_audit_msg_php_setup_inefficient')); + else + $aMessage = array('type' => BX_DOL_AUDIT_OK); + $s .= $this->getBlock(_t('_sys_audit_php_setup'), $sSapi, $this->getMsgHTML(_t('_sys_audit_php_setup'), $aMessage)); + + echo $this->getSection('PHP', '', $s); + } + + protected function optimizationMySQL() + { + $s = ''; + $oDb = BxDolDb::getInstance(); + + foreach ($this->aMysqlOptimizationSettings as $sName => $r) { + $a = $this->checkMysqlSetting($sName, $r, $oDb); + $aMessage = array('type' => BX_DOL_AUDIT_OK); + if (!$a['res']) + $aMessage = array('type' => BX_DOL_AUDIT_FAIL, 'msg' => _t('_sys_audit_msg_must_be', $r['op'], $this->format_output($r['val'], $r))); + $s .= $this->getBlock($sName, $this->format_output($a['real_val'], $r), $this->getMsgHTML($sName, $aMessage)); + } + + echo $this->getSection('MySQL', '', $s); + } + + protected function optimizationWebServer() + { + $s = ''; + + $sName = 'expires_module'; + $sApacheModuleChack = _t('_sys_audit_msg_optimization_apache_module', $sName, $this->getMsgHTML($sName, $this->checkApacheModule($sName))); + $s .= $this->getBlock(_t('_sys_audit_userside_caching'), '', _t('_sys_audit_msg_userside_caching', $this->getUrlForGooglePageSpeed('LeverageBrowserCaching'), $sApacheModuleChack)); + + $sName = 'deflate_module'; + $sApacheModuleChack = _t('_sys_audit_msg_optimization_apache_module', $sName, $this->getMsgHTML($sName, $this->checkApacheModule($sName))); + $s .= $this->getBlock(_t('_sys_audit_serverside_compression'), '', _t('_sys_audit_msg_serverside_compression', $sApacheModuleChack)); + + echo $this->getSection(_t('_sys_audit_section_webserver'), '', $s); + } + + protected function optimizationScript() + { + $s = ''; + foreach ($this->aOptimizationSettings as $sName => $a) { + + $sVal = ('always_on' == $a['enabled'] || getParam($a['enabled'])) ? 'On' : 'Off'; + if ($a['cache_engine']) + $sVal .= _t('_sys_audit_msg_x_based_cache_engine', getParam($a['cache_engine'])); + + if ('always_on' != $a['enabled'] && !getParam($a['enabled'])) + $aMessage = array('type' => BX_DOL_AUDIT_FAIL, 'msg' => _t('_sys_audit_msg_optimization_fail')); + elseif ($a['check_accel'] && !$this->getPhpAccelerator() && 'File' == getParam($a['cache_engine'])) + $aMessage = array('type' => BX_DOL_AUDIT_WARN, 'msg' => _t('_sys_audit_msg_optimization_warn')); + else + $aMessage = array('type' => BX_DOL_AUDIT_OK); + + $s .= $this->getBlock($sName, $sVal, $this->getMsgHTML($sName, $aMessage)); + } + + echo $this->getSection('UNA', '', $s); + } + + protected function manualCheck() + { + echo ''; + echo '' . _t('_sys_audit_header_manual_audit') . ''; + echo _t('_sys_audit_msg_manual_audit'); + } + + protected function checkPhpSetting($sName, $a) + { + $mixedVal = ini_get($sName); + $mixedVal = $this->format_input ($mixedVal, $a); + + switch ($a['op']) { + case 'without': + $aFuncsDisabled = explode(',', $mixedVal); + array_walk($aFuncsDisabled, function (&$sVal, $sKey) { + $sVal = trim($sVal); + }); + $aFuncsMustBeEnabled = explode(',', $a['val']); + $a = array_intersect($aFuncsDisabled, $aFuncsMustBeEnabled); + $bResult = !$a; + break; + case 'module': + $bResult = extension_loaded($a['val']); + $mixedVal = $bResult ? $a['val'] : ''; + break; + case '>': + $bResult = (isset($a['unlimited']) && $mixedVal == $a['unlimited']) ? true : ($mixedVal > $a['val']); + break; + case '>=': + $bResult = (isset($a['unlimited']) && $mixedVal == $a['unlimited']) ? true : ($mixedVal >= $a['val']); + break; + case '=': + default: + $bResult = ($mixedVal == $a['val']); + } + return array ('res' => $bResult, 'real_val' => $mixedVal); + } + + protected function checkMysqlSetting($sName, $a, $oDb) + { + $mixedVal = $oDb->getOption($sName); + $mixedVal = $this->format_input ($mixedVal, $a); + + switch ($a['op']) { + case '>': + $bResult = ($mixedVal > $a['val']); + break; + case '>=': + $bResult = ($mixedVal >= $a['val']); + break; + case 'strcasecmp': + $bResult = 0 === strcasecmp($mixedVal, $a['val']); + break; + case '=': + default: + $bResult = ($mixedVal == $a['val']); + } + return array ('res' => $bResult, 'real_val' => $mixedVal); + } + + protected function format_output ($mixedVal, $a) + { + if (isset($a['type']) && 'bytes' == $a['type']) + return function_exists('_t_format_size') ? _t_format_size($mixedVal) : $mixedVal; + if (isset($a['type']) && 'bool' == $a['type']) + return $mixedVal ? 'On' : 'Off'; + else + return $mixedVal; + } + + protected function format_input ($mixedVal, $a) + { + if (isset($a['type']) && 'bytes' == $a['type']) + return $this->format_bytes ($mixedVal); + else + return $mixedVal; + } + + protected function format_bytes($val) + { + return return_bytes($val); + } + + protected function checkApacheModule ($sModule, $sNameCompiledName = '') + { + $a = array ( + 'deflate_module' => 'mod_deflate', + 'expires_module' => 'mod_expires', + ); + if (!$sNameCompiledName && isset($a[$sModule])) + $sNameCompiledName = $a[$sModule]; + + if (function_exists('apache_get_modules')) { + + $aModules = apache_get_modules(); + $ret = in_array($sNameCompiledName, $aModules); + + } else { + + $sApachectlPath = trim(`which apachectl`); + if (!$sApachectlPath) + $sApachectlPath = trim(`which apache2ctl`); + if (!$sApachectlPath) + $sApachectlPath = trim(`which /usr/local/apache/bin/apachectl`); + if (!$sApachectlPath) + $sApachectlPath = trim(`which /usr/local/apache/bin/apache2ctl`); + if (!$sApachectlPath) { + return array('type' => BX_DOL_AUDIT_UNDEF); + } + $ret = (boolean)`$sApachectlPath -M 2>&1 | grep $sModule`; + if (!$ret) + $ret = (boolean)`$sApachectlPath -l 2>&1 | grep $sNameCompiledName`; + } + + $aMessage = array('type' => BX_DOL_AUDIT_OK); + if (!$ret) + $aMessage = array('type' => BX_DOL_AUDIT_FAIL, 'msg' => _t('_sys_audit_msg_apache_module_fail', $sModule)); + + return $aMessage; + } + + protected function getPhpAccelerator () + { + $aAccelerators = array ( + 'APC' => array('op' => 'module', 'val' => 'apc'), + 'XCache' => array('op' => 'module', 'val' => 'xcache'), + 'ZendOPcache' => array('op' => 'module', 'val' => 'Zend OPcache'), + ); + foreach ($aAccelerators as $sName => $r) { + $a = $this->checkPhpSetting($sName, $r); + if ($a['res']) + return $sName; + } + return false; + } + + protected function getUrlForGooglePageSpeed ($sRule) + { + if (defined('BX_DOL_URL_ROOT')) { + $sUrl = BX_DOL_URL_ROOT; + } + else { + $sUrl = 'http://'; + if ( + (isset($_SERVER['HTTPS']) && $_SERVER['HTTPS']) || + (isset($_SERVER['HTTP_X_FORWARDED_PROTO']) && 'https' == strtolower($_SERVER['HTTP_X_FORWARDED_PROTO'])) || + getenv('UNA_HTTPS') + ) + $sUrl = 'https://'; + $sUrl .= $_SERVER['HTTP_HOST'] . str_replace('/install/index.php', '', $_SERVER['PHP_SELF']); + } + return 'https://pagespeed.web.dev/report?url=' . $sUrl; + } + + protected function sendTestEmail () + { + $sEmailToCkeckMailSending = isset($_GET['email']) ? $_GET['email'] : getParam('site_email'); + $mixedRet = sendMail($sEmailToCkeckMailSending, 'Audit Test Email', 'Sample text for testingSample text for testing', '', array(), BX_EMAIL_SYSTEM); + if (!$mixedRet) { + $aMessage = array('type' => BX_DOL_AUDIT_FAIL, 'msg' => _t('_sys_audit_msg_mail_send_failed')); + return $this->getBlock('', '', $this->getMsgHTML(_t('_sys_audit_mail_sending'), $aMessage), false); + } else { + return _t('_sys_audit_msg_mail_sent', $sEmailToCkeckMailSending); + } + } + + protected function setErrorReporting () + { + if (version_compare(phpversion(), "5.3.0", ">=") == 1) + $this->iPhpErrorReporting = error_reporting(E_ALL & ~E_NOTICE & ~E_WARNING & ~E_DEPRECATED & ~E_STRICT); + else + $this->iPhpErrorReporting = error_reporting(E_ALL & ~E_NOTICE & ~E_WARNING); + } + + protected function restoreErrorReporting () + { + error_reporting($this->iPhpErrorReporting); + } + + protected function getSection($sTitle, $sTitleAddon, $sContent) + { + $s = '' . $sTitle . ': ' . $sTitleAddon; + $s .= ''; + $s .= $sContent; + $s .= ''; + return $s; + } + + protected function getBlock($sName, $sValue = '', $sMsg = '', $bWrapAsListItem = true) + { + $s = $bWrapAsListItem ? '' : ''; + if ($sName !== '') + $s .= "$sName "; + if ($sValue !== '') + $s .= " = $sValue "; + if ($sMsg) + $s .= ($s ? " - " : '') . $sMsg; + return $s . ($bWrapAsListItem ? '' : '') . "\n"; + } + + protected function getMsgHTML($sName, $a) + { + $s = ''; + $s .= '' . $this->aType2Title[$a['type']]. ' '; + if (isset($a['msg'])) + $s .= '(' . $a['msg'] . ')'; + return $s; + } +} + +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/js/agents.js b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/js/agents.js new file mode 100644 index 0000000000..30edf170b0 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/js/agents.js @@ -0,0 +1,130 @@ +/** + * Copyright (c) UNA, Inc - https://una.io + * MIT License - https://opensource.org/licenses/MIT + * + * @defgroup UnaStudio UNA Studio + * @{ + */ +function BxDolStudioPageAgents(oOptions) +{ + BxDolStudioPage.call(this, oOptions); + + this.sPageUrl = oOptions.sPageUrl; + this.sObjName = oOptions.sObjName == undefined ? 'oBxDolStudioPageAgents' : oOptions.sObjName; + + this.sActionUrlCmts = oOptions.sActionUrlCmts == undefined ? this.sActionUrl : oOptions.sActionUrlCmts; + this.sActionUrlGrid = oOptions.sActionUrlGrid == undefined ? this.sActionUrl : oOptions.sActionUrlGrid; + + /* + * Note. Are needed for Grid and don't used for now. + * + this.sObjNameGrid = oOptions.sObjNameGrid; + this.sParamsDivider = oOptions.sParamsDivider == undefined ? '#-#' : oOptions.sParamsDivider; + this.sTextSearchInput = oOptions.sTextSearchInput == undefined ? '' : oOptions.sTextSearchInput; + */ +} + +BxDolStudioPageAgents.prototype = Object.create(BxDolStudioPage.prototype); +BxDolStudioPageAgents.prototype.constructor = BxDolStudioPageAgents; + +BxDolStudioPageAgents.prototype.onChangeAutomatorType = function(oSelect) { + var aHide = []; + var aShow = []; + switch($(oSelect).val()) { + case 'event': + aHide = []; //['scheduler_time']; + aShow = []; //['alert_unit', 'alert_action']; + break; + + case 'scheduler': + aHide = []; //['alert_unit', 'alert_action']; + aShow = []; //['scheduler_time']; + break; + + default: + aHide = []; //['alert_unit', 'alert_action', 'scheduler_time']; + aShow = []; + } + + var sHide = ''; + aHide.forEach((sItem) => { + sHide += ".bx-form-advanced #bx-form-element-" + sItem + ","; + }); + + var sShow = ''; + aShow.forEach((sItem) => { + sShow += ".bx-form-advanced #bx-form-element-" + sItem + ","; + }); + + $(sHide.substring(0, sHide.length - 1)).bx_anim('hide', this.sAnimationEffect, 0); + $(sShow.substring(0, sShow.length - 1)).bx_anim('show', this.sAnimationEffect, 0); +}; + +BxDolStudioPageAgents.prototype.approveCode = function(oSource, iCmtId) { + var $this = this; + var oData = this._getDefaultData(); + oData = jQuery.extend({}, oData, {action: 'approveCode', Cmt: iCmtId}); + + oSource = $(oSource); + bx_loading_btn(oSource, true); + + jQuery.post ( + this.sActionUrlCmts, + oData, + function(oData) { + bx_loading_btn(oSource, false); + + processJsonData(oData); + }, + 'json' + ); +}; + +BxDolStudioPageAgents.prototype.providerAdd = function(oButton, sName) { + var oButton = $(oButton); + + var oSubentry = oButton.parents('#bx-form-element-' + sName).find('.bx-form-input-provider:first').clone(); + oSubentry.find("select").val(''); + oSubentry.find("input[type = 'hidden']").remove(); + + oButton.parents('.bx-form-input-provider-add:first').before(oSubentry); +}; + +BxDolStudioPageAgents.prototype.providerDelete = function(oButton) { + $(oButton).parents('.bx-form-input-provider:first').remove(); +}; + +BxDolStudioPageAgents.prototype.helperAdd = function(oButton, sName) { + var oButton = $(oButton); + + var oSubentry = oButton.parents('#bx-form-element-' + sName).find('.bx-form-input-helper:first').clone(); + oSubentry.find("select").val(''); + oSubentry.find("input[type = 'hidden']").remove(); + + oButton.parents('.bx-form-input-helper-add:first').before(oSubentry); +}; + +BxDolStudioPageAgents.prototype.helperDelete = function(oButton) { + $(oButton).parents('.bx-form-input-helper:first').remove(); +}; + +BxDolStudioPageAgents.prototype.assistantAdd = function(oButton, sName) { + var oButton = $(oButton); + + var oSubentry = oButton.parents('#bx-form-element-' + sName).find('.bx-form-input-assistant:first').clone(); + oSubentry.find("select").val(''); + oSubentry.find("input[type = 'hidden']").remove(); + + oButton.parents('.bx-form-input-assistant-add:first').before(oSubentry); +}; + +BxDolStudioPageAgents.prototype.assistantDelete = function(oButton) { + $(oButton).parents('.bx-form-input-assistant:first').remove(); +}; + +BxDolStudioPageAgents.prototype._getDefaultData = function() { + var oDate = new Date(); + return jQuery.extend({}, this._oRequestParams, {_t:oDate.getTime()}); +}; + +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/js/launcher.js b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/js/launcher.js new file mode 100644 index 0000000000..98dd729ac0 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/js/launcher.js @@ -0,0 +1,302 @@ +/** + * Copyright (c) UNA, Inc - https://una.io + * MIT License - https://opensource.org/licenses/MIT + * + * @defgroup UnaStudio UNA Studio + * @{ + */ +function BxDolStudioLauncher(oOptions) { + this.sActionsUrl = oOptions.sActionUrl; + this.sObjName = oOptions.sObjName == undefined ? 'oBxDolStudioLauncher' : oOptions.sObjName; + this.sAnimationEffect = oOptions.sAnimationEffect == undefined ? 'fade' : oOptions.sAnimationEffect; + this.iAnimationSpeed = oOptions.iAnimationSpeed == undefined ? 'fast' : oOptions.iAnimationSpeed; + this.bInit = oOptions.bInit == undefined ? true : oOptions.bInit; + + //--- Jitter Settings ---// + this.bJitterMode = false; + this.aJitterConf = { + item: '.bx-std-widget-icon', + elements: '.bx-std-widget-actions,.bx-std-widget-icon-jitter,.bx-std-widget-caption-jitter' + }; + + this.aSortingConf = { + parent: '.bx-std-widgets', + item: '.bx-std-widget', + placeholder: 'bx-std-widget bx-std-widget-empty' + }; + + if(this.bInit) + this.init(); +} + +BxDolStudioLauncher.prototype.init = function() { + var $this = this; + + $(document).ready(function() { + var hammertime = new Hammer($('.bx-std-widgets').get(0)); + hammertime.get('press').set({time: 1000}); + hammertime.on('press', function(oEvent) { + if(!$this.bJitterMode) + $this.enableJitter(); + else + $this.disableJitter(); + }); + + //--- Enable Sorting for Page Edit mode ---// + $($this.aSortingConf.parent).sortable({ + disabled: true, + handle: '.bx-std-widget-icon-jitter', + items: $this.aSortingConf.item, + placeholder: $this.aSortingConf.placeholder, + start: function(oEvent, oUi) { + oUi.item.addClass('bx-std-widget-dragging'); + }, + stop: function(oEvent, oUi) { + oUi.item.removeClass('bx-std-widget-dragging'); + $this.reorder(oUi.item); + } + }); + + //--- Check for Featured mode. + if($this._isFeatured()) + $('.bx-menu-tab-featured').addClass('bx-menu-tab-active'); + }); + + window.addEventListener('keydown', (e) => { + if(e.keyCode === 114 || (e.ctrlKey && e.keyCode === 70) || (e.metaKey && e.keyCode === 70)) { + e.preventDefault(); + + $('.bx-menu-tab-search .bx-form-input-text[name="search"]').focus(); + } + }); +}; + +BxDolStudioLauncher.prototype.browser = function(oLink, sType) { + var $this = this; + var oDate = new Date(); + + if(sType == undefined) + sType = ''; + + var oBrowser = $('#bx-std-launcher-browser'); + if(oBrowser.length > 0) { + var fBrowserShow = function() { + oBrowser.dolPopup({ + closeOnOuterClick: true, + pointer: { + el: '.bx-menu-breadcrumb .bx-menu-bc-' + (sType.length > 0 ? 'type' : 'home'), + align: 'left', + offset: '-16 0' + }, + onBeforeShow: function(oPopup) { + $this.browserChangeType(oLink, sType); + } + }); + } + + if(oBrowser.is(':visible')) + oBrowser.dolPopupHide({ + onHide: function() { + if(oBrowser.find('.bx-std-lb-menu .bx-std-pmen-item.bx-std-pmen-item-' + sType + '.bx-menu-tab-active').length == 0) + fBrowserShow(); + } + }); + else + fBrowserShow(); + + return false; + } + + $.get( + this.sActionsUrl, + { + action: 'launcher-browser', + type: sType, + _t: oDate.getTime() + }, + function(oData) { + processJsonData(oData); + }, + 'json' + ); + + return false; +}; + +BxDolStudioLauncher.prototype.browserChangeType = function(oLink, sType) { + var sMenuActive = 'bx-menu-tab-active'; + var sContentActive = 'bx-std-lbw-active'; + + var oMenuActive = $('.bx-std-launcher-browser .bx-std-lb-menu .bx-std-pmen-item.' + sMenuActive); + if(oMenuActive.hasClass('bx-std-pmen-item-' + sType)) + return; + + oMenuActive.removeClass(sMenuActive).siblings('.bx-std-pmen-item-' + sType).addClass(sMenuActive); + $('.bx-std-launcher-browser .bx-std-lb-content .bx-std-lb-widgets.' + sContentActive).removeClass(sContentActive).siblings('.bx-std-lbw-' + sType).addClass(sContentActive); +}; + +BxDolStudioLauncher.prototype.updateCache = function() { + var oDate = new Date(); + + $.get( + this.sActionsUrl, + { + action: 'launcher-update-cache', + _t:oDate.getTime() + } + ); +}; + +BxDolStudioLauncher.prototype.reorder = function(oDraggable) { + var oDate = new Date(); + + $.post( + this.sActionsUrl + '?' + oDraggable.parent('.bx-std-widgets').sortable('serialize', {key: 'items[]'}), + { + action: 'launcher-reorder', + page: this.sScrollCurrent, + _t:oDate.getTime() + }, + function(oData) { + if(oData.code != 0) { + bx_alert(oData.message); + return; + } + }, + 'json' + ); + + return true; +}; + +BxDolStudioLauncher.prototype.featured = function(sPageName, oLink) { + var $this = this; + var oDate = new Date(); + + $.get( + this.sActionsUrl, + { + action: 'page-featured', + page: sPageName, + _t: oDate.getTime() + }, + function(oData) { + $('.bx-popup-applied:visible').dolPopupHide(); + + if(oData.code != 0) { + bx_alert(oData.message); + return; + } + + var oSettings = $(oLink).parents('.bx-mod-popup-settings:first'); + if(oSettings.length > 0 && oData.widget_id != undefined && oData.widget.length > 0) { + $('#bx-std-widget-' + oData.widget_id).replaceWith(oData.widget); + if($this.bInit) + oBxDolStudioLauncher.enableJitter(); + } + }, + 'json' + ); + return true; +}; + +BxDolStudioLauncher.prototype.bookmark = function(sPageName, oLink) { + var oDate = new Date(); + + $.get( + this.sActionsUrl, + { + action: 'page-bookmark', + page: sPageName, + _t: oDate.getTime() + }, + function(oData) { + $('.bx-popup-applied:visible').dolPopupHide(); + + if(oData.code != 0) { + bx_alert(oData.message); + return; + } + }, + 'json' + ); + + return true; +}; + +BxDolStudioLauncher.prototype.rearrange = function(iWidgetId, oSelect) { + var oDate = new Date(); + var oSelect = $(oSelect); + var oPopup = oSelect.parents('.bx-popup'); + + bx_loading(oPopup, true); + + $.get( + this.sActionsUrl, + { + action: 'widget-rearrange', + widget_id: iWidgetId, + type: oSelect.val(), + _t: oDate.getTime() + }, + function(oData) { + bx_loading(oPopup, false); + + processJsonData(oData); + }, + 'json' + ); + + return true; +}; + +BxDolStudioLauncher.prototype.enableJitter = function() { + this._disableFeatured(); + $('.bx-menu-tab-featured').removeClass('bx-menu-tab-active'); + + $(this.aJitterConf.elements).fadeIn('fast'); + $(this.aJitterConf.item).removeClass('bx-std-widget-icon-trans'); + $(this.aSortingConf.parent).addClass('bx-std-jitter').sortable('option', 'disabled', false); + + this.bJitterMode = true; +}; + +BxDolStudioLauncher.prototype.disableJitter = function() { + $(this.aJitterConf.elements).fadeOut('fast'); + $(this.aJitterConf.item).addClass('bx-std-widget-icon-trans'); + $(this.aSortingConf.parent).removeClass('bx-std-jitter').sortable('option', 'disabled', true); + + this.bJitterMode = false; +}; + +BxDolStudioLauncher.prototype.enableFeatured = function() { + this.disableJitter(); + $('.bx-menu-tab-edit').removeClass('bx-menu-tab-active'); + + $.cookie('bx_studio_featured', '1', {path: '/'}); + + this._enableFeatured(); +}; + +BxDolStudioLauncher.prototype.disableFeatured = function() { + $.cookie('bx_studio_featured', '0', {path: '/'}); + + this._disableFeatured(); +}; + +BxDolStudioLauncher.prototype._isFeatured = function() { + return parseInt($.cookie('bx_studio_featured')) == 1; +}; + +BxDolStudioLauncher.prototype._enableFeatured = function() { + var $this = this; + + $('.bx-std-widget:not(.bx-std-widget-icon-featured)').bx_anim('hide', this.sAnimationEffect, this.iAnimationSpeed); +}; + +BxDolStudioLauncher.prototype._disableFeatured = function() { + var $this = this; + + $('.bx-std-widget:not(.bx-std-widget-icon-featured)').bx_anim('show', this.sAnimationEffect, this.iAnimationSpeed); +}; +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/js/page.js b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/js/page.js new file mode 100644 index 0000000000..911a1d52c0 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/js/page.js @@ -0,0 +1,99 @@ +/** + * Copyright (c) UNA, Inc - https://una.io + * MIT License - https://opensource.org/licenses/MIT + * + * @defgroup UnaStudio UNA Studio + * @{ + */ +function BxDolStudioPage(oOptions) { + this.sActionsUrl = oOptions.sActionUrl; + this.sObjName = oOptions.sObjName == undefined ? 'oBxDolStudioPage' : oOptions.sObjName; + this.sCodeMirror = oOptions.sCodeMirror == undefined ? '' : oOptions.sCodeMirror; + this.sAnimationEffect = oOptions.sAnimationEffect == undefined ? 'slide' : oOptions.sAnimationEffect; + this.iAnimationSpeed = oOptions.iAnimationSpeed == undefined ? 'slow' : oOptions.iAnimationSpeed; + this.oPopupOptions = { + fog: { + color: '#fff', + opacity: .7 + }, + closeOnOuterClick: false + }; + + var $this = this; + $(document).ready (function () { + if($this.sCodeMirror != '') + $this.initCodeMirror($this.sCodeMirror); + }); +} + +BxDolStudioPage.prototype.processJson = function (oData) { + bx_loading('bx-std-page-columns', false); + + processJsonData(oData); +}; + +BxDolStudioPage.prototype.togglePopup = function(sName, oLink) { + var $this = this; + + var sId = '#bx-std-pcap-menu-popup-' + sName; + if($(sId + ':visible').length > 0) { + $(sId).dolPopupHide(); + return; + } + + $(oLink).parent().addClass('bx-menu-tab-active'); + + var oPopupOptions = { + pointer:{ + el:$(oLink) + }, + onHide: function() { + $(oLink).parent().removeClass('bx-menu-tab-active'); + } + }; + + switch(sName) { + case 'assistant': + break; + + case 'help': + oPopupOptions = $.extend({}, oPopupOptions, { + onBeforeShow: function() { + var oPopup = $(sId); + var oPopupRss = oPopup.find('.RSSAggrCont'); + if(oPopupRss.contents().length) + return; + + oPopupRss.dolRSSFeed({ + onError: function() { + oPopupRss.html(_t('_adm_txt_show_help_content_empty')); + oPopup._dolPopupSetPosition(oPopupOptions); + }, + onShow: function() { + oPopup._dolPopupSetPosition(oPopupOptions); + } + }); + + oPopup._dolPopupSetPosition(oPopupOptions); + } + }); + break; + } + + if($(sId).html().length > 0) + $(sId).dolPopup(oPopupOptions); +}; + +BxDolStudioPage.prototype.initCodeMirror = function(sSelector) { + var oSelector = $(sSelector); + for(var i = 0; i < oSelector.length; i++) { + var e = CodeMirror.fromTextArea(oSelector.get(i), { + lineNumbers: true, + mode: "htmlmixed", + htmlMode: true, + matchBrackets: true + }); + } +}; + +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/options.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/options.php new file mode 100644 index 0000000000..1a93931ed3 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/options.php @@ -0,0 +1,36 @@ +checkAction()) !== false) { + echoJson($mixedResult); + exit; +} + +echo $oOptions->getCode(); +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/agents_assistant_codes.html b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/agents_assistant_codes.html new file mode 100644 index 0000000000..90f078f281 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/agents_assistant_codes.html @@ -0,0 +1,10 @@ + + + + __code_onclick__ + + + + __code_button__ + + \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/agents_assistant_info.html b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/agents_assistant_info.html new file mode 100644 index 0000000000..2f20eb672b --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/agents_assistant_info.html @@ -0,0 +1,19 @@ + + + + + __assistant_name__ + + __assistant_info__ + + + + __chat_name__ + + __chat_info__ + + + + + + \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/agents_automator_form_assistants.html b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/agents_automator_form_assistants.html new file mode 100644 index 0000000000..0d06acbb3b --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/agents_automator_form_assistants.html @@ -0,0 +1,11 @@ + + + + __input_select__ + + + + + + __btn_add__ + \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/css/agents.css b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/css/agents.css new file mode 100644 index 0000000000..7925405abe --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/css/agents.css @@ -0,0 +1,93 @@ +/**--- Automators ---**/ +.cmt .bx-menu-custom.bx-menu-custom-hor > li > span { + margin-right: 0; +} +.cmt .bx-base-general-unit-meta ul.bx-menu-custom li:first-child .bx-base-general-unit-meta-div { + display: none; +} +.bx-def-vanilla-html pre, +.cmt-body.bx-def-vanilla-html pre{ + max-height: 20rem; + + border-width: 0; + border-radius: 0.375rem; + + background-color: #1f2937; + + color: #e5e7eb; +} + +/*-- Automators form: Providers --*/ +.bx-form-input-provider { + display: -webkit-flex; + display: flex; + -webkit-align-items: center; + align-items: center; +} +.bx-form-input-provider-cell.bx-fi-pc-txt { + -webkit-flex: 1 1 auto; + -ms-flex: 1 1 auto; + flex: 1 1 auto; +} +.bx-form-input-provider-cell.bx-fi-pc-btn { + -webkit-flex: 0 0 auto; + -ms-flex: 0 0 auto; + flex: 0 0 auto; +} +.bx-form-input-provider-add { + text-align: right; +} +.bx-form-input-provider-add .bx-form-input-button { + display: inline-block; + float: none; +} + +/*-- Automators form: Helpers --*/ +.bx-form-input-helper { + display: -webkit-flex; + display: flex; + -webkit-align-items: center; + align-items: center; +} +.bx-form-input-helper-cell.bx-fi-hc-txt { + -webkit-flex: 1 1 auto; + -ms-flex: 1 1 auto; + flex: 1 1 auto; +} +.bx-form-input-helper-cell.bx-fi-hc-btn { + -webkit-flex: 0 0 auto; + -ms-flex: 0 0 auto; + flex: 0 0 auto; +} +.bx-form-input-helper-add { + text-align: right; +} +.bx-form-input-helper-add .bx-form-input-button { + display: inline-block; + float: none; +} + +/*-- Automators form: Assistants --*/ +.bx-form-input-assistant { + display: -webkit-flex; + display: flex; + -webkit-align-items: center; + align-items: center; +} +.bx-form-input-assistant-cell.bx-fi-ac-txt { + -webkit-flex: 1 1 auto; + -ms-flex: 1 1 auto; + flex: 1 1 auto; +} +.bx-form-input-assistant-cell.bx-fi-ac-btn { + -webkit-flex: 0 0 auto; + -ms-flex: 0 0 auto; + flex: 0 0 auto; +} +.bx-form-input-assistant-add { + text-align: right; +} +.bx-form-input-assistant-add .bx-form-input-button { + display: inline-block; + float: none; +} \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/css/menu_top.css b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/css/menu_top.css new file mode 100644 index 0000000000..13c153b8f4 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/css/menu_top.css @@ -0,0 +1,447 @@ +div.bx-std-menu-top-wrp { + position: relative; + display: -webkit-flex; + display: flex; + -webkit-justify-content: space-between; + justify-content: space-between; + -webkit-align-items: center; + align-items: center; + -webkit-flex-wrap: nowrap; + flex-wrap: nowrap; + + width: 100%; + height: 5rem; +} +div.bx-std-menu-top-wrp .bx-std-menu-top.bx-std-menu-top-center:first-child { + padding-left: 0.75rem; +} + +div.bx-std-menu-top {} +div.bx-std-menu-top.bx-std-menu-top-left, +div.bx-std-menu-top.bx-std-menu-top-center, +div.bx-std-menu-top.bx-std-menu-top-right { + -webkit-flex: 0 1 auto; + flex: 0 1 auto; +} +div.bx-std-menu-top.bx-std-menu-top-left, +div.bx-std-menu-top.bx-std-menu-top-right { + position: relative; + z-index: 2; + min-width: 10%; +} +div.bx-std-menu-top.bx-std-menu-top-center { + z-index: 1; + -webkit-flex-grow: 1; + flex-grow: 1; + height: 3.5rem; +} +div.bx-std-menu-top.bx-std-menu-top-center .bx-std-menu-top-center-cnt { + position: absolute; + left: 0; + width: 100vw; +} +div.bx-std-menu-top-center ul { + position: relative; + display: -webkit-flex; + display: flex; + -webkit-align-items: stretch; + align-items: stretch; + -webkit-flex-wrap: nowrap; + flex-wrap: nowrap; + +} +div.bx-std-menu-top-left { + padding-left: 1rem; + line-height: 4rem; + text-align: left; + font-size: 1.5rem; +} +div.bx-std-menu-top-right { + padding-right: 1rem; + text-align: right; +} + +/*--- Breadcrumb (Left) ---*/ +div.bx-std-menu-top .bx-menu-breadcrumb { + position: relative; + display: -webkit-flex; + display: flex; + -webkit-flex-wrap: nowrap; + flex-wrap: nowrap; + -webkit-align-items: center; + align-items: center; +} + +/*--- Widgets (Center) ---*/ +div.bx-std-menu-top .bx-menu-top-center { + display: flex; + justify-content: center; + align-items: center; + gap: 0.25rem; + + padding: 0; + margin: 0; + + list-style: none; +} + +div.bx-std-menu-top .bx-menu-breadcrumb li.bx-menu-bc-item, +div.bx-std-menu-top .bx-menu-top-center li { + position: relative; + display: -webkit-flex; + display: flex; + -webkit-justify-content: center; + justify-content: center; + -webkit-align-items: center; + align-items: center; + + width: 3.5rem; + height: 3.5rem; +} + +div.bx-std-menu-top .bx-menu-breadcrumb li.bx-menu-bc-div img { + height: 2.0rem; +} + +div.bx-std-menu-top .bx-menu-breadcrumb li.bx-menu-bc-item.bx-menu-bc-page { + width: auto; + padding-left: 0.5rem; + padding-right: 0.5rem; +} + +/* + * Vertical divider between static and dynamic menu items. + * +div.bx-std-menu-top .bx-menu-top-center li.bx-menu-item-static + li.bx-menu-item-dynamic { + border-left: 1px solid rgba(240, 240, 240, 0.2); +} +*/ + +.bx-menu-breadcrumb li.bx-menu-bc-item > a, +div.bx-std-menu-top .bx-menu-top-center li a { + display: block; + z-index: 2; + box-sizing: content-box; + + width: 2.5rem; + height: 2.5rem; +} +.bx-menu-breadcrumb li.bx-menu-bc-item > a { + display: -webkit-flex; + display: flex; + -webkit-align-items: center; + align-items: center; + + width: auto; +} +div.bx-std-menu-top .bx-menu-top-center li.bx-menu-tab-active a { + border-color: rgba(37, 99, 235, 0.8); +} +div.bx-std-menu-top .bx-menu-top-center li .bx-mi-bg { + position: absolute; + display: none; + z-index: 1; + + top: 0; + left: 0; + width: 100%; + height: 100%; + + filter: blur(6px); +} +div.bx-std-menu-top .bx-menu-top-center li.bx-menu-tab-active .bx-mi-bg { + display: block; +} +div.bx-std-menu-top .bx-menu-breadcrumb li.bx-menu-bc-item .bx-mi-icon, +div.bx-std-menu-top .bx-menu-top-center li .bx-mi-icon { + overflow: hidden; +} +div.bx-std-menu-top .bx-menu-breadcrumb li.bx-menu-bc-item .bx-mi-icon { + border-radius: 1.5rem; +} +div.bx-std-menu-top .bx-menu-breadcrumb li.bx-menu-bc-item .bx-mi-title { + text-align: center; + letter-spacing: -0.02em; + + font-size: 1.5rem; + font-weight: 500; + + color: rgb(243, 244, 246); +} +div.bx-std-menu-top .bx-menu-breadcrumb li.bx-menu-bc-item img, +div.bx-std-menu-top .bx-menu-breadcrumb li.bx-menu-bc-item:not(.bx-menu-tab-search) svg, +div.bx-std-menu-top .bx-menu-breadcrumb li.bx-menu-bc-item .sys-icon, +div.bx-std-menu-top .bx-menu-top-center li img, +div.bx-std-menu-top .bx-menu-top-center li .sys-icon { + display: block; + box-sizing: content-box; + + width: 2.5rem; + height: 2.5rem; + + margin: 0; +} + +div.bx-std-menu-top .bx-menu-top-center li img { + position: relative; + z-index: -1; +} + +div.bx-std-menu-top .bx-menu-top-center li .sys-icon { + font-size: 1.5rem; + color: rgba(255, 255, 255, 0.7); +} + +div.bx-std-menu-top .bx-menu-top-center li .bx-mi-title { + margin-top: 0.25rem; + + font-size: 0.75rem; + font-weight: normal; + color: rgba(255, 255, 255, 0.7); + + text-overflow: ellipsis; + overflow: hidden; +} +div.bx-std-menu-top .bx-menu-top-center li.bx-menu-tab-divider { + width: 0.25rem; + height: 1.75rem; +} + +/*--- Search box (Top Left\Center\Right) ---*/ +div.bx-std-menu-top ul li.bx-menu-tab-search { + overflow: visible; +} +div.bx-std-menu-top ul li.bx-menu-tab-search > div { + position: absolute; + display: -webkit-flex; + display: flex; + -webkit-align-items: center; + align-items: center; + -webkit-flex-wrap: nowrap; + flex-wrap: nowrap; + + width: 2.5rem; + height: 2.5rem; + right: 0; + + border-radius: 1.5rem; +} +div.bx-std-menu-top ul.bx-menu-breadcrumb li.bx-menu-tab-search > div { + left: 0.5rem; + right: auto; +} +div.bx-std-menu-top ul li.bx-menu-tab-search.bx-mt-active > div { + width: 13.75rem; +} +div.bx-std-menu-top ul li.bx-menu-tab-search .bx-form-input-text { + height: 2.5rem; + padding-left: 0.5rem; + padding-right: 0.5rem; + + border-width: 0; + background-color: transparent; + + font-style: normal; + font-weight: 500; +} + + +/*--- Toolbar (Right) ---*/ +div.bx-std-menu-top .bx-menu-toolbar { + position: relative; + display: -webkit-flex; + display: flex; + -webkit-flex-wrap: nowrap; + flex-wrap: nowrap; + -webkit-justify-content: flex-end; + justify-content: flex-end; +} + +div.bx-std-menu-top .bx-menu-toolbar li { + position: relative; + float: none; + display: block; + + height: 2.5rem; + min-width: 2.5rem; + + border-radius: 1.5rem; + background-color: rgba(17, 24, 39, 1); + + line-height: 2.5rem; + overflow: hidden; +} +div.bx-std-menu-top .bx-menu-toolbar li:not(.bx-menu-tab-search) a { + position: relative; + display: -webkit-flex; + display: flex; + -webkit-justify-content: center; + justify-content: center; + -webkit-align-items: center; + align-items: center; + + width: 100%; + height: 100%; + + border-radius: 1.5rem; +} + +div.bx-std-menu-top .bx-menu-toolbar li a:hover { + color: #ffffff; +} + +div.bx-std-menu-top .bx-menu-toolbar li svg g { + opacity: 0.7; +} +div.bx-std-menu-top .bx-menu-toolbar li:hover { + background-color: rgba(31, 41, 55, 1); +} +div.bx-std-menu-top .bx-menu-toolbar li:hover svg g { + opacity: 0.85; +} + +div.bx-std-menu-top i.sys-icon { + -webkit-transition: all 0.2s ease-in-out; + transition: all 0.2s ease-in-out; +} + +div.bx-std-menu-top-right li.bx-menu-tab-active i.sys-icon { + color: #ffe900; + text-shadow: 0 0 4px #ffe900; +} + +/*--- Account, Actions, Help and Settings popups ---*/ +body > .bx-popup-wrapper.bx-std-mod-popup-settings-wrapper, +#bx-std-pcap-menu-popup-help, +#bx-std-pcap-menu-popup-assistant, +#bx-std-pcap-menu-popup-actions, +#bx-std-pcap-menu-popup-account { + overflow: visible; +} +.bx-std-mod-popup-settings-wrapper .bx-popup-gap, +#bx-std-pcap-menu-popup-help .bx-popup-gap, +#bx-std-pcap-menu-popup-assistant .bx-popup-gap, +#bx-std-pcap-menu-popup-actions .bx-popup-gap, +#bx-std-pcap-menu-popup-account .bx-popup-gap { + margin-left: 0; + margin-right: 0; +} +#bx-std-pcap-menu-popup-help .bx-popup, +#bx-std-pcap-menu-popup-assistant .bx-popup, +#bx-std-pcap-menu-popup-assistant .bx-popup .bx-popup-header-color-bg, +#bx-std-pcap-menu-popup-actions .bx-popup, +#bx-std-pcap-menu-popup-account .bx-popup, +.bx-std-mod-popup-settings-wrapper.bx-popup-applied:not(.bx-popup-chain) .bx-popup { + border-width: 0; + background-color: #001529; +} +#bx-std-pcap-menu-popup-actions .bx-popup-content { + padding: 1.0rem; +} +#bx-std-pcap-menu-popup-account .bx-popup-content { + padding: 0.5rem 0; +} +#bx-std-pcap-menu-popup-account .bx-popup li { + position: relative; + height: 2.5rem; + margin: 0; + padding: 0 1rem; + + white-space: nowrap; + line-height: 2.5rem; + font-size: 0.875rem; + font-weight: 400; + overflow: hidden; +} +#bx-std-pcap-menu-popup-account .bx-popup li a { + position: relative; + display: -webkit-flex; + display: flex; + -webkit-align-items: center; + align-items: center; +} +#bx-std-pcap-menu-popup-account .bx-popup li svg { + margin-right: 0.75rem; +} + +.bx-std-mod-popup-settings-wrapper, +#bx-std-pcap-menu-popup-help .bx-popup, +#bx-std-pcap-menu-popup-help .bx-popup a, +#bx-std-pcap-menu-popup-help .bx-popup .sys-icon, +#bx-std-pcap-menu-popup-assistant .bx-popup, +#bx-std-pcap-menu-popup-assistant .bx-popup .bx-popup-header h2, +#bx-std-pcap-menu-popup-assistant .bx-popup .bx-popup-header .bx-icon, +#bx-std-pcap-menu-popup-assistant .bx-popup a, +#bx-std-pcap-menu-popup-assistant .bx-popup .sys-icon, +#bx-std-pcap-menu-popup-actions .bx-popup, +#bx-std-pcap-menu-popup-account .bx-popup li a, +#bx-std-pcap-menu-popup-account .bx-popup li .sys-icon { + color: rgba(255, 255, 255, 0.7); +} +#bx-std-pcap-menu-popup-account .bx-popup li svg g { + opacity: 0.7; +} +#bx-std-pcap-menu-popup-help .bx-popup a:hover, +#bx-std-pcap-menu-popup-assistant .bx-popup a:hover, +#bx-std-pcap-menu-popup-account .bx-popup li:hover a, +#bx-std-pcap-menu-popup-account .bx-popup li:hover a .sys-icon { + color: rgba(255, 255, 255, 0.85); +} +#bx-std-pcap-menu-popup-account .bx-popup li.bx-menu-tab-active { + background-color: rgba(24, 144, 255, 0.2); + box-shadow: inset 3px 0px 0px rgba(24, 144, 255, 1.0); +} +#bx-std-pcap-menu-popup-account .bx-popup li:hover svg g, +#bx-std-pcap-menu-popup-account .bx-popup li.bx-menu-tab-active svg g { + opacity: 0.85; +} + +.bx-std-mod-popup-settings-wrapper .bx-form-input-select { + border-color: rgb(55, 65, 81, 1.0); + background-color: rgb(17, 24, 39, 1.0); +} + +/*--- Assistant ---*/ +#bx-std-pcap-menu-popup-assistant .bx-popup .bx-popup-header { + border-bottom: 1px solid rgb(31 41 55); +} +#bx-std-pcap-menu-popup-assistant .bx-popup .bx-popup-content { + padding-top: 0; +} +.bx-std-pcap-assistant div.cmts { + max-height: calc(0.5 * 100vh); + overflow-y: auto; +} +.bx-std-pcap-assistant div.cmts > ul.cmts { + margin-top: 1rem; +} +.bx-std-pcap-assistant .cmt > .cmts { + display: none; +} +.bx-std-pcap-assistant .cmt .cmt-head .cmt-meta { + margin-right: 0; + color: rgb(156 163 175); +} +.bx-std-pcap-assistant .cmt .cmt-head ul li:first-child .bx-base-general-unit-meta-div { + display: none; +} +.bx-std-pcap-assistant .cmt .cmt-cont .cmt-body { + color: rgb(229, 231, 235); +} +.bx-std-pcap-assistant .cmt-reply.cmt-reply-bottom { + margin-bottom: 0; +} +.bx-std-pcap-assistant .bx-form-section-content { + display: flex; +} +.bx-std-pcap-assistant .bx-form-section-content > .bx-form-element-wrapper:first-child { + flex: 1 1 auto; +} +.bx-std-pcap-assistant .bx-form-section-content > .bx-form-element-wrapper:last-child { + flex: 0 0 auto; + margin: 0 0 0 1rem; +} +.bx-std-pcap-assistant .bx-form-value .bx-form-input-textarea { + height: 2.5rem; + background-color: rgb(31 41 55); +} \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/images/icons/mi-agt-assistants.svg b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/images/icons/mi-agt-assistants.svg new file mode 100644 index 0000000000..a4c85c2108 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/images/icons/mi-agt-assistants.svg @@ -0,0 +1,14 @@ + + + + + + + + + + + + + + diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/images/icons/mi-agt-automators.svg b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/images/icons/mi-agt-automators.svg new file mode 100644 index 0000000000..cc3f61139e --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/images/icons/mi-agt-automators.svg @@ -0,0 +1,14 @@ + + + + + + + + + + + + + + diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/images/icons/mi-agt-helpers.svg b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/images/icons/mi-agt-helpers.svg new file mode 100644 index 0000000000..4d8d000637 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/images/icons/mi-agt-helpers.svg @@ -0,0 +1,14 @@ + + + + + + + + + + + + + + diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/images/icons/mi-agt-providers.svg b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/images/icons/mi-agt-providers.svg new file mode 100644 index 0000000000..dc624487b4 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/images/icons/mi-agt-providers.svg @@ -0,0 +1,14 @@ + + + + + + + + + + + + + + diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/images/icons/mi-cog.svg b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/images/icons/mi-cog.svg new file mode 100644 index 0000000000..108cdb5514 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/images/icons/mi-cog.svg @@ -0,0 +1,14 @@ + + + + + + + + + + + + + + diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/images/icons/tmi-assistant.svg b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/images/icons/tmi-assistant.svg new file mode 100644 index 0000000000..7706171ba5 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/images/icons/tmi-assistant.svg @@ -0,0 +1,3 @@ + + + diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/images/icons/wi-bld-roles.svg b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/images/icons/wi-bld-roles.svg new file mode 100644 index 0000000000..ad78074073 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/images/icons/wi-bld-roles.svg @@ -0,0 +1,27 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/page_caption_assistant.html b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/page_caption_assistant.html new file mode 100644 index 0000000000..d55182f7f8 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/page_caption_assistant.html @@ -0,0 +1,3 @@ + + __content__ + \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/pgt_etemplates_creative_fld.html b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/pgt_etemplates_creative_fld.html new file mode 100644 index 0000000000..f9d110e668 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/pgt_etemplates_creative_fld.html @@ -0,0 +1,39 @@ + + __content_html__ + __content_data__ + + + \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/pgt_etemplates_creative_frm.html b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/pgt_etemplates_creative_frm.html new file mode 100644 index 0000000000..ad4ad02922 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/pgt_etemplates_creative_frm.html @@ -0,0 +1,3 @@ +__warning__ + +__form__ \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/scripts/BxBaseStudioAgents.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/scripts/BxBaseStudioAgents.php new file mode 100644 index 0000000000..1294fb1388 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/scripts/BxBaseStudioAgents.php @@ -0,0 +1,317 @@ +sSubpageUrl = BX_DOL_URL_STUDIO . 'agents.php?page='; + + $this->aPageJs = array_merge($this->aPageJs, ['agents.js']); + $this->aPageCss = array_merge($this->aPageCss, ['cmts.css', 'agents.css']); + + $this->sPageJsClass = 'BxDolStudioPageAgents'; + $this->sPageJsObject = 'oBxDolStudioPageAgents'; + $this->aPageJsOptions = [ + 'sActionUrl' => BX_DOL_URL_STUDIO . 'agents.php', + 'sPageUrl' => $this->sSubpageUrl + ]; + + $this->aMenuItems = [ + BX_DOL_STUDIO_AGENTS_TYPE_SETTINGS => ['icon' => 'mi-cog.svg', 'icon_bg' => true], + BX_DOL_STUDIO_AGENTS_TYPE_PROVIDERS => ['icon' => 'mi-agt-providers.svg', 'icon_bg' => true], + BX_DOL_STUDIO_AGENTS_TYPE_HELPERS => ['icon' => 'mi-agt-helpers.svg', 'icon_bg' => true], + BX_DOL_STUDIO_AGENTS_TYPE_ASSISTANTS => ['icon' => 'mi-agt-assistants.svg', 'icon_bg' => true], + BX_DOL_STUDIO_AGENTS_TYPE_AUTOMATORS => ['icon' => 'mi-agt-automators.svg', 'icon_bg' => true], + ]; + + $this->aGridObjects = [ + BX_DOL_STUDIO_AGENTS_TYPE_AUTOMATORS => 'sys_studio_agents_automators', + BX_DOL_STUDIO_AGENTS_TYPE_PROVIDERS => 'sys_studio_agents_providers', + BX_DOL_STUDIO_AGENTS_TYPE_ASSISTANTS => 'sys_studio_agents_assistants', + BX_DOL_STUDIO_AGENTS_TYPE_ASSISTANTS . '_chats' => 'sys_studio_agents_assistants_chats', + BX_DOL_STUDIO_AGENTS_TYPE_ASSISTANTS . '_files' => 'sys_studio_agents_assistants_files', + BX_DOL_STUDIO_AGENTS_TYPE_HELPERS => 'sys_studio_agents_helpers', + ]; + } + + public function getPageJsCode($aOptions = [], $bWrap = true) + { + return parent::getPageJsCode(array_merge($aOptions, $this->aPageJsOptions), $bWrap); + } + + public function getPageMenu($aMenu = [], $aMarkers = []) + { + $sJsObject = $this->getPageJsObject(); + + $aMenu = []; + foreach($this->aMenuItems as $sMenuItem => $aItem) + $aMenu[] = array_merge($aItem, [ + 'name' => $sMenuItem, + 'link' => $this->sSubpageUrl . $sMenuItem, + 'title' => _t('_adm_lmi_cpt_' . $sMenuItem), + 'selected' => $sMenuItem == $this->sPage + ]); + + return parent::getPageMenu($aMenu); + } + + protected function getSettings() + { + $oOptions = new BxTemplStudioOptions(BX_DOL_STUDIO_STG_TYPE_DEFAULT, [ + 'agents_general', + 'agents_usage', + ]); + + $this->aPageCss = array_merge($this->aPageCss, $oOptions->getCss()); + $this->aPageJs = array_merge($this->aPageJs, $oOptions->getJs()); + + return $oOptions->getCode(); + } + + protected function getAutomators() + { + $oTemplate = BxDolStudioTemplate::getInstance(); + + $this->aPageJsOptions['sPageUrl'] .= 'automators'; + + if(($iId = bx_get('id')) !== false) { + if(($oCmts = BxDolAI::getInstance()->getAutomatorCmtsObject($iId, $oTemplate)) !== false) { + $this->aPageJsOptions = array_merge($this->aPageJsOptions, [ + 'sPageUrl' => $this->sSubpageUrl . 'automators&id=' . $iId, + 'sActionUrlCmts' => bx_append_url_params(BX_DOL_URL_ROOT . 'cmts.php', [ + 'sys' => $oCmts->getSystemName(), + 'id' => $iId + ]) + ]); + + return $oCmts->getCommentsBlock(); + } + else + return MsgBox(_t('_error occured')); + } + + return $this->getGrid($this->aGridObjects[BX_DOL_STUDIO_AGENTS_TYPE_AUTOMATORS]); + } + + protected function getHelpers() + { + $oTemplate = BxDolStudioTemplate::getInstance(); + + $this->aPageJsOptions['sPageUrl'] .= 'helpers'; + + if(($iId = bx_get('id')) !== false) { + $this->aPageJsOptions = array_merge($this->aPageJsOptions, [ + 'sPageUrl' => $this->sSubpageUrl . 'helpers&id=' . $iId, + ]); + + $aHelper = BxDolAI::getInstance()->getHelperById($iId); + + $aForm = $this->_getHelpersForm('tune', $aHelper); + $oForm = new BxTemplFormView($aForm); + $oForm->initChecker(); + + if($oForm->isSubmittedAndValid()) { + if($oForm->update($iId) !== false) { + $sMessage = $oForm->getCleanValue('message'); + $oForm->aInputs['result']['value'] = BxDolAI::callHelper($iId, $sMessage); + } + } + + return $oForm->getCode(); + } + + return $this->getGrid($this->aGridObjects[BX_DOL_STUDIO_AGENTS_TYPE_HELPERS]); + } + + protected function getAssistants() + { + $oAi = BxDolAI::getInstance(); + $oTemplate = BxDolStudioTemplate::getInstance(); + + $this->aPageJsOptions['sPageUrl'] .= 'assistants'; + + $sSubPage = ''; + if(($sSubPage = bx_get('spage')) !== false) + $sSubPage = bx_process_input($sSubPage, BX_DATA_TEXT); + + $iAssistantId = 0; + if(($iAssistantId = bx_get('aid')) !== false) + $iAssistantId = bx_process_input($iAssistantId, BX_DATA_INT); + + $iChatId = 0; + if(($iChatId = bx_get('cid')) !== false) + $iChatId = bx_process_input($iChatId, BX_DATA_INT); + + if($iAssistantId && $iChatId) { + $aResult = []; + + $sAssistantUrl = $this->sSubpageUrl . 'assistants&spage=chats&aid=' . $iAssistantId; + $aAssistant = $oAi->getAssistantById($iAssistantId); + if(!empty($aAssistant) && is_array($aAssistant)) { + $aChat = $oAi->getAssistantChatById($iChatId); + if(!empty($aChat) && is_array($aChat)) + $aResult[] = $oTemplate->parseHtmlByName('agents_assistant_info.html', [ + 'assistant_name' => $aAssistant['name'], + 'assistant_info' => $aAssistant['description'], + 'bx_if:show_chat' => [ + 'condition' => true, + 'content' => [ + 'chat_name' => $aChat['name'], + 'chat_info' => $aChat['description'], + ] + ], + 'url_back' => $sAssistantUrl + ]); + } + + if(($oCmts = $oAi->getAssistantChatCmtsObject($iChatId, $oTemplate)) !== false) { + $this->aPageJsOptions = array_merge($this->aPageJsOptions, [ + 'sPageUrl' => $sAssistantUrl . '&cid=' . $iChatId, + 'sActionUrlCmts' => bx_append_url_params(BX_DOL_URL_ROOT . 'cmts.php', [ + 'sys' => $oCmts->getSystemName(), + 'id' => $iChatId + ]) + ]); + + $aResult[] = $oCmts->getCommentsBlock(); + } + else + $aResult[] = MsgBox(_t('_error occured')); + + return $aResult; + } + else if($iAssistantId) { + $aResult = []; + + $aAssistant = $oAi->getAssistantById($iAssistantId); + if(!empty($aAssistant) && is_array($aAssistant)) + $aResult[] = $oTemplate->parseHtmlByName('agents_assistant_info.html', [ + 'assistant_name' => $aAssistant['name'], + 'assistant_info' => $aAssistant['description'], + 'bx_if:show_chat' => [ + 'condition' => false, + 'content' => [ + 'chat_name' => '', + 'chat_info' => '', + ] + ], + 'url_back' => $this->aPageJsOptions['sPageUrl'] + ]); + + switch($sSubPage) { + case 'chats': + $aResult[] = $this->getGrid($this->aGridObjects[BX_DOL_STUDIO_AGENTS_TYPE_ASSISTANTS . '_chats']); + break; + + case 'files': + $aResult[] = $this->getGrid($this->aGridObjects[BX_DOL_STUDIO_AGENTS_TYPE_ASSISTANTS . '_files']); + break; + } + + return $aResult; + } + + return $this->getGrid($this->aGridObjects[BX_DOL_STUDIO_AGENTS_TYPE_ASSISTANTS]); + } + + protected function getProviders() + { + $this->aPageJsOptions = array_merge($this->aPageJsOptions, [ + 'sPageUrl' => $this->sSubpageUrl . 'providers', + 'sActionUrlGrid' => bx_append_url_params(BX_DOL_URL_ROOT . 'grid.php', [ + 'o' => 'sys_studio_agents_providers' + ]) + ]); + + return $this->getGrid($this->aGridObjects[BX_DOL_STUDIO_AGENTS_TYPE_PROVIDERS]); + } + + protected function getGrid($sObjectName, $bObject = false) + { + $oGrid = BxDolGrid::getObjectInstance($sObjectName); + if(!$oGrid) + return ''; + + return $bObject ? $oGrid : $oGrid->getCode(); + } + + protected function _getHelpersForm($sAction, $aHelper = []) + { + $aForm = array( + 'form_attrs' => array( + 'id' => 'bx_std_agents_helpers_' . $sAction, + 'action' => $this->aPageJsOptions['sPageUrl'], + 'method' => 'post', + ), + 'params' => array ( + 'db' => array( + 'table' => 'sys_agents_helpers', + 'key' => 'id', + 'submit_name' => 'do_submit', + ), + ), + 'inputs' => [ + 'prompt' => [ + 'type' => 'textarea', + 'name' => 'prompt', + 'caption' => _t('_sys_agents_helpers_field_prompt'), + 'value' => isset($aHelper['prompt']) ? $aHelper['prompt'] : '', + 'required' => '1', + 'checker' => [ + 'func' => 'Avail', + 'params' => [], + 'error' => _t('_sys_agents_helpers_field_prompt_err'), + ], + 'db' => [ + 'pass' => 'Xss', + ] + ], + 'message' => [ + 'type' => 'textarea', + 'name' => 'message', + 'caption' => _t('_sys_agents_helpers_field_message'), + 'value' => '', + 'required' => '1', + 'checker' => [ + 'func' => 'Avail', + 'params' => [], + 'error' => _t('_sys_agents_helpers_field_message_err'), + ], + ], + 'result' => [ + 'type' => 'textarea', + 'name' => 'result', + 'caption' => _t('_sys_agents_helpers_field_result'), + 'value' => '', + 'attrs' => [ + 'disabled' => 'disabled' + ] + ], + 'submit' => [ + 'type' => 'submit', + 'name' => 'do_submit', + 'value' => _t('_sys_submit'), + ], + ], + ); + + return $aForm; + } +} + +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/scripts/BxBaseStudioAgentsAssistants.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/scripts/BxBaseStudioAgentsAssistants.php new file mode 100644 index 0000000000..cc767f3e3d --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/scripts/BxBaseStudioAgentsAssistants.php @@ -0,0 +1,368 @@ +_sUrlPage = BX_DOL_URL_STUDIO . 'agents.php?page=assistants'; + + $this->_sFieldName = 'name'; + } + + public function getPageJsObject() + { + return 'oBxDolStudioPageAgents'; + } + + public function performActionAdd() + { + $sAction = 'add'; + + $oAI = BxDolAI::getInstance(); + + $aForm = $this->_getForm($sAction); + $oForm = new BxTemplFormView($aForm); + $oForm->initChecker(); + + if($oForm->isSubmittedAndValid()) { + $aValsToAdd = ['added' => time()]; + + $sName = $oForm->getCleanValue($this->_sFieldName); + $sName = BxDolAIAssistant::getName($sName); + BxDolForm::setSubmittedValue($this->_sFieldName, $sName, $oForm->aFormAttrs['method']); + + $iProfileId = $oForm->getCleanValue('profile_id'); + if(empty($iProfileId)) { + $iProfileId = (int)getParam('sys_agents_profile'); + if(empty($iProfileId)) + $iProfileId = current(bx_srv('system', 'get_options_agents_profile', [false], 'TemplServices'))['key']; + + $aValsToAdd['profile_id'] = $iProfileId; + } + + $oAIModel = $oAI->getModelObject($oForm->getCleanValue('model_id')); + if(($aAssistant = $oAIModel->getAssistant(['name' => $sName, 'prompt' => $oForm->getCleanValue('prompt')])) !== false) + $aValsToAdd = array_merge($aValsToAdd, [ + 'ai_vs_id' => $aAssistant['vector_store_id'], + 'ai_asst_id' => $aAssistant['assistant_id'] + ]); + + if(($iId = $oForm->insert($aValsToAdd)) !== false) + $aRes = ['grid' => $this->getCode(false), 'blink' => $iId]; + else + $aRes = ['msg' => _t('_sys_txt_error_occured')]; + + return echoJson($aRes); + } + + $sFormId = $oForm->getId(); + $sContent = BxTemplStudioFunctions::getInstance()->popupBox($sFormId . '_popup', _t('_sys_agents_assistants_popup_add'), $this->_oTemplate->parseHtmlByName('agents_automator_form.html', [ + 'form_id' => $sFormId, + 'form' => $oForm->getCode(true), + 'object' => $this->_sObject, + 'action' => $sAction + ])); + + return echoJson(['popup' => ['html' => $sContent, 'options' => ['closeOnOuterClick' => false]]]); + } + + public function performActionEdit() + { + $sAction = 'edit'; + + $iId = $this->_getId(); + $aHelper = $this->_oDb->getAssistantsBy(['sample' => 'id', 'id' => $iId]); + + $aForm = $this->_getFormEdit($sAction, $aHelper); + $oForm = new BxTemplFormView($aForm); + $oForm->initChecker(); + + if($oForm->isSubmittedAndValid()) { + $aValsToAdd = []; + + $sName = $oForm->getCleanValue($this->_sFieldName); + if($aHelper[$this->_sFieldName] != $sName) { + $sName = BxDolAIAssistant::getName($sName); + BxDolForm::setSubmittedValue($this->_sFieldName, $sName, $oForm->aFormAttrs['method']); + } + + $iProfileId = $oForm->getCleanValue('profile_id'); + if(empty($iProfileId)) { + $iProfileId = (int)getParam('sys_agents_profile'); + if(empty($iProfileId)) + $iProfileId = current(bx_srv('system', 'get_options_agents_profile', [false], 'TemplServices'))['key']; + + $aValsToAdd['profile_id'] = $iProfileId; + } + + if($oForm->update($iId, $aValsToAdd) !== false) + $aRes = ['grid' => $this->getCode(false), 'blink' => $iId]; + else + $aRes = ['msg' => _t('_sys_txt_error_occured')]; + + return echoJson($aRes); + } + + $sFormId = $oForm->getId(); + $sContent = BxTemplStudioFunctions::getInstance()->popupBox($sFormId . '_popup', _t('_sys_agents_assistants_popup_edit'), $this->_oTemplate->parseHtmlByName('agents_automator_form.html', [ + 'form_id' => $sFormId, + 'form' => $oForm->getCode(true), + 'object' => $this->_sObject, + 'action' => $sAction + ])); + + return echoJson(['popup' => ['html' => $sContent, 'options' => ['closeOnOuterClick' => false]]]); + } + + public function performActionCodes() + { + $sAction = 'codes'; + + $iId = $this->_getId(); + + $sContent = BxTemplStudioFunctions::getInstance()->transBox('bx_std_agents_assistants_codes', $this->_oTemplate->parseHtmlByName('agents_assistant_codes.html', [ + 'code_onclick' => '{onclick}', + 'code_button' => htmlspecialchars($this->_oTemplate->parseLink('javascript:void(0)', _t('_sys_agents_assistants_txt_add_knowledge'), [ + 'class' => 'bx-btn', + 'onclick' => '{onclick}' + ]), ENT_NOQUOTES) + ])); + $sContent = bx_replace_markers($sContent, ['onclick' => "javascript:bx_agents_action(this, 'asst', 'add_knowledge', {id: " . $iId . "})"]); + + + return echoJson(['popup' => ['html' => $sContent, 'options' => []]]); + } + + protected function _getCellModelId($mixedValue, $sKey, $aField, $aRow) + { + $aModel = $this->_oDb->getModelsBy(['sample' => 'id', 'id' => $mixedValue]); + if(!empty($aModel) && is_array($aModel)) + $mixedValue = $aModel['title']; + + return parent::_getCellDefault($mixedValue, $sKey, $aField, $aRow); + } + + protected function _getCellProfileId($mixedValue, $sKey, $aField, $aRow) + { + return parent::_getCellDefault(BxDolProfile::getInstanceMagic($mixedValue)->getDisplayName(), $sKey, $aField, $aRow); + } + + protected function _getCellAdded($mixedValue, $sKey, $aField, $aRow) + { + return parent::_getCellDefault(bx_time_js($mixedValue), $sKey, $aField, $aRow); + } + + protected function _getActionChats($sType, $sKey, $a, $isSmall = false, $isDisabled = false, $aRow = []) + { + $a['attr'] = array_merge($a['attr'], [ + "onclick" => "window.open('" . $this->_sUrlPage . '&spage=chats&aid=' . $aRow['id'] . "', '_self');" + ]); + + return $this->_getActionDefault ($sType, $sKey, $a, $isSmall, $isDisabled, $aRow); + } + + protected function _getActionFiles($sType, $sKey, $a, $isSmall = false, $isDisabled = false, $aRow = []) + { + $a['attr'] = array_merge($a['attr'], [ + "onclick" => "window.open('" . $this->_sUrlPage . '&spage=files&aid=' . $aRow['id'] . "', '_self');" + ]); + + return $this->_getActionDefault ($sType, $sKey, $a, $isSmall, $isDisabled, $aRow); + } + + protected function _addJsCss() + { + parent::_addJsCss(); + + $this->_oTemplate->addJs(['jquery.form.min.js']); + + $oForm = new BxTemplStudioFormView([]); + $oForm->addCssJs(); + } + + protected function _isCheckboxDisabled($aRow) + { + return false; + } + + protected function _getActionsDisabledBehavior($aRow) + { + return false; + } + + protected function _delete ($mixedId) + { + $iAssistantId = (int)$mixedId; + $aAssistant = $this->_oDb->getAssistantsBy(['sample' => 'id', 'id' => $iAssistantId]); + + $mixedResult = parent::_delete($mixedId); + if($mixedResult) { + $oAi = BxDolAI::getInstance(); + $oAIModel = $oAi->getModelObject($aAssistant['model_id']); + + $aChats = $this->_oDb->getChatsBy(['sample' => 'assistant_id', 'assistant_id' => $iAssistantId]); + foreach($aChats as $aChat) { + if(($oCmts = $oAi->getAssistantChatCmtsObject($aChat['id'])) !== false) + $oCmts->onObjectDelete(); + + if(!empty($aChat['ai_file_id'])) { + $oAIModel->callVectorStoresFilesDelete($aAssistant['ai_vs_id'], $aChat['ai_file_id']); + $oAIModel->callFilesDelete($aChat['ai_file_id']); + } + } + + $this->_oDb->deleteChats(['assistant_id' => $iAssistantId]); + + $this->_oDb->deleteAutomatorAssistants(['assistant_id' => $iAssistantId]); + + $oAIModel->callVectorStoresDelete($aAssistant['ai_vs_id']); + $oAIModel->callAssistantsDelete($aAssistant['ai_asst_id']); + } + + return $mixedResult; + } + + protected function _getFormEdit($sAction, $aHelper = []) + { + $aForm = $this->_getForm($sAction, $aHelper); + $aForm['form_attrs']['action'] .= '&id=' . $aHelper['id']; + + return $aForm; + } + + protected function _getForm($sAction, $aHelper = []) + { + $sJsObject = $this->getPageJsObject(); + + $aForm = [ + 'form_attrs' => [ + 'id' => 'bx_std_agents_assistants_' . $sAction, + 'action' => BX_DOL_URL_ROOT . bx_append_url_params('grid.php', ['o' => 'sys_studio_agents_assistants', 'a' => $sAction]), + 'method' => 'post', + ], + 'params' => [ + 'db' => [ + 'table' => 'sys_agents_assistants', + 'key' => 'id', + 'submit_name' => 'do_submit', + ], + ], + 'inputs' => [ + 'name' => [ + 'type' => 'text', + 'name' => 'name', + 'required' => '1', + 'caption' => _t('_sys_agents_assistants_field_name'), + 'value' => isset($aHelper['name']) ? $aHelper['name'] : '', + 'required' => '1', + 'checker' => [ + 'func' => 'Avail', + 'params' => [], + 'error' => _t('_sys_agents_form_field_err_enter'), + ], + 'db' => [ + 'pass' => 'Xss', + ] + ], + 'model_id' => [ + 'type' => 'select', + 'name' => 'model_id', + 'caption' => _t('_sys_agents_assistants_field_model_id'), + 'info' => '', + 'value' => isset($aHelper['model_id']) ? $aHelper['model_id'] : BxDolAI::getDefaultModel(), + 'values' => $this->_oDb->getModelsBy(['sample' => 'all_pairs', 'for_asst' => 1, 'active' => 1, 'hidden' => 0]), + 'required' => '1', + 'db' => [ + 'pass' => 'Int', + ] + ], + 'profile_id' => [ + 'type' => 'select', + 'name' => 'profile_id', + 'caption' => _t('_sys_agents_assistants_field_profile_id'), + 'info' => _t('_sys_agents_assistants_field_profile_id_inf'), + 'value' => isset($aHelper['profile_id']) ? $aHelper['profile_id'] : 0, + 'values' => bx_srv('system', 'get_options_agents_profile', [], 'TemplServices'), + 'required' => '0', + 'db' => [ + 'pass' => 'Int', + ] + ], + 'description' => [ + 'type' => 'textarea', + 'name' => 'description', + 'caption' => _t('_sys_agents_assistants_field_description'), + 'value' => isset($aHelper['description']) ? $aHelper['description'] : '', + 'required' => '1', + 'checker' => [ + 'func' => 'Avail', + 'params' => [], + 'error' => _t('_sys_agents_form_field_err_enter'), + ], + 'db' => [ + 'pass' => 'Xss', + ] + ], + 'prompt' => [ + 'type' => 'textarea', + 'name' => 'prompt', + 'caption' => _t('_sys_agents_assistants_field_prompt'), + 'value' => isset($aHelper['prompt']) ? $aHelper['prompt'] : '', + 'required' => '1', + 'checker' => [ + 'func' => 'Avail', + 'params' => [], + 'error' => _t('_sys_agents_assistants_field_prompt_err'), + ], + 'db' => [ + 'pass' => 'Xss', + ] + ], + 'submit' => [ + 'type' => 'input_set', + 0 => [ + 'type' => 'submit', + 'name' => 'do_submit', + 'value' => _t('_sys_submit'), + ], + 1 => [ + 'type' => 'reset', + 'name' => 'close', + 'value' => _t('_sys_close'), + 'attrs' => ['class' => 'bx-def-margin-sec-left', 'onclick' => '$(\'.bx-popup-applied:visible\').dolPopupHide();'], + ], + ], + ], + ]; + + return $aForm; + } + + protected function _getId() + { + $aIds = bx_get('ids'); + if(!empty($aIds) && is_array($aIds)) + return array_shift($aIds); + + $iId = (int)bx_get('id'); + if(!$iId) + return false; + + return $iId; + } +} + +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/scripts/BxBaseStudioAgentsAsstChats.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/scripts/BxBaseStudioAgentsAsstChats.php new file mode 100644 index 0000000000..5e2679c686 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/scripts/BxBaseStudioAgentsAsstChats.php @@ -0,0 +1,341 @@ +_sUrlPage = BX_DOL_URL_STUDIO . 'agents.php?page=assistants&spage=chats&aid=' . $this->_iAssistantId; + + $this->_sFieldName = 'name'; + } + + public function getPageJsObject() + { + return 'oBxDolStudioPageAgents'; + } + + public function performActionAdd() + { + $sAction = 'add'; + + $aForm = $this->_getForm($sAction); + $oForm = new BxTemplFormView($aForm); + $oForm->initChecker(); + + if($oForm->isSubmittedAndValid()) { + $aValsToAdd = ['assistant_id' => $this->_iAssistantId, 'added' => time()]; + + $sName = $oForm->getCleanValue($this->_sFieldName); + $sName = BxDolAIAssistant::getChatName($sName); + BxDolForm::setSubmittedValue($this->_sFieldName, $sName, $oForm->aFormAttrs['method']); + + if(($iId = $oForm->insert($aValsToAdd)) !== false) + $aRes = ['grid' => $this->getCode(false), 'blink' => $iId]; + else + $aRes = ['msg' => _t('_sys_txt_error_occured')]; + + return echoJson($aRes); + } + + $sFormId = $oForm->getId(); + $sContent = BxTemplStudioFunctions::getInstance()->popupBox($sFormId . '_popup', _t('_sys_agents_assistants_chats_popup_add'), $this->_oTemplate->parseHtmlByName('agents_automator_form.html', [ + 'form_id' => $sFormId, + 'form' => $oForm->getCode(true), + 'object' => $this->_sObject, + 'action' => $sAction + ])); + + return echoJson(['popup' => ['html' => $sContent, 'options' => ['closeOnOuterClick' => false]]]); + } + + public function performActionEdit() + { + $sAction = 'edit'; + + $iId = $this->_getId(); + $aChat = $this->_oDb->getChatsBy(['sample' => 'id', 'id' => $iId]); + + $aForm = $this->_getFormEdit($sAction, $aChat); + $oForm = new BxTemplFormView($aForm); + $oForm->initChecker(); + + if($oForm->isSubmittedAndValid()) { + $aValsToAdd = []; + + $sName = $oForm->getCleanValue($this->_sFieldName); + if($aChat[$this->_sFieldName] != $sName) { + $sName = BxDolAIAssistant::getChatName($sName); + BxDolForm::setSubmittedValue($this->_sFieldName, $sName, $oForm->aFormAttrs['method']); + } + + if($oForm->update($iId, $aValsToAdd) !== false) + $aRes = ['grid' => $this->getCode(false), 'blink' => $iId]; + else + $aRes = ['msg' => _t('_sys_txt_error_occured')]; + + return echoJson($aRes); + } + + $sFormId = $oForm->getId(); + $sContent = BxTemplStudioFunctions::getInstance()->popupBox($sFormId . '_popup', _t('_sys_agents_assistants_chats_popup_edit'), $this->_oTemplate->parseHtmlByName('agents_automator_form.html', [ + 'form_id' => $sFormId, + 'form' => $oForm->getCode(true), + 'object' => $this->_sObject, + 'action' => $sAction + ])); + + return echoJson(['popup' => ['html' => $sContent, 'options' => ['closeOnOuterClick' => false]]]); + } + + public function performActionStore() + { + $sAction = 'store'; + + $oAI = BxDolAI::getInstance(); + + $iId = $this->_getId(); + $aChat = $this->_oDb->getChatsBy(['sample' => 'id', 'id' => $iId]); + $aAssistant = $this->_oDb->getAssistantsBy(['sample' => 'id', 'id' => $aChat['assistant_id']]); + + $aComments = $oAI->getAssistantChatCmtsObject($iId)->getCommentsBy(['type' => 'object_id', 'object_id' => $iId]); + + $aMessages = []; + foreach($aComments as $aComment) + $aMessages[] = [ + 'role' => (int)$aComment['cmt_author_id'] == $this->_iProfileIdAi ? "assistant" : "user", + 'content' => $aComment['cmt_text'] + ]; + + $oAIModel = $oAI->getModelObject($aAssistant['model_id']); + + if(!empty($aChat['ai_file_id'])) { + $aResponse = $oAIModel->callVectorStoresFilesDelete($aAssistant['ai_vs_id'], $aChat['ai_file_id']); + if(!$aResponse) + return echoJson([]); + + $aResponse = $oAIModel->callFilesDelete($aChat['ai_file_id']); + if(!$aResponse) + return echoJson([]); + + $this->_oDb->updateChats(['ai_file_id' => '', 'stored' => 0], ['id' => $iId]); + } + + $aRes = []; + if(($sFile = $aChat['name'] . '.json') && ($aFile = $oAIModel->callFiles(['content' => json_encode($aMessages), 'name' => $sFile, 'mime' => 'application/json'])) !== false) { + if(($aResponse = $oAIModel->callVectorStoresFiles($aAssistant['ai_vs_id'], ['file_id' => $aFile['id']])) !== false) { + $iNow = time(); + $this->_oDb->insertFile(['name' => $sFile, 'assistant_id' => $aAssistant['id'], 'added' => $iNow, 'ai_file_id' => $aFile['id'], 'locked' => 1]); + $this->_oDb->updateChats(['type' => BX_DOL_AI_ASST_TYPE_PERMANENT, 'ai_file_id' => $aFile['id'], 'stored' => $iNow], ['id' => $iId]); + + $aRes = ['grid' => $this->getCode(false), 'blink' => $iId]; + } + } + + return echoJson($aRes); + } + + public function performActionUnstore() + { + $sAction = 'unstore'; + + $oAI = BxDolAI::getInstance(); + + $iId = $this->_getId(); + $aChat = $this->_oDb->getChatsBy(['sample' => 'id', 'id' => $iId]); + if(empty($aChat['ai_file_id'])) + return echoJson([]); + + $aAssistant = $this->_oDb->getAssistantsBy(['sample' => 'id', 'id' => $aChat['assistant_id']]); + + $oAIModel = $oAI->getModelObject($aAssistant['model_id']); + if(!$oAIModel->callVectorStoresFilesDelete($aAssistant['ai_vs_id'], $aChat['ai_file_id'])) + return echoJson([]); + + if(!$oAIModel->callFilesDelete($aChat['ai_file_id'])) + return echoJson([]); + + $this->_oDb->deleteFiles(['ai_file_id' => $aChat['ai_file_id']]); + $this->_oDb->updateChats(['ai_file_id' => '', 'stored' => 0], ['id' => $iId]); + + echoJson(['grid' => $this->getCode(false), 'blink' => $iId]); + } + + protected function _getCellType($mixedValue, $sKey, $aField, $aRow) + { + return parent::_getCellDefault(_t('_sys_agents_assistants_chats_txt_type_' . $mixedValue), $sKey, $aField, $aRow); + } + + protected function _getCellAdded($mixedValue, $sKey, $aField, $aRow) + { + return parent::_getCellDefault(bx_time_js($mixedValue), $sKey, $aField, $aRow); + } + + protected function _getCellStored($mixedValue, $sKey, $aField, $aRow) + { + return parent::_getCellDefault($mixedValue ? bx_time_js($mixedValue) : '', $sKey, $aField, $aRow); + } + + protected function _getActionChat($sType, $sKey, $a, $isSmall = false, $isDisabled = false, $aRow = []) + { + $a['attr'] = array_merge($a['attr'], [ + "onclick" => "window.open('" . $this->_sUrlPage . "&cid=" . $aRow['id'] . "', '_self');" + ]); + + return $this->_getActionDefault ($sType, $sKey, $a, $isSmall, $isDisabled, $aRow); + } + + protected function _getActionStore($sType, $sKey, $a, $isSmall = false, $isDisabled = false, $aRow = []) + { + $aChat = $this->_oDb->getChatsBy(['sample' => 'id', 'id' => $aRow['id']]); + if(!empty($aChat['ai_file_id'])) + return ''; + + return $this->_getActionDefault ($sType, $sKey, $a, $isSmall, $isDisabled, $aRow); + } + + protected function _getActionUnstore($sType, $sKey, $a, $isSmall = false, $isDisabled = false, $aRow = []) + { + $aChat = $this->_oDb->getChatsBy(['sample' => 'id', 'id' => $aRow['id']]); + if(empty($aChat['ai_file_id'])) + return ''; + + return $this->_getActionDefault ($sType, $sKey, $a, $isSmall, $isDisabled, $aRow); + } + + protected function _addJsCss() + { + parent::_addJsCss(); + + $this->_oTemplate->addJs(['jquery.form.min.js']); + + $oForm = new BxTemplStudioFormView([]); + $oForm->addCssJs(); + } + + protected function _isCheckboxDisabled($aRow) + { + return false; + } + + protected function _getActionsDisabledBehavior($aRow) + { + return false; + } + + protected function _delete ($mixedId) + { + $aChat = $this->_oDb->getChatsBy(['sample' => 'id', 'id' => (int)$mixedId]); + + $mixedResult = parent::_delete($mixedId); + if($mixedResult) + BxDolAIAssistant::getObjectInstance($aChat['assistant_id'])->deleteChat($aChat); + + return $mixedResult; + } + + protected function _getFormEdit($sAction, $aChat = []) + { + $aForm = $this->_getForm($sAction, $aChat); + $aForm['form_attrs']['action'] .= '&id=' . $aChat['id']; + + return $aForm; + } + + protected function _getForm($sAction, $aChat = []) + { + $sJsObject = $this->getPageJsObject(); + + $aForm = array( + 'form_attrs' => array( + 'id' => 'bx_std_agents_assistants_' . $sAction, + 'action' => BX_DOL_URL_ROOT . bx_append_url_params('grid.php', ['o' => 'sys_studio_agents_assistants_chats', 'a' => $sAction, 'aid' => $this->_iAssistantId]), + 'method' => 'post', + ), + 'params' => array ( + 'db' => array( + 'table' => 'sys_agents_assistants_chats', + 'key' => 'id', + 'submit_name' => 'do_submit', + ), + ), + 'inputs' => array( + 'name' => [ + 'type' => 'text', + 'name' => 'name', + 'required' => '1', + 'caption' => _t('_sys_agents_assistants_chats_field_name'), + 'value' => isset($aChat['name']) ? $aChat['name'] : '', + 'required' => '1', + 'checker' => [ + 'func' => 'Avail', + 'params' => [], + 'error' => _t('_sys_agents_form_field_err_enter'), + ], + 'db' => [ + 'pass' => 'Xss', + ] + ], + 'description' => [ + 'type' => 'textarea', + 'name' => 'description', + 'caption' => _t('_sys_agents_assistants_chats_field_description'), + 'value' => isset($aChat['description']) ? $aChat['description'] : '', + 'required' => '1', + 'checker' => [ + 'func' => 'Avail', + 'params' => [], + 'error' => _t('_sys_agents_form_field_err_enter'), + ], + 'db' => [ + 'pass' => 'Xss', + ] + ], + 'submit' => array( + 'type' => 'input_set', + 0 => array ( + 'type' => 'submit', + 'name' => 'do_submit', + 'value' => _t('_sys_submit'), + ), + 1 => array ( + 'type' => 'reset', + 'name' => 'close', + 'value' => _t('_sys_close'), + 'attrs' => array('class' => 'bx-def-margin-sec-left', 'onclick' => '$(\'.bx-popup-applied:visible\').dolPopupHide();'), + ), + ), + + ), + ); + + return $aForm; + } + + protected function _getId() + { + $aIds = bx_get('ids'); + if(!empty($aIds) && is_array($aIds)) + return array_shift($aIds); + + $iId = (int)bx_get('id'); + if(!$iId) + return false; + + return $iId; + } +} + +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/scripts/BxBaseStudioAgentsAsstFiles.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/scripts/BxBaseStudioAgentsAsstFiles.php new file mode 100644 index 0000000000..2bebc48aef --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/scripts/BxBaseStudioAgentsAsstFiles.php @@ -0,0 +1,236 @@ +_sUrlPage = BX_DOL_URL_STUDIO . 'agents.php?page=assistants&spage=files&aid=' . $this->_iAssistantId; + } + + public function getPageJsObject() + { + return 'oBxDolStudioPageAgents'; + } + + public function performActionAdd() + { + $sAction = 'add'; + + $aForm = $this->_getForm($sAction); + $oForm = new BxTemplFormView($aForm); + $oForm->initChecker(); + + if($oForm->isSubmittedAndValid()) { + $aValsToAdd = ['assistant_id' => $this->_iAssistantId, 'added' => time()]; + + if(!empty($_FILES['file']['tmp_name'])) { + $sName = $_FILES['file']['name']; + $sMime = $_FILES['file']['type']; + $iSize = $_FILES['file']['size']; + + $oHandle = fopen($_FILES['file']['tmp_name'], "r"); + $sContents = fread($oHandle, $iSize); + fclose($oHandle); + + $oAIModel = BxDolAI::getInstance()->getModelObject($this->_aAssistantInfo['model_id']); + if(($aFile = $oAIModel->callFiles(['content' => $sContents, 'name' => $sName, 'mime' => $sMime])) !== false) { + if(($aResponse = $oAIModel->callVectorStoresFiles($this->_aAssistantInfo['ai_vs_id'], ['file_id' => $aFile['id']])) !== false) { + $aValsToAdd = array_merge($aValsToAdd, [ + 'name' => $sName, + 'ai_file_id' => $aFile['id'], + 'ai_file_size' => $iSize + ]); + } + } + } + + if(($iId = $oForm->insert($aValsToAdd)) !== false) + $aRes = ['grid' => $this->getCode(false), 'blink' => $iId]; + else + $aRes = ['msg' => _t('_sys_txt_error_occured')]; + + return echoJson($aRes); + } + + $sFormId = $oForm->getId(); + $sContent = BxTemplStudioFunctions::getInstance()->popupBox($sFormId . '_popup', _t('_sys_agents_assistants_files_popup_add'), $this->_oTemplate->parseHtmlByName('agents_automator_form.html', [ + 'form_id' => $sFormId, + 'form' => $oForm->getCode(true), + 'object' => $this->_sObject, + 'action' => $sAction + ])); + + return echoJson(['popup' => ['html' => $sContent, 'options' => ['closeOnOuterClick' => false]]]); + } + + public function performActionSync() + { + $sAction = 'sync'; + + $oAIModel = BxDolAI::getInstance()->getModelObject($this->_aAssistantInfo['model_id']); + if(($aFiles = $oAIModel->callVectorStoresFilesList($this->_aAssistantInfo['ai_vs_id'])) === false) + return echoJson([]); + + foreach($aFiles as $aFile) { + $aFileInfo = $oAIModel->callFilesRetrieve($aFile['id']); + + $this->_oDb->updateFiles([ + 'ai_file_size' => is_array($aFileInfo) && !empty($aFileInfo['bytes']) ? $aFileInfo['bytes'] : 0, + 'ai_file_status' => $aFile['status'] + ], ['ai_file_id' => $aFile['id']]); + } + + return echoJson(['grid' => $this->getCode(false)]); + } + + public function performActionDelete() + { + $sAction = 'delete'; + + $iId = $this->_getId(); + + $aFile = $this->_oDb->getFilesBy(['sample' => 'id', 'id' => $iId]); + if(empty($aFile) || !is_array($aFile)) + return echoJson([]); + + return parent::performActionDelete(); + } + + protected function _getCellSize($mixedValue, $sKey, $aField, $aRow) + { + return parent::_getCellDefault(!empty($aRow['ai_file_size']) ? _t_format_size($aRow['ai_file_size']) : _t('_undefined'), $sKey, $aField, $aRow); + } + + protected function _getCellStatus($mixedValue, $sKey, $aField, $aRow) + { + return parent::_getCellDefault(_t('_sys_agents_assistants_files_txt_status_' . $aRow['ai_file_status']), $sKey, $aField, $aRow); + } + + protected function _getCellAdded($mixedValue, $sKey, $aField, $aRow) + { + return parent::_getCellDefault(bx_time_js($mixedValue), $sKey, $aField, $aRow); + } + + protected function _getActionDelete($sType, $sKey, $a, $isSmall = false, $isDisabled = false, $aRow = []) + { + if((int)$aRow['locked'] != 0) + return ''; + + return $this->_getActionDefault ($sType, $sKey, $a, $isSmall, $isDisabled, $aRow); + } + + protected function _addJsCss() + { + parent::_addJsCss(); + + $this->_oTemplate->addJs(['jquery.form.min.js']); + + $oForm = new BxTemplStudioFormView([]); + $oForm->addCssJs(); + } + + protected function _isCheckboxDisabled($aRow) + { + return false; + } + + protected function _getActionsDisabledBehavior($aRow) + { + return false; + } + + protected function _delete ($mixedId) + { + $iFileId = (int)$mixedId; + $aFile = $this->_oDb->getFilesBy(['sample' => 'id', 'id' => $iFileId]); + + $mixedResult = parent::_delete($mixedId); + if($mixedResult && !empty($aFile['ai_file_id'])) { + $oAi = BxDolAI::getInstance(); + + $oAIModel = $oAi->getModelObject($this->_aAssistantInfo['model_id']); + $oAIModel->callVectorStoresFilesDelete($this->_aAssistantInfo['ai_vs_id'], $aFile['ai_file_id']); + $oAIModel->callFilesDelete($aFile['ai_file_id']); + } + + return $mixedResult; + } + + protected function _getForm($sAction, $aFiles = []) + { + $sJsObject = $this->getPageJsObject(); + + $aForm = array( + 'form_attrs' => array( + 'id' => 'bx_std_agents_assistants_files_' . $sAction, + 'action' => BX_DOL_URL_ROOT . bx_append_url_params('grid.php', ['o' => 'sys_studio_agents_assistants_files', 'a' => $sAction, 'aid' => $this->_iAssistantId]), + 'method' => 'post', + ), + 'params' => array ( + 'db' => array( + 'table' => 'sys_agents_assistants_files', + 'key' => 'id', + 'submit_name' => 'do_submit', + ), + ), + 'inputs' => array( + 'file' => [ + 'type' => 'file', + 'name' => 'file', + 'required' => '1', + 'caption' => _t('_sys_agents_assistants_files_field_file'), + 'value' => '', + 'checker' => [ + 'func' => 'Avail', + 'params' => '', + 'error' => _t('_sys_agents_form_field_err_enter'), + ] + ], + 'submit' => array( + 'type' => 'input_set', + 0 => array ( + 'type' => 'submit', + 'name' => 'do_submit', + 'value' => _t('_sys_submit'), + ), + 1 => array ( + 'type' => 'reset', + 'name' => 'close', + 'value' => _t('_sys_close'), + 'attrs' => array('class' => 'bx-def-margin-sec-left', 'onclick' => '$(\'.bx-popup-applied:visible\').dolPopupHide();'), + ), + ), + + ), + ); + + return $aForm; + } + + protected function _getId() + { + $aIds = bx_get('ids'); + if(!empty($aIds) && is_array($aIds)) + return array_shift($aIds); + + $iId = (int)bx_get('id'); + if(!$iId) + return false; + + return $iId; + } +} + +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/scripts/BxBaseStudioAgentsAutomators.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/scripts/BxBaseStudioAgentsAutomators.php new file mode 100644 index 0000000000..c6edadccbc --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/scripts/BxBaseStudioAgentsAutomators.php @@ -0,0 +1,862 @@ +_sUrlPage = BX_DOL_URL_STUDIO . 'agents.php?page=automators'; + + $this->_sFieldName = 'name'; + } + + public function getPageJsObject() + { + return 'oBxDolStudioPageAgents'; + } + + public function performActionAdd() + { + $sAction = 'add'; + + $oAI = BxDolAI::getInstance(); + + $aForm = $this->_getForm($sAction); + $oForm = new BxTemplFormView($aForm); + $oForm->initChecker(); + + if($oForm->isSubmittedAndValid()) { + $aValsToAdd = [ + 'added' => time() + ]; + + $sName = $oForm->getCleanValue($this->_sFieldName); + $sName = $this->_getAutomatorName($sName); + BxDolForm::setSubmittedValue($this->_sFieldName, $sName, $oForm->aFormAttrs['method']); + + $iProfileId = $oForm->getCleanValue('profile_id'); + if(empty($iProfileId)) { + $iProfileId = (int)getParam('sys_agents_profile'); + if(empty($iProfileId)) + $iProfileId = current(bx_srv('system', 'get_options_agents_profile', [false], 'TemplServices'))['key']; + + $aValsToAdd['profile_id'] = $iProfileId; + } + + $sSchedulerTime = $oForm->getCleanValue('scheduler_time'); + if(!empty($sSchedulerTime)) + $aValsToAdd['params'] = json_encode(['scheduler_time' => $sSchedulerTime]); + + $iModel = $oForm->getCleanValue('model_id'); + $sType = $oForm->getCleanValue('type'); + $aProviders = $oForm->getCleanValue('providers'); + $bProviders = !empty($aProviders) && is_array($aProviders); + $aHelpers = $oForm->getCleanValue('helpers'); + $bHelpers = !empty($aHelpers) && is_array($aHelpers); + $aAssistants = $oForm->getCleanValue('assistants'); + $bAssistants = !empty($aAssistants) && is_array($aAssistants); + $sMessage = $oForm->getCleanValue('message'); + $bMessage = !empty($sMessage); + $sMessageAdd = ''; + $sMessageResponse = ''; + + $oAIModel = $oAI->getModelObject($iModel); + + $sInstructions = $oAI->getAutomatorInstruction('profile', $iProfileId); + if($bProviders) + $sInstructions .= $oAI->getAutomatorInstruction('providers', $aProviders); + if($bHelpers) + $sInstructions .= $oAI->getAutomatorInstruction('helpers', $aHelpers); + if($bAssistants) + $sInstructions .= $oAI->getAutomatorInstruction('assistants', $aAssistants); + + $bIsValid = true; + $aResponseInit = []; + switch($sType) { + case BX_DOL_AI_AUTOMATOR_EVENT: + if(($aResponseInit = $oAIModel->getResponseInit($sType, $sMessage)) !== false) { + $oAIModel->setParams($aResponseInit['params']); + + $sMessageAdd = $aResponseInit['params']['trigger']; + + $aValsToAdd = array_merge($aValsToAdd, $aResponseInit); + if(!empty($aValsToAdd['params']) && is_array($aValsToAdd['params'])) + $aValsToAdd['params'] = json_encode($aValsToAdd['params']); + } + else { + $oForm->aInputs['message']['error'] = _t('_sys_agents_automators_err_event_not_found'); + $bIsValid = false; + } + break; + + case BX_DOL_AI_AUTOMATOR_SCHEDULER: + case BX_DOL_AI_AUTOMATOR_WEBHOOK: + if(($aResponseInit = $oAIModel->getResponseInit($sType, $sMessage)) !== false) { + $oAIModel->setParams($aResponseInit['params']); + + $aValsToAdd = array_merge($aValsToAdd, $aResponseInit); + if(!empty($aValsToAdd['params']) && is_array($aValsToAdd['params'])) + $aValsToAdd['params'] = json_encode($aValsToAdd['params']); + } + else { + $oForm->aInputs['message']['error'] = _t('_sys_agents_automators_err_event_not_found'); + $bIsValid = false; + } + break; + } + + if($bIsValid) { + if(($sResponse = $oAIModel->getResponse($sType, $sMessage . $sInstructions . $sMessageAdd, $oAIModel->getParams())) !== false) { + $sMessageResponse = $sResponse; + } + else { + $oForm->aInputs['message']['error'] = _t('_sys_agents_automators_err_cannot_get_code'); + $bIsValid = false; + } + } + + if($bIsValid) { + if(($iId = $oForm->insert($aValsToAdd)) !== false) { + if($bProviders) + foreach($aProviders as $iProviderId) + $this->_oDb->insertAutomatorProvider([ + 'automator_id' => $iId, + 'provider_id' => $iProviderId + ]); + + if($bHelpers) + foreach($aHelpers as $iHelperId) + $this->_oDb->insertAutomatorHelper([ + 'automator_id' => $iId, + 'helper_id' => $iHelperId + ]); + + if($bAssistants) + foreach($aAssistants as $iAssistantId) + $this->_oDb->insertAutomatorAssistant([ + 'automator_id' => $iId, + 'assistant_id' => $iAssistantId + ]); + + if(($oCmts = BxDolCmts::getObjectInstance($this->_sCmts, $iId)) !== null) { + if($bMessage) { + $iProfileId = bx_get_logged_profile_id(); + + $aResult = $oCmts->addAuto([ + 'cmt_author_id' => $iProfileId, + 'cmt_parent_id' => 0, + 'cmt_text' => $sMessage + ]); + + if(!empty($aResult['id'])) + $this->_oDb->updateAutomators(['message_id' => $aResult['id']], ['id' => $iId]); + + sleep(1); + $oCmts->addAuto([ + 'cmt_author_id' => $iProfileId, + 'cmt_parent_id' => 0, + 'cmt_text' => $sInstructions + ]); + } + + if($sMessageResponse) { + sleep(1); + $oCmts->addAuto([ + 'cmt_author_id' => $this->_iProfileIdAi, + 'cmt_parent_id' => 0, + 'cmt_text' => $sMessageResponse + ]); + } + } + + $aRes = ['grid' => $this->getCode(false), 'blink' => $iId]; + } + else + $aRes = ['msg' => _t('_sys_txt_error_occured')]; + + return echoJson($aRes); + } + } + + $sFormId = $oForm->getId(); + $sContent = BxTemplStudioFunctions::getInstance()->popupBox($sFormId . '_popup', _t('_sys_agents_automators_popup_add'), $this->_oTemplate->parseHtmlByName('agents_automator_form.html', [ + 'form_id' => $sFormId, + 'form' => $oForm->getCode(true), + 'object' => $this->_sObject, + 'action' => $sAction + ])); + + return echoJson(['popup' => ['html' => $sContent, 'options' => ['closeOnOuterClick' => false]]]); + } + + public function performActionEdit() + { + $sAction = 'edit'; + + $oAI = BxDolAI::getInstance(); + + $iId = $this->_getId(); + $aAutomator = $oAI->getAutomator($iId); + $aAutomator['providers'] = $this->_oDb->getAutomatorsBy(['sample' => 'providers_by_id_pairs', 'id' => $iId]); + $aAutomator['helpers'] = $this->_oDb->getAutomatorsBy(['sample' => 'helpers_by_id_pairs', 'id' => $iId]); + + $aForm = $this->_getFormEdit($sAction, $aAutomator); + $oForm = new BxTemplFormView($aForm); + $oForm->initChecker(); + + if($oForm->isSubmittedAndValid()) { + $aValsToAdd = []; + + $sName = $oForm->getCleanValue($this->_sFieldName); + if($aAutomator[$this->_sFieldName] != $sName) { + $sName = $this->_getAutomatorName($sName); + BxDolForm::setSubmittedValue($this->_sFieldName, $sName, $oForm->aFormAttrs['method']); + } + + /** + * Process Providers + */ + $aProvidersIds = $oForm->getCleanValue('providers_ids'); + $bProvidersIds = !empty($aProvidersIds) && is_array($aProvidersIds); + $aProvidersValues = $oForm->getCleanValue('providers'); + $bProvidersValues = !empty($aProvidersValues) && is_array($aProvidersValues); + + //--- Providers: Remove deleted + if(!empty($aAutomator['providers']) && is_array($aAutomator['providers'])) + $this->_oDb->deleteAutomatorProvidersById(array_diff(array_keys($aAutomator['providers']), $bProvidersIds ? $aProvidersIds : [])); + + //--- Providers: Update existed + if($bProvidersIds) + foreach($aProvidersIds as $iIndex => $iApId) + $this->_oDb->updateAutomatorProvider(['provider_id' => (int)$aProvidersValues[$iIndex]], ['id' => (int)$iApId]); + + //--- Providers: Add new + $iProvidersIds = $bProvidersIds ? count($aProvidersIds) : 0; + $iProvidersValues = $bProvidersValues ? count($aProvidersValues) : 0; + if($iProvidersValues > $iProvidersIds) { + $aProvidersValues = array_slice($aProvidersValues, $iProvidersIds); + foreach($aProvidersValues as $iProvidersValue) + $this->_oDb->insertAutomatorProvider([ + 'automator_id' => $iId, + 'provider_id' => (int)$iProvidersValue, + ]); + } + + /** + * Process Helpers + */ + $aHelpersIds = $oForm->getCleanValue('helpers_ids'); + $bHelpersIds = !empty($aHelpersIds) && is_array($aHelpersIds); + $aHelpersValues = $oForm->getCleanValue('helpers'); + $bHelpersValues = !empty($aHelpersValues) && is_array($aHelpersValues); + + //--- Helpers: Remove deleted + if(!empty($aAutomator['helpers']) && is_array($aAutomator['helpers'])) + $this->_oDb->deleteAutomatorHelpersById(array_diff(array_keys($aAutomator['helpers']), $bHelpersIds ? $aHelpersIds : [])); + + //--- Helpers: Update existed + if($bHelpersIds) + foreach($aHelpersIds as $iIndex => $iAhId) + $this->_oDb->updateAutomatorHelper(['helper_id' => (int)$aHelpersValues[$iIndex]], ['id' => (int)$iAhId]); + + //--- Helpers: Add new + $iHelpersIds = $bHelpersIds ? count($aHelpersIds) : 0; + $iHelpersValues = $bHelpersValues ? count($aHelpersValues) : 0; + if($iHelpersValues > $iHelpersIds) { + $aHelpersValues = array_slice($aHelpersValues, $iHelpersIds); + foreach($aHelpersValues as $iHelpersValue) + $this->_oDb->insertAutomatorHelper([ + 'automator_id' => $iId, + 'helper_id' => (int)$iHelpersValue, + ]); + } + + /** + * Process Assistants + */ + $aAssistantsIds = $oForm->getCleanValue('assistants_ids'); + $bAssistantsIds = !empty($aAssistantsIds) && is_array($aAssistantsIds); + $aAssistantsValues = $oForm->getCleanValue('assistants'); + $bAssistantsValues = !empty($aAssistantsValues) && is_array($aAssistantsValues); + + //--- Assistants: Remove deleted + if(!empty($aAutomator['assistants']) && is_array($aAutomator['assistants'])) + $this->_oDb->deleteAutomatorAssistantsById(array_diff(array_keys($aAutomator['assistants']), $bAssistantsIds ? $aAssistantsIds : [])); + + //--- Assistants: Update existed + if($bAssistantsIds) + foreach($aAssistantsIds as $iIndex => $iAhId) + $this->_oDb->updateAutomatorAssistant(['assistant_id' => (int)$aAssistantsValues[$iIndex]], ['id' => (int)$iAhId]); + + //--- Assistants: Add new + $iAssistantsIds = $bAssistantsIds ? count($aAssistantsIds) : 0; + $iAssistantsValues = $bAssistantsValues ? count($aAssistantsValues) : 0; + if($iAssistantsValues > $iAssistantsIds) { + $aAssistantsValues = array_slice($aAssistantsValues, $iAssistantsIds); + foreach($aAssistantsValues as $iAssistantsValue) + $this->_oDb->insertAutomatorAssistant([ + 'automator_id' => $iId, + 'helper_id' => (int)$iAssistantsValue, + ]); + } + + $iProfileId = $oForm->getCleanValue('profile_id'); + if(empty($iProfileId)) { + $iProfileId = (int)getParam('sys_agents_profile'); + if(empty($iProfileId)) + $iProfileId = current(bx_srv('system', 'get_options_agents_profile', [false], 'TemplServices'))['key']; + + $aValsToAdd['profile_id'] = $iProfileId; + } + + $sSchedulerTime = $oForm->getCleanValue('scheduler_time'); + if(!empty($sSchedulerTime)) + $aValsToAdd['params'] = json_encode(['scheduler_time' => $sSchedulerTime]); + + if($oForm->update($iId, $aValsToAdd) !== false) { + if(($oCmts = BxDolCmts::getObjectInstance($this->_sCmts, $iId)) !== null) { + $sInstructions = $oAI->getAutomatorInstruction('profile', $iProfileId); + + $aProviders = $this->_oDb->getAutomatorsBy(['sample' => 'providers_by_id_pairs', 'id' => $iId]); + if(!empty($aProviders) && is_array($aProviders)) + $sInstructions .= $oAI->getAutomatorInstruction('providers', array_values($aProviders)); + + $aHelpers = $this->_oDb->getAutomatorsBy(['sample' => 'helpers_by_id_pairs', 'id' => $iId]); + if(!empty($aHelpers) && is_array($aHelpers)) + $sInstructions .= $oAI->getAutomatorInstruction('helpers', array_values($aHelpers)); + + $aAssistants = $this->_oDb->getAutomatorsBy(['sample' => 'assistants_by_id_pairs', 'id' => $iId]); + if(!empty($aAssistants) && is_array($aAssistants)) + $sInstructions .= $oAI->getAutomatorInstruction('assistants', array_values($aAssistants)); + + $oCmts->addAuto([ + 'cmt_author_id' => $iProfileId, + 'cmt_parent_id' => 0, + 'cmt_text' => $sInstructions + ]); + + if(($sResponse = $oAI->getModelObject($aAutomator['model_id'])->getResponse($aAutomator['type'], $sInstructions, $aAutomator['params'])) !== false) { + sleep(1); + $oCmts->addAuto([ + 'cmt_author_id' => $this->_iProfileIdAi, + 'cmt_parent_id' => 0, + 'cmt_text' => $sResponse + ]); + } + } + + $aRes = ['grid' => $this->getCode(false), 'blink' => $iId]; + } + else + $aRes = ['msg' => _t('_sys_txt_error_occured')]; + + return echoJson($aRes); + } + + $sFormId = $oForm->getId(); + $sContent = BxTemplStudioFunctions::getInstance()->popupBox($sFormId . '_popup', _t('_sys_agents_automators_popup_edit'), $this->_oTemplate->parseHtmlByName('agents_automator_form.html', [ + 'form_id' => $sFormId, + 'form' => $oForm->getCode(true), + 'object' => $this->_sObject, + 'action' => $sAction + ])); + + return echoJson(['popup' => ['html' => $sContent, 'options' => ['closeOnOuterClick' => false]]]); + } + + protected function _getCellSwitcher ($mixedValue, $sKey, $aField, $aRow) + { + if(empty($aRow['code']) || $aRow['status'] != BX_DOL_AI_AUTOMATOR_STATUS_READY) + return parent::_getCellDefault('', $sKey, $aField, $aRow); + + return parent::_getCellSwitcher ($mixedValue, $sKey, $aField, $aRow); + } + + protected function _getCellModelId($mixedValue, $sKey, $aField, $aRow) + { + $aModel = $this->_oDb->getModelsBy(['sample' => 'id', 'id' => $mixedValue]); + if(!empty($aModel) && is_array($aModel)) + $mixedValue = $aModel['title']; + + return parent::_getCellDefault($mixedValue, $sKey, $aField, $aRow); + } + + protected function _getCellProfileId($mixedValue, $sKey, $aField, $aRow) + { + return parent::_getCellDefault(BxDolProfile::getInstanceMagic($mixedValue)->getDisplayName(), $sKey, $aField, $aRow); + } + + protected function _getCellType($mixedValue, $sKey, $aField, $aRow) + { + return parent::_getCellDefault(_t('_sys_agents_automators_field_type_' . $mixedValue), $sKey, $aField, $aRow); + } + + protected function _getCellData($sKey, $aField, $aRow) + { + if($sKey == 'message_id' && ($iCmtId = (int)$aRow[$sKey]) != 0 && ($oCmts = BxDolAI::getInstance()->getAutomatorCmtsObject($aRow['id'])) !== false) { + $aCmt = $oCmts->getCommentSimple($iCmtId); + if(!empty($aCmt) && is_array($aCmt)) + $aRow[$sKey] = $aCmt['cmt_text']; + } + + return parent::_getCellData($sKey, $aField, $aRow); + } + + protected function _getCellAdded($mixedValue, $sKey, $aField, $aRow) + { + return parent::_getCellDefault(bx_time_js($mixedValue), $sKey, $aField, $aRow); + } + + protected function _getCellStatus($mixedValue, $sKey, $aField, $aRow) + { + return parent::_getCellDefault(_t('_sys_agents_automators_field_status_' . $mixedValue), $sKey, $aField, $aRow); + } + + protected function _getActionTune($sType, $sKey, $a, $isSmall = false, $isDisabled = false, $aRow = []) + { + $a['attr'] = array_merge($a['attr'], [ + "onclick" => "window.open('" . $this->_sUrlPage . '&id=' . $aRow['id'] . "', '_self');" + ]); + + return $this->_getActionDefault ($sType, $sKey, $a, $isSmall, $isDisabled, $aRow); + } + + protected function _addJsCss() + { + parent::_addJsCss(); + + $this->_oTemplate->addJs(['jquery.form.min.js']); + + $oForm = new BxTemplStudioFormView([]); + $oForm->addCssJs(); + } + + protected function _isCheckboxDisabled($aRow) + { + return false; + } + + protected function _getActionsDisabledBehavior($aRow) + { + return false; + } + + protected function _delete ($mixedId) + { + $mixedResult = parent::_delete($mixedId); + if($mixedResult) { + $this->_oDb->deleteAutomatorProviders(['automator_id' => (int)$mixedId]); + $this->_oDb->deleteAutomatorHelpers(['automator_id' => (int)$mixedId]); + $this->_oDb->deleteAutomatorAssistants(['automator_id' => (int)$mixedId]); + + if(($oCmts = BxDolAI::getInstance()->getAutomatorCmtsObject($mixedId)) !== false) + $oCmts->onObjectDelete(); + } + + return $mixedResult; + } + + protected function _getFormEdit($sAction, $aAutomator = []) + { + $aForm = $this->_getForm($sAction, $aAutomator); + $aForm['form_attrs']['action'] .= '&id=' . $aAutomator['id']; + + unset($aForm['inputs']['type']); + unset($aForm['inputs']['message']); + + return $aForm; + } + + protected function _getForm($sAction, $aAutomator = []) + { + $sJsObject = $this->getPageJsObject(); + + $sType = isset($aAutomator['type']) ? $aAutomator['type'] : 'event'; + + if(!empty($aAutomator['params']) && is_string($aAutomator['params'])) + $aAutomator['params'] = json_decode($aAutomator['params'], true); + + $aForm = array( + 'form_attrs' => array( + 'id' => 'bx_std_agents_automators_' . $sAction, + 'action' => BX_DOL_URL_ROOT . 'grid.php?o=sys_studio_agents_automators&a=' . $sAction, + 'method' => 'post', + ), + 'params' => array ( + 'db' => array( + 'table' => 'sys_agents_automators', + 'key' => 'id', + 'submit_name' => 'do_submit', + ), + ), + 'inputs' => array( + 'name' => [ + 'type' => 'text', + 'name' => 'name', + 'caption' => _t('_sys_agents_automators_field_name'), + 'value' => isset($aAutomator['name']) ? $aAutomator['name'] : '', + 'required' => '1', + 'checker' => [ + 'func' => 'Avail', + 'params' => [], + 'error' => _t('_sys_agents_form_field_err_enter'), + ], + 'db' => [ + 'pass' => 'Xss', + ], + ], + 'model_id' => [ + 'type' => 'select', + 'name' => 'model_id', + 'caption' => _t('_sys_agents_automators_field_model_id'), + 'info' => '', + 'value' => isset($aAutomator['model_id']) ? $aAutomator['model_id'] : BxDolAI::getDefaultModel(), + 'values' => $this->_oDb->getModelsBy(['sample' => 'all_pairs', 'active' => 1, 'hidden' => 0]), + 'required' => '1', + 'checker' => [ + 'func' => 'Avail', + 'params' => [], + 'error' => _t('_sys_agents_form_field_err_select'), + ], + 'db' => [ + 'pass' => 'Int', + ], + ], + 'profile_id' => [ + 'type' => 'select', + 'name' => 'profile_id', + 'caption' => _t('_sys_agents_automators_field_profile_id'), + 'info' => _t('_sys_agents_automators_field_profile_id_inf'), + 'value' => isset($aAutomator['profile_id']) ? $aAutomator['profile_id'] : 0, + 'values' => bx_srv('system', 'get_options_agents_profile', [], 'TemplServices'), + 'required' => '0', + 'db' => [ + 'pass' => 'Int', + ] + ], + 'type' => [ + 'type' => 'select', + 'name' => 'type', + 'caption' => _t('_sys_agents_automators_field_type'), + 'info' => '', + 'value' => $sType, + 'values' => [ + 'event' => _t('_sys_agents_automators_field_type_event'), + 'scheduler' => _t('_sys_agents_automators_field_type_scheduler'), + 'webhook' => _t('_sys_agents_automators_field_type_webhook'), + ], + 'attrs' => [ + 'onchange' => $this->getPageJsObject() . '.onChangeAutomatorType(this)', + ], + 'required' => '1', + 'db' => [ + 'pass' => 'Xss', + ] + ], + 'alert_unit' => [ + 'type' => 'hidden', + 'name' => 'alert_unit', + 'caption' => _t('_sys_agents_automators_field_alert_unit'), + 'value' => isset($aAutomator['alert_unit']) ? $aAutomator['alert_unit'] : '', + 'tr_attrs' => [ + 'style' => $sType != 'event' ? 'display:none' : '' + ], + 'db' => [ + 'pass' => 'Xss', + ], + ], + 'alert_action' => [ + 'type' => 'hidden', + 'name' => 'alert_action', + 'caption' => _t('_sys_agents_automators_field_alert_action'), + 'value' => isset($aAutomator['alert_action']) ? $aAutomator['alert_action'] : '', + 'tr_attrs' => [ + 'style' => $sType != 'event' ? 'display:none' : '' + ], + 'db' => [ + 'pass' => 'Xss', + ], + ], + 'scheduler_time' => [ + 'type' => 'hidden', + 'name' => 'scheduler_time', + 'caption' => _t('_sys_agents_automators_field_scheduler_time'), + 'value' => isset($aAutomator['params']['scheduler_time']) ? $aAutomator['params']['scheduler_time'] : '', + 'tr_attrs' => [ + 'style' => $sType != 'scheduler' ? 'display:none' : '' + ], + ], + 'providers' => [ + 'type' => 'custom', + 'name' => 'providers', + 'caption' => _t('_sys_agents_automators_field_providers'), + 'value' => '', + ], + 'helpers' => [ + 'type' => 'custom', + 'name' => 'helpers', + 'caption' => _t('_sys_agents_automators_field_helpers'), + 'value' => '', + ], + 'assistants' => [ + 'type' => 'custom', + 'name' => 'assistants', + 'caption' => _t('_sys_agents_automators_field_assistants'), + 'value' => '', + ], + 'message' => [ + 'type' => 'textarea', + 'name' => 'message', + 'caption' => _t('_sys_agents_automators_field_message'), + 'required' => '1', + 'checker' => [ + 'func' => 'Avail', + 'params' => [], + 'error' => _t('_sys_agents_automators_field_message_err'), + ], + ], + 'submit' => array( + 'type' => 'input_set', + 0 => array ( + 'type' => 'submit', + 'name' => 'do_submit', + 'value' => _t('_sys_submit'), + ), + 1 => array ( + 'type' => 'reset', + 'name' => 'close', + 'value' => _t('_sys_close'), + 'attrs' => array('class' => 'bx-def-margin-sec-left', 'onclick' => '$(\'.bx-popup-applied:visible\').dolPopupHide();'), + ), + ), + + ), + ); + + if(isset($aForm['inputs']['providers'])) { + $oForm = new BxTemplFormView([]); + + $sProviders = 'providers'; + $aProviders = array_map(function($sTitle) { + return _t($sTitle); + }, ['' => '_sys_please_select'] + $this->_oDb->getProvidersBy(['sample' => 'all_pairs', 'active' => 1])); + + $aTmplVarsProviders = []; + if(!empty($aAutomator[$sProviders]) && is_array($aAutomator[$sProviders])) { + foreach($aAutomator[$sProviders] as $iApId => $iProviderId) { + $aInputSelect = [ + 'type' => 'select', + 'name' => $sProviders . '[]', + 'values' => $aProviders, + 'value' => (int)$iProviderId, + 'attrs' => [ + 'class' => 'bx-def-margin-sec-top-auto' + ] + ]; + $sInput = $oForm->genInput($aInputSelect); + + $aInputHidden = [ + 'type' => 'hidden', + 'name' => $sProviders . '_ids[]', + 'value' => (int)$iApId, + ]; + $sInput .= $oForm->genInput($aInputHidden); + + $aTmplVarsProviders[] = ['js_object' => $sJsObject, 'input_select' => $sInput]; + } + } + else { + $aInputSelect = [ + 'type' => 'select', + 'name' => $sProviders . '[]', + 'values' => $aProviders, + 'value' => '', + 'attrs' => [ + 'class' => 'bx-def-margin-sec-top-auto' + ] + ]; + + $aTmplVarsProviders = [ + ['js_object' => $sJsObject, 'input_select' => $oForm->genInput($aInputSelect)], + ]; + } + + $aInputButton = [ + 'type' => 'button', + 'name' => $sProviders . '_add', + 'value' => _t('_sys_agents_automators_field_providers_add'), + 'attrs' => [ + 'class' => 'bx-def-margin-sec-top', + 'onclick' => $sJsObject . ".providerAdd(this, '" . $sProviders . "');" + ] + ]; + + $aForm['inputs'][$sProviders]['content'] = $this->_oTemplate->parseHtmlByName('agents_automator_form_providers.html', [ + 'bx_repeat:providers' => $aTmplVarsProviders, + 'btn_add' => $oForm->genInputButton($aInputButton) + ]); + } + + if(isset($aForm['inputs']['helpers'])) { + $oForm = new BxTemplFormView([]); + + $sHelpers = 'helpers'; + $aHelpers = array_map(function($sTitle) { + return _t($sTitle); + }, ['' => '_sys_please_select'] + $this->_oDb->getHelpersBy(['sample' => 'all_pairs', 'active' => 1])); + + $aTmplVarsHelpers = []; + if(!empty($aAutomator[$sHelpers]) && is_array($aAutomator[$sHelpers])) { + foreach($aAutomator[$sHelpers] as $iAhId => $iHelperId) { + $aInputSelect = [ + 'type' => 'select', + 'name' => $sHelpers . '[]', + 'values' => $aHelpers, + 'value' => (int)$iHelperId, + 'attrs' => [ + 'class' => 'bx-def-margin-sec-top-auto' + ] + ]; + $sInput = $oForm->genInput($aInputSelect); + + $aInputHidden = [ + 'type' => 'hidden', + 'name' => $sHelpers . '_ids[]', + 'value' => (int)$iAhId, + ]; + $sInput .= $oForm->genInput($aInputHidden); + + $aTmplVarsHelpers[] = ['js_object' => $sJsObject, 'input_select' => $sInput]; + } + } + else { + $aInputSelect = [ + 'type' => 'select', + 'name' => $sHelpers . '[]', + 'values' => $aHelpers, + 'value' => '', + 'attrs' => [ + 'class' => 'bx-def-margin-sec-top-auto' + ] + ]; + + $aTmplVarsHelpers = [ + ['js_object' => $sJsObject, 'input_select' => $oForm->genInput($aInputSelect)], + ]; + } + + $aInputButton = [ + 'type' => 'button', + 'name' => $sHelpers . '_add', + 'value' => _t('_sys_agents_automators_field_helpers_add'), + 'attrs' => [ + 'class' => 'bx-def-margin-sec-top', + 'onclick' => $sJsObject . ".helperAdd(this, '" . $sHelpers . "');" + ] + ]; + + $aForm['inputs'][$sHelpers]['content'] = $this->_oTemplate->parseHtmlByName('agents_automator_form_helpers.html', [ + 'bx_repeat:helpers' => $aTmplVarsHelpers, + 'btn_add' => $oForm->genInputButton($aInputButton) + ]); + } + + if(isset($aForm['inputs']['assistants'])) { + $oForm = new BxTemplFormView([]); + + $sAssistants = 'assistants'; + $aAssistants = array_map(function($sTitle) { + return _t($sTitle); + }, ['' => '_sys_please_select'] + $this->_oDb->getAssistantsBy(['sample' => 'all_pairs', 'active' => 1])); + + $aTmplVarsAssistants = []; + if(!empty($aAutomator[$sAssistants]) && is_array($aAutomator[$sAssistants])) { + foreach($aAutomator[$sAssistants] as $iAhId => $iAssistantId) { + $aInputSelect = [ + 'type' => 'select', + 'name' => $sAssistants . '[]', + 'values' => $aAssistants, + 'value' => (int)$iAssistantId, + 'attrs' => [ + 'class' => 'bx-def-margin-sec-top-auto' + ] + ]; + $sInput = $oForm->genInput($aInputSelect); + + $aInputHidden = [ + 'type' => 'hidden', + 'name' => $sAssistants . '_ids[]', + 'value' => (int)$iAhId, + ]; + $sInput .= $oForm->genInput($aInputHidden); + + $aTmplVarsAssistants[] = ['js_object' => $sJsObject, 'input_select' => $sInput]; + } + } + else { + $aInputSelect = [ + 'type' => 'select', + 'name' => $sAssistants . '[]', + 'values' => $aAssistants, + 'value' => '', + 'attrs' => [ + 'class' => 'bx-def-margin-sec-top-auto' + ] + ]; + + $aTmplVarsAssistants = [ + ['js_object' => $sJsObject, 'input_select' => $oForm->genInput($aInputSelect)], + ]; + } + + $aInputButton = [ + 'type' => 'button', + 'name' => $sAssistants . '_add', + 'value' => _t('_sys_agents_automators_field_assistants_add'), + 'attrs' => [ + 'class' => 'bx-def-margin-sec-top', + 'onclick' => $sJsObject . ".assistantAdd(this, '" . $sAssistants . "');" + ] + ]; + + $aForm['inputs'][$sAssistants]['content'] = $this->_oTemplate->parseHtmlByName('agents_automator_form_assistants.html', [ + 'bx_repeat:assistants' => $aTmplVarsAssistants, + 'btn_add' => $oForm->genInputButton($aInputButton) + ]); + } + + return $aForm; + } + + protected function _getId() + { + $aIds = bx_get('ids'); + if(!empty($aIds) && is_array($aIds)) + return array_shift($aIds); + + $iId = (int)bx_get('id'); + if(!$iId) + return false; + + return $iId; + } + + protected function _getAutomatorName($sName) + { + return uriGenerate($sName, 'sys_agents_automators', 'name', ['lowercase' => false]); + } +} + +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/scripts/BxBaseStudioAgentsHelpers.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/scripts/BxBaseStudioAgentsHelpers.php new file mode 100644 index 0000000000..0ae340ef8a --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/scripts/BxBaseStudioAgentsHelpers.php @@ -0,0 +1,318 @@ +_sUrlPage = BX_DOL_URL_STUDIO . 'agents.php?page=helpers'; + + $this->_sFieldName = 'name'; + } + + public function getPageJsObject() + { + return 'oBxDolStudioPageAgents'; + } + + public function performActionAdd() + { + $sAction = 'add'; + + $aForm = $this->_getForm($sAction); + $oForm = new BxTemplFormView($aForm); + $oForm->initChecker(); + + if($oForm->isSubmittedAndValid()) { + $aValsToAdd = ['added' => time()]; + + $sName = $oForm->getCleanValue($this->_sFieldName); + $sName = $this->_getHelperName($sName); + BxDolForm::setSubmittedValue($this->_sFieldName, $sName, $oForm->aFormAttrs['method']); + + $iProfileId = $oForm->getCleanValue('profile_id'); + if(empty($iProfileId)) { + $iProfileId = (int)getParam('sys_agents_profile'); + if(empty($iProfileId)) + $iProfileId = current(bx_srv('system', 'get_options_agents_profile', [false], 'TemplServices'))['key']; + + $aValsToAdd['profile_id'] = $iProfileId; + } + + $bIsValid = true; + if($bIsValid) { + if(($iId = $oForm->insert($aValsToAdd)) !== false) { + $aRes = ['grid' => $this->getCode(false), 'blink' => $iId]; + } + else + $aRes = ['msg' => _t('_sys_txt_error_occured')]; + + return echoJson($aRes); + } + } + + $sFormId = $oForm->getId(); + $sContent = BxTemplStudioFunctions::getInstance()->popupBox($sFormId . '_popup', _t('_sys_agents_helpers_popup_add'), $this->_oTemplate->parseHtmlByName('agents_automator_form.html', [ + 'form_id' => $sFormId, + 'form' => $oForm->getCode(true), + 'object' => $this->_sObject, + 'action' => $sAction + ])); + + return echoJson(['popup' => ['html' => $sContent, 'options' => ['closeOnOuterClick' => false]]]); + } + + public function performActionEdit() + { + $sAction = 'edit'; + + $iId = $this->_getId(); + $aHelper = $this->_oDb->getHelpersBy(['sample' => 'id', 'id' => $iId]); + + $aForm = $this->_getFormEdit($sAction, $aHelper); + $oForm = new BxTemplFormView($aForm); + $oForm->initChecker(); + + if($oForm->isSubmittedAndValid()) { + $aValsToAdd = []; + + $sName = $oForm->getCleanValue($this->_sFieldName); + if($aHelper[$this->_sFieldName] != $sName) { + $sName = $this->_getHelperName($sName); + BxDolForm::setSubmittedValue($this->_sFieldName, $sName, $oForm->aFormAttrs['method']); + } + + $iProfileId = $oForm->getCleanValue('profile_id'); + if(empty($iProfileId)) { + $iProfileId = (int)getParam('sys_agents_profile'); + if(empty($iProfileId)) + $iProfileId = current(bx_srv('system', 'get_options_agents_profile', [false], 'TemplServices'))['key']; + + $aValsToAdd['profile_id'] = $iProfileId; + } + + if($oForm->update($iId, $aValsToAdd) !== false) + $aRes = ['grid' => $this->getCode(false), 'blink' => $iId]; + else + $aRes = ['msg' => _t('_sys_txt_error_occured')]; + + return echoJson($aRes); + } + + $sFormId = $oForm->getId(); + $sContent = BxTemplStudioFunctions::getInstance()->popupBox($sFormId . '_popup', _t('_sys_agents_helpers_popup_edit'), $this->_oTemplate->parseHtmlByName('agents_automator_form.html', [ + 'form_id' => $sFormId, + 'form' => $oForm->getCode(true), + 'object' => $this->_sObject, + 'action' => $sAction + ])); + + return echoJson(['popup' => ['html' => $sContent, 'options' => ['closeOnOuterClick' => false]]]); + } + + protected function _getCellModelId($mixedValue, $sKey, $aField, $aRow) + { + $aModel = $this->_oDb->getModelsBy(['sample' => 'id', 'id' => $mixedValue]); + if(!empty($aModel) && is_array($aModel)) + $mixedValue = $aModel['title']; + + return parent::_getCellDefault($mixedValue, $sKey, $aField, $aRow); + } + + protected function _getCellProfileId($mixedValue, $sKey, $aField, $aRow) + { + return parent::_getCellDefault(BxDolProfile::getInstanceMagic($mixedValue)->getDisplayName(), $sKey, $aField, $aRow); + } + + protected function _getCellAdded($mixedValue, $sKey, $aField, $aRow) + { + return parent::_getCellDefault(bx_time_js($mixedValue), $sKey, $aField, $aRow); + } + + protected function _getActionTune($sType, $sKey, $a, $isSmall = false, $isDisabled = false, $aRow = []) + { + $a['attr'] = array_merge($a['attr'], [ + "onclick" => "window.open('" . $this->_sUrlPage . '&id=' . $aRow['id'] . "', '_self');" + ]); + + return $this->_getActionDefault ($sType, $sKey, $a, $isSmall, $isDisabled, $aRow); + } + + protected function _addJsCss() + { + parent::_addJsCss(); + + $this->_oTemplate->addJs(['jquery.form.min.js']); + + $oForm = new BxTemplStudioFormView([]); + $oForm->addCssJs(); + } + + protected function _isCheckboxDisabled($aRow) + { + return false; + } + + protected function _getActionsDisabledBehavior($aRow) + { + return false; + } + + protected function _delete ($mixedId) + { + $mixedResult = parent::_delete($mixedId); + if($mixedResult) + $this->_oDb->deleteAutomatorHelpers(['helper_id' => (int)$mixedId]); + + return $mixedResult; + } + + protected function _getFormEdit($sAction, $aHelper = []) + { + $aForm = $this->_getForm($sAction, $aHelper); + $aForm['form_attrs']['action'] .= '&id=' . $aHelper['id']; + + return $aForm; + } + + protected function _getForm($sAction, $aHelper = []) + { + $sJsObject = $this->getPageJsObject(); + + $aForm = array( + 'form_attrs' => array( + 'id' => 'bx_std_agents_helpers_' . $sAction, + 'action' => BX_DOL_URL_ROOT . 'grid.php?o=sys_studio_agents_helpers&a=' . $sAction, + 'method' => 'post', + ), + 'params' => array ( + 'db' => array( + 'table' => 'sys_agents_helpers', + 'key' => 'id', + 'submit_name' => 'do_submit', + ), + ), + 'inputs' => array( + 'name' => [ + 'type' => 'text', + 'name' => 'name', + 'required' => '1', + 'caption' => _t('_sys_agents_helpers_field_name'), + 'value' => isset($aHelper['name']) ? $aHelper['name'] : '', + 'required' => '1', + 'checker' => [ + 'func' => 'Avail', + 'params' => [], + 'error' => _t('_sys_agents_form_field_err_enter'), + ], + 'db' => [ + 'pass' => 'Xss', + ] + ], + 'model_id' => [ + 'type' => 'select', + 'name' => 'model_id', + 'caption' => _t('_sys_agents_helpers_field_model_id'), + 'info' => '', + 'value' => isset($aHelper['model_id']) ? $aHelper['model_id'] : BxDolAI::getDefaultModel(), + 'values' => $this->_oDb->getModelsBy(['sample' => 'all_pairs', 'active' => 1, 'hidden' => 0]), + 'required' => '1', + 'db' => [ + 'pass' => 'Int', + ] + ], + 'profile_id' => [ + 'type' => 'select', + 'name' => 'profile_id', + 'caption' => _t('_sys_agents_helpers_field_profile_id'), + 'info' => _t('_sys_agents_helpers_field_profile_id_inf'), + 'value' => isset($aHelper['profile_id']) ? $aHelper['profile_id'] : 0, + 'values' => bx_srv('system', 'get_options_agents_profile', [], 'TemplServices'), + 'required' => '0', + 'db' => [ + 'pass' => 'Int', + ] + ], + 'description' => [ + 'type' => 'textarea', + 'name' => 'description', + 'caption' => _t('_sys_agents_helpers_field_description'), + 'value' => isset($aHelper['description']) ? $aHelper['description'] : '', + 'required' => '1', + 'checker' => [ + 'func' => 'Avail', + 'params' => [], + 'error' => _t('_sys_agents_form_field_err_enter'), + ], + 'db' => [ + 'pass' => 'Xss', + ] + ], + 'prompt' => [ + 'type' => 'textarea', + 'name' => 'prompt', + 'caption' => _t('_sys_agents_helpers_field_prompt'), + 'value' => isset($aHelper['prompt']) ? $aHelper['prompt'] : '', + 'required' => '1', + 'checker' => [ + 'func' => 'Avail', + 'params' => [], + 'error' => _t('_sys_agents_helpers_field_prompt_err'), + ], + 'db' => [ + 'pass' => 'Xss', + ] + ], + 'submit' => array( + 'type' => 'input_set', + 0 => array ( + 'type' => 'submit', + 'name' => 'do_submit', + 'value' => _t('_sys_submit'), + ), + 1 => array ( + 'type' => 'reset', + 'name' => 'close', + 'value' => _t('_sys_close'), + 'attrs' => array('class' => 'bx-def-margin-sec-left', 'onclick' => '$(\'.bx-popup-applied:visible\').dolPopupHide();'), + ), + ), + + ), + ); + + return $aForm; + } + + protected function _getId() + { + $aIds = bx_get('ids'); + if(!empty($aIds) && is_array($aIds)) + return array_shift($aIds); + + $iId = (int)bx_get('id'); + if(!$iId) + return false; + + return $iId; + } + + protected function _getHelperName($sName) + { + return uriGenerate($sName, 'sys_agents_helpers', 'name', ['lowercase' => false]); + } +} + +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/scripts/BxBaseStudioAgentsProviders.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/scripts/BxBaseStudioAgentsProviders.php new file mode 100644 index 0000000000..dc93c3bd4c --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/scripts/BxBaseStudioAgentsProviders.php @@ -0,0 +1,343 @@ +_sUrlPage = BX_DOL_URL_STUDIO . 'agents.php?page=providers'; + + $this->_sFieldName = 'name'; + } + + public function getPageJsObject() + { + return 'oBxDolStudioPageAgents'; + } + + public function performActionAdd() + { + $sAction = 'add'; + + $aProvider = []; + if(($iTypeId = bx_get('type_id')) !== false && $iTypeId > 0) { + $aProvider = [ + 'type_id' => (int)$iTypeId, + 'options' => $this->_oDb->getProviderOptionsBy(['sample' => 'provider_type_id', 'provider_type_id' => $iTypeId]) + ]; + } + + $aForm = $this->_getForm($sAction, $aProvider); + $oForm = new BxTemplFormView($aForm); + $oForm->initChecker(); + + if($oForm->isSubmittedAndValid()) { + $aValsToAdd = [ + 'profile_id' => bx_get_logged_profile_id(), + 'added' => time(), + 'active' => 1 + ]; + + $sName = $oForm->getCleanValue($this->_sFieldName); + $sName = $this->_getProviderName($sName); + BxDolForm::setSubmittedValue($this->_sFieldName, $sName, $oForm->aFormAttrs['method']); + + if(($iId = $oForm->insert($aValsToAdd)) !== false) { + if(!empty($aProvider['options']) && is_array($aProvider['options'])) + foreach($aProvider['options'] as $aOption) + $this->_oDb->insertProviderValue([ + 'provider_id' => $iId, + 'option_id' => $aOption['id'], + 'value' => $oForm->getCleanValue($aOption['name']) + ]); + + $aRes = ['grid' => $this->getCode(false), 'blink' => $iId]; + } + else + $aRes = ['msg' => _t('_sys_txt_error_occured')]; + + return echoJson($aRes); + } + + $sFormId = $oForm->getId(); + $sContent = BxTemplStudioFunctions::getInstance()->popupBox($sFormId . '_popup_' . $sAction, _t('_sys_agents_providers_popup_add'), $this->_oTemplate->parseHtmlByName('agents_provider_form.html', [ + 'form_id' => $sFormId, + 'form' => $oForm->getCode(true), + 'object' => $this->_sObject, + 'action' => $sAction + ])); + + return echoJson(['popup' => ['html' => $sContent, 'options' => ['closeOnOuterClick' => false]]]); + } + + public function performActionEdit() + { + $sAction = 'edit'; + + $iId = $this->_getId(); + + $oAIProvider = BxDolAI::getInstance()->getProviderObject($iId); + if(!$oAIProvider) + return echoJson([]); + + $aProviderInfo = $oAIProvider->getInfo(); + + $aForm = $this->_getFormEdit($sAction, $aProviderInfo); + $oForm = new BxTemplFormView($aForm); + $oForm->initChecker(); + + if($oForm->isSubmittedAndValid()) { + $sName = $oForm->getCleanValue($this->_sFieldName); + if($aProviderInfo[$this->_sFieldName] != $sName) { + $sName = $this->_getProviderName($sName); + BxDolForm::setSubmittedValue($this->_sFieldName, $sName, $oForm->aFormAttrs['method']); + } + + if($oForm->update($iId) === false) + return echoJson(['msg' => _t('_sys_txt_error_occured')]); + + if(!empty($aProviderInfo['options']) && is_array($aProviderInfo['options'])) + foreach($aProviderInfo['options'] as $aOption) + $this->_oDb->insertProviderValue([ + 'provider_id' => $iId, + 'option_id' => $aOption['id'], + 'value' => $oForm->getCleanValue($aOption['name']) + ]); + + return echoJson(['grid' => $this->getCode(false), 'blink' => $iId]); + } + + $sFormId = $oForm->getId(); + $sContent = BxTemplStudioFunctions::getInstance()->popupBox($sFormId . '_popup_' . $sAction, _t('_sys_agents_providers_popup_edit'), $this->_oTemplate->parseHtmlByName('agents_provider_form.html', [ + 'form_id' => $sFormId, + 'form' => $oForm->getCode(true), + 'object' => $this->_sObject, + 'action' => $sAction + ])); + + return echoJson(['popup' => ['html' => $sContent, 'options' => ['closeOnOuterClick' => false]]]); + } + + public function performActionInfo() + { + $sAction = 'view'; + + $iId = $this->_getId(); + + $oAIProvider = BxDolAI::getInstance()->getProviderObject($iId); + if(!$oAIProvider) + return echoJson([]); + + $aProviderInfo = $oAIProvider->getInfo(); + + $aForm = $this->_getFormView($sAction, $aProviderInfo); + $oForm = new BxTemplFormView($aForm); + $oForm->initChecker($aProviderInfo); + + $sFormId = $oForm->getId(); + $sContent = BxTemplStudioFunctions::getInstance()->popupBox($sFormId . '_popup_' . $sAction, _t('_sys_agents_providers_popup_view'), $this->_oTemplate->parseHtmlByName('agents_provider_form.html', [ + 'form_id' => $oForm->getId(), + 'form' => $oForm->getCode(true), + 'object' => $this->_sObject, + 'action' => $sAction + ])); + + echoJson(['popup' => ['html' => $sContent, 'options' => ['closeOnOuterClick' => true, 'removeOnClose' => true]]]); + } + + protected function _getCellAdded($mixedValue, $sKey, $aField, $aRow) + { + return parent::_getCellDefault(bx_time_js($mixedValue), $sKey, $aField, $aRow); + } + + protected function _addJsCss() + { + parent::_addJsCss(); + + $this->_oTemplate->addJs(['jquery.form.min.js']); + + $oForm = new BxTemplStudioFormView([]); + $oForm->addCssJs(); + } + + protected function _isCheckboxDisabled($aRow) + { + return false; + } + + protected function _getActionsDisabledBehavior($aRow) + { + return false; + } + + protected function _delete ($mixedId) + { + $mixedResult = parent::_delete($mixedId); + if($mixedResult) { + $this->_oDb->deleteProviderValues(['provider_id' => (int)$mixedId]); + + $this->_oDb->deleteAutomatorProviders(['provider_id' => (int)$mixedId]); + } + + return $mixedResult; + } + + protected function _getFormView($sAction, $aProvider = []) + { + $aForm = $this->_getForm($sAction, $aProvider); + $aForm['params']['view_mode'] = 1; + + return $aForm; + } + + protected function _getFormEdit($sAction, $aProvider = []) + { + $aForm = $this->_getForm($sAction, $aProvider); + $aForm['form_attrs']['action'] .= '&id=' . $aProvider['id']; + + return $aForm; + } + + protected function _getForm($sAction, $aProvider = []) + { + $bProvider = !empty($aProvider) && is_array($aProvider); + + $aForm = [ + 'form_attrs' => [ + 'id' => 'bx_std_agents_providers_' . $sAction, + 'action' => BX_DOL_URL_ROOT . 'grid.php?o=sys_studio_agents_providers&a=' . $sAction, + 'method' => 'post', + ], + 'params' => [ + 'db' => [ + 'table' => 'sys_agents_providers', + 'key' => 'id', + 'submit_name' => 'do_submit', + ], + ], + 'inputs' => [ + 'controls' => [ + 'type' => 'input_set', + 0 => [ + 'type' => 'submit', + 'name' => 'do_submit', + 'value' => _t('_sys_submit'), + ], + 1 => [ + 'type' => 'reset', + 'name' => 'close', + 'value' => _t('_sys_close'), + 'attrs' => ['class' => 'bx-def-margin-sec-left', 'onclick' => '$(\'.bx-popup-applied:visible\').dolPopupHide();'], + ], + ], + + ], + ]; + + if($sAction == 'add' && !$bProvider) { + $aForm['inputs'] = bx_array_insert_before([ + 'type_id' => [ + 'type' => 'select', + 'name' => 'type_id', + 'caption' => _t('_sys_agents_providers_field_type_id'), + 'info' => '', + 'value' => isset($aProvider['type_id']) ? $aProvider['type_id'] : 0, + 'values' => array_map(function($sTitle) { + return _t($sTitle); + }, ['' => '_sys_please_select'] + $this->_oDb->getProviderTypesBy(['sample' => 'all_pairs', 'active' => 1])), + 'required' => '1', + 'db' => [ + 'pass' => 'Int', + ] + ], + ], $aForm['inputs'], 'controls'); + + $aForm['inputs']['controls'][0] = array_merge($aForm['inputs']['controls'][0], [ + 'name' => 'do_select', + 'value' => _t('_sys_select') + ]); + } + else { + $aInputsAdd = [ + 'type_id' => [ + 'type' => 'hidden', + 'name' => 'type_id', + 'value' => isset($aProvider['type_id']) ? $aProvider['type_id'] : 0, + 'db' => [ + 'pass' => 'Int', + ] + ], + 'name' => [ + 'type' => 'text', + 'name' => 'name', + 'caption' => _t('_sys_agents_providers_field_name'), + 'value' => isset($aProvider['name']) ? $aProvider['name'] : '', + 'required' => '1', + 'checker' => [ + 'func' => 'Avail', + 'params' => [], + 'error' => _t('_sys_agents_form_field_err_enter'), + ], + 'db' => [ + 'pass' => 'Xss', + ], + ], + ]; + + if(!empty($aProvider['options']) && is_array($aProvider['options'])) + foreach($aProvider['options'] as $aOption) { + if($aOption['type'] == 'value' && empty($aOption['value'])) + continue; + + $aInputsAdd[$aOption['name']] = [ + 'type' => $aOption['type'], + 'name' => $aOption['name'], + 'caption' => _t($aOption['title']), + 'info' => _t($aOption['description']), + 'value' => isset($aOption['value']) ? $aOption['value'] : '', + 'checker' => !empty($aOption['check_type']) ? [ + 'func' => $aOption['check_type'], + 'params' => !empty($aOption['check_params']) ? unserialize($aOption['check_params']) : '', + 'error' => _t($aOption['check_error']), + ] : null, + ]; + } + + $aForm['inputs'] = bx_array_insert_before($aInputsAdd, $aForm['inputs'], 'controls'); + } + + return $aForm; + } + + protected function _getId() + { + $aIds = bx_get('ids'); + if(!empty($aIds) && is_array($aIds)) + return array_shift($aIds); + + $iId = (int)bx_get('id'); + if(!$iId) + return false; + + return $iId; + } + + protected function _getProviderName($sName) + { + return uriGenerate($sName, 'sys_agents_providers', 'name', ['lowercase' => false]); + } +} + +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/scripts/BxBaseStudioOptions.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/scripts/BxBaseStudioOptions.php new file mode 100644 index 0000000000..cfe3005152 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/scripts/BxBaseStudioOptions.php @@ -0,0 +1,777 @@ +getJsObject(); + + $aCategories = []; + $iCategories = $this->oDb->getCategories(['type' => 'by_type_name_key_name', 'type_name' => $this->sType, 'category_name' => $this->sCategory, 'hidden' => 0], $aCategories); + if($iCategories > 0) + $aCategories = array_keys($aCategories); + + $bMix = false; + $aOptions2Mixes = []; + if($this->bMixes) { + if(!empty($this->sMix)) + $aMixesBrowse = ['type' => 'by_name', 'value' => $this->sMix]; + else if(is_string($this->sCategory)) + $aMixesBrowse = ['type' => 'by_type_category', 'mix_type' => $this->sType, 'mix_category' => $this->sCategory, 'active' => 1]; + else + $aMixesBrowse = ['type' => 'by_type', 'value' => $this->sType, 'active' => 1]; + + $aMix = array(); + $this->oDb->getMixes($aMixesBrowse, $aMix, false); + if(!empty($aMix) && is_array($aMix)) { + $this->aMix = $aMix; + $this->sMix = $aMix['name']; + + $bMix = true; + $this->oDb->getMixesOptions(['type' => 'by_mix_id_pair_option_value', 'value' => $this->aMix['id']], $aOptions2Mixes, false); + } + else + $this->sMix = BX_DOL_STUDIO_STG_MIX_DEFAULT; + } + + $bWrap = count($aCategories) > 1; + $aForm = [ + 'form_attrs' => [ + 'id' => 'adm-settings-form' . ($bWrap ? '-categorized' : ''), + 'name' => 'adm-settings-form', + 'action' => bx_append_url_params($this->sBaseUrl, ['type' => $this->sType]), + 'method' => 'post', + 'enctype' => 'multipart/form-data', + 'target' => 'adm-settings-iframe', + 'onsubmit' => 'return ' . $sJsObject . '.onSubmit(this)' + ], + 'params' => [ + 'db' => [ + 'table' => 'sys_options', + 'key' => 'id', + 'uri' => '', + 'uri_title' => '', + 'submit_name' => 'save' + ], + ], + 'inputs' => [] + ]; + + if($bMix) + $aForm['inputs']['mix_id'] = [ + 'type' => 'hidden', + 'name' => 'mix_id', + 'value' => $this->aMix['id'], + 'db' => [ + 'pass' => 'Int', + ], + ]; + + foreach($aCategories as $sCategory) { + $aFields = []; + + if(empty($sCategory)) + continue; + + $aCategory = array(); + $iCategory = $this->oDb->getCategories(['type' => 'by_name', 'value' => $sCategory], $aCategory); + if($iCategory != 1) + continue; + + $aOptions = array(); + $iOptions = $this->oDb->getOptions(['type' => 'by_category_id', 'value' => $aCategory['id']], $aOptions); + + foreach($aOptions as $aOption) + $aFields[$aOption['name']] = $this->field($aOption, $aOptions2Mixes); + + if($bWrap) { + $aCategory['selected'] = $aCategory['name'] == $sCategorySelected; + $aFields = $this->header($aCategory, $aFields); + } + + $aForm['inputs'] = array_merge($aForm['inputs'], $aFields); + } + + $aForm['inputs'] = array_merge( + $aForm['inputs'], (!$bWrap ? [] : [ + 'header_save' => [ + 'type' => 'block_header', + ], + ]), [ + 'categories' => [ + 'type' => 'hidden', + 'name' => 'categories', + 'value' => implode(',', $aCategories), + 'db' => [ + 'pass' => 'Xss', + ], + ] + ], ($this->isReadOnly() ? [] : [ + 'save' => [ + 'type' => 'submit', + 'name' => 'save', + 'value' => _t("_adm_btn_settings_save") + ], + ]) + ); + + $oForm = new BxTemplStudioFormView($aForm, $oTemplate); + $oForm->initChecker(); + + if($oForm->isSubmittedAndValid()) { + echo $this->saveChanges($oForm); + exit; + } + + $bTmplVarsMixes = false; + $aTmplVarsMixes = []; + if($this->bMixes) { + if(is_string($this->sCategory)) + $aMixesBrowse = ['type' => 'by_type_category', 'mix_type' => $this->sType, 'mix_category' => $this->sCategory]; + else + $aMixesBrowse = ['type' => 'by_type', 'value' => $this->sType]; + + $aMixes = []; + $this->oDb->getMixes($aMixesBrowse, $aMixes, false); + $aMixes = array_merge([['name' => BX_DOL_STUDIO_STG_MIX_DEFAULT, 'title' => _t('_adm_stg_txt_mix_' . BX_DOL_STUDIO_STG_MIX_DEFAULT)]], $aMixes); + + foreach($aMixes as $aMix) + $aTmplVarsMixes[] = [ + 'value' => $aMix['name'], + 'title' => $aMix['title'], + 'bx_if:show_checked_mix' => [ + 'condition' => !empty($this->sMix) && $aMix['name'] == $this->sMix, + 'content' => [] + ] + ]; + + $bTmplVarsMixes = !empty($aTmplVarsMixes); + } + + $bMixSelected = !empty($this->sMix) && !empty($this->aMix); + + $aTmplVarsButton = []; + if($bMixSelected) + $aTmplVarsButton = [ + 'js_object' => $sJsObject, + 'id' => $this->aMix['id'] + ]; + + return $oTemplate->parseHtmlByName('options.html', [ + 'base_url' => $this->sBaseUrl, + 'param_prefix' => $this->sParamPrefix, + 'js_object' => $sJsObject, + 'type' => $this->sType, + 'category' => is_array($this->sCategory) ? json_encode($this->sCategory) : $this->sCategory, + 'mix' => $this->sMix, + 'bx_if:show_manage' => [ + 'condition' => $this->bManage, + 'content' => [ + 'js_object' => $sJsObject, + ] + ], + 'bx_if:show_mixes' => [ + 'condition' => $this->bMixes, + 'content' => [ + 'js_object' => $sJsObject, + 'bx_if:show_select_mix' => [ + 'condition' => $bTmplVarsMixes, + 'content' => [ + 'js_object' => $sJsObject, + 'bx_repeat:mixes' => $aTmplVarsMixes, + ] + ], + 'bx_if:show_publish_mix' => [ + 'condition' => $bMixSelected && (int)$this->aMix['published'] == 0, + 'content' => $aTmplVarsButton + ], + 'bx_if:show_hide_mix' => [ + 'condition' => $bMixSelected && (int)$this->aMix['published'] != 0, + 'content' => $aTmplVarsButton + ], + 'bx_if:show_export_mix' => [ + 'condition' => $bMixSelected, + 'content' => $aTmplVarsButton + ], + 'bx_if:show_delete_mix' => [ + 'condition' => $bMixSelected, + 'content' => $aTmplVarsButton + ], + ] + ], + 'form' => $oForm->getCode() + ]); + } + + public function getPopupCodeImport($sType) + { + $oTemplate = BxDolStudioTemplate::getInstance(); + $sJsObject = $this->getJsObject(); + + $sForm = 'adm-settings-import-form'; + $aForm = [ + 'form_attrs' => [ + 'id' => $sForm, + 'name' => $sForm, + 'action' => bx_append_url_params($this->sBaseUrl, [$this->sParamPrefix . '_action' => 'import']), + 'method' => 'post', + 'enctype' => 'multipart/form-data' + ], + 'params' => [ + 'db' => [ + 'submit_name' => 'save' + ], + ], + 'inputs' => [ + 'file' => [ + 'type' => 'file', + 'name' => 'file', + 'caption' => '', + 'value' => '', + ], + 'controls' => [ + 'type' => 'input_set', [ + 'type' => 'submit', + 'name' => 'save', + 'value' => _t('_adm_btn_settings_import'), + ], [ + 'type' => 'button', + 'name' => 'cancel', + 'value' => _t('_adm_txt_confirm_cancel'), + 'attrs' => [ + 'class' => 'bx-def-margin-sec-left-auto', + 'onclick' => '$(".bx-popup-applied:visible").dolPopupHide()' + ] + ] + ] + ] + ]; + + $oForm = new BxTemplStudioFormView($aForm); + $oForm->initChecker(); + + if($oForm->isSubmittedAndValid()) { + $sError = _t('_adm_stg_err_cannot_perform'); + $sErrorWf = _t('_adm_stg_err_import_wrong_format'); + + $aFile = $_FILES['file']; + if(empty($aFile['tmp_name'])) + return ['code' => '1', 'message' => $sError]; + + $sFile = $aFile['tmp_name']; + $rHandle = @fopen($sFile, "r"); + if(!$rHandle) + return ['code' => '2', 'message' => $sError]; + + $sContents = fread($rHandle, filesize($sFile)); + fclose($rHandle); + + $aContent = json_decode($sContents, true); + if(!is_array($aContent) || empty($aContent['meta']) || empty($aContent['data'])) + return ['code' => '3', 'message' => $sErrorWf]; + + if(empty($aContent['meta']['type']) || strcmp($aContent['meta']['type'], $sType) != 0) + return ['code' => '4', 'message' => $sErrorWf]; + + $iData = 0; + foreach($aContent['data']['types'] as $aType) { + if(empty($aType['categories']) || !is_array($aType['categories'])) + continue; + + foreach($aType['categories'] as $aCategory) { + if(empty($aCategory['options']) || !is_array($aCategory['options'])) + continue; + + foreach($aCategory['options'] as $sOptName => $sOptValue) { + setParam($sOptName, $sOptValue); + $iData += 1; + } + } + } + + $this->clearCache(); + return [ + 'message' => _t('_adm_stg_msg_imported', $iData), + 'eval' => $sJsObject . '.onImport(oData);' + ]; + } + + return [ + 'popup' => BxTemplStudioFunctions::getInstance()->popupBox('adm-stg-import-popup', _t('_adm_stg_txt_import_popup'), $oTemplate->parseHtmlByName('options_manage_popup.html', [ + 'js_object' => $sJsObject, + 'form_id' => $sForm, + 'form' => $oForm->getCode(true), + ])) + ]; + } + + public function getPopupCodeCreateMix() + { + $oTemplate = BxDolStudioTemplate::getInstance(); + $sJsObject = $this->getJsObject(); + + $sForm = 'adm-settings-create-mix-form'; + $aForm = [ + 'form_attrs' => [ + 'id' => $sForm, + 'name' => $sForm, + 'action' => bx_append_url_params($this->sBaseUrl, [$this->sParamPrefix . '_action' => 'create-mix']), + 'method' => 'post', + 'enctype' => 'multipart/form-data' + ], + 'params' => [ + 'db' => [ + 'table' => 'sys_options_mixes', + 'key' => 'id', + 'uri' => 'name', + 'uri_title' => 'title', + 'submit_name' => 'save' + ], + ], + 'inputs' => [ + 'type' => [ + 'type' => 'hidden', + 'name' => 'type', + 'value' => $this->sType + ], + 'category' => [ + 'type' => 'hidden', + 'name' => 'category', + 'value' => is_array($this->sCategory) ? json_encode($this->sCategory) : $this->sCategory, + ], + 'title' => [ + 'type' => 'text', + 'name' => 'title', + 'caption' => _t('_adm_stg_txt_mix_title'), + 'info' => _t('_adm_stg_txt_mix_title_inf'), + 'value' => '', + 'required' => true, + 'checker' => [ + 'func' => 'avail', + 'params' => [], + 'error' => _t('_adm_stg_txt_mix_title_err') + ], + 'db' => ['pass' => 'Xss'] + ], + 'dark' => [ + 'type' => 'switcher', + 'name' => 'dark', + 'caption' => _t('_adm_stg_txt_mix_dark'), + 'info' => '', + 'value' => '1', + 'db' => ['pass' => 'Int'] + ], + 'duplicate' => [ + 'type' => 'select', + 'name' => 'duplicate', + 'caption' => _t('_adm_stg_txt_mix_duplicate'), + 'info' => _t('_adm_stg_txt_mix_duplicate_inf'), + 'values' => [ + ['key' => '', 'value' => _t('_None')] + ], + 'value' => '', + ], + 'controls' => [ + 'type' => 'input_set', [ + 'type' => 'submit', + 'name' => 'save', + 'value' => _t('_adm_btn_settings_save'), + ], [ + 'type' => 'button', + 'name' => 'cancel', + 'value' => _t('_adm_txt_confirm_cancel'), + 'attrs' => [ + 'class' => 'bx-def-margin-sec-left-auto', + 'onclick' => '$(".bx-popup-applied:visible").dolPopupHide()' + ] + ] + ] + ] + ]; + + if(is_string($this->sCategory)) + $aMixesBrowse = ['type' => 'by_type_category', 'mix_type' => $this->sType, 'mix_category' => $this->sCategory]; + else + $aMixesBrowse = ['type' => 'by_type', 'value' => $this->sType]; + + $aMixes = []; + $this->oDb->getMixes($aMixesBrowse, $aMixes, false); + foreach($aMixes as $aMix) + $aForm['inputs']['duplicate']['values'][] = ['key' => $aMix['name'], 'value' => $aMix['title']]; + + $oForm = new BxTemplStudioFormView($aForm); + $oForm->initChecker(); + + if($oForm->isSubmittedAndValid()) { + $iId = $oForm->insert([ + 'type' => $this->sType, + 'category' => is_string($this->sCategory) ? $this->sCategory : '', + 'name' => $oForm->generateUri() + ]); + + if($iId === false) + return ['code' => '1', 'message' => _t('_adm_stg_err_cannot_perform')]; + + $this->oDb->updateMixes(['active' => 0], [ + 'type' => $this->sType, + 'category' => is_string($this->sCategory) ? $this->sCategory : '', + 'active' => 1 + ]); + $this->oDb->updateMixes(['active' => 1], ['id' => $iId]); + + $aDuplicate = []; + $this->oDb->getMixes(['type' => 'by_name', 'value' => $oForm->getCleanValue('duplicate')], $aDuplicate, false); + if(!empty($aDuplicate) && is_array($aDuplicate)) + $this->oDb->duplicateMixesOptions($aDuplicate['id'], $iId); + + $this->clearCache(); + return ['eval' => $sJsObject . '.onMixCreate(oData);']; + } + + return [ + 'popup' => BxTemplStudioFunctions::getInstance()->popupBox('adm-stg-create-mix-popup', _t('_adm_stg_txt_create_mix_popup'), $oTemplate->parseHtmlByName('options_create_mix.html', [ + 'js_object' => $sJsObject, + 'form_id' => $sForm, + 'form' => $oForm->getCode(true), + ])) + ]; + } + + public function getPopupCodeImportMix() + { + $oTemplate = BxDolStudioTemplate::getInstance(); + $sJsObject = $this->getJsObject(); + + $sForm = 'adm-settings-import-mix-form'; + $aForm = [ + 'form_attrs' => [ + 'id' => $sForm, + 'name' => $sForm, + 'action' => bx_append_url_params($this->sBaseUrl, [$this->sParamPrefix . '_action' => 'import-mix']), + 'method' => 'post', + 'enctype' => 'multipart/form-data' + ], + 'params' => [ + 'db' => [ + 'table' => 'sys_options_mixes', + 'key' => 'id', + 'uri' => 'name', + 'uri_title' => 'title', + 'submit_name' => 'save' + ], + ], + 'inputs' => [ + 'type' => [ + 'type' => 'hidden', + 'name' => 'type', + 'value' => $this->sType + ], + 'category' => [ + 'type' => 'hidden', + 'name' => 'category', + 'value' => is_array($this->sCategory) ? json_encode($this->sCategory) : $this->sCategory, + ], + 'file' => [ + 'type' => 'file', + 'name' => 'file', + 'caption' => '', + 'value' => '', + ], + 'controls' => [ + 'type' => 'input_set', [ + 'type' => 'submit', + 'name' => 'save', + 'value' => _t('_adm_btn_settings_import'), + ], [ + 'type' => 'button', + 'name' => 'cancel', + 'value' => _t('_adm_txt_confirm_cancel'), + 'attrs' => [ + 'class' => 'bx-def-margin-sec-left-auto', + 'onclick' => '$(".bx-popup-applied:visible").dolPopupHide()' + ] + ] + ] + ] + ]; + + $oForm = new BxTemplStudioFormView($aForm); + $oForm->initChecker(); + + if($oForm->isSubmittedAndValid()) { + $sError = _t('_adm_stg_err_cannot_perform'); + + $aFile = $_FILES['file']; + if(empty($aFile['tmp_name'])) + return ['code' => '1', 'message' => $sError]; + + $sFile = $aFile['tmp_name']; + $rHandle = @fopen($sFile, "r"); + if(!$rHandle) + return ['code' => '2', 'message' => $sError]; + + $sContents = fread($rHandle, filesize($sFile)); + fclose($rHandle); + + $aContent = json_decode($sContents, true); + if(!is_array($aContent) || empty($aContent['mix']) || empty($aContent['options'])) + return ['code' => '3', 'message' => $sError]; + + $aMix = []; + $this->oDb->getMixes(['type' => 'by_name', 'value' => $aContent['mix']['name']], $aMix, false); + if(!empty($aMix) && is_array($aMix)) + return ['code' => '4', 'message' => _t('_adm_stg_err_mix_already_exists')]; + + $iId = $oForm->insert([ + 'type' => $aContent['mix']['type'], + 'category' => $aContent['mix']['category'], + 'name' => $aContent['mix']['name'], + 'title' => $aContent['mix']['title'] + ]); + if($iId === false) + return ['code' => '5', 'message' => $sError]; + + foreach($aContent['options'] as $sKey => $sValue) + $this->oDb->insertMixesOptions([ + 'option' => $sKey, + 'mix_id' => $iId, + 'value' => $sValue + ]); + + $this->oDb->updateMixes(['active' => 0], [ + 'type' => $this->sType, + 'category' => is_string($this->sCategory) ? $this->sCategory : '', + 'active' => 1 + ]); + $this->oDb->updateMixes(['active' => 1], ['id' => $iId]); + + $this->clearCache(); + return ['eval' => $sJsObject . '.onMixImport(oData);']; + } + + return [ + 'popup' => BxTemplStudioFunctions::getInstance()->popupBox('adm-stg-import-mix-popup', _t('_adm_stg_txt_import_mix_popup'), $oTemplate->parseHtmlByName('options_import_mix.html', [ + 'js_object' => $sJsObject, + 'form_id' => $sForm, + 'form' => $oForm->getCode(true), + ])) + ]; + } + + protected function header($aCategory, $aFields) + { + return array_merge([ + 'category_' . $aCategory['id'] . '_beg' => [ + 'type' => 'block_header', + 'name' => 'category_' . $aCategory['id'] . '_beg', + 'caption' => _t($aCategory['caption']), + 'collapsable' => true, + 'collapsed' => !$aCategory['selected'] + ] + ], + $aFields + ); + } + + protected function field($aItem, $aItems2Mixes) + { + $mixedValue = isset($aItems2Mixes[$aItem['name']]) ? $aItems2Mixes[$aItem['name']] : $aItem['value']; + + $sMethod = 'getCustomValue' . bx_gen_method_name(trim(str_replace($this->sType, '', $aItem['name']), '_')); + if(method_exists($this, $sMethod)) + $mixedValue = $this->$sMethod($aItem, $mixedValue); + + $aAttributes = array(); + if($this->isReadOnly()) + $aAttributes = array_merge($aAttributes, [ + 'disabled' => 'disabled' + ]); + + $aField = []; + switch($aItem['type']) { + case 'value': + $aField = [ + 'type' => 'text', + 'name' => $aItem['name'], + 'caption' => _t($aItem['caption']), + 'info' => _t($aItem['info']), + 'value' => $mixedValue, + 'attrs' => array_merge($aAttributes, ['readonly' => 'readonly']), + 'db' => ['pass' => 'Xss'], + ]; + break; + case 'digit': + $aField = [ + 'type' => 'text', + 'name' => $aItem['name'], + 'caption' => _t($aItem['caption']), + 'info' => _t($aItem['info']), + 'value' => $mixedValue, + 'attrs' => $aAttributes, + 'db' => ['pass' => 'Xss'], + ]; + break; + case 'text': + $aField = [ + 'type' => 'textarea', + 'name' => $aItem['name'], + 'caption' => _t($aItem['caption']), + 'info' => _t($aItem['info']), + 'value' => $mixedValue, + 'attrs' => $aAttributes, + 'db' => ['pass' => 'XssHtml'], + ]; + break; + case 'code': + $aField = [ + 'type' => 'textarea', + 'code' => true, + 'name' => $aItem['name'], + 'caption' => _t($aItem['caption']), + 'info' => _t($aItem['info']), + 'value' => $mixedValue, + 'attrs' => $aAttributes, + 'db' => ['pass' => 'XssHtml'], + ]; + break; + case 'checkbox': + $aField = [ + 'type' => 'checkbox', + 'name' => $aItem['name'], + 'caption' => _t($aItem['caption']), + 'info' => _t($aItem['info']), + 'value' => 'on', + 'checked' => $mixedValue == 'on', + 'attrs' => $aAttributes, + 'db' => ['pass' => 'Xss'], + ]; + break; + case 'list': + case 'rlist': + $aField = [ + 'type' => 'checkbox_set', + 'name' => $aItem['name'], + 'caption' => _t($aItem['caption']), + 'info' => _t($aItem['info']), + 'value' => !empty($mixedValue) ? explode(',', $mixedValue) : [], + 'reverse' => $aItem['type'] == 'rlist', + 'attrs' => $aAttributes, + 'db' => ['pass' => 'Xss'], + ]; + + if (BxDolService::isSerializedService($aItem['extra'])) + $aField['values'] = BxDolService::callSerialized($aItem['extra']); + else + foreach(explode(',', $aItem['extra']) as $sValue) + $aField['values'][$sValue] = $sValue; + break; + case 'select': + $aField = [ + 'type' => 'select', + 'name' => $aItem['name'], + 'caption' => _t($aItem['caption']), + 'info' => _t($aItem['info']), + 'value' => $mixedValue, + 'values' => [], + 'attrs' => $aAttributes, + 'db' => ['pass' => 'Xss'], + ]; + + if (BxDolService::isSerializedService($aItem['extra'])) + $aField['values'] = BxDolService::callSerialized($aItem['extra']); + else + foreach(explode(',', $aItem['extra']) as $sValue) + $aField['values'][] = ['key' => $sValue, 'value' => $sValue]; + break; + case 'file': + $aField = [ + 'type' => 'file', + 'name' => $aItem['name'], + 'caption' => _t($aItem['caption']), + 'info' => _t($aItem['info']), + 'value' => $mixedValue, + 'attrs' => $aAttributes, + 'db' => ['pass' => 'Xss'] + ]; + break; + case 'image': + //--- Concatenation integer values as strings is required to get unique content id + $iContentId = (int)($aItem['id'] . ($this->bMixes && isset($this->aMix['id']) ? $this->aMix['id'] : 0)); + + $aField = [ + 'type' => 'files', + 'name' => $aItem['name'], + 'storage_object' => $this->sStorage, + 'storage_private' => 0, + 'images_transcoder' => $this->sTranscoder, + 'uploaders' => ['sys_settings_html5'], + 'upload_buttons_titles' => ['HTML5' => _t('_sys_uploader_button_name_single')], + 'multiple' => false, + 'content_id' => $iContentId, + 'ghost_template' => BxTemplStudioFunctions::getInstance()->getDefaultGhostTemplate($aItem['name']), + 'caption' => _t($aItem['caption']), + 'info' => _t($aItem['info']), + 'value' => $mixedValue, + 'attrs' => $aAttributes, + 'db' => ['pass' => 'Xss'] + ]; + break; + case 'rgb': + case 'rgba': + $aField = [ + 'type' => $aItem['type'], + 'name' => $aItem['name'], + 'caption' => _t($aItem['caption']), + 'info' => _t($aItem['info']), + 'value' => $mixedValue, + 'attrs' => $aAttributes, + 'db' => ['pass' => 'Xss'], + ]; + break; + case 'datetime': + $aField = [ + 'type' => 'datetime', + 'name' => $aItem['name'], + 'caption' => _t($aItem['caption']), + 'info' => _t($aItem['info']), + 'value' => $mixedValue, + 'attrs' => $aAttributes, + 'db' => ['pass' => 'DateTimeUtc'], + ]; + break; + } + + return $aField; + } +} + +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/scripts/BxBaseStudioPage.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/scripts/BxBaseStudioPage.php new file mode 100644 index 0000000000..95f94def91 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/scripts/BxBaseStudioPage.php @@ -0,0 +1,243 @@ +aPageCss = [ + 'page.css', + 'page-media-tablet.css', + 'page-media-desktop.css', + 'page_columns.css', + 'menu_top.css' + ]; + + $this->aPageJs = [ + 'jquery.anim.js', + 'jquery.jfeed.pack.js', + 'jquery.dolRSSFeed.js', + 'page.js' + ]; + + $this->sPageJsClass = 'BxDolStudioPage'; + $this->sPageJsObject = 'oBxDolStudioPage'; + } + + public function getPageIndex() + { + if(!is_array($this->aPage) || empty($this->aPage)) + return BX_PAGE_DEFAULT; + + if(!$this->bPageMultiple) + return !empty($this->aPage['index']) ? (int)$this->aPage['index'] : BX_PAGE_DEFAULT; + else + return !empty($this->aPage[$this->sPageSelected]['index']) ? (int)$this->aPage[$this->sPageSelected]['index'] : BX_PAGE_DEFAULT; + + $this->aMarkers = array_merge($this->aMarkers, array( + 'js_object' => $this->getPageJsObject(), + )); + } + + public function getPageJs() + { + return $this->aPageJs; + } + + public function getPageJsClass() + { + return $this->sPageJsClass; + } + + public function getPageJsObject() + { + return $this->sPageJsObject; + } + + public function getPageJsCode($aOptions = array(), $bWrap = true) + { + $sJsClass = $this->getPageJsClass(); + $sJsObject = $this->getPageJsObject(); + if(empty($sJsClass) || empty($sJsObject)) + return ''; + + $sOptions = '{}'; + if(!empty($aOptions)) + $sOptions = json_encode($aOptions); + + $sContent = 'var ' . $sJsObject . ' = new ' . $sJsClass . '(' . $sOptions . ');'; + if($bWrap) + $sContent = BxDolStudioTemplate::getInstance()->_wrapInTagJsCode($sContent); + + return $sContent; + } + + public function getPageCss() + { + return $this->aPageCss; + } + + public function getPageHeader() + { + if(empty($this->aPage) || !is_array($this->aPage)) + return ''; + + return _t(!$this->bPageMultiple ? $this->aPage['caption'] : $this->aPage[$this->sPageSelected]['caption']); + } + + public function getPageBreadcrumb() + { + $bPageHome = $this->aPage['name'] == 'home'; + $bWidgetType = !empty($this->aPage['wid_type']); + + $aMarkers = array('js_object_launcher' => BxTemplStudioLauncher::getInstance()->getPageJsObject()); + if($bWidgetType) + $aMarkers['widget_type'] = $this->aPage['wid_type']; + + $this->addMarkers($aMarkers); + + $aMenuItems = []; + $aMenuItems['home'] = [ + 'name' => 'home', + 'icon' => 'bc-home.svg', + 'link' => BX_DOL_URL_STUDIO, + //'onclick' => bx_replace_markers('return {js_object_launcher}.browser(this)', $this->aMarkers), + 'title' => '' + ]; + + /** + * Hidden for now. + */ + if(false && $bWidgetType) + $aMenuItems['type'] = [ + 'name' => 'type', + 'icon' => $this->getPageTypeIcon(), + 'link' => $this->getPageTypeUrl(), + 'onclick' => bx_replace_markers("return {js_object_launcher}.browser(this, '{widget_type}')", $this->aMarkers), + 'title' => '' + ]; + + if(!$bPageHome) + $aMenuItems['page'] = [ + 'name' => 'page', + 'icon' => '', //$this->aPage['icon'], + 'link' => $this->getPageUrl(), + 'title' => _t($this->aPage['caption']) + ]; + + $oMenu = new BxTemplStudioMenu([ + 'template' => 'page_breadcrumb.html', + 'menu_items' => $aMenuItems + ]); + $sMenu = $oMenu->getCode(); + + return BxDolStudioTemplate::getInstance()->parseHtmlByContent($sMenu, [ + 'bx_if:show_search' => [ + 'condition' => $bPageHome && getParam('sys_std_show_header_left_search') == 'on', + 'content' => [true] + ] + ]); + } + + public function getPageCaption() + { + if(($sAssistant = $this->getPageCaptionAssistant()) != '') { + $sAssistant = BxTemplStudioFunctions::getInstance()->popupBox('bx-std-pcap-menu-popup-assistant', _t('_adm_txt_assistant_popup_title'), $sAssistant, true); + + BxDolStudioTemplate::getInstance()->addInjection('injection_header', 'text', $sAssistant); + } + + return ''; + } + + public function getPageAttributes() + { + return ''; + } + + public function getPageMenu($aMenu = array(), $aMarkers = array()) + { + $oMenu = $this->getPageMenuObject($aMenu, $aMarkers); + return $oMenu->getCode(); + } + + public function getPageCode($sPage = '', $bWrap = true) { + if(empty($this->aPage) || !is_array($this->aPage)) { + $this->setError('_sys_txt_not_found'); + return false; + } + + return ''; + } + + protected function getPageMenuObject($aMenu = array(), $aMarkers = array()) + { + $oMenu = new BxTemplStudioMenu(array('template' => 'menu_side.html', 'menu_items' => $aMenu)); + if(!empty($aMarkers)) + $oMenu->addMarkers($aMarkers); + + return $oMenu; + } + + protected function getPageCaptionHelp() + { + $sContent = BxDolRss::getObjectInstance($this->sPageRssHelpObject)->getHolder($this->sPageRssHelpId, $this->iPageRssHelpLength, 0, false); + + $oTemplate = BxDolStudioTemplate::getInstance(); + $oTemplate->addJsTranslation('_adm_txt_show_help_content_empty'); + return $oTemplate->parseHtmlByName('page_caption_help.html', array( + 'content' => $sContent + )); + } + + protected function getPageCaptionAssistant() + { + if(!$this->_bShowHeaderRightAssistant) + return ''; + + $oAssistant = BxDolAIAssistant::getObjectInstance($this->iPageAssistantId); + if(!$oAssistant) + return ''; + + $oTemplate = BxDolStudioTemplate::getInstance(); + + $sContent = $oAssistant->getAskChat($this->iPageAssistantChatName, '', $oTemplate); + if(!$sContent) + return ''; + + return $oTemplate->parseHtmlByName('page_caption_assistant.html', [ + 'content' => $sContent + ]); + } + + protected function getJsResult($sMessage, $bTranslate = true, $bRedirect = false, $sRedirect = '', $sOnResult = '') + { + return bx_get_js_result(array( + 'message' => $sMessage, + 'translate' => $bTranslate, + 'redirect' => $bRedirect === true && !empty($sRedirect) ? $sRedirect : $bRedirect, + 'eval' => $sOnResult + )); + } + + protected function getJsResultBy($aParams) + { + return bx_get_js_result($aParams); + } +} + +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/scripts/BxBaseStudioPolyglot.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/scripts/BxBaseStudioPolyglot.php new file mode 100644 index 0000000000..4fab17e992 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/scripts/BxBaseStudioPolyglot.php @@ -0,0 +1,285 @@ +aPageCss = array_merge($this->aPageCss, ['forms.css', 'paginate.css', 'polyglot.css']); + $this->aPageJs = array_merge($this->aPageJs, ['polyglot.js']); + $this->sPageJsClass = 'BxDolStudioPolyglot'; + $this->sPageJsObject = 'oBxDolStudioPolyglot'; + + $this->sSubpageUrl = BX_DOL_URL_STUDIO . 'polyglot.php?page='; + + $this->aMenuItems = array( + BX_DOL_STUDIO_PGT_TYPE_SETTINGS => array('icon' => 'cogs'), + BX_DOL_STUDIO_PGT_TYPE_KEYS => array('icon' => 'key'), + BX_DOL_STUDIO_PGT_TYPE_ETEMPLATES => array('icon' => 'far envelope'), + /* + * Isn't used for now. + * + BX_DOL_STUDIO_PGT_TYPE_ETEMPLATES_HF => array('icon' => 'far sticky-note'), + * + */ + BX_DOL_STUDIO_PGT_TYPE_ETEMPLATES_CREATIVE => array('icon' => 'far object-group') + ); + + $this->aGridObjects = array( + 'keys' => 'sys_studio_lang_keys', + 'etemplates' => 'sys_studio_lang_etemplates', + ); + + $this->aHtmlIds = [ + 'etc_builder_id' => 'adm-pgt-etc-builder', + ]; + } + + public function getPageJsCode($aOptions = array(), $bWrap = true) + { + $aOptions = array_merge($aOptions, array( + 'sActionUrl' => BX_DOL_URL_STUDIO . 'polyglot.php' + )); + + return parent::getPageJsCode($aOptions, $bWrap); + } + + public function getPageMenu($aMenu = array(), $aMarkers = array()) + { + $sJsObject = $this->getPageJsObject(); + + $aMenu = array(); + foreach($this->aMenuItems as $sMenuItem => $aItem) + $aMenu[] = array( + 'name' => $sMenuItem, + 'icon' => $aItem['icon'], + 'link' => $this->sSubpageUrl . $sMenuItem, + 'title' => _t('_adm_lmi_cpt_' . $sMenuItem), + 'selected' => $sMenuItem == $this->sPage + ); + + return parent::getPageMenu($aMenu); + } + + protected function getSettings() + { + $oOptions = new BxTemplStudioOptions(BX_DOL_STUDIO_STG_TYPE_DEFAULT, BX_DOL_STUDIO_STG_CATEGORY_LANGUAGES); + + $this->aPageCss = array_merge($this->aPageCss, $oOptions->getCss()); + $this->aPageJs = array_merge($this->aPageJs, $oOptions->getJs()); + return BxDolStudioTemplate::getInstance()->parseHtmlByName('polyglot.html', array( + 'content' => $oOptions->getCode(), + 'js_content' => '' + )); + } + + protected function getKeys() + { + return $this->getGrid($this->aGridObjects['keys']); + } + + protected function getEtemplates() + { + return $this->getGrid($this->aGridObjects['etemplates']); + } + + protected function getEtemplatesHf() + { + $oTemplate = BxDolStudioTemplate::getInstance(); + + $sFormId = 'adm-dsg-et-hf-form'; + $sIFrameId = 'adm-dsg-et-hf-iframe'; + + $aForm = array( + 'form_attrs' => array( + 'id' => $sFormId, + 'name' => $sFormId, + 'action' => BX_DOL_URL_STUDIO . 'polyglot.php', + 'method' => 'post', + 'enctype' => 'multipart/form-data', + 'target' => $sIFrameId + ), + 'params' => array( + 'db' => array( + 'table' => '', + 'key' => '', + 'uri' => '', + 'uri_title' => '', + 'submit_name' => 'save' + ), + ), + 'inputs' => array( + 'page' => array( + 'type' => 'hidden', + 'name' => 'page', + 'value' => $this->sPage + ), + 'et_hf_header' => array( + 'type' => 'textarea', + 'code' => true, + 'name' => 'et_hf_header', + 'caption' => _t('_adm_stg_cpt_option_site_email_html_template_header'), + 'info' => _t('_adm_pgt_txt_et_hf_inf'), + 'value' => getParam('site_email_html_template_header'), + 'db' => array ( + 'pass' => 'Xss', + ), + ), + 'et_hf_footer' => array( + 'type' => 'textarea', + 'code' => true, + 'name' => 'et_hf_footer', + 'caption' => _t('_adm_stg_cpt_option_site_email_html_template_footer'), + 'info' => _t('_adm_pgt_txt_et_hf_inf'), + 'value' => getParam('site_email_html_template_footer'), + 'db' => array ( + 'pass' => 'Xss', + ), + ), + 'save' => array( + 'type' => 'submit', + 'name' => 'save', + 'value' => _t('_adm_pgt_btn_et_hf_submit'), + ) + ) + ); + + $oForm = new BxTemplStudioFormView($aForm, $oTemplate); + $oForm->initChecker(); + + if($oForm->isSubmittedAndValid()) { + echo $this->submitEtemplatesHf($oForm); + exit; + } + + $oTemplate->addJs(array('codemirror/codemirror.min.js')); + $oTemplate->addCss(BX_DIRECTORY_PATH_PLUGINS_PUBLIC . 'codemirror/|codemirror.css'); + + return $oTemplate->parseHtmlByName('polyglot.html', array( + 'content' => $oTemplate->parseHtmlByName('pgt_etemplates_hf.html', array( + 'warning' => '', + 'iframe_id' => $sIFrameId, + 'form' => $oForm->getCode() + )), + 'js_content' => $this->getPageJsCode(array( + 'sCodeMirror' => 'textarea[name=et_hf_header],textarea[name=et_hf_footer]' + )) + )); + } + + protected function getEtemplatesCreative() + { + $oTemplate = BxDolStudioTemplate::getInstance(); + + $sFormId = 'adm-dsg-et-creative-form'; + $sIFrameId = 'adm-dsg-et-creative-iframe'; + + $sContent = ''; + $sContent .= getParam('site_email_html_template_header'); + $sContent .= $this->sEtcContent; + $sContent .= getParam('site_email_html_template_footer'); + + $aForm = [ + 'form_attrs' => [ + 'id' => $sFormId, + 'name' => $sFormId, + 'action' => BX_DOL_URL_STUDIO . 'polyglot.php', + 'method' => 'post', + 'enctype' => 'multipart/form-data', + 'target' => $sIFrameId + ], + 'params' => [ + 'db' => [ + 'table' => '', + 'key' => '', + 'uri' => '', + 'uri_title' => '', + 'submit_name' => 'save' + ], + ], + 'inputs' => [ + 'page' => [ + 'type' => 'hidden', + 'name' => 'page', + 'value' => $this->sPage + ], + 'content' => [ + 'type' => 'custom', + 'name' => 'content', + 'caption' => '', + 'content' => $oTemplate->parseHtmlByName('pgt_etemplates_creative_fld.html', [ + 'html_id' => $this->aHtmlIds['etc_builder_id'], + 'content_html' => $sContent, + 'content_data' => json_encode([ + 'pages' => [ + ['component' => $sContent] + ] + ]) + ]), + 'required' => '0', + 'db' => [ + 'pass' => 'XssHtml', + ], + ], + 'save' => [ + 'type' => 'submit', + 'name' => 'save', + 'value' => _t('_adm_pgt_btn_et_hf_submit'), + ] + ] + ]; + + $oForm = new BxTemplStudioFormView($aForm, $oTemplate); + $oForm->initChecker(); + + if($oForm->isSubmittedAndValid()) { + echo $this->submitEtemplatesCreative($oForm); + exit; + } + + $oTemplate->addJs([ + 'grapesjs/grapes.min.js', + 'grapesjs/grapesjs-preset-newsletter.min.js' + ]); + $oTemplate->addCss([ + BX_DIRECTORY_PATH_PLUGINS_PUBLIC . 'grapesjs/|grapes.min.css' + ]); + + return $oTemplate->parseHtmlByName('polyglot.html', [ + 'content' => $oTemplate->parseHtmlByName('pgt_etemplates_creative_frm.html', [ + 'warning' => '', + 'iframe_id' => $sIFrameId, + 'form' => $oForm->getCode() + ]), + 'js_content' => $this->getPageJsCode() + ]); + } + + protected function getGrid($sObjectName) + { + $oGrid = BxDolGrid::getObjectInstance($sObjectName); + if(!$oGrid) + return ''; + + return BxDolStudioTemplate::getInstance()->parseHtmlByName('polyglot.html', array( + 'content' => $oGrid->getCode(), + 'js_content' => '' + )); + } +} + +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/scripts/BxBaseStudioStore.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/scripts/BxBaseStudioStore.php new file mode 100644 index 0000000000..5591a04cbc --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/scripts/BxBaseStudioStore.php @@ -0,0 +1,1108 @@ +addJsTranslation(array('_adm_btn_queued_submit')); + return array_merge(parent::getPageJs(), array('fancybox/jquery.fancybox.pack.js', 'store.js')); + } + + function getPageJsObject() + { + return 'oBxDolStudioStore'; + } + + function getPageMenu($aMenu = array(), $aMarkers = array()) + { + $sJsObject = $this->getPageJsObject(); + $oTemplate = BxDolStudioTemplate::getInstance(); + + $aMenu = []; + $aMenuItems = [ + 'goodies' => ['icon' => 'mi-str-home.svg', 'icon_bg' => true], + 'latest' => ['icon' => 'mi-str-latest.svg', 'icon_bg' => true], + 'featured' => ['icon' => 'mi-str-featured.svg', 'icon_bg' => true], + 'popular' => ['icon' => 'mi-str-popular.svg', 'icon_bg' => true], + 'categories' => ['icon' => 'mi-str-categories.svg', 'icon_bg' => true], + 'search' => ['icon' => 'mi-str-search.svg', 'icon_bg' => true], + 'purchases' => ['icon' => 'mi-str-purchases.svg', 'icon_bg' => true], + 'updates' => ['icon' => 'mi-str-updates.svg', 'icon_bg' => true], + 'checkout' => ['icon' => 'mi-str-checkout.svg', 'icon_bg' => true], + 'downloaded' => ['icon' => 'mi-str-downloaded.svg', 'icon_bg' => true] + ]; + foreach($aMenuItems as $sMenuItem => $aItem) + $aMenu[] = array_merge($aItem, [ + 'name' => $sMenuItem, + 'link' => $this->getBaseUrl($sMenuItem), + 'title' => _t('_adm_lmi_cpt_' . $sMenuItem), + 'selected' => $sMenuItem == $this->sPage + ]); + + $iCounter = BxDolStudioCart::getInstance()->getCount(); + + $aMarkers = array( + 'checkout_counter' => $oTemplate->parseHtmlByName('menu_side_counter.html', array( + 'bx_if:hide_counter' => array( + 'condition' => $iCounter <= 0, + 'content' => array() + ), + 'counter' => $iCounter + )) + ); + + return parent::getPageMenu($aMenu, $aMarkers); + } + + function getPageCode($sPage = '', $bWrap = true) + { + $sResult = parent::getPageCode($sPage, $bWrap); + if($sResult === false) + return false; + + $sMethod = 'get' . ucfirst($this->sPage) . 'List'; + if(!method_exists($this, $sMethod)) + return ''; + + return $this->$sMethod() . $sResult; + } + + function getPageContent() + { + $sMethod = 'get' . ucfirst($this->sPage) . 'List'; + if(!method_exists($this, $sMethod)) + return ''; + + return $this->$sMethod(false); + } + + protected function getGoodiesList() + { + $sJsObject = $this->getPageJsObject(); + $oTemplate = BxDolStudioTemplate::getInstance(); + + $mixedResult = $this->authorizeClient(); + if($mixedResult === true) { + $aProducts = $this->loadGoodies(); + + $sContent = ""; + $sContent .= $this->displayNonOwnerNotification(); + + $sContent .= $this->getBlocksLine(array( + array( + 'caption' => '_adm_block_cpt_categories', + 'actions' => array(), + 'items' => $this->getCategoriesList(false) + ), + array( + 'caption' => '_adm_block_cpt_tags', + 'actions' => array(), + 'items' => $this->getTagsList(false) + ) + )); + + foreach($aProducts as $aBlock) { + $aBlock['items'] = $oTemplate->parseHtmlByName('str_products.html', array( + 'list' => $this->displayProducts($aBlock['items']), + 'paginate' => '' + )); + + $sContent .= $this->getBlockCode($aBlock); + } + } + else + $sContent = $this->getBlockCode(array( + 'caption' => '_adm_block_cpt_goodies', + 'items' => $mixedResult, + )); + + return $oTemplate->parseHtmlByName('store.html', array( + 'js_object' => $sJsObject, + 'content' => $sContent + )); + } + + protected function getLatestList($bWrapInBlock = true) + { + return $this->getBrowsingList('latest', $bWrapInBlock); + } + + protected function getFeaturedList($bWrapInBlock = true) + { + return $this->getBrowsingList('featured', $bWrapInBlock); + } + + protected function getPopularList($bWrapInBlock = true) + { + return $this->getBrowsingList('popular', $bWrapInBlock); + } + + protected function getBrowsingList($sType, $bWrapInBlock = true) + { + $sJsObject = $this->getPageJsObject(); + $oTemplate = BxDolStudioTemplate::getInstance(); + + $mixedResult = $this->authorizeClient(); + if($mixedResult === true) { + $iStart = (int)bx_get('str_start'); + $iPerPage = (int)bx_get('str_per_page'); + if(empty($iPerPage)) + $iPerPage = $this->iPerPageDefault; + + $aProducts = $this->{'load' . bx_gen_method_name($sType)}($iStart, $iPerPage + 1); + + $oPaginate = new BxTemplPaginate(array( + 'start' => $iStart, + 'per_page' => $iPerPage, + 'on_change_page' => $sJsObject . ".changePagePaginate(this, '" . $sType . "', null, {start}, {per_page})" + )); + $oPaginate->setNumFromDataArray($aProducts); + + $sContent = $oTemplate->parseHtmlByName('str_products.html', array( + 'list' => $this->displayProducts($aProducts), + 'paginate' => $oPaginate->getSimplePaginate() + )); + } + else + $sContent = $mixedResult; + + if(!$bWrapInBlock) + return $sContent; + + return $oTemplate->parseHtmlByName('store.html', array( + 'js_object' => $sJsObject, + 'content' => $this->getBlockCode(array( + 'caption' => '_adm_block_cpt_' . $sType, + 'items' => $sContent + )) + )); + } + + protected function getCategoriesList($bWrapInBlock = true) + { + return $this->getLabelsList('categories', $bWrapInBlock); + } + + protected function getCategoryList($bWrapInBlock = true) + { + $sKey = 'value'; + if(bx_get($sKey) === false) + $sKey = 'str_value'; + + $aValue = array(); + $aValue['value'] = (int)bx_get($sKey); + if(bx_get('title') !== false) + $aValue['title'] = bx_process_input(urldecode(bx_get('title'))); + + return $this->getLabelList('category', $aValue, $bWrapInBlock); + } + + protected function getTagsList($bWrapInBlock = true) + { + return $this->getLabelsList('tags', $bWrapInBlock); + } + + protected function getTagList($bWrapInBlock = true) + { + $sKey = 'value'; + if(bx_get($sKey) === false) + $sKey = 'str_value'; + + return $this->getLabelList('tag', bx_process_input(bx_get($sKey)), $bWrapInBlock); + } + + protected function getLabelsList($sType, $bWrapInBlock = true) + { + $mixedResult = $this->authorizeClient(); + if($mixedResult === true) { + $aLabels = $this->{'load' . bx_gen_method_name($sType)}(); + $sContent = $this->{'display' . bx_gen_method_name($sType)}($aLabels); + } + else + $sContent = $mixedResult; + + if(!$bWrapInBlock) + return $sContent; + + return BxDolStudioTemplate::getInstance()->parseHtmlByName('store.html', array( + 'js_object' => $this->getPageJsObject(), + 'content' => $this->getBlockCode(array( + 'caption' => '_adm_block_cpt_' . $sType, + 'items' => $sContent + )) + )); + } + + protected function getLabelList($sType, $mixedValue, $bWrapInBlock = true) + { + $sJsObject = $this->getPageJsObject(); + $oTemplate = BxDolStudioTemplate::getInstance(); + + $iStart = (int)bx_get('str_start'); + $iPerPage = (int)bx_get('str_per_page'); + if(empty($iPerPage)) + $iPerPage = $this->iPerPageDefault; + + $bArray = is_array($mixedValue); + $sValue = $bArray ? $mixedValue['value'] : $mixedValue; + $sTitle = $bArray && !empty($mixedValue['title']) ? $mixedValue['title'] : $sValue; + + $sMethod = 'load' . bx_gen_method_name($sType); + $aProducts = $this->$sMethod($sValue, $iStart, $iPerPage + 1); + + $oPaginate = new BxTemplPaginate(array( + 'start' => $iStart, + 'per_page' => $iPerPage, + 'on_change_page' => $sJsObject . ".changePagePaginate(this, '" . $sType . "', '" . $sValue . "', {start}, {per_page})" + )); + $oPaginate->setNumFromDataArray($aProducts); + + $sContent = $oTemplate->parseHtmlByName('str_products.html', array( + 'list' => $this->displayProducts($aProducts), + 'paginate' => $oPaginate->getSimplePaginate() + )); + + if(!$bWrapInBlock) + return $sContent; + + return $oTemplate->parseHtmlByName('store.html', array( + 'js_object' => $sJsObject, + 'content' => $this->getBlockCode(array( + 'caption' => array('_adm_block_cpt_' . $sType, $sTitle), + 'items' => $sContent, + )) + )); + } + + protected function getSearchList($bWrapInBlock = true) + { + $sJsObject = $this->getPageJsObject(); + $oTemplate = BxDolStudioTemplate::getInstance(); + + $mixedResult = $this->authorizeClient(); + if($mixedResult === true) { + //--- Search form + $aForm = array( + 'form_attrs' => array( + 'id' => 'adm-str-search-form', + 'name' => 'adm-str-search-form', + 'action' => '', + 'method' => 'post' + ), + 'params' => array( + 'db' => array( + 'table' => '', + 'key' => '', + 'uri' => '', + 'uri_title' => '', + 'submit_name' => 'search' + ), + ), + 'inputs' => array( + 'page' => array( + 'type' => 'hidden', + 'name' => 'page', + 'value' => $this->sPage + ), + 'keyword' => array( + 'type' => 'text', + 'name' => 'keyword', + 'caption' => '', + 'value' => '', + 'attrs' => array( + 'placeholder' => bx_html_attribute(_t('_sys_search_placeholder')) + ), + 'db' => array ( + 'pass' => 'Xss', + ) + ), + 'search' => array( + 'type' => 'submit', + 'name' => 'search', + 'value' => _t('_adm_btn_store_search'), + ) + ) + ); + + $oForm = new BxTemplStudioFormView($aForm); + $oForm->initChecker(); + + $sResults = ''; + if($oForm->isSubmittedAndValid()) { + $sKeyword = $oForm->getCleanValue('keyword'); + + $iStart = (int)bx_get('str_start'); + $iPerPage = (int)bx_get('str_per_page'); + if(empty($iPerPage)) + $iPerPage = 999; + + $aProducts = $this->loadSearch($sKeyword, $iStart, $iPerPage + 1); + $sResults = empty($aProducts) || !is_array($aProducts) ? MsgBox(_t('_Empty')) : $oTemplate->parseHtmlByName('str_products.html', array( + 'list' => $this->displayProducts($aProducts), + 'paginate' => '' + )); + } + + $sContent = $oTemplate->parseHtmlByName('str_search.html', array( + 'form' => $oForm->getCode(), + 'bx_if:show_results' => array( + 'condition' => !empty($sResults), + 'content' => array( + 'results' => $sResults + ) + ) + )); + } + else + $sContent = $mixedResult; + + if(!$bWrapInBlock) + return $sContent; + + return $oTemplate->parseHtmlByName('store.html', array( + 'js_object' => $sJsObject, + 'content' => $this->getBlockCode(array( + 'caption' => '_adm_block_cpt_search', + 'items' => $sContent + )) + )); + } + + protected function getPurchasesList() + { + $oTemplate = BxDolStudioTemplate::getInstance(); + + $aProducts = $this->loadPurchases(); + return $oTemplate->parseHtmlByName('store.html', array( + 'js_object' => $this->getPageJsObject(), + 'content' => $this->getBlockCode(array( + 'caption' => '_adm_block_cpt_purchases', + 'items' => $oTemplate->parseHtmlByName('str_products.html', array( + 'list' => $this->displayProducts($aProducts), + 'paginate' => '' + )) + )) + )); + } + + protected function getUpdatesList() + { + $oTemplate = BxDolStudioTemplate::getInstance(); + + $aUpdates = $this->loadUpdates(); + return $oTemplate->parseHtmlByName('store.html', array( + 'js_object' => $this->getPageJsObject(), + 'content' => $this->getBlockCode(array( + 'caption' => '_adm_block_cpt_updates', + 'items' => $oTemplate->parseHtmlByName('str_products.html', array( + 'list' => $this->displayUpdates($aUpdates), + 'paginate' => '' + )) + )) + )); + } + + protected function getCheckoutList() + { + $sJsObject = $this->getPageJsObject(); + $oTemplate = BxDolStudioTemplate::getInstance(); + + //--- Empty cart by vendor if the payment was accepted. + $mixedVendor = bx_get('vendor'); + $mixedProducts = bx_get('products'); + if($mixedVendor !== false && $mixedProducts !== false) { + $oCart = BxDolStudioCart::getInstance(); + + $aProducts = explode(',', base64_decode($mixedProducts)); + foreach($aProducts as $iId) + $oCart->delete($mixedVendor, $iId); + + return $this->getMessage('_adm_block_cpt_checkout', '_adm_msg_modules_success_checkouted'); + } + + $aVendors = $this->loadCheckout(); + if(empty($aVendors)) + return $this->getMessage('_adm_block_cpt_checkout', '_Empty'); + + $sContent = ''; + foreach($aVendors as $iVendor => $aInfo) { + $fTotal = 0; + $sVendor = $sCurrency = ''; + if(!empty($aInfo['products']) && is_array($aInfo['products'])) + foreach($aInfo['products'] as $aProduct) { + $iCount = isset($aInfo['counts'][$aProduct['id']]) ? (int)$aInfo['counts'][$aProduct['id']] : 1; + $fTotal += $iCount * $aProduct['price_single']; + + if($sVendor == '' && isset($aProduct['author_name'])) + $sVendor = $aProduct['author_name']; + + if($sCurrency == '' && isset($aProduct['author_currency_sign'])) + $sCurrency = $aProduct['author_currency_sign']; + } + + $aMenu = array( + array('id' => 'checkout-' . $iVendor, 'name' => 'checkout-' . $iVendor, 'link' => 'javascript:void(0)', 'onclick' => $sJsObject . ".checkoutCart(" . $iVendor . ", this);", 'target' => '_self', 'title' => '_adm_action_cpt_checkout', 'active' => 1), + array('id' => 'delete-all-' . $iVendor, 'name' => 'delete-all-' . $iVendor, 'link' => 'javascript:void(0)', 'onclick' => $sJsObject . ".deleteAllFromCart(" . $iVendor . ", this)", 'target' => '_self', 'title' => '_adm_action_cpt_delete_all', 'active' => 1) + ); + $oMenu = new BxTemplMenu(array('object'=> 'adm-std-checkout', 'template' => 'menu_buttons_hor.html', 'menu_items' => $aMenu)); + + $sContent .= $this->getBlockCode(array( + 'caption' => _t('_adm_block_cpt_checkout_by_vendor_csign', $sVendor, $sCurrency, $fTotal), + 'items' => $oTemplate->parseHtmlByName('str_products.html', array( + 'list' => $this->displayProducts($aInfo['products'], array('is_shopping_cart' => true, 'counts' => $aInfo['counts'])), + 'paginate' => '' + )), + 'panel_bottom' => $oMenu->getCode() + )); + } + + return $oTemplate->parseHtmlByName('store.html', array( + 'js_object' => $sJsObject, + 'content' => $sContent + )); + } + + protected function getDownloadedList() + { + $sJsObject = $this->getPageJsObject(); + $oTemplate = BxDolStudioTemplate::getInstance(); + + $sContent = $sModules = $sUpdates = ""; + $aProducts = $this->loadDownloaded(); + + //--- Prepare modules. + $bCacheImage = getParam('sys_template_cache_image_enable') == 'on'; + foreach($aProducts['modules'] as $aModule) { + $sIcon = BxDolStudioUtils::getModuleIcon($aModule, 'store'); + $bIcon = ($bCacheImage && substr($sIcon, 0, 10) == 'data:image') || strpos($sIcon, '.') !== false; + + $bInstalled = $aModule['installed']; + $bQueued = !$bInstalled && $this->oDb->isQueued('action', $aModule['dir']); + + $sModules .= $oTemplate->parseHtmlByName('str_product_v1.html', array( + 'js_object' => $sJsObject, + 'name' => $aModule['name'], + 'bx_if:no_icon' => array ( + 'condition' => !$bIcon, + 'content' => array( + 'icon' => $sIcon + ), + ), + 'bx_if:icon' => array ( + 'condition' => $bIcon, + 'content' => array( + 'icon_url' => $sIcon, + ), + ), + 'title' => $aModule['title'], + 'vendor' => strtolower($aModule['vendor']) == 'boonex' ? 'UNA INC' : $aModule['vendor'], + 'version' => $aModule['version'], + 'dir' => $aModule['dir'], + 'bx_if:hide_install' => array( + 'condition' => $bInstalled || $bQueued, + 'content' => array() + ), + 'bx_if:hide_queued' => array( + 'condition' => !$bQueued, + 'content' => array() + ), + 'bx_if:hide_installed' => array( + 'condition' => !$bInstalled || $bQueued, + 'content' => array() + ) + )); + } + + //--- Prepare updates. + foreach($aProducts['updates'] as $aUpdate) { + $sIcon = BxDolStudioUtils::getModuleIcon(array('type' => $aUpdate['module_type'], 'name' => $aUpdate['module_name'], 'dir' => $aUpdate['module_dir']), 'store'); + $bIcon = ($bCacheImage && substr($sIcon, 0, 10) == 'data:image') || strpos($sIcon, '.') !== false; + + $sUpdates .= $oTemplate->parseHtmlByName('str_update_v1.html', array( + 'js_object' => $sJsObject, + 'name' => $aUpdate['module_name'], + 'bx_if:no_icon' => array ( + 'condition' => !$bIcon, + 'content' => array( + 'icon' => $sIcon + ), + ), + 'bx_if:icon' => array ( + 'condition' => $bIcon, + 'content' => array( + 'icon_url' => $sIcon, + ), + ), + 'title' => $aUpdate['title'], + 'vendor' => strtolower($aUpdate['vendor']) == 'boonex' ? 'UNA INC' : $aUpdate['vendor'], + 'versions' => _t('_adm_str_txt_update_from_to', $aUpdate['version_from'], $aUpdate['version_to']), + 'dir' => $aUpdate['dir'] + )); + } + + if(!empty($sModules)) + $sContent .= $this->getBlockCode(array( + 'type' => BX_DB_DEF, + 'caption' => '_adm_block_cpt_downloaded_modules', + 'items' => $oTemplate->parseHtmlByName('str_products.html', array( + 'list' => $sModules, + 'paginate' => '' + )), + )); + + if(!empty($sUpdates)) + $sContent .= $this->getBlockCode(array( + 'type' => BX_DB_DEF, + 'caption' => '_adm_block_cpt_downloaded_updates', + 'items' => $oTemplate->parseHtmlByName('str_products.html', array( + 'list' => $sUpdates, + 'paginate' => '' + )), + )); + + return $oTemplate->parseHtmlByName('store.html', array( + 'js_object' => $sJsObject, + 'content' => $sContent + )); + } + + protected function getMessage($sCaption, $sContent, $aActions = array()) + { + return BxDolStudioTemplate::getInstance()->parseHtmlByName('store.html', array( + 'js_object' => $this->getPageJsObject(), + 'content' => $this->getBlockCode(array( + 'caption' => $sCaption, + 'actions' => $aActions, + 'items' => MsgBox(_t($sContent)) + )) + )); + } + + protected function getProduct($sModuleName) + { + $bShowRating = true; + $sJsObject = $this->getPageJsObject(); + $oTemplate = BxDolStudioTemplate::getInstance(); + + $aProduct = $this->loadProduct($sModuleName); + if(empty($aProduct) || !is_array($aProduct)) + return array('code' => BX_DOL_STUDIO_IU_RC_FAILED, 'message' => (!empty($aProduct) ? $aProduct : _t('_adm_str_err_no_product_info'))); + + $aDownloaded = $this->getDownloadedModules(false); + + $bFree = (int)$aProduct['is_free'] == 1; + $bPurchased = (int)$aProduct['is_purchased'] == 1; + + $bPurchaseSingle = !$bFree && !$bPurchased && (float)$aProduct['price_single'] != 0; + $bInCart = $bPurchaseSingle && BxDolStudioCart::getInstance()->exists($aProduct['author_id'], $aProduct['id']); + + $bPurchaseRecurring = !$bFree && !$bPurchased && (float)$aProduct['price_recurring'] != 0; + + $bDownloadable = (int)$aProduct['is_file'] == 1; + $bDownloaded = array_key_exists($sModuleName, $aDownloaded); + $bDownload = ($bFree || $bPurchased) && $bDownloadable; + + $bDiscount = !empty($aProduct['discount_single']); + $sVersion = $bDownloaded && version_compare(strtolower($aDownloaded[$sModuleName]['version']), strtolower($aProduct['version'])) != 0 ? _t('_adm_str_txt_pv_version_mask', $aDownloaded[$sModuleName]['version'], $aProduct['version']) : $aProduct['version']; + + $iScreenshots = 0; + $aScreenshots = array(); + $bScreenshots = is_array($aProduct['screenshots']) && !empty($aProduct['screenshots']); + if($bScreenshots) { + $iScreenshots = count($aProduct['screenshots']); + foreach($aProduct['screenshots'] as $aScreenshot) + $aScreenshots[] = array( + 'view_url' => $aProduct['url'], + 'image_url' => $aScreenshot['big'] + ); + } + + $bTmplVarsRate = $bShowRating; + if($bTmplVarsRate) + $aTmplVarsRate = array( + 'rate' => $this->getVoteStars($aProduct) + ); + + $aTmplVarsVotes = array(); + $bTmplVarsVotes = $bShowRating && (int)$aProduct['votes_cnt'] > 0; + if($bTmplVarsVotes) + $aTmplVarsVotes = array( + 'count' => (int)$aProduct['votes_cnt'] + ); + + $sContent = $oTemplate->parseHtmlByname('str_product_view.html', array( + 'id' => $aProduct['id'], + 'title' => $aProduct['title'], + 'url' => $aProduct['url'], + 'author_name' => $aProduct['author_name'], + 'author_url' => $aProduct['author_url'], + 'version' => $sVersion, + 'bx_if:show_price_single' => array( + 'condition' => $bFree || (float)$aProduct['price_single'] != 0, + 'content' => array( + 'price_single' => !$bFree ? _t('_adm_str_txt_price_single', $aProduct['author_currency_sign'], $aProduct['price_single']) : _t('_adm_str_txt_price_free'), + 'bx_if:show_discount' => array( + 'condition' => !$bFree && $bDiscount, + 'content' => array( + 'discount_single' => $bDiscount ? _t('_adm_str_txt_pv_discount_off_csign', $aProduct['discount_single']['percent'], $aProduct['author_currency_sign'], $aProduct['discount_single']['save']) : '' + ) + ) + ) + ), + 'bx_if:show_price_recurring' => array( + 'condition' => (float)$aProduct['price_recurring'] != 0, + 'content' => array( + 'price_recurring' => _t('_adm_str_txt_price_recurring', $aProduct['author_currency_sign'], $aProduct['price_recurring'], _t('_adm_str_txt_per_' . $aProduct['duration_recurring'])) + ) + ), + 'bx_if:show_rate' => array( + 'condition' => $bTmplVarsRate, + 'content' => $aTmplVarsRate + ), + 'bx_if:show_votes' => array( + 'condition' => $bTmplVarsVotes, + 'content' => $aTmplVarsVotes + ), + 'category' => $aProduct['category'], + 'category_url' => $aProduct['category_url'], + 'tags' => implode(', ', explode(',', $aProduct['tags'])), + 'reviews' => _t('_adm_str_txt_pv_stats_reviews', $aProduct['reviews_cnt']), + 'reviews_url' => $aProduct['reviews_url'], + 'votes' => _t('_adm_str_txt_pv_stats_votes', $aProduct['votes_cnt']), + 'views' => _t('_adm_str_txt_pv_stats_views', $aProduct['views_cnt']), + 'created' => bx_time_js($aProduct['created']), + 'updated' => bx_time_js($aProduct['updated']), + 'description' => $aProduct['description'], + 'bx_if:show_screenshots' => array( + 'condition' => $bScreenshots, + 'content' => array( + 'width' => 222 * $iScreenshots - 20, + 'bx_repeat:screenshots' => $aScreenshots + ) + ), + 'bx_if:show_purchase' => array( + 'condition' => $bPurchaseSingle || $bPurchaseRecurring, + 'content' => array( + 'bx_if:show_purchase_single' => array( + 'condition' => $bPurchaseSingle && !$bInCart, + 'content' => array( + 'js_object' => $sJsObject, + 'id' => $aProduct['id'], + 'vendor_id' => $aProduct['author_id'], + 'price_single' => _t('_adm_str_txt_price_single', $aProduct['author_currency_sign'], $aProduct['price_single']) + ) + ), + 'bx_if:show_checkout_single' => array( + 'condition' => $bPurchaseSingle, + 'content' => array( + 'js_object' => $sJsObject, + 'id' => $aProduct['id'], + 'vendor_id' => $aProduct['author_id'], + 'bx_if:show_as_hidden' => array( + 'condition' => !$bInCart, + 'content' => array() + ) + ) + ), + 'bx_if:show_purchase_recurring' => array( + 'condition' => $bPurchaseRecurring, + 'content' => array( + 'js_object' => $sJsObject, + 'id' => $aProduct['id'], + 'vendor_id' => $aProduct['author_id'], + 'price_recurring' => _t('_adm_str_txt_price_recurring', $aProduct['author_currency_sign'], $aProduct['price_recurring'], _t('_adm_str_txt_per_' . $aProduct['duration_recurring'])) + ) + ) + ) + ), + 'bx_if:show_download' => array( + 'condition' => $bDownload && !$bDownloaded, + 'content' => array( + 'js_object' => $sJsObject, + 'file_id' => $aProduct['file_id'], + ) + ), + 'bx_if:show_download_disabled' => array( + 'condition' => $bDownload && $bDownloaded, + 'content' => array() + ), + )); + + return [ + 'code' => BX_DOL_STUDIO_IU_RC_SUCCESS, + 'message' => '', + 'popup' => BxTemplStudioFunctions::getInstance()->popupBox('bx-std-str-popup-product', $aProduct['title'], $sContent, true), + 'screenshots' => $iScreenshots + ]; + } + + protected function getFile($iFileId) + { + $mixedResult = $this->loadFile($iFileId); + if($mixedResult === true) + return array('code' => BX_DOL_STUDIO_IU_RC_SUCCESS, 'message' => _t('_adm_str_msg_download_successfully')); + + if(is_string($mixedResult)) + return array('code' => BX_DOL_STUDIO_IU_RC_FAILED, 'message' => (!empty($mixedResult) ? $mixedResult : _t('_adm_str_err_download_failed'))); + + if(is_array($mixedResult)) + return array_merge(array('code' => BX_DOL_STUDIO_IU_RC_FAILED, 'message' => _t('_adm_str_err_download_failed')), $mixedResult); + } + + protected function getUpdate($sModuleName, $bApplyUpdate = false) + { + $aResult = array(); + + $mixedResult = $this->loadUpdate($sModuleName, $bApplyUpdate); + if($mixedResult === true) + $aResult = array('code' => BX_DOL_STUDIO_IU_RC_SUCCESS, 'message' => _t('_adm_str_msg_download' . ($bApplyUpdate ? '_and_install' : '') . '_successfully')); + else if(is_string($mixedResult)) + $aResult = array('code' => BX_DOL_STUDIO_IU_RC_FAILED, 'message' => (!empty($mixedResult) ? $mixedResult : _t('_adm_str_err_download_failed'))); + else if(is_array($mixedResult)) + $aResult = array_merge(array('code' => BX_DOL_STUDIO_IU_RC_FAILED, 'message' => _t('_adm_str_err_download_failed')), $mixedResult); + + $aResult['reload'] = 3000; + return $aResult; + } + + protected function displayProducts($mixedItems, $aParams = array()) + { + $bShowRating = false; + + if(!is_array($mixedItems)) + return MsgBox($mixedItems); + + $sJsObject = $this->getPageJsObject(); + $oTemplate = BxDolStudioTemplate::getInstance(); + + $aDownloaded = $this->getDownloadedModules(); + $bShoppingCart = isset($aParams['is_shopping_cart']) && $aParams['is_shopping_cart']; + + $sResult = ''; + foreach($mixedItems as $aItem) { + $bFree = (int)$aItem['is_free'] == 1; + $bPurchased = (int)$aItem['is_purchased'] == 1; + + $bPurchaseSingle = !$bShoppingCart && !$bFree && !$bPurchased && (float)$aItem['price_single'] != 0; + $bInCart = $bPurchaseSingle && BxDolStudioCart::getInstance()->exists($aItem['author_id'], $aItem['id']); + + $bPurchaseRecurring = !$bShoppingCart && !$bFree && !$bPurchased && (float)$aItem['price_recurring'] != 0; + + $bDownloadable = (int)$aItem['is_file'] == 1; + $bDownloaded = in_array($aItem['name'], $aDownloaded); + $bDownload = !$bShoppingCart && ($bFree || $bPurchased) && $bDownloadable; + $bQueued = $this->oDb->isQueued('download', $aItem['name']); + + $sPrice = !$bFree ? _t('_adm_str_txt_price_single', $aItem['author_currency_sign'], $aItem['price_single']) : _t('_adm_str_txt_price_free'); + $sDiscount = !$bFree && !empty($aItem['discount_single']) ? _t('_adm_str_txt_discount_csign', $aItem['author_currency_sign'], $aItem['discount_single']['price']) : ''; + + $sIcon = !empty($aItem['thumbnail']['small']) ? $aItem['thumbnail']['small'] : BxDolStudioUtils::getIconDefault(BX_DOL_MODULE_TYPE_MODULE); + $bIcon = strpos($sIcon, '.') !== false; + + $sImage = ''; + $bImage = $bImageRaw = false; + if(empty($aItem['cover_raw'])) { + if(!empty($aItem['cover']['medium'])) + $sImage = $aItem['cover']['medium']; + else if(!empty($aItem['cover']['large'])) + $sImage = $aItem['cover']['large']; + else if(!empty($aItem['cover']['big'])) + $sImage = $aItem['cover']['big']; + + $bImage = !empty($sImage) && strpos($sImage, '.') !== false; + } + else { + $sImage = $aItem['cover_raw']; + $bImageRaw = true; + } + + $aTmplVarsRate = array(); + $bTmplVarsRate = $bShowRating && !$bShoppingCart; + if($bTmplVarsRate) + $aTmplVarsRate = array( + 'rate' => $this->getVoteStars($aItem) + ); + + $aTmplVarsVotes = array(); + $bTmplVarsVotes = $bShowRating && !$bShoppingCart && (int)$aItem['votes_cnt'] > 0; + if($bTmplVarsVotes) + $aTmplVarsVotes = array( + 'count' => (int)$aItem['votes_cnt'] + ); + + $sResult .= $oTemplate->parseHtmlByName('str_product_v2.html', array( + 'js_object' => $sJsObject, + 'id' => $aItem['id'], + 'name' => $aItem['name'], + 'url' => $aItem['url'], + 'description_plain_attr' => bx_html_attribute($aItem['description_plain']), + 'bx_if:no_icon' => array ( + 'condition' => !$bIcon, + 'content' => array( + 'icon' => $sIcon + ), + ), + 'bx_if:icon' => array ( + 'condition' => $bIcon, + 'content' => array( + 'icon_url' => $sIcon, + ), + ), + 'bx_if:no_image' => array ( + 'condition' => !$bImage && !$bImageRaw, + 'content' => array( + 'description_plain' => $aItem['description_plain'], + 'strecher' => mb_strlen($aItem['description_plain']) > 240 ? '' : str_repeat(' ', round((240 - mb_strlen($aItem['description_plain'])) / 6)) + ), + ), + 'bx_if:image' => array ( + 'condition' => $bImage, + 'content' => array( + 'image_url' => $sImage, + 'strecher' => str_repeat(' ', 40) + ), + ), + 'bx_if:image_raw' => array ( + 'condition' => $bImageRaw, + 'content' => array( + 'image_raw' => $sImage, + ), + ), + 'title' => $aItem['title'], + 'bx_if:show_vendor' => array( + 'condition' => !$bShoppingCart, + 'content' => array( + 'vendor_name' => $aItem['author_name'], + 'vendor_url' => $aItem['author_url'], + 'bx_if:show_version' => array( + 'condition' => !empty($aItem['file_version']), + 'content' => array( + 'version' => $aItem['file_version'], + ) + ), + ) + ), + 'bx_if:show_count_price' => array( + 'condition' => $bShoppingCart, + 'content' => array( + 'count' => isset($aParams['counts'][$aItem['id']]) ? (int)$aParams['counts'][$aItem['id']] : 1, + 'price_single' => $sPrice, + 'discount_single' => $sDiscount, + ) + ), + 'bx_if:show_rate' => array( + 'condition' => $bTmplVarsRate, + 'content' => $aTmplVarsRate + ), + 'bx_if:show_votes' => array( + 'condition' => $bTmplVarsVotes, + 'content' => $aTmplVarsVotes + ), + 'bx_if:show_purchase_single' => array( + 'condition' => $bPurchaseSingle && !$bInCart, + 'content' => array( + 'js_object' => $sJsObject, + 'id' => $aItem['id'], + 'vendor_id' => $aItem['author_id'], + 'price_single' => _t('_adm_str_txt_price_single', $aItem['author_currency_sign'], $aItem['price_single']) + ) + ), + 'bx_if:show_checkout_single' => array( + 'condition' => $bPurchaseSingle, + 'content' => array( + 'js_object' => $sJsObject, + 'id' => $aItem['id'], + 'vendor_id' => $aItem['author_id'], + 'bx_if:show_as_hidden' => array( + 'condition' => !$bInCart, + 'content' => array() + ) + ) + ), + 'bx_if:show_purchase_recurring' => array( + 'condition' => $bPurchaseRecurring, + 'content' => array( + 'js_object' => $sJsObject, + 'id' => $aItem['id'], + 'vendor_id' => $aItem['author_id'], + 'price_recurring' => _t('_adm_str_txt_price_recurring', $aItem['author_currency_sign'], $aItem['price_recurring'], _t('_adm_str_txt_per_' . $aItem['duration_recurring'] . '_short')) + ) + ), + 'bx_if:show_download' => array( + 'condition' => $bDownload && !$bQueued && !$bDownloaded, + 'content' => array( + 'js_object' => $sJsObject, + 'file_id' => $aItem['file_id'] + ) + ), + 'bx_if:show_download_disabled' => array( + 'condition' => $bDownload && !$bQueued && $bDownloaded, + 'content' => array() + ), + 'bx_if:show_queued_disabled' => array( + 'condition' => $bDownload && $bQueued && !$bDownloaded, + 'content' => array() + ), + 'bx_if:show_delete' => array( + 'condition' => $bShoppingCart, + 'content' => array( + 'js_object' => $sJsObject, + 'id' => $aItem['id'], + 'vendor_id' => $aItem['author_id'] + ) + ) + )); + } + + return $sResult; + } + + protected function displayUpdates($mixedItems, $aParams = array()) + { + if(!is_array($mixedItems)) + return MsgBox($mixedItems); + + if(empty($mixedItems)) + return MsgBox(_t('_Empty')); + + $sJsObject = $this->getPageJsObject(); + $oTemplate = BxDolStudioTemplate::getInstance(); + + $sResult = ''; + foreach($mixedItems as $aItem) { + $bDownloadable = (int)$aItem['is_file'] == 1; + $bQueued = $this->oDb->isQueued('download', $aItem['name']); + + $sIcon = !empty($aItem['thumbnail']['big']) ? $aItem['thumbnail']['big'] : BxDolStudioUtils::getIconDefault(BX_DOL_MODULE_TYPE_MODULE); + $bIcon = strpos($sIcon, '.') !== false; + + $sImage = !empty($aItem['cover']['big']) ? $aItem['cover']['big'] : ''; + $bImage = strpos($sImage, '.') !== false; + + $sResult .= $oTemplate->parseHtmlByName('str_update_v2.html', array( + 'js_object' => $sJsObject, + 'id' => $aItem['id'], + 'name' => $aItem['name'], + 'url' => $aItem['url'], + 'bx_if:no_icon' => array ( + 'condition' => !$bIcon, + 'content' => array( + 'icon' => $sIcon + ), + ), + 'bx_if:icon' => array ( + 'condition' => $bIcon, + 'content' => array( + 'icon_url' => $sIcon, + ), + ), + 'bx_if:no_image' => array ( + 'condition' => !$bImage, + 'content' => array( + 'note' => $aItem['description_plain'], + 'strecher' => mb_strlen($aItem['description_plain']) > 240 ? '' : str_repeat(' ', round((240 - mb_strlen($aItem['description_plain'])) / 6)) + ), + ), + 'bx_if:image' => array ( + 'condition' => $bImage, + 'content' => array( + 'image_url' => $sImage, + 'strecher' => str_repeat(' ', 40) + ), + ), + 'title' => $aItem['title'], + 'vendor' => $aItem['author_name'], + 'versions' => _t('_adm_str_txt_update_from_to', $aItem['file_version'], $aItem['file_version_to']), + 'bx_if:show_download' => array( + 'condition' => $bDownloadable && !$bQueued, + 'content' => array( + 'caption' => _t('_adm_btn_install_submit'), + 'on_click' => $sJsObject . ".getUpdateAndInstall('" . $aItem['name'] . "', this)" + ) + ), + 'bx_if:show_queued_disabled' => array( + 'condition' => $bDownloadable && $bQueued, + 'content' => array() + ) + )); + } + + return $sResult; + } + + protected function displayCategories($aCategories) + { + foreach($aCategories['bx_repeat:cats'] as $iKey => $aItem) + $aCategories['bx_repeat:cats'][$iKey]['url'] = $this->getBaseUrl(array('page' => 'category', 'value' => $aItem['value'], 'title' => urlencode($aItem['name']))); + + return BxDolStudioTemplate::getInstance()->parseHtmlByName('str_lbl_categories.html', $aCategories); + } + + protected function displayTags($aTags) + { + foreach($aTags['bx_repeat:units'] as $iKey => $aItem) + $aTags['bx_repeat:units'][$iKey]['href'] = $this->getBaseUrl(array('page' => 'tag', 'value' => $aItem['keyword'])); + + return BxDolStudioTemplate::getInstance()->parseHtmlByName('str_lbl_tags.html', $aTags); + } + + protected function displayNonOwnerNotification() + { + if(BxDolStudioOAuth::isAuthorizedOwner()) + return; + + $oSession = BxDolSession::getInstance(); + if($oSession->getValue($this->sSessionKeyNonOwnerNotified) === true) + return; + + $oSession->setValue($this->sSessionKeyNonOwnerNotified, true); + return $this->getJsResultBy(array( + 'message' => '_adm_msg_oauth_non_owner_logged', + 'translate' => array(BX_DOL_MARKET_URL_ROOT), + 'on_page_load' => true + )); + } + + private function getDownloadedModules($bNamesOnly = true) + { + $aModules = BxDolStudioInstallerUtils::getInstance()->getModules(false); + + return $bNamesOnly ? array_keys($aModules) : $aModules; + } + + private function getVoteStars($aItem) + { + $aTmplVarsStars = array(); + for($i = (int)$aItem['rate_min']; $i <= (int)$aItem['rate_max']; $i++) + $aTmplVarsStars[] = array('value' => $i); + + return BxDolStudioTemplate::getInstance()->parseHtmlByName('str_vote_stars.html', array( + 'id' => $aItem['id'], + 'value' => (float)$aItem['rate'], + 'bx_repeat:stars' => $aTmplVarsStars, + 'bx_repeat:slider' => $aTmplVarsStars, + )); + } +} + +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/scripts/BxBaseStudioWidget.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/scripts/BxBaseStudioWidget.php new file mode 100644 index 0000000000..da1d5dc531 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/scripts/BxBaseStudioWidget.php @@ -0,0 +1,331 @@ +aPageCodeNoWrap = array(); + } + + public function getPageCss() + { + return array_merge(parent::getPageCss(), array( + 'launcher.css' + )); + } + + public function getPageJs() + { + return array_merge(parent::getPageJs(), array( + 'launcher.js' + )); + } + + public function getPageCaption() + { + if(empty($this->aPage) || !is_array($this->aPage)) + return ''; + + $sResult = parent::getPageCaption(); + + $this->updateHistory(); + + $oTemplate = BxDolStudioTemplate::getInstance(); + $oFunctions = BxTemplStudioFunctions::getInstance(); + + $bActions = false; + $sActions = $this->getPageCaptionActions(); + if(($bActions = strlen($sActions)) > 0) + $sActions = $oFunctions->transBox('bx-std-pcap-menu-popup-actions', $sActions, true); + + $bHelp = false; + $sHelp = $this->getPageCaptionHelp(); + if(($bHelp = strlen($sHelp)) > 0) + $sHelp = $oFunctions->transBox('bx-std-pcap-menu-popup-help', $sHelp, true); + + $oTemplate->addInjection('injection_header', 'text', $sActions . $sHelp); + + //--- Menu Right ---// + $aItemsRight = []; + + if($bHelp) + $aItemsRight['help'] = [ + 'name' => 'help', + 'icon' => 'tmi-help.svg', + 'onclick' => BX_DOL_STUDIO_PAGE_JS_OBJECT . ".togglePopup('help', this)", + 'title' => '_adm_txt_show_help' + ]; + + if($this->_bShowHeaderRightAssistant) + $aItemsRight['assistant'] = [ + 'name' => 'assistant', + 'icon' => 'tmi-assistant.svg', + 'link' => 'javascript:void(0);', + 'onclick' => BX_DOL_STUDIO_PAGE_JS_OBJECT . ".togglePopup('assistant', this)", + 'title' => '_adm_tmi_cpt_assistant' + ]; + + if($bActions) + $aItemsRight['actions'] = [ + 'name' => 'actions', + 'icon' => 'tmi-actions.svg', + 'onclick' => BX_DOL_STUDIO_PAGE_JS_OBJECT . ".togglePopup('actions', this)", + 'title' => '_adm_txt_show_actions' + ]; + + if($this->_bShowHeaderRightSite) + $aItemsRight['site'] = [ + 'name' => 'site', + 'icon' => 'tmi-site.svg', + 'link' => '{url_root}', + 'title' => '_adm_tmi_cpt_site' + ]; + + $aItemsRight['account'] = [ + 'name' => 'account', + 'icon' => 'tmi-account.svg', + 'link' => 'javascript:void(0);', + 'onclick' => 'bx_menu_popup_inline(\'#bx-std-pcap-menu-popup-account\', this);', + 'title' => '_adm_tmi_cpt_account' + ]; + + $oTopMenu = BxTemplStudioMenuTop::getInstance(); + $oTopMenu->setPageName($this->aPage['name']); + $oTopMenu->setContent(BX_DOL_STUDIO_MT_LEFT, $this->getPageBreadcrumb()); + $oTopMenu->setSelected(BX_DOL_STUDIO_MT_CENTER, $this->aPage['name']); + $oTopMenu->setContent(BX_DOL_STUDIO_MT_RIGHT, array( + 'template' => 'menu_top_toolbar.html', + 'menu_items' => $aItemsRight + )); + + return $sResult; + } + + public function getPageCode($sPage = '', $bWrap = true) + { + $sResult = parent::getPageCode($sPage, $bWrap); + if($sResult === false) + return false; + + if(!empty($this->aPage['wid_type']) && !BxDolStudioRolesUtils::getInstance()->isActionAllowed('use ' . $this->aPage['wid_type'])) { + $this->setError('_Access denied'); + return false; + } + + if(empty($sPage)) + $sPage = $this->sPage; + + $sMethod = 'get' . bx_gen_method_name($sPage); + if(method_exists($this, $sMethod)) { + $mixedContent = $this->$sMethod(); + if(!$bWrap || in_array($sPage, $this->aPageCodeNoWrap)) + $sResult .= $mixedContent; + else if(is_string($mixedContent)) + $sResult .= $this->getBlockCode(array( + 'content' => $mixedContent + )); + else if(is_array($mixedContent)) + foreach($mixedContent as $sBlock) + $sResult .= $this->getBlockCode(array( + 'content' => $sBlock + )); + else if(is_a($mixedContent, 'BxDolPage')) + $sResult .= $mixedContent->getCode(); + } + + return $sResult . BxTemplStudioLauncher::getInstance()->getPageJsCode(array( + 'bInit' => false + )); + } + + + /** + * Block related methods + */ + public function getBlocksLine($aBlocks) + { + $aTmplVarsBlocks = array(); + foreach ($aBlocks as $aBlock) { + $aTmplVarsBlocks[] = array( + 'content' => $this->getBlockCode($aBlock) + ); + } + + return BxDolStudioTemplate::getInstance()->parseHtmlByName('page_blocks_line.html', array( + 'count' => count($aTmplVarsBlocks), + 'bx_repeat:blocks' => $aTmplVarsBlocks + )); + } + public function getBlockCode($aBlock) + { + $aTypeI2S = [ + BX_DB_CONTENT_ONLY => 'cnt', + BX_DB_DEF => 'cnt-ttl-bg bg-white rounded-2xl', + BX_DB_NO_CAPTION => 'cnt-bg bg-white rounded-2xl' + ]; + $iType = isset($aBlock['type'], $aTypeI2S[$aBlock['type']]) ? $aBlock['type'] : BX_DB_NO_CAPTION; + + $sContent = ''; + if(!empty($aBlock['content'])) + $sContent = $aBlock['content']; + else if(!empty($aBlock['items'])) + $sContent = $aBlock['items']; + + return BxDolStudioTemplate::getInstance()->parseHtmlByName('page_block.html', array( + 'type' => $aTypeI2S[$iType], + 'caption' => !in_array($iType, [BX_DB_CONTENT_ONLY, BX_DB_NO_CAPTION]) ? $this->getBlockCaption($aBlock) : '', + 'panel_top' => $this->getBlockPanelTop($aBlock), + 'items' => $sContent, + 'panel_bottom' => $this->getBlockPanelBottom($aBlock) + )); + } + + public function getBlockCaption($aBlock) + { + if(empty($aBlock) || !is_array($aBlock) || (empty($aBlock['caption']) && empty($aBlock['actions']))) + return ''; + + $aTmplActions = array(); + if(!empty($aBlock['actions']) && is_array($aBlock['actions'])) + foreach($aBlock['actions'] as $aAction) { + $sCaption = is_array($aAction['caption']) ? call_user_func_array('_t', $aAction['caption']) : _t($aAction['caption']); + + $bOnClick = !empty($aAction['onclick']); + $aOnClick = $bOnClick ? array('onclick' => $aAction['onclick']) : array(); + + $aTmplActions[] = array( + 'name' => $aAction['name'], + 'url' => $aAction['url'], + 'title' => $sCaption, + 'bx_if:show_onclick' => array( + 'condition' => $bOnClick, + 'content' => $aOnClick + ), + 'caption' => $sCaption + ); + } + + return BxDolStudioTemplate::getInstance()->parseHtmlByName('block_caption.html', array( + 'caption' => is_array($aBlock['caption']) ? call_user_func_array('_t', $aBlock['caption']) : _t($aBlock['caption']), + 'bx_if:show_actions' => array( + 'condition' => !empty($aTmplActions), + 'content' => array( + 'bx_repeat:actions' => $aTmplActions + ) + ), + )); + } + + public function getBlockPanelTop($aBlock) + { + if(empty($aBlock) || !is_array($aBlock) || empty($aBlock['panel_top'])) + return ''; + + return BxDolStudioTemplate::getInstance()->parseHtmlByName('block_panel_top.html', array( + 'content' => $aBlock['panel_top'] + )); + } + + public function getBlockPanelBottom($aBlock) + { + if(empty($aBlock) || !is_array($aBlock) || empty($aBlock['panel_bottom'])) + return ''; + + return BxDolStudioTemplate::getInstance()->parseHtmlByName('block_panel_bottom.html', array( + 'content' => $aBlock['panel_bottom'] + )); + } + + + /** + * Internal methods. + */ + protected function getPageCaptionActions() + { + $sActions = $this->getPageActions(); + if(empty($sActions)) + return ""; + + return BxDolStudioTemplate::getInstance()->parseHtmlByName('page_caption_actions.html', array( + 'content' => $sActions + )); + } + + protected function getPageActions($iWidgetId = 0) + { + if(empty($this->aActions)) + return ""; + + $aMarkers = array( + 'widget_id' => $iWidgetId, + ); + + if(!empty($iWidgetId)) { + $aWidget = BxDolStudioWidgetsQuery::getInstance()->getWidgets(array('type' => 'by_id', 'value' => $iWidgetId)); + if(!empty($aWidget) && is_array($aWidget)) + $aMarkers['widget_type'] = $aWidget['type']; + } + + $aForm = array( + 'form_attrs' => array( + 'id' => 'adm-page-actions', + 'name' => 'adm-page-actions', + 'action' => '', + 'method' => 'post', + ), + 'params' => array(), + 'inputs' => array() + ); + + foreach($this->aActions as $aAction) { + if($aAction['name'] == 'rearrange' && (empty($iWidgetId) || getParam('sys_std_show_launcher_left') != 'on')) + continue; + + $aInput = array( + 'type' => $aAction['type'], + 'name' => $aAction['name'], + 'caption' => _t($aAction['caption']) + ); + + switch($aAction['type']) { + case 'switcher': + $aInput['checked'] = $aAction['checked']; + $aInput['attrs']['onchange'] = bx_replace_markers($aAction['onchange'], $aMarkers); + break; + + case 'select': + $aInput['value'] = bx_replace_markers($aAction['value'], $aMarkers); + $aInput['values'] = $aAction['values']; + $aInput['attrs']['onchange'] = bx_replace_markers($aAction['onchange'], $aMarkers); + break; + } + + $aForm['inputs'][$aInput['name']] = $aInput; + } + + $oForm = new BxTemplStudioFormView($aForm); + return $oForm->getCode(); + } + + protected function getPageMenuObject($aMenu = array(), $aMarkers = array()) + { + $oMenu = parent::getPageMenuObject($aMenu, $aMarkers); + $oMenu->setInlineIcons(false); + + return $oMenu; + } +} + +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/scripts/BxBaseStudioWidgets.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/scripts/BxBaseStudioWidgets.php new file mode 100644 index 0000000000..edf7fcb70f --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/scripts/BxBaseStudioWidgets.php @@ -0,0 +1,158 @@ + $aType) { + if(!$oUtils->isActionAllowed('use ' . $sName, $iAccountId)) + continue; + + $aTypeData = unserialize($aType['Data']); + + $aMenuItems[] = array( + 'name' => $sName, + 'title' => _t($aType['LKey']), + 'link' => bx_append_url_params($this->sPageUrl, array( + 'type' => $sName + )), + 'icon' => !empty($aTypeData['icon']) ? $aTypeData['icon'] : '', + 'selected' => $sName == $this->_sType + ); + } + + return parent::getPageMenu($aMenuItems); + } + + public function getPageCode($sPage = '', $bWrap = true) + { + $sResult = parent::getPageCode($sPage, $bWrap); + if($sResult === false) + return false; + + $aWidgetsParams = array( + 'featured' => $this->isFeatured(), + 'notices' => $this->aWidgetsNotices + ); + + if(!$this->bPageMultiple) + return $this->wrapWidgets($this->aPage['name'], $this->getWidgets($this->aPage['name'], $this->aWidgets, $aWidgetsParams)); + + $sContent = ""; + foreach($this->aWidgets as $sPage => $aWidgets) + $sContent .= $this->wrapWidgets($sPage, $this->getWidgets($sPage, $aWidgets, $aWidgetsParams), $sPage != $this->sPageSelected); + + return $sContent; + } + + public function getPageCaption() + { + if(empty($this->aPage) || !is_array($this->aPage)) + return ''; + + $sResult = parent::getPageCaption(); + + //--- Menu Right ---// + $aItemsRight = array( + 'template' => 'menu_top_toolbar.html', + 'menu_items' => array( + 'tour' => array( + 'name' => 'tour', + 'icon' => 'tmi-help.svg', + 'link' => 'javascript:void(0);', + 'onclick' => 'glTour.start()', + 'title' => '_adm_tmi_cpt_tour' + ), + 'assistant' => array( + 'name' => 'assistant', + 'icon' => 'tmi-assistant.svg', + 'link' => 'javascript:void(0);', + 'onclick' => BX_DOL_STUDIO_PAGE_JS_OBJECT . ".togglePopup('assistant', this)", + 'title' => '_adm_tmi_cpt_assistant' + ), + 'site' => array( + 'name' => 'site', + 'icon' => 'tmi-site.svg', + 'link' => '{url_root}', + 'title' => '_adm_tmi_cpt_site' + ), + 'account' => array( + 'name' => 'account', + 'icon' => 'tmi-account.svg', + 'link' => 'javascript:void(0);', + 'onclick' => 'bx_menu_popup_inline(\'#bx-std-pcap-menu-popup-account\', this);', + 'title' => '_adm_tmi_cpt_account' + ) + ) + ); + + if(!$this->_bShowHeaderRightSite) + unset($aItemsRight['menu_items']['site']); + + if(!$this->_bShowHeaderRightAssistant) + unset($aItemsRight['menu_items']['assistant']); + + if($this->_sType != BX_DOL_STUDIO_WTYPE_DEFAULT || getParam('site_tour_studio') != 'on') + unset($aItemsRight['menu_items']['tour']); + + $oTopMenu = BxTemplStudioMenuTop::getInstance(); + $oTopMenu->setPageName($this->aPage['name']); + $oTopMenu->setContent(BX_DOL_STUDIO_MT_LEFT, $this->getPageBreadcrumb()); + $oTopMenu->setContent(BX_DOL_STUDIO_MT_RIGHT, $aItemsRight); + + return $sResult; + } + + protected function wrapWidgets($sName, $sContent, $bHidden = false) + { + return BxDolStudioTemplate::getInstance()->parseHtmlByName('widgets_page.html', array( + 'page' => $sName, + 'bx_if:page_hidden' => array( + 'condition' => $bHidden, + 'content' => array() + ), + 'content' => $sContent + )); + } + + protected function getWidgets($sPage, $aWidgets, $aParams = array()) + { + $oFunction = BxTemplStudioFunctions::getInstance(); + + $aTmplVars = array(); + foreach($aWidgets as $aWidget) { + $sWidget = $oFunction->getWidget($aWidget, $aParams); + if(empty($sWidget)) + continue; + + $aTmplVars[] = array( + 'widget' => $sWidget, + ); + } + + return BxDolStudioTemplate::getInstance()->parseHtmlByName('widgets.html', array( + 'bx_repeat:widgets' => $aTmplVars + )); + } +} + +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/scripts_templ/BxTemplStudioAgentsAssistants.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/scripts_templ/BxTemplStudioAgentsAssistants.php new file mode 100644 index 0000000000..b4f2b993cc --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/studio/template/scripts_templ/BxTemplStudioAgentsAssistants.php @@ -0,0 +1,19 @@ + + + + + + + + + + + + __strecher__ + + + + + __image_raw__ + + + + + + + + + + + + + + + + + + + + + + __title__ + + + + __vendor_name__ + + + __count__ __price_single__ __discount_single__ + + • __rate__ + __count__ + + + + + + + + + + + + + + + + + + + + + + + __price_single__ + + + style="display:none;"> + + + + __price_recurring__ + + + + + + \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/_page_toolbar.html b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/_page_toolbar.html new file mode 100644 index 0000000000..2d1469390f --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/_page_toolbar.html @@ -0,0 +1,36 @@ + + + + + + + + + + + + + + + __main_logo__ + + + + + + + + + + + __sys_toolbar_search__ + + + + + + + + + + \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/_page_toolbar_search.html b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/_page_toolbar_search.html new file mode 100644 index 0000000000..2af06f834a --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/_page_toolbar_search.html @@ -0,0 +1,12 @@ + + __sys_site_search__ + + + + + + + + + + diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/agents_comment_content.html b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/agents_comment_content.html new file mode 100644 index 0000000000..65fd2e4abd --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/agents_comment_content.html @@ -0,0 +1,8 @@ + + __text__ + + + + __attached__ + +__counters__ \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/agents_form.html b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/agents_form.html new file mode 100644 index 0000000000..408f575c8a --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/agents_form.html @@ -0,0 +1,24 @@ + + + __form__ + + + \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/agents_popup.html b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/agents_popup.html new file mode 100644 index 0000000000..348ddd2ceb --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/agents_popup.html @@ -0,0 +1,3 @@ + + __content__ + \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/block_join.html b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/block_join.html new file mode 100644 index 0000000000..ef31505ad8 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/block_join.html @@ -0,0 +1,14 @@ + + __content__ + __content__ + + + + + + + + + __agreement__ + + \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/block_login.html b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/block_login.html new file mode 100644 index 0000000000..c73ef46eea --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/block_login.html @@ -0,0 +1,34 @@ + + __custom_html_before__ + __content__ + __content__ + __custom_html_after__ + + + + + + + + + __agreement__ + + + + + \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/category_list_multi.html b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/category_list_multi.html new file mode 100644 index 0000000000..965a0f23a5 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/category_list_multi.html @@ -0,0 +1,5 @@ + + + __name__ (__num__) + + \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/css/_mixins.less b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/css/_mixins.less new file mode 100644 index 0000000000..053408a604 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/css/_mixins.less @@ -0,0 +1,75 @@ +@import '_remixins.less'; + +.radius(@val) { + @rem-val: (unit(@val) / @base-font-size-px); + border-radius:~"@{rem-val}rem"; + background-clip: padding-box; +} + +.border (@width: 1px, @type: solid, @color: #ccc) { + @rem-w: (unit(@width) / @base-font-size-px); + border: ~"@{width} @{type} @{color}"; + border: ~"@{rem-w}rem @{type} @{color}"; +} +.border-top (@width: 1px, @type: solid, @color: #ccc) { + @rem-w: (unit(@width) / @base-font-size-px); + border-top: ~"@{width} @{type} @{color}"; + border-top: ~"@{rem-w}rem @{type} @{color}"; +} +.border-bottom (@width: 1px, @type: solid, @color: #ccc) { + @rem-w: (unit(@width) / @base-font-size-px); + border-bottom: ~"@{width} @{type} @{color}"; + border-bottom: ~"@{rem-w}rem @{type} @{color}"; +} +.border-left (@width: 1px, @type: solid, @color: #ccc) { + @rem-w: (unit(@width) / @base-font-size-px); + border-left: ~"@{width} @{type} @{color}"; + border-left: ~"@{rem-w}rem @{type} @{color}"; +} +.border-right (@width: 1px, @type: solid, @color: #ccc) { + @rem-w: (unit(@width) / @base-font-size-px); + border-right: ~"@{width} @{type} @{color}"; + border-right: ~"@{rem-w}rem @{type} @{color}"; +} + +.drop-shadow (@x: 0px, @y: 1px, @blur: 2px, @spread: 0px, @color: rgba(0, 0, 0, .25)) { + @rem-x: (unit(@x) / @base-font-size-px); + @rem-y: (unit(@y) / @base-font-size-px); + @rem-b: (unit(@blur) / @base-font-size-px); + @rem-s: (unit(@spread) / @base-font-size-px); + -webkit-box-shadow: ~"@{rem-x}rem @{rem-y}rem @{rem-b}rem @{rem-s}rem @{color}"; + -moz-box-shadow: ~"@{rem-x}rem @{rem-y}rem @{rem-b}rem @{rem-s}rem @{color}"; + box-shadow: ~"@{rem-x}rem @{rem-y}rem @{rem-b}rem @{rem-s}rem @{color}"; +} + +.box-sizing (@type: border-box) { + -webkit-box-sizing: @type; + -moz-box-sizing: @type; + -ms-box-sizing: @type; + box-sizing: @type; +} + +.background-color (@color) { + background-color: @color; +} +.column-width (@width) { + @rem-w: (unit(@width) / @base-font-size-px); + -webkit-column-width: ~"@{rem-w}rem"; + -moz-column-width: ~"@{rem-w}rem"; + -ms-column-width: ~"@{rem-w}rem"; + column-width: ~"@{rem-w}rem"; +} +.column-width-raw (@width) { + -webkit-column-width: @width; + -moz-column-width: @width; + -ms-column-width: @width; + column-width: @width; +} + +.blur(@val) { + -webkit-filter: blur(@val); + -moz-filter: blur(@val); + -o-filter: blur(@val); + -ms-filter: blur(@val); + filter: blur(@val); +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/css/common.css b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/css/common.css new file mode 100644 index 0000000000..b546e188a1 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/css/common.css @@ -0,0 +1,963 @@ +* { + -webkit-font-smoothing: antialiased; + -webkit-text-size-adjust: 100%; + -moz-text-size-adjust: 100%; + -ms-text-size-adjust: 100%; + text-size-adjust: 100%; +} + +a { + text-decoration:none; + outline:none; + color:#3e8685; /* 26.13.13: prev val #387877; */ +} + +a:hover { + text-decoration:none; +} + +a > img { + border:none; +} + +html { + height:100%; +} +/*-- Tailwind overwrite --*/ +html.hidden { + display: block !important; +} +body { + min-height: 100%; + min-height: 100vh; + padding: 0; + margin: 0; +} + +blockquote { + /* NOTE: this style was copied to editor.css */ + border-left: 2px solid #ccc; + padding-left: 10px; +} + +.bx-tl-content pre, +.bx-base-text-entity-content pre, +.bx-content-description pre, +.cmt-body pre { + /* NOTE: this style was copied to editor.css */ + padding: 5px; + border: 1px solid green; + background-color: white; + color: #009900; + display: block; + margin: 0; + overflow-x: auto; +} + +.bx-main { + position: relative; + display: -webkit-flex; + display: flex; + -webkit-flex-direction: column; + flex-direction: column; + min-height: 100%; + min-height: 100vh; +} + +/*-- Application mode: Sidebar --*/ +.bx-main.bx-pt-application .bx-main-column .bx-menu-panel .bx-def-thumb-size { + width: 2rem; + height: 2rem; +} +.bx-main.bx-pt-application .bx-main-column.narrow.bx-mc-narrowed .bx-menu-panel .bx-profile-avatar-cnt { + -webkit-justify-content:center; + justify-content:center; +} +.bx-main.bx-pt-application .bx-main-column.narrow.bx-mc-narrowed .bx-mc-cnt { + padding-left: 0; + padding-right: 0; +} + +/*-- Application mode: Toolbar --*/ +.bx-main.bx-pt-application .bx-toolbar-content { + position: relative; + display: -webkit-flex; + display: flex; + -webkit-align-items: center; + align-items: center; +} +.bx-main.bx-pt-application .bx-toolbar-content .bx-toolbar-item.bx-ti-left { + -webkit-flex: 0 0 auto; + -ms-flex: 0 0 auto; + flex: 0 0 auto; +} +.bx-main.bx-pt-application .bx-toolbar-content .bx-toolbar-item.bx-ti-left .bx-menu-item-main-menu { + display: none; +} +.bx-main.bx-pt-application .bx-toolbar-content .bx-toolbar-item.bx-ti-menu { + -webkit-flex: 2 1 auto; + -ms-flex: 2 1 auto; + flex: 2 1 auto; +} +.bx-main.bx-pt-application .bx-toolbar-content .bx-toolbar-item.bx-ti-right { + -webkit-flex: 0 1 0%; + -ms-flex: 0 1 0%; + flex: 0 1 0%; +} + +.bx-clear { + clear:both; + float:none; + display:block; + width: 0px; + height: 0px; + font-size:1px; +} + +.bx-clearfix:before, +.bx-clearfix:after { + content:""; + display:table; +} +.bx-clearfix:after { + clear:both; +} + +.bx-anchor-invisible, +.bx-anchor { + -webkit-background-clip:content-box; + background-clip:content-box; +} +.bx-anchor-invisible { + display:block; + height:0px; + width:0px; + overflow:hidden; +} + +.bx-bullet:before { + content: "\00A0\00b7\00A0"; + + color: #999999; +} +.bx-bullet-narrow:before { + content: "\00b7"; + + color: #999999; +} + +.bx-tag b, +.bx-tag s { + text-decoration: none; + font-weight: normal; +} + +.sys-icon-a { + width:1.5rem; + height:1.5rem; +} + +.sys-icon-emoji{ + font-weight: normal !important; +} + +.sys-icon-image, +.sys-icon-svg{ + display: inline-block; + width: 1.5rem; + height: 1.5rem; + background-size: contain; + background-position: center; + background-repeat: no-repeat; +} + +.bx-search-site { + width:20rem; + margin-left:auto; + margin-right:auto; +} +.bx-search-site .sys-search-results-quick { + padding-top: 0.5rem +} +.bx-search-site .sys-search-results-quick .bx-btn.sys-agents-ask { + display: flex; + float: none; + + width: 100%; + margin-bottom: 0.5rem; +} +.bx-agents-popup .cmts { + max-height: calc(0.5 * 100vh); + overflow-y: auto; +} +.bx-acl-err-msg { + padding: 0 10%; +} + +/* --------------- design boxes */ + +.bx-db-container { + position:relative; +} +.bx-db-header { + display: -webkit-box; + display: -webkit-flex; + display: -ms-flexbox; + display: flex; + + -webkit-box-align: center; + -webkit-align-items: center; + -ms-flex-align: center; + align-items: center; + + -webkit-flex-wrap: nowrap; + -ms-flex-wrap: nowrap; + flex-wrap: nowrap; +} +.bx-db-container.bx-dbc-nopadding > .bx-db-header { + padding-left: 0; + padding-right: 0; +} +.bx-db-container.bx-dbc-nobg > .bx-db-divider { + display: none; +} +.bx-db-title { + -webkit-flex: 1 1 auto; + -ms-flex: 1 1 auto; + flex: 1 1 auto; + + white-space: nowrap; + text-overflow: ellipsis; + overflow: hidden; + + line-height: 1.5; + font-size: 1.0rem; + font-weight: 600; +} + +.bx-db-menu { + -webkit-flex: 1 2 auto; + -ms-flex: 1 2 auto; + flex: 1 2 auto; + + max-width: 75%; +} + +.bx-media-phone .bx-db-menu { + max-width: 65%; +} + +.bx-db-menu-tab { + margin-left: 5px; + padding-top: 1px; + padding-bottom: 1px; + text-align: right; + overflow-x: auto; +} +.bx-db-menu-tab.bx-db-menu-tab-more-auto { + overflow-x: visible; +} + +.bx-db-menu-tab .bx-menu-custom-hor:not(.bx-menu-more-auto) { + width: max-content; +} +.bx-db-menu-tab-active { + text-decoration:underline; +} + +.bx-db-menu-tab-btn a { + text-decoration:none; +} + +.bx-db-menu-tab-btn a.bx-btn { + display: inline-block; + float: none; +} + +.bx-db-menu .sys-icon-a { + vertical-align:middle; +} + +.bx-db-menu-popup { + text-align: left; +} + +.bx-db-content { + position: relative; +} + +.bx-content-padding-block { + padding: 1rem; +} + +.bx-db-content .bx-db-help { + position: absolute; + top: 0; + right: 0; + width: 2.0rem; + height: 2.0rem; + border-radius: 2rem; + background-color: rgba(0, 0, 0, 0.1); + line-height: 2rem; + text-align: center; +} + +.bx-db-help-popup { + max-width: 25rem; + max-height: 25rem; + overflow: auto; +} + +/*--- Design Boxes Menu ---*/ +.bx-db-menu ul li { + border-radius: 0; + + white-space: nowrap; +} +.bx-db-menu ul.bx-menu-hor, +.bx-db-menu ul.bx-menu-custom.bx-menu-custom-hor, +.bx-db-menu ul.bx-menu-custom.bx-menu-custom-hor.bx-menu-more-auto:not(.bx-menu-submenu-more-auto) { + display: -webkit-inline-flex; + display: inline-flex; + -webkit-justify-content: flex-end; + justify-content: flex-end; +} +.bx-db-menu ul.bx-menu-hor > li, +.bx-db-menu ul.bx-menu-custom.bx-menu-custom-hor > li { + display: block; + + -webkit-flex: 0 1 auto; + -ms-flex: 0 1 auto; + flex: 0 1 auto; + + padding: 0 0.5rem; + + border-bottom: 1px solid transparent; +} +.bx-db-menu .bx-menu-custom.bx-menu-custom-hor > li > span { + display: block; + + margin: 0; + padding: 0; +} +.bx-db-menu ul.bx-menu-hor > li a.bx-btn, +.bx-db-menu ul.bx-menu-custom.bx-menu-custom-hor > li a.bx-btn { + display: inline-block; + float: none; +} +.bx-db-menu ul.bx-menu-hor > li a > span, +.bx-db-menu ul.bx-menu-custom.bx-menu-custom-hor > li a > span { + vertical-align: middle; +} +.bx-db-menu ul > li:not(.bx-menu-item-more-auto) a .sys-icon, +.bx-db-menu ul > li:not(.bx-menu-item-more-auto) a .sys-icon-image { + display: none; +} +.bx-db-menu ul.bx-menu-submenu-more-auto { + line-height: normal; +} +.bx-db-menu ul li:not(.bx-menu-item-more-auto) a span, +.bx-db-menu .bx-menu-item-more-popup ul.bx-menu-custom.bx-menu-submenu-more-auto li:not(.bx-menu-item-more-auto) a span, +.bx-db-menu .bx-popup .bx-db-menu-popup ul.bx-menu-custom.bx-menu-custom-ver li a > span, +.bx-db-menu .bx-popup .bx-db-menu-popup ul.bx-menu-ver li a > div > span { + margin: 0; +} +.bx-db-menu ul.bx-menu-hor li.bx-menu-tab-active, +.bx-db-menu ul.bx-menu-custom.bx-menu-custom-hor li.bx-menu-tab-active { + border-bottom: 0; +} +.bx-db-menu ul.bx-menu-custom-ver li.bx-menu-item-more-auto { + display: none; +} + +/* --------------- popup boxes */ + +html.bx-popup-lock, body.bx-popup-lock { + overflow: hidden; +} + +body > .bx-popup-wrapper { + max-height:100%; + overflow-x:hidden; + overflow-y:auto; + /* -webkit-overflow-scrolling:touch; */ +} + +.bx-popup-transitions { + -webkit-transition: opacity 0.2s ease-in-out, -webkit-transform 0.2s ease-in-out; + transition: opacity 0.2s ease-in-out, transform 0.2s ease-in-out; +} + +.bx-popup-inactive { + -webkit-opacity: 0; + opacity: 0; + + -webkit-transform: scale(0.75); + transform: scale(0.75); +} + +.bx-popup-active { + max-height:100%; + overflow-y:auto; + + -webkit-opacity: 1; + opacity: 1; + + -webkit-transform: scale(1); + transform: scale(1); + + -webkit-transition: opacity 0.2s ease-in-out, -webkit-transform 0.2s ease-in-out; + transition: opacity 0.2s ease-in-out, transform 0.2s ease-in-out; +} + +.bx-popup-width { + width: 500px; +} + +.bx-popup-width-small { + width: 14rem; +} + +.bx-popup-border { + border:1px solid #383d66; +} + +.bx-popup-color-bg { + background-color:#fff; +} + +.bx-popup-fog { + position: fixed; + top: 0; + left: 0; + opacity: 0.7; + background-color: #ffffff; + -webkit-backface-visibility: hidden; +} + +.bx-popup { + overflow:hidden; +} + +.bx-popup-header { + position: relative; +} +.bx-popup-header-color-bg { + background-color: #3b8686; +} + +.bx-popup-header .bx-db-menu-tab-btn { + padding-top:16px; +} + +.bx-popup-header h2 { + margin:0; + text-align:center; + color:#FFFFFF; +} + +.bx-popup-box-pointer { + display:none; + position:relative; + top:10px; + width:13px; + height:7px; + overflow:hidden; +} + +.bx-popup-box-pointer > i { + display:block; + position:absolute; + top:-5px; + width:0px; + height:0px; + border-width:6px; + border-style:solid; + border-top-color:transparent; + border-right-color:transparent; + border-left-color:transparent; +} + +.bx-popup-image-container { + position: relative; +} + +.bx-popup-image-btn { + position: absolute; + right: 0; + top: 0; +} + +.bx-popup-image-wrapper img { + display: block; +} + +.bx-popup-element-close:hover, +.bx-popup-element-close { + position: absolute; + top: 0; + right: 0; + text-decoration: none; + font-size: 1.75rem !important; +} + +.bx-popup-slide-wrapper { + width:100%; + + background-color: rgba(255, 255, 255, 0.9); +} +.bx-popup-slide-wrapper li { + text-align:right; +} + +.bx-popup-trans-wrapper .bx-popup-close-wrapper { + display: -webkit-flex; + display: flex; + -webkit-justify-content: flex-end; + justify-content: flex-end; +} +.bx-popup-trans-wrapper .bx-popup-close-wrapper .bx-popup-element-close { + position: relative; + line-height: 1.2rem; +} +.bx-popup-image-wrapper .bx-popup-close-wrapper, +.bx-popup-image-wrapper .bx-popup-element-close { + display:none; +} + +#bx-popup-alert, +#bx-popup-confirm, +#bx-popup-prompt { + max-width: 500px; + max-width: 31.25rem; +} + +.popup_alert_actions .bx-btn, +.popup_confirm_actions .bx-btn, +.popup_prompt_actions .bx-btn { + float: none; +} + +/* --------------- full screen popup */ +.bx-popup-full-screen.bx-popup-trans-wrapper, +.bx-popup-full-screen.bx-popup-box-wrapper, +.bx-popup-full-screen .bx-popup-trans, +.bx-popup-full-screen .bx-popup-box { + position:fixed !important; + top:0 !important; + left:0 !important; + bottom:0 !important; + right:0 !important; + width:100%; + width:100vw; + height:100%; + height:100vh; + overflow:auto; +} + +.bx-popup-full-screen .bx-popup-trans > div, +.bx-popup-full-screen .bx-popup-box > div { + border-radius:0; + -moz-border-radius:0; + -webkit-border-radius:0; +} + +.bx-popup-full-screen.bx-popup-trans-wrapper .bx-popup-border, +.bx-popup-full-screen.bx-popup-box-wrapper .bx-popup-border { + border:none; +} + +.bx-popup-full-screen.bx-popup-trans-wrapper .bx-popup, +.bx-popup-full-screen.bx-popup-box-wrapper .bx-popup { + -moz-box-shadow:none; + -webkit-box-shadow:none; + box-shadow:none; +} + +.bx-popup-full-screen .bx-popup-width { + width:100%; +} + +.bx-popup-full-screen .bx-popup .bx-popup-close-wrapper { + display: flex !important; +} + +/* --------------- notification boxes */ +.bx-popup-inline-holder { + padding-top: 70px; + padding-top: 4.375rem; +} +.bx-popup-inline { + width: 100%; +} +.bx-popup-inline .bx-popup { + position: relative; + + width: 100%; + height: 4.25rem; + + border-width: 1px 0px 1px 0px; + border-color: #000000; + border-radius: 0px; + + background-color: rgba(85, 85, 85, .9); + + color: #ffffff; +} +.bx-popup-inline .bx-popup .bx-popup-content { + position: relative; + display: flex; + + height: 100%; + + padding: 0px 3.75rem; + + align-items: center; +} +.bx-popup-inline .bx-popup .bx-popup-content > * { + max-height: 100%; +} +.bx-popup-inline .bx-popup .bx-popup-actions { + position: absolute; + display: flex; + + height: 100%; + top: 0px; + + align-items: center; +} +.bx-popup-inline .bx-popup .bx-pa-left { + left: 0px; +} +.bx-popup-inline .bx-popup .bx-pa-right { + right: 0px; +} +.bx-popup-inline .bx-popup .bx-popup-actions a { + text-decoration: none; + font-size: 1.75rem; + color: #9c9c9c; +} + +/* --------------- chain notifications */ +div.bx-popup-chain { + position: relative; + max-width: 22.5rem; +} +div.bx-popup-chain-cnt { + position: relative; +} +div.bx-popup-chain-item { + position: relative; + width: 100%; + overflow: hidden; +} +div.bx-popup-chain-item-actions { + position: absolute; + top: 0px; +} +div.bx-popup-cia-left { + left: 0px; +} +div.bx-popup-cia-right { + right: 0px; +} +div.bx-popup-chain-item-actions a { + line-height: initial; + text-decoration: none; +} +div.bx-popup-chain-item-actions .sys-icon { + display: inline-block; + width: 1.5rem; + height: 1.5rem; + line-height: 1.5rem; + text-align: center; +} +div.bx-popup-chain-item .bx-loading-ajax { + height: auto; +} + +/* --------------- message box */ +.bx-msg-box-container { + padding:0px 5px; + text-align:center; +} + +.bx-msg-box { + display:inline-block; + margin-right:auto; + margin-left:auto; + + text-align:center; + font-size:1rem; + padding:10px; + text-transform:uppercase; +} + +/* --------------- loading indicator */ + +.bx-loading-ajax { + position:absolute; + width:100px; + height:100px; + margin-left:auto; + margin-right:auto; + + background-color: transparent; + + border-radius:10px; + -moz-border-radius:10px; + -webkit-border-radius:10px; + + text-align:center; + color:#CCCCCC; +} +.bx-loading-ajax.static { + position: static; +} +.bx-loading-ajax svg { + box-sizing: content-box; + width: 50px; + height: 50px; + padding: 25px; +} + +.bx-loading-ajax-btn { + position: relative; + display: inline-block; + vertical-align: top; + + min-width: 2.0rem; + + margin-left: 5px; +} + +@-moz-document url-prefix() { + button.bx-btn .bx-loading-ajax-btn { + top: -1px; + } +} + +button.bx-btn:focus, +button.bx-btn:focus .bx-loading-ajax-btn { + outline: 0; +} + +.bx-form-element-wrapper .bx-loading-ajax { + width: 4rem; + height: 4rem; +} + + +/* --------------- SVG loading indicator */ +svg .outer, +svg .inner{ + -webkit-transform-origin: 50% 50%; + -moz-transform-origin: 50% 50%; + transform-origin: 50% 50%; +} +svg .outer{ + -webkit-animation: clockwise 5s infinite linear; + -moz-animation: clockwise 5s infinite linear; + animation: clockwise 5s infinite linear; + + +} +svg .inner{ + -webkit-animation: counter-clockwise 2s infinite linear; + -moz-animation: counter-clockwise 2s infinite linear; + animation: counter-clockwise 2s infinite linear; + +} +svg .colored .inner .p1 { + fill:#2AB191; +} +svg .colored .inner .p2, +svg .colored .outer .p1 { + fill:#4990E2; +} +svg .colored .outer .p2 { + fill:#EE6666; +} +svg .gray .inner .p1, +svg .gray .inner .p2, +svg .gray .outer .p1, +svg .gray .outer .p2 { + fill:#4A4A4A; +} + +@-webkit-keyframes counter-clockwise { + 0% { -webkit-transform: rotate(0deg); } + 100% { -webkit-transform: rotate(360deg); } +} +@-webkit-keyframes clockwise { + 0% { -webkit-transform: rotate(360deg); } + 100% { -webkit-transform: rotate(0deg); } +} +@-moz-keyframes counter-clockwise { + 0% { -moz-transform: rotate(0deg); } + 100% { -moz-transform: rotate(360deg); } +} +@-moz-keyframes clockwise { + 0% { -moz-transform: rotate(360deg); } + 100% { -moz-transform: rotate(0deg); } +} + +@keyframes counter-clockwise { + 0% { transform: rotate(0deg); } + 100% { transform: rotate(360deg); } +} +@keyframes clockwise { + 0% { transform: rotate(360deg); } + 100% { transform: rotate(0deg); } +} + +/* --------------- button */ +.bx-btn-height { + height: 2.2rem; + line-height: 2.2rem; +} +.bx-btn-border { + border: none; +} +.bx-btn:active, +.bx-btn:hover { + background-color: #79bd9a; + text-decoration:none; +} +.bx-btn img { + width:1.2rem; + height:1.2rem; + max-width: none; + + background-size: contain; + background-repeat: no-repeat; + background-position:center center; +} +.bx-btn .bx-def-valign-center{ + height: 100%; +} +.bx-btn u { + margin-left: 10px; + text-decoration: none; +} +.bx-btn u:first-child { + margin-left: 0px; +} +.bx-btn .sys-icon { + font-size:1.2em; +} +.bx-btn .sys-icon-bigger { + font-size:1.4em; +} + +.bx-btn-small-height { + height: 1.6rem; + line-height: 1.5rem; +} + +.bx-btn-small-border { + border: none; +} + +.bx-btn.bx-btn-primary { + background-color: #357877; +} +.bx-btn.bx-btn-primary:hover, +.bx-btn.bx-btn-primary:active { + background-color: #3a8686; +} + +.bx-btn.bx-btn-symbol { + font-family: "Times New Roman", Georgia, Serif; + font-size:1.3rem; + line-height:32px; +} +.bx-btn.bx-btn-symbol:hover { + text-decoration:none; +} +.bx-btn.bx-btn-symbol-small { + font-size:1rem; +} + +.bx-btn-group .bx-btn { + margin-left:0px; + margin-right:0px; +} +.bx-btn-group .bx-btn:not(:first-child):after { + content:""; + position:absolute; + display:block; + top:0px; + left:-0.05em; + width:0.1em; + height:100%; + background-color:rgba(255,255,255,0.1); +} +.bx-btn-group .bx-btn + .bx-btn:not(:last-child) { + border-radius:0px; + -moz-border-radius:0px; + -webkit-border-radius:0px; +} +.bx-btn-group .bx-btn:first-child { + -webkit-border-top-right-radius: 0px; + -webkit-border-bottom-right-radius: 0px; + -moz-border-radius-topright: 0px; + -moz-border-radius-bottomright: 0px; + border-top-right-radius: 0px; + border-bottom-right-radius: 0px; +} +.bx-btn-group .bx-btn:last-child { + -webkit-border-top-left-radius: 0px; + -webkit-border-bottom-left-radius: 0px; + -moz-border-radius-topleft: 0px; + -moz-border-radius-bottomleft: 0px; + border-top-left-radius: 0px; + border-bottom-left-radius: 0px; +} + +/* --------------- button at the end of cut string */ + +.bx-str-limit { + margin-left:0.5rem; + cursor:pointer; +} + +/* --------------- categories */ + +.bx-category-list-item { + line-height: 1.5rem; +} +.bx-category-list-item-selected { + font-weight: bold; +} + +/* --------------- Show More */ +.bx-overflow-ready { + max-height: 250px; + overflow: hidden; +} +.bx-overflow-ready.bx-or-cmt { + max-height: 80px; +} +.bx-overflow:before { + position: absolute; + bottom: 0; + width: 100%; + height: 20%; + + content: ''; +} + +.bx-show-more { + padding-top: 0.25rem; + padding-bottom: 0.25rem; + + text-align: center +} + +/* --------------- Flickity: Tailwind overwrite */ +.flickity-enabled .flickity-viewport .flickity-slider img, +.flickity-enabled .flickity-viewport .flickity-slider video { + display: inline; + max-width: none; +} \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/css/cover.css b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/css/cover.css new file mode 100644 index 0000000000..ddddb76017 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/css/cover.css @@ -0,0 +1,124 @@ +.bx-cover-gap { + position:relative; +} +.bx-media-phone .bx-cover-gap { + padding-left: 0; + padding-right: 0; +} + +.bx-cover-wrapper { + position:relative; + background-image: url(../images/cover.svg); + background-color: #eee; + background-repeat: no-repeat; + background-position: center center; + -webkit-background-size: cover; + -moz-background-size: cover; + -o-background-size: cover; + background-size: cover; + overflow: hidden; +} + +.bx-image-edit-buttons{ + position: absolute; + left:1rem; + top:1rem; + z-index: 100; +} +.bx-image-edit-buttons .bx-btn.bx-btn-small{ + padding: 0.375rem 0.5rem; +} +.bx-base-pofile-cover-thumb .bx-image-edit-buttons{ + display: flex; + width: 100%; + justify-content: center; + left:0px; + bottom:1rem; + top:auto; +} +.bx-image-edit-move{ + cursor:move; + position: relative; + z-index: 99; +} +.bg-cover{ + background-size: 100% auto !important; +} +.bx-image-edit-move-info{ + display: flex; + align-items: center; + position: absolute; + opacity: 0.5; + background-color: #000; + -webkit-backface-visibility: hidden; + padding: 0.5rem 1rem; + border-radius: 1rem; + color:#fff; + letter-spacing: 1px; +} +.bx-image-edit-move-info i{ + color:#fff; + font-size: 1.25rem; + margin-right: 1rem; +} +.bx-image-edit-buttons-no-image .bx-image-edit-buttons-edit{ + display: none; +} + +.bx-image-edit-buttons .bx-uploader-html5-drop-area{ + display: none; +} + +.bx-cover-gradient { + position: absolute; + width: 100%; + height: 100%; + pointer-events: none; + background: url(data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiA/Pgo8c3ZnIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgd2lkdGg9IjEwMCUiIGhlaWdodD0iMTAwJSIgdmlld0JveD0iMCAwIDEgMSIgcHJlc2VydmVBc3BlY3RSYXRpbz0ibm9uZSI+CiAgPGxpbmVhckdyYWRpZW50IGlkPSJncmFkLXVjZ2ctZ2VuZXJhdGVkIiBncmFkaWVudFVuaXRzPSJ1c2VyU3BhY2VPblVzZSIgeDE9IjAlIiB5MT0iMCUiIHgyPSIwJSIgeTI9IjEwMCUiPgogICAgPHN0b3Agb2Zmc2V0PSIwJSIgc3RvcC1jb2xvcj0iIzAwMDAwMCIgc3RvcC1vcGFjaXR5PSIwIi8+CiAgICA8c3RvcCBvZmZzZXQ9IjEwMCUiIHN0b3AtY29sb3I9IiMwMDAwMDAiIHN0b3Atb3BhY2l0eT0iMC4xNyIvPgogIDwvbGluZWFyR3JhZGllbnQ+CiAgPHJlY3QgeD0iMCIgeT0iMCIgd2lkdGg9IjEiIGhlaWdodD0iMSIgZmlsbD0idXJsKCNncmFkLXVjZ2ctZ2VuZXJhdGVkKSIgLz4KPC9zdmc+); + background: -moz-linear-gradient(top, rgba(0,0,0,0) 0%, rgba(0,0,0,0.17) 100%); + background: -webkit-linear-gradient(top, rgba(0,0,0,0) 0%,rgba(0,0,0,0.17) 100%); + background: linear-gradient(to bottom, rgba(0,0,0,0) 0%,rgba(0,0,0,0.17) 100%); + filter: progid:DXImageTransform.Microsoft.gradient( startColorstr='#00000000', endColorstr='#2b000000',GradientType=0 ); +} + +.bx-cover { + position: relative; + z-index: 2; + display: -webkit-flex; + display: flex; + -webkit-align-items: center; + align-items: center; + min-height: 40vh; + text-align: center; +} + +.bx-cover-cnt { + width: 100%; +} + +.bx-cover-title { + font-weight:bold; + vertical-align:middle; + text-shadow:-1px 0px 0px rgba(0, 0, 0, .3), 1px 0px 0px rgba(0, 0, 0, .3), 0px -1px 0px rgba(0, 0, 0, .3), 0px 1px 0px rgba(0, 0, 0, .3); +} + +.bx-cover-title .bx-btn { + display:inline-block; + float:none; +} + +.bx-cover-image img { + width:6.25rem; + height:6.25rem; + background-size: cover; + vertical-align: middle; +} + +.bx-cover-title .sys-icon, +.bx-cover-title span { + vertical-align: middle; +} + +.bx-cover-homepage { + background-image: url(../images/cover-homepage.svg); +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/css/default.less b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/css/default.less new file mode 100644 index 0000000000..451de4ccc2 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/css/default.less @@ -0,0 +1,750 @@ +@import (reference) '_mixins.less'; + +.bx-def-page-width { + max-width:@bx-page-width; + width: 100%; +} + +.bx-def-box-sizing { + .box-sizing(border-box); +} + +.bx-def-align-center { + display: -webkit-flex !important; + display: flex !important; + + -webkit-justify-content: center; + justify-content: center; + + -webkit-align-items: center; + align-items: center; +} + +.bx-def-valign-center { + display: -webkit-flex !important; + display: flex !important; + + -webkit-align-items: center; + align-items: center; +} + +/* margins */ +.bx-def-centered { + margin: 0px auto; +} + +.bx-def-margin { + .margin(@bx-margin); +} +.bx-def-margin-neg { + .margin(-@bx-margin); +} +.bx-def-margin-lefttopright { + .margin-left(@bx-margin); + .margin-top(@bx-margin); + .margin-right(@bx-margin); +} +.bx-def-margin-rightbottomleft { + .margin-right(@bx-margin); + .margin-bottom(@bx-margin); + .margin-left(@bx-margin); +} +.bx-def-margin-leftright { + .margin-left(@bx-margin); + .margin-right(@bx-margin); +} +.bx-def-margin-leftright-neg { + .margin-left(-@bx-margin); + .margin-right(-@bx-margin); +} +.bx-def-margin-topbottom { + .margin-top(@bx-margin); + .margin-bottom(@bx-margin); +} +.bx-def-margin-topbottom-neg { + .margin-top(-@bx-margin); + .margin-bottom(-@bx-margin); +} +.bx-def-margin-top { + .margin-top(@bx-margin); +} +.bx-def-margin-top-auto { + .margin-top(@bx-margin); + &:first-child { + .margin-top(0px); + } +} +.bx-def-margin-right { + .margin-right(@bx-margin); +} +.bx-def-margin-bottom { + .margin-bottom(@bx-margin); +} +.bx-def-margin-bottom-neg { + .margin-bottom(-@bx-margin); +} +.bx-def-margin-left { + .margin-left(@bx-margin); +} +.bx-def-margin-left-auto { + .margin-left(@bx-margin); + &:first-child { + .margin-left(0); + } +} +.bx-def-margin-right-auto { + .margin-right(@bx-margin); + /* &:last-child { + .margin-right(0); + }*/ +} + +.bx-def-margin-sec { + .margin(@bx-margin-sec); +} +.bx-def-margin-sec-neg { + .margin(-@bx-margin-sec); +} +.bx-def-margin-sec-lefttopright { + .margin-left(@bx-margin-sec); + .margin-top(@bx-margin-sec); + .margin-right(@bx-margin-sec); +} +.bx-def-margin-sec-lefttopright-neg { + .margin-left(-@bx-margin-sec); + .margin-top(-@bx-margin-sec); + .margin-right(-@bx-margin-sec); +} +.bx-def-margin-sec-bottom-neg { + .margin-bottom(-@bx-margin-sec); +} +.bx-def-margin-sec-rightbottomleft { + .margin-right(@bx-margin-sec); + .margin-bottom(@bx-margin-sec); + .margin-left(@bx-margin-sec); +} +.bx-def-margin-sec-leftright { + .margin-left(@bx-margin-sec); + .margin-right(@bx-margin-sec); +} +.bx-def-margin-sec-leftright-neg { + .margin-left(-@bx-margin-sec); + .margin-right(-@bx-margin-sec); +} +.bx-def-margin-sec-topbottom { + .margin-top(@bx-margin-sec); + .margin-bottom(@bx-margin-sec); +} +.bx-def-margin-sec-top { + .margin-top(@bx-margin-sec); +} +.bx-def-margin-sec-top-neg { + .margin-top(-@bx-margin-sec); +} +.bx-def-margin-sec-top-auto { + .margin-top(@bx-margin-sec); + &:first-child { + .margin-top(0); + } +} +.bx-def-margin-sec-right { + .margin-right(@bx-margin-sec); +} +.bx-def-margin-sec-bottom { + .margin-bottom(@bx-margin-sec); +} +.bx-def-margin-sec-left { + .margin-left(@bx-margin-sec); +} +.bx-def-margin-sec-left-auto { + .margin-left(@bx-margin-sec); + &:first-child { + .margin-left(0); + } +} +.bx-def-margin-sec-right-auto { + .margin-right(@bx-margin-sec); + &:last-child { + .margin-right(0); + } +} + +.bx-def-margin-thd { + .margin(@bx-margin-thd); +} +.bx-def-margin-thd-neg { + .margin(-@bx-margin-thd); +} +.bx-def-margin-thd-rightbottomleft { + .margin-right(@bx-margin-thd); + .margin-bottom(@bx-margin-thd); + .margin-left(@bx-margin-thd); +} +.bx-def-margin-thd-leftright { + .margin-left(@bx-margin-thd); + .margin-right(@bx-margin-thd); +} +.bx-def-margin-thd-leftright-neg { + .margin-left(-@bx-margin-thd); + .margin-right(-@bx-margin-thd); +} +.bx-def-margin-thd-topbottom { + .margin-top(@bx-margin-thd); + .margin-bottom(@bx-margin-thd); +} +.bx-def-margin-thd-top { + .margin-top(@bx-margin-thd); +} +.bx-def-margin-thd-top-auto { + .margin-top(@bx-margin-thd); + &:first-child { + .margin-top(0); + } +} +.bx-def-margin-thd-right { + .margin-right(@bx-margin-thd); +} +.bx-def-margin-thd-bottom { + .margin-bottom(@bx-margin-thd); +} +.bx-def-margin-thd-left { + .margin-left(@bx-margin-thd); +} +.bx-def-margin-thd-left-auto { + .margin-left(@bx-margin-thd); + &:first-child { + .margin-left(0); + } +} + +/* paddings */ +.bx-def-padding { + .padding(@bx-padding); +} +.bx-def-padding-lefttopright { + .padding-left(@bx-padding); + .padding-top(@bx-padding); + .padding-right(@bx-padding); +} +.bx-def-padding-rightbottomleft { + .padding-right(@bx-padding); + .padding-bottom(@bx-padding); + .padding-left(@bx-padding); +} +.bx-def-padding-leftright { + .padding-left(@bx-padding); + .padding-right(@bx-padding); +} +.bx-def-padding-topbottom { + .padding-top(@bx-padding); + .padding-bottom(@bx-padding); +} +.bx-def-padding-top { + .padding-top(@bx-padding); +} +.bx-def-padding-right { + .padding-right(@bx-padding); +} +.bx-def-padding-bottom { + .padding-bottom(@bx-padding); +} +.bx-def-padding-left { + .padding-left(@bx-padding); +} + +.bx-def-padding-sec { + .padding(@bx-padding-sec); +} +.bx-def-padding-sec-rightbottomleft { + .padding-right(@bx-padding-sec); + .padding-bottom(@bx-padding-sec); + .padding-left(@bx-padding-sec); +} +.bx-def-padding-sec-topbottom { + .padding-top(@bx-padding-sec); + .padding-bottom(@bx-padding-sec); +} +.bx-def-padding-sec-leftright { + .padding-left(@bx-padding-sec); + .padding-right(@bx-padding-sec); +} +.bx-def-padding-sec-top { + .padding-top(@bx-padding-sec); +} +.bx-def-padding-sec-right { + .padding-right(@bx-padding-sec); +} +.bx-def-padding-sec-bottom { + .padding-bottom(@bx-padding-sec); +} +.bx-def-padding-sec-left { + .padding-left(@bx-padding-sec); +} + +.bx-def-padding-thd { + .padding(@bx-padding-thd); +} +.bx-def-padding-thd-rightbottomleft { + .padding-right(@bx-padding-thd); + .padding-bottom(@bx-padding-thd); + .padding-left(@bx-padding-thd); +} +.bx-def-padding-thd-topbottom { + .padding-top(@bx-padding-thd); + .padding-bottom(@bx-padding-thd); +} +.bx-def-padding-thd-leftright { + .padding-left(@bx-padding-thd); + .padding-right(@bx-padding-thd); +} +.bx-def-padding-thd-top { + .padding-top(@bx-padding-thd); +} +.bx-def-padding-thd-right { + .padding-right(@bx-padding-thd); +} +.bx-def-padding-thd-bottom { + .padding-bottom(@bx-padding-thd); +} +.bx-def-padding-thd-left { + .padding-left(@bx-padding-thd); +} + +/* colors */ +.bx-def-color-bg-block { + .background-color (@bx-color-block); +} +.bx-def-color-bg-box { + .background-color (@bx-color-box); +} +.bx-def-color-bg-box-active, +.bx-def-color-bg-box-hover:hover { + .background-color (@bx-color-box-hover); +} +.bx-def-color-bg-sec { + .background-color (@bx-color-sec); +} + +.bx-def-color-bg-hl, +.bx-def-color-bg-hl-even:nth-child(even), +.bx-def-color-bg-hl-hover:hover { + .background-color (@bx-color-hl); +} + +.bx-def-color-bg-active { + .background-color (@bx-color-active); +} + +.bx-btn.bx-btn-disabled:active, +.bx-btn.bx-btn-disabled:hover, +.bx-btn.bx-btn-disabled, +.bx-btn.bx-btn-small.bx-btn-disabled:active, +.bx-btn.bx-btn-small.bx-btn-disabled:hover, +.bx-btn.bx-btn-small.bx-btn-disabled, +.bx-btn.bx-btn-primary.bx-btn-disabled:active, +.bx-btn.bx-btn-primary.bx-btn-disabled:hover, +.bx-btn.bx-btn-primary.bx-btn-disabled { + .background-color (@bx-color-disabled); +} + +/* hr */ +.bx-def-hr, +.bx-def-hr-auto { + margin-left:0; + margin-right:0; + padding:0; + border:0px; + border-top:@bx-border-width @bx-border-type @bx-border-color-hr; +} +.bx-def-hr-auto:first-child { + display: none; +} + +/* border for common layout elements likedesign boxes, pads, menu items, etc */ +.bx-def-border { + border:@bx-border-width @bx-border-type @bx-border-color; +} +.bx-def-border-rightbottomleft { + border-right:@bx-border-width @bx-border-type @bx-border-color; + border-bottom:@bx-border-width @bx-border-type @bx-border-color; + border-left:@bx-border-width @bx-border-type @bx-border-color; +} +.bx-def-border-top { + border-top:@bx-border-width @bx-border-type @bx-border-color; +} +.bx-def-border-top-auto { + border-top:@bx-border-width @bx-border-type @bx-border-color; + &:first-child { + border-top:none; + } +} +.bx-def-border-right { + border-right:@bx-border-width @bx-border-type @bx-border-color; +} +.bx-def-border-bottom { + border-bottom:@bx-border-width @bx-border-type @bx-border-color; +} +.bx-def-border-left { + border-left:@bx-border-width @bx-border-type @bx-border-color; +} +.bx-def-border-right { + border-right:@bx-border-width @bx-border-type @bx-border-color; +} + +/* shadow */ +.bx-def-shadow { + .drop-shadow (0px, 1px, 3px, 0px, rgba(51, 51, 51, 0.1)); +} + +/* round corders */ +.bx-def-round-corners { + .radius(@bx-round-corners-radius); +} + +/* blur */ +.bx-def-blur { + .blur(2px); +} + +/* fonts */ + +/* NOTE: bx-def-font, h1, h2, h3 styles were copied to editor.css */ + +.bx-def-font-inputs { + font-family:@bx-font-family; + font-weight:400; + .font-size(@bx-font-size-default); +} + +.bx-def-font-color, +.bx-def-font-color:hover { + color:@bx-font-color-default; +} + +.bx-def-font-grayed { + color:@bx-font-color-grayed; +} + +.bx-def-font-contrasted:after, +.bx-def-font-contrasted:before, +.bx-def-font-contrasted { + color:@bx-font-color-contrasted; +} + +.bx-def-font-small { + .font-size(@bx-font-size-small); +} + +.bx-def-font-middle { + .font-size(@bx-font-size-middle); +} + +.bx-def-font-large { + .font-size(@bx-font-size-large); +} + +.bx-def-font-light { + font-weight: 300; +} + +.bx-def-font-normal { + font-weight: 400; +} + +.bx-def-font-semibold { + font-weight: 600; +} + +.bx-def-font-bold { + font-weight: 700; +} + +.bx-def-font-extrabold { + font-weight: 900; +} + +.bx-def-font-align-center { + text-align: center; +} + +h1, +.bx-def-font-h1 { + .font-size(@bx-font-size-h1); + font-weight:700; +} + +h2, +.bx-def-font-h2 { + .font-size(@bx-font-size-h2); + font-weight:700; +} + +h3, +.bx-def-font-h3 { + .font-size(@bx-font-size-h3); + font-weight:500; +} + +.bx-def-vanilla-html { + margin-left: auto; + margin-right: auto; +} +.bx-layout-column-thin .bx-def-vanilla-html, +.bx-layout-column-half .bx-def-vanilla-html, +.bx-layout-column-wide .bx-def-vanilla-html { + max-width: none; +} +.bx-layout-column-fullwidth .bx-base-text-entity-content.bx-def-vanilla-html { + margin-top: 1.5rem; + margin-bottom: 1.5rem; +} +.bx-def-vanilla-html.bx-def-constraint-pre pre { + max-width: none; + overflow: auto; +} + +/* image/thumbnail/gallery default styles */ + +.bx-def-icon, +.bx-def-thumb, +.bx-def-ava, +.bx-def-ava-big { + overflow:hidden; +} + +.bx-def-ava-big-size { + .width(@bx-size-avatar-big); + .height(@bx-size-avatar-big); +} +.bx-def-ava-big-size-max-height { + .max-height(@bx-size-avatar-big); +} +.bx-def-ava-big-size-min-height { + .min-height(@bx-size-avatar-big); +} +.bx-def-ava-big-size-left-indent { + .margin-left(@bx-size-avatar-big + @bx-margin); +} + + +.bx-def-ava-size { + .width(@bx-size-avatar); + .height(@bx-size-avatar); +} +.bx-def-ava-size-max-height { + .max-height(@bx-size-avatar); +} +.bx-def-ava-size-min-height { + .min-height(@bx-size-avatar); +} +.bx-def-ava-size-left-indent { + .margin-left(@bx-size-avatar + @bx-margin); +} + + +.bx-def-thumb-size { + .width(@bx-size-thumb); + .height(@bx-size-thumb); +} +.bx-def-thumb-size-max-height { + .max-height(@bx-size-thumb); +} +.bx-def-thumb-size-min-height { + .min-height(@bx-size-thumb); +} +.bx-def-thumb-size-left-indent { + .margin-left(@bx-size-thumb + @bx-margin); +} + +.bx-def-icon-size { + .width(@bx-size-icon); + .height(@bx-size-icon); +} +.bx-def-icon-size-max-height { + .max-height(@bx-size-icon); +} +.bx-def-icon-size-min-height { + .min-height(@bx-size-icon); +} +.bx-def-icon-size-left-indent { + .margin-left(@bx-size-icon + @bx-margin); +} + +/*--- Unit ---*/ +.bx-def-unit { + position:relative; + white-space:nowrap; +} +.bx-def-unit-info { + .box-sizing(border-box); + + text-overflow:ellipsis; + overflow:hidden; +} +.bx-def-unit .bx-def-unit-line .bx-def-ui-div:first-child { + display: none; +} + +/*-- Unit: Tailwind overwrite --*/ +.bx-def-unit.absolute { + position: relative; +} +.bx-def-unit.absolute .bx-def-unit-img { + position: absolute; + top: 0px; + left: 0px; +} +.bx-def-unit.absolute .bx-def-unit-info { + display: -webkit-flex; + display: flex; + -webkit-align-items: center; + align-items: center; +} +.bx-def-unit.absolute .bx-def-unit-info-cnt { + width: 100%; +} +.bx-def-unit.absolute .bx-def-unit-line { + text-overflow:ellipsis; + overflow:hidden; +} + +/*--- Alerts ---*/ +.bx-def-unit-alert, +.bx-def-unit-alert-small, +.bx-def-unit-alert-middle { + display:block; + position:absolute; + box-sizing: content-box; + top: 0; + right: -2px; + text-align:center; + color:white; +} +.bx-def-unit-alert { + .min-width(@bx-font-size-default); + .height(@bx-font-size-default); + .line-height(@bx-font-size-default); + .radius(@bx-font-size-default); + .font-size(@bx-font-size-middle - 2); + .padding(4px); +} +.bx-def-unit-alert-small { + .min-width(@bx-font-size-small + 2); + .height(@bx-font-size-small + 2); + .line-height(@bx-font-size-small + 2); + .radius(@bx-font-size-default); + .font-size(@bx-font-size-small); + .padding(1px); +} +.bx-def-unit-alert-middle { + .min-width(@bx-font-size-middle - 2); + .height(@bx-font-size-middle - 2); + .line-height(@bx-font-size-middle - 2); + .radius(@bx-font-size-middle - 2); + .font-size(@bx-font-size-middle - 2); + .padding(3px); +} + +.bx-def-unit-live-search { + text-align: left; + overflow: hidden; +} + +.bx-def-unit-live-search .bx-def-unit-img:not(.empty) { + background-size:cover; + background-repeat:no-repeat; + background-position:center center; +} +.bx-def-unit-live-search .bx-def-unit-img-empty { + position: relative; + display: -webkit-flex; + display: flex; + -webkit-align-items: center; + align-items: center; + -webkit-justify-content: center; + justify-content: center; +} +.bx-def-unit-live-search .bx-def-unit-img-empty i { + font-size: 1.2rem; +} + + + +.bx-def-gal-img-column { + .column-width-raw(100%); +} + +.bx-def-gal-img-size { + .width(@bx-size-gallery-img-width); + .height(@bx-size-gallery-img-height); +} + +.bx-def-gal-div-size { + width:100%; + .height(@bx-size-gallery-img-height); +} +.bx-def-gal-unit-column { + .column-width-raw(100%); +} +.bx-def-gal-unit-size { + display:inline-block; + width:100%; + height:auto; + vertical-align:top; + overflow:hidden; + .box-sizing(); +} + + +/* label */ + +.bx-def-label { + .box-sizing(border-box); + + min-width: 1.5rem; + .padding-left(@bx-padding-sec); + .padding-right(@bx-padding-sec); + + .radius(@bx-round-corners-radius-label); + + background-color: @bx-color-label; + + line-height: 1.5rem; + font-size: @bx-font-size-small; +} +.bx-def-label, +.bx-def-label a, +.bx-def-label .sys-icon { + color: @bx-font-color-grayed; +} + +.bx-def-label.menu { + .radius(@bx-round-corners-radius-label-menu); + + background-color: @bx-color-label-menu; +} + +.bx-def-label.menu, +.bx-def-label.menu a, +.bx-def-label.menu .sys-icon { + color: @bx-font-color-contrasted; +} + + +/* z-index */ + +.bx-def-z-index-front { + z-index:100; +} + +.bx-def-z-index-nav { + z-index:5000; +} + +.bx-def-z-index-overlay { + z-index:9700; +} + +.bx-def-z-index-modal { + z-index:10000; +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/css/forms.css b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/css/forms.css new file mode 100644 index 0000000000..ab33579c6a --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/css/forms.css @@ -0,0 +1,691 @@ + +.bx-form-advanced-wrapper .bx-form-section-wrapper:first-child { + margin-top:0; +} + +.bx-form-advanced-wrapper .bx-form-section-wrapper:last-child { + margin-bottom:0; +} + +.bx-form-advanced-wrapper .bx-form-section-divider:first-child { + border:none; + padding:0; +} + +.bx-form-advanced-wrapper .bx-form-section-divider:first-child .bx-form-section-content { + padding-top:0; +} + +.bx-form-advanced-wrapper .bx-form-section-divider:last-child .bx-form-section-content { + padding-bottom:0; +} + +.bx-form-section-wrapper { + position:relative; +} + +.bx-form-section { + margin:0; +} + +.bx-form-section-header .bx-form-section-title { + display: -webkit-flex; + display: flex; + -webkit-align-items: center; + align-items: center; + -webkit-flex-wrap: nowrap; + flex-wrap: nowrap; + + line-height: 1.5rem; + text-transform: uppercase; +} + +.bx-form-section-header .bx-form-section-title .sys-icon { + color: inherit; +} + +.bx-form-section-header .bx-form-section-title u { + cursor: pointer; +} + +.bx-form-section-header .bx-form-section-title span { + white-space: nowrap; + text-transform: none; + font-size: 0.75rem; +} + +.bx-form-section-hidden .bx-form-section-content { + display:none; +} + +.bx-form-caption { + margin-bottom:5px; +} + +.bx-form-required { + color:red; +} + +.bx-form-warn { + color:red; + font-style:italic; +} + +.bx-form-option-info { + display: inline-flex; + flex-direction: column; +} + +.bx-form-info { + +} + +/* section toggler */ + +.bx-form-collapsable .bx-form-section-toggler { + display: -webkit-flex; + display: flex; + -webkit-align-items: center; + align-items: center; + -webkit-justify-content: center; + justify-content: center; + + width: 1.25rem; + height: 1.25rem; + + text-decoration:none; + + -moz-transform: rotate(180deg); + -webkit-transform: rotate(180deg); + -ms-transform: rotate(180deg); + -o-transform: rotate(180deg); + + -webkit-transition: all 0.5s ease; + -moz-transition: all 0.5s ease; + -ms-transition: all 0.5s ease; + -o-transition: all 0.5s ease; + + line-height: 1.25rem; +} + +.bx-form-collapsed .bx-form-section-toggler { + -moz-transform: rotate(0deg); + -webkit-transform: rotate(0deg); + -ms-transform: rotate(0deg); + -o-transform: rotate(0deg); +} + +.bx-form-section-toggler .sys-icon { + font-size: 0.875rem; +} + +/* form inputs */ +.bx-form-input-wrapper { + position: relative; +} + +.bx-form-input-disabled {} + +.bx-form-input-slider, +.bx-form-input-doublerange, +.bx-form-input-select_multiple, +.bx-form-input-select, +.bx-form-input-radio_set, +.bx-form-input-checkbox_set, +.bx-form-input-number, +.bx-form-input-time, +.bx-form-input-datepicker, +.bx-form-input-datetime, +.bx-form-input-textarea, +.bx-form-input-wrapper-password, +.bx-form-input-text, +.bx-form-input-price, +.bx-form-input-wrapper-price span { + + height:40px; + height:2.5rem; + width:100%; + + -moz-box-sizing: border-box; + -ms-box-sizing: border-box; + -webkit-box-sizing: border-box; + box-sizing: border-box; + + -webkit-appearance: none; + -moz-appearance: none; + appearance: none; + + padding:7px 3px 7px 3px; + padding:0.2rem 0.4rem; + + vertical-align:middle; + + border:2px solid #79bd9a; + border:0.125rem solid #79bd9a; + + -webkit-border-radius:0.3rem; + -moz-border-radius:0.3rem; + border-radius:0.3rem; + + outline:none; + + -ms-filter: "progid:DXImageTransform.Microsoft.Alpha(Opacity=90)"; + filter: alpha(opacity=90); + -moz-opacity: 0.9; + -khtml-opacity: 0.9; + opacity: 0.9; +} + +.bx-form-input-slider:focus, +.bx-form-input-doublerange:focus, +.bx-form-input-number:focus, +.bx-form-input-time:focus, +.bx-form-input-datepicker:focus, +.bx-form-input-datetime:focus, +.bx-form-input-textarea:focus, +.bx-form-input-text:focus, +.bx-form-input-price:focus, +.bx-form-input-wrapper-password.bx-form-input-focus { + border-color:#6caa8a; + + -ms-filter: "progid:DXImageTransform.Microsoft.Alpha(Opacity=100)"; + filter: alpha(opacity=100); + -moz-opacity: 1.0; + -khtml-opacity: 1.0; + opacity: 1.0; + + -webkit-transition: all 0.2s linear; + -moz-transition: all 0.2s linear; + -o-transition: all 0.2s linear; + transition: all 0.2s linear; +} +.bx-form-input-wrapper-password { + padding: 0 2.125rem 0 0; +} +.bx-form-input-wrapper-password > a { + position: absolute; + z-index: 1000; + + display: -webkit-flex; + display: flex; + -webkit-align-items: center; + align-items: center; + -webkit-justify-content: center; + justify-content: center; + + top: 0; + right: 0; + height: 100%; + + margin: 0 0.5rem; +} +.bx-form-input-password { + position: relative; + + -moz-box-sizing: border-box; + -ms-box-sizing: border-box; + -webkit-box-sizing: border-box; + box-sizing: border-box; + + width: 100%; + height: 100%; + + margin: 0; + padding: 7px 3px 7px 3px; + padding: 0.2rem 0.4rem; + + border: 0; + background-color: transparent; +} +.bx-form-input-password:focus { + border-color: transparent; + outline: none; + box-shadow: none; +} + +.bx-form-input-select_multiple, +.bx-form-input-radio_set, +.bx-form-input-checkbox_set { + height:auto; +} + +.bx-form-value .bx-form-input-radio_set, +.bx-form-value .bx-form-input-checkbox_set { + line-height: 2.0; +} + +.bx-form-value .bx-form-input-radio_set input, +.bx-form-value .bx-form-input-checkbox_set input, +.bx-form-value .bx-form-input-radio_set label, +.bx-form-value .bx-form-input-checkbox_set label { + display: inline-block; + vertical-align: middle; +} + +.bx-form-value .bx-form-input-radio_set label, +.bx-form-value .bx-form-input-checkbox_set label { + padding-left: 0.75rem; +} + +.bx-form-input-textarea { + padding:0.5rem; + height:150px; + height:10rem; + + line-height:normal; +} + +.bx-form-input-wrapper-dateselect select{ + min-width:70px; +} +.bx-form-input-wrapper-dateselect select.month{ + min-width:120px; +} + +.bx-form-input-datetime { + width:10.2rem; +} + +.bx-form-datepicker-modal { + z-index:10001 !important; +} + +.bx-form-input-number, +.bx-form-input-time +{ + width:6rem; +} + +.bx-form-input-wrapper-file .bx-btn { + float: none; +} +.bx-form-input-file { + position: fixed; + top: -1000px; + + border: none; + background-color: transparent; + visibility: hidden; +} + +.bx-form-input-wrapper-slider, +.bx-form-input-wrapper-doublerange { + position:relative; +} + +.bx-form-input-wrapper-slider .ui-slider, +.bx-form-input-wrapper-doublerange .ui-slider { + position:absolute; + top:0px; + right:0px; +} + +.bx-form-input-wrapper-slider .ui-slider .ui-slider-handle, +.bx-form-input-wrapper-doublerange .ui-slider .ui-slider-handle { + z-index: 1; +} + +/* price */ +.bx-form-element .bx-form-value .bx-form-input-wrapper-price { + display: -webkit-flex; + display: flex; + -webkit-align-items: stretch; + align-items: stretch; +} +.bx-form-element .bx-form-value .bx-form-input-wrapper-price span { + display: -webkit-flex; + display: flex; + -webkit-align-items: center; + align-items: center; + + width: auto; + border-right-width: 0; + border-top-right-radius: 0; + border-bottom-right-radius: 0; +} +.bx-form-input-wrapper-price span { + background-color: rgba(249, 250, 251, 1.0); +} +.bx-form-element .bx-form-value .bx-form-input-price:not(:first-child) { + border-top-left-radius: 0; + border-bottom-left-radius: 0; +} + +/* privacy group chooser */ +.bx-form-input-wrapper-pgc { + position: relative; +} + +.bx-form-input-pgc { + position: absolute; + display: -webkit-flex; + display: flex; + -webkit-align-items: center; + align-items: center; + -webkit-justify-content: center; + justify-content: center; + top: -1.375rem; + right: 0; + width: 1rem; + height: 1rem; +} + +.bx-form-input-pgc-popup .bx-form-input-wrapper-input_set { + display: -webkit-flex; + display: flex; + -webkit-flex-wrap: nowrap; + flex-wrap: nowrap; + -webkit-align-items: center; + align-items: center; +} + +/* help popup */ +.bx-form-input-help-popup { + max-width: 25rem; + max-height: 25rem; + overflow: auto; +} + +/* switcher element */ +.bx-switcher-cont input { + display: none !important; +} + +/* oneline element */ +.bx-form-element-wrapper-oneline .bx-form-element { + display: -webkit-flex; + display: flex; + -webkit-flex-flow: row nowrap; + flex-flow: row nowrap; + -webkit-align-items: center; + align-items: center; + -webkit-justify-content: flex-start; + justify-content: flex-start; +} +.bx-form-value-oneline, +.bx-form-caption-oneline { + float: none; +} +.bx-form-caption-oneline { + margin-bottom: 0; +} + +.bx-form-input-wrapper-submit .bx-btn { + float: none; +} +.bx-form-input-wrapper-input_set .bx-btn { + float:left; +} + +/* extra features */ + +.bx-form-right-line-aligned { + float:right; + margin-top: 5px; +} + +/* view mode */ +.bx-form-row-view-wrapper > div { + position: relative; + display: inline-block; + width: 100%; + + vertical-align: bottom; + white-space: normal; + text-overflow: ellipsis; + overflow: hidden; +} +.bx-form-row-view-ratevalue{ + display: flex !important; + justify-content: flex-start; +} +.bx-form-row-view-ratevalue .bx-form-row-view-value{ + flex-grow: 2; +} +.bx-form-row-view-wrapper-textarea > div { + vertical-align:top; +} + +.bx-form-row-view-caption { + font-weight:bold; +} + + +/**************************************** +* Custom reCaptcha Theme +****************************************/ +.bx-form-input-captcha-custom { + background-color: #b71800; + padding: 0.5em; + border-radius: 1em; + position: relative; + overflow: auto; + max-width: 480px; + font: 0.75em/1em Helvetica, Arial, sans-serif; + color: #ffffff; +} +.bx-form-input-captcha-custom a { + color: #ffffff; + text-decoration: none; +} +.bx-form-input-captcha-custom img, +.bx-form-input-captcha-custom #recaptcha_image { + width: 100% !important; + height: auto !important; + -webkit-border-radius: 0.5em; + -moz-border-radius: 0.5em; + border-radius: 0.5em; + -moz-background-clip: padding; + -webkit-background-clip: padding-box; + background-clip: padding-box; +} +.bx-form-input-captcha-custom .solution { + position: relative; + float: left; + width: 75%; +} +.bx-form-input-captcha-custom .solution-cnt { + margin-top: 0.5em; + padding: 1.2em 1em; + -webkit-border-radius: 0.5em; + -moz-border-radius: 0.5em; + border-radius: 0.5em; + -moz-background-clip: padding; + -webkit-background-clip: padding-box; + background-clip: padding-box; + background-color: #fbe098; + color: #000000; + display: block; +} +.bx-form-input-captcha-custom .solution-cnt input { + display: block; + width: calc(90% - 2px); + margin: 0.35em auto; + -webkit-appereance: none; + border: 1px solid #f7c236; + font: inherit; + font-size: 150%; + outline: none; +} +.bx-form-input-captcha-custom .solution-cnt input:focus { + border-color: #b71800; +} +.bx-form-input-captcha-custom .options { + position: relative; + float: right; + width: 25%; + +} +.bx-form-input-captcha-custom .options-cnt { + margin-top: 0.5em; + padding-left: 0.5em; + -webkit-border-radius: 0.5em; + -moz-border-radius: 0.5em; + border-radius: 0.5em; + -moz-background-clip: padding; + -webkit-background-clip: padding-box; + background-clip: padding-box; +} +.bx-form-input-captcha-custom .options-cnt a { + background-color: #c5523d; + display: block; + padding: 0.5em 1.0em; + border-top: 1px solid #000000; + border-left: 1px solid #000000; + border-right: 1px solid #000000; +} +.bx-form-input-captcha-custom .options-cnt a:first-child { + border-radius: 0.5em 0.5em 0 0; +} +.bx-form-input-captcha-custom .options-cnt a:last-child { + border-radius: 0 0 0.5em 0.5em; + border-bottom: 1px solid #000000; +} + + +/**************************************** +* Overwrite 3d Party MiniColors plug-in +****************************************/ +.bx-form-input-wrapper.bx-form-input-wrapper-text .minicolors-theme-bootstrap .minicolors-swatch { + top: 6px; + left: 6px; + + width: 25px; + width: 1.5625rem; + height: 25px; + height: 1.5625rem; + + border-radius: 20px; + border-radius: 1.25rem; +} + +/* auto-siggestion input */ + +.bx-form-value .bx-form-input-autotoken { + float:left; + padding:0px; + height:auto; + box-shadow: none; + padding: 2px; +} +.bx-form-value .bx-form-input-autotoken b { + cursor:pointer; + display:block; + float:left; + padding-right: 1.5em; + margin:0.1em; + font-weight:normal; + border-radius: 1.25rem; +} +.bx-form-value .bx-form-input-autotoken b.val-wo-icon { + padding-left: 1.5em; +} +.bx-form-value .bx-form-input-autotoken b:hover { + opacity:0.7; +} +.bx-form-value .bx-form-input-autotoken b:after { + font-family: 'sys-user', 'sys-user-fal'; + content: "\f00d"; + position:absolute; + padding:0 0.5em; + margin-left: 0.25em; + font-size:0.7em; + font-weight:bold; +} +.bx-form-value .bx-form-input-autotoken.bx-form-input-disabled b { + cursor: default; +} +.bx-form-value .bx-form-input-autotoken.bx-form-input-disabled b:after{ + display: none; +} +.bx-form-value .bx-form-input-autotoken input { + border:0; + margin:0; + padding:0 0 0 5px; + width:auto; + float:left; + box-shadow: none; +} +.bx-form-value .bx-form-input-autotoken .bx-def-thumb-size { + width: 2.5rem; + height: 2.5rem; + line-height: 2.5rem; + float:left; +} +.bx-form-value .bx-form-input-autotoken .bx-base-pofile-unit-wo-info { + display: inline-block; + vertical-align: middle; + + margin-right: 8px; + margin-right: 0.5rem; +} +.bx-form-value .bx-form-input-labels-sel b { + display:inline-block; + line-height:1.5rem; + font-size:85%; + padding-right:1em; + margin-top:0.625rem; + font-style:normal; +} +.bx-form-value .bx-form-input-labels-sel b:after { + display:none; +} +.select2-container { + width:100% !important; +} + +/* Location field */ + +.bx-form-input-location-cont:not(.minimized) .bx-form-input-location-country, +.bx-form-input-location-cont:not(.minimized) .bx-form-input-location-zip, +.bx-form-input-location-cont:not(.minimized) .bx-form-input-location-state, +.bx-form-input-location-cont:not(.minimized) .bx-form-input-location-city { + width:49%; +} + +.bx-form-input-location-street { + width:83%; +} + +.bx-form-input-location-street_number { + width:15%; +} + +.bx-form-input-location-street_number, +.bx-form-input-location-street, +.bx-form-input-location-state, +.bx-form-input-location-city { + margin-bottom:0.25rem; +} + +.bx-form-input-location-cont .bx-form-input-location-status-cont { + float:none; + width:98%; + line-height:normal; +} +.bx-form-input-location-cont.minimized .bx-form-input-location-status-cont { + display: flex; + flex-direction: column; + width: auto; +} +.bx-form-input-location-status { + float:left; +} +.bx-form-input-location-copyright { + float:right; +} +.bx-form-input-location-cont.minimized .bx-form-input-location-copyright { + float: none; + margin-top: 0.25rem; +} + +.bx-form-input-location-auto-cont { + display:table; +} +.bx-form-input-location-auto-cont > div { + display:table-cell; + vertical-align:middle; +} +.combodate { + display: flex; +} diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/css/general.css b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/css/general.css new file mode 100644 index 0000000000..d7a3559fd1 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/css/general.css @@ -0,0 +1,686 @@ + +.bx-page-image-container img, +.bx-page-html-container img { + max-width:100%; + height:auto; +} +.bx-page-html-container { + overflow:hidden; +} + +/* --------------- toolbar */ + +.bx-toolbar-anim { + -webkit-transition: all .25s ease-in-out; + -moz-transition: all .25s ease-in-out; + -o-transition: all .25s ease-in-out; + transition: all .25s ease-in-out +} + +.bx-toolbar-reset { + -webkit-transform: translateY(0); + -ms-transform: translateY(0); + transform: translateY(0) +} + +.bx-toolbar-up { + -webkit-transform: translateY(-100%); + -ms-transform: translateY(-100%); + transform: translateY(-100%) +} + +#bx-toolbar { + position:fixed; + width:100%; + height:48px; + height:3rem; +} + +.bx-toolbar-content { + display: -webkit-flex; + display: flex; + z-index: 500; + + -webkit-justify-content: flex-start; + justify-content: flex-start; + + -webkit-align-items: center; + align-items: center; + + -webkit-flex-flow: row nowrap; + flex-flow: row nowrap; +} +.bx-toolbar-content .bx-toolbar-item { + position: relative; + -webkit-flex: 0 1 auto; + -ms-flex: 0 1 auto; + flex: 0 1 auto; +} +.bx-toolbar-content .bx-toolbar-item.bx-ti-stretcher { + -webkit-flex-grow: 1; + flex-grow: 1; + white-space: nowrap; +} + +.bx-toolbar-content .bx-toolbar-item.bx-ti-logo { + white-space: nowrap; +} + +.bx-toolbar-content .bx-toolbar-item.bx-ti-logo img { + display: block; +} + +#bx-menu-toolbar-1-container, +#bx-menu-toolbar-2-container { + position:relative; +} + +#bx-logo-container { + -moz-box-sizing: border-box; + -ms-box-sizing: border-box; + box-sizing: border-box; + + height: 3rem; + margin:0 1.0rem; + + text-align: center; + font-size: 2rem; +} + +#bx-logo-container a { + position: relative; + display: block; + + text-decoration: none; +} + +#bx-logo-container a span { + position: relative; + display: block; + + max-width: 100%; + + line-height: 48px; + line-height: 3rem; + + white-space: nowrap; + overflow: hidden; + text-overflow: ellipsis; +} + +#bx-logo { + vertical-align:middle; +} + +/* --------------- Submenu */ +.bx-menu-main-bar-gap { + position: relative; +} +.bx-media-tablet .bx-menu-main-bar-gap.bx-def-page-width, +.bx-media-phone .bx-menu-main-bar-gap.bx-def-page-width { + width: 100%; +} +.bx-media-phone .bx-menu-main-bar-gap { + padding-left: 0; + padding-right: 0; +} +.bx-menu-main-bar-wrapper { + position: relative; + + border-top-left-radius: 0; + border-top-right-radius: 0; +} +.bx-menu-main-bar-wrapper:before, +.bx-menu-main-bar-wrapper:after { + display: block; + content: ""; + position: absolute; + top: 0; + width: 1.0rem; + height: 100%; + z-index: 1; +} +.bx-menu-main-bar-wrapper:before { + left: 0px; +} +.bx-menu-main-bar-wrapper:after { + right: 0px; +} +.bx-media-phone .bx-menu-main-bar-wrapper { + border-left-width: 0; + border-right-width: 0; + border-bottom-left-radius: 0; + border-bottom-right-radius: 0; +} +.bx-media-phone .bx-menu-main-bar-wrapper:before { + border-bottom-left-radius: 0; +} +.bx-media-phone .bx-menu-main-bar-wrapper:after { + border-bottom-right-radius: 0; +} + +.bx-menu-main-bar { + text-align: center; + + -webkit-overflow-scrolling: touch; +} +.bx-menu-main-bar:not(.bx-menu-more-auto) { + overflow-x: auto; +} + +.bx-menu-main-bar-cnt { + height: 2.5rem; +} +.bx-menu-main-bar-gap.bx-menu-main-bar-hidden, +.bx-menu-main-bar-wrapper.bx-menu-main-bar-hidden, +.bx-menu-main-bar.bx-menu-main-bar-hidden { + display: none; +} + + +/* --------------- content */ + +#bx-content-wrapper { + position: relative; + -webkit-flex-grow: 3; + flex-grow: 3; +} + +/* --------------- footer */ + +#bx-footer-wrapper { + position: relative; + + -webkit-flex-grow: 0; + flex-grow: 0; + + width: 100%; + bottom: 0; +} +#bx-footer-wrapper .bx-def-hr { + margin-top: 0px; +} +#bx-menu-bottom ul { + text-align: center; +} +#bx-menu-bottom ul li { + line-height: 2rem; +} +.bx-menu-switch-language-inline { + float: none; + clear: both; +} +.bx-menu-switch-language-inline .bx-menu-hor { + text-align: center; +} +.bx-menu-switch-language-inline .bx-menu-hor li { + float: none; + display: inline-block; +} + +/* --------------- System objects like Views, Votes, Comments, etc, */ +.sys-action-counter.sys-ac-hidden { + display: none; +} +.sys-action-counter.sys-action-counter-iconset .sys-ac-link { + padding-left: 0.75rem; +} +.bx-media-phone .sys-action-counter.sys-action-counter-iconset .sys-ac-link, +.bx-media-tablet .bx-layout-column-thin .sys-action-counter.sys-action-counter-iconset .sys-ac-link, +.bx-media-tablet .bx-layout-column-half .sys-action-counter.sys-action-counter-iconset .sys-ac-link { + padding-left: 1.0rem; +} + +.sys-action-counter.sys-action-counter-iconset .bx-def-icon-size { + width: 1.5rem; + height: 1.5rem; +} +.sys-action-counter.sys-action-counter-iconset .bx-base-pofile-unit-wo-info, +.sys-action-counter.sys-action-counter-iconset .sys-action-counter-icon { + margin-left: -0.5rem; +} +.bx-media-phone .sys-action-counter.sys-action-counter-iconset .bx-base-pofile-unit-wo-info, +.bx-media-phone .sys-action-counter.sys-action-counter-iconset .sys-action-counter-icon, +.bx-media-tablet .bx-layout-column-thin .sys-action-counter.sys-action-counter-iconset .bx-base-pofile-unit-wo-info, +.bx-media-tablet .bx-layout-column-thin .sys-action-counter.sys-action-counter-iconset .sys-action-counter-icon, +.bx-media-tablet .bx-layout-column-half .sys-action-counter.sys-action-counter-iconset .bx-base-pofile-unit-wo-info, +.bx-media-tablet .bx-layout-column-half .sys-action-counter.sys-action-counter-iconset .sys-action-counter-icon { + margin-left: -0.75rem; +} + +/* --------------- 'Add to Homescreen' popup */ +.ath-container { + color: #333; +} + +/* --------------- Account */ +div.bx-account-unit-online { + position: absolute; + right: 0; + bottom: 0; + width: 0.625rem; + height: 0.625rem; + border: 1px solid #ffffff; + border-radius: 0.625rem; + background-color: #7ed321; +} + +/* --------------- Mentions */ + +.bx-mention-row{ + display: flex !important; + align-items: center; +} + +.bx-mention-row img { + width:1rem; + height:1rem; + vertical-align:middle; + +} + +.bx-mention-row span { + vertical-align:middle; + margin-right: 10px; +} + +/* --------------- Profile Avatar */ +.bx-profile-avatar { + overflow: hidden; +} + +.bx-profile-avatar-cnt { + display: -webkit-flex; + display: flex; + -webkit-align-items: center; + align-items: center; + -webkit-justify-content: flex-start; + justify-content: flex-start; +} + +.bx-profile-avatar .bx-def-ava-size { + width: 3.75rem; + height: 3.75rem; +} + +.bx-profile-avatar .bx-def-ava-size, +.bx-profile-avatar div.bx-def-unit-img p.bx-base-pofile-unit-thumb.bx-def-ava-size { + line-height: 3.5rem; + font-size: 2.325rem; +} + +.bx-profile-avatar .bx-pa-img, +.bx-profile-avatar .bx-pa-actions { + -webkit-flex: 0 2 auto; + flex: 0 2 auto; +} + +.bx-profile-avatar .bx-pa-info { + -webkit-flex: 1 1 auto; + flex: 1 1 auto; + overflow: hidden; +} + +.bx-profile-avatar .bx-pa-info-cnt { + display: -webkit-flex; + display: flex; + -webkit-align-items: flex-start; + align-items: flex-start; + -webkit-flex-direction: column; + flex-direction: column; +} + +.bx-profile-avatar .bx-pai-line, +.bx-profile-avatar .bx-pai-line a { + max-width: 100%; +} +.bx-profile-avatar .bx-pai-line a { + display: inline-block; + overflow: hidden; + text-overflow: ellipsis; +} + +.bx-profile-avatar .bx-pa-action { + width: 2rem; + height: 2rem; + + border-radius: 2rem; +} +.bx-profile-avatar .bx-pa-action .sys-icon { + display: inline-block; + text-align: center; + line-height: 1.5rem; + width: 1.5rem; + height: 1.5rem; + font-size: 1.0rem; +} + +.bx-profile-avatar-switcher .bx-def-hr { + display: none; +} +.bx-profile-avatar-switcher .sys-profile-switch-row { + padding-left: 0px; + padding-right: 0px; +} + + +/* --------------- Profile Stats */ +.bx-profile-stats { + overflow: hidden; +} + +.bx-profile-stats .bx-ps-user-cnt { + display: -webkit-flex; + display: flex; + -webkit-align-items: center; + align-items: center; + -webkit-justify-content: flex-start; + justify-content: flex-start; +} + +.bx-profile-stats .bx-ps-user-cnt .bx-def-ava-size { + width: 3.75rem; + height: 3.75rem; +} + +.bx-profile-stats .bx-ps-user-cnt .bx-def-ava-size, +.bx-profile-stats .bx-ps-user-cnt div.bx-def-unit-img p.bx-base-pofile-unit-thumb.bx-def-ava-size { + line-height: 3.5rem; + font-size: 2.325rem; +} + +.bx-profile-stats .bx-ps-user-img { + -webkit-flex: 0 2 auto; + flex: 0 2 auto; +} + +.bx-profile-stats .bx-ps-user-info { + -webkit-flex: 1 1 auto; + flex: 1 1 auto; + overflow: hidden; +} + +.bx-profile-stats .bx-ps-user-info-cnt { + display: -webkit-flex; + display: flex; + -webkit-align-items: flex-start; + align-items: flex-start; + -webkit-flex-direction: column; + flex-direction: column; +} +.bx-profile-stats .bx-ps-user-line, +.bx-profile-stats .bx-ps-user-line a { + max-width: 100%; +} +.bx-profile-stats .bx-ps-user-line a { + display: inline-block; + overflow: hidden; + text-overflow: ellipsis; +} + +.bx-menu-vertical-more-less li.bx-psmi-show-more:hover, +.bx-menu-vertical-more-less li.bx-psmi-show-less:hover { + background-color: transparent; +} + + +/* --------------- Join/Login Forms */ + +.sys-jf .bx-form-advanced .bx-form-element .bx-form-input-submit.bx-btn, +.sys-lf .bx-form-advanced .bx-form-element .bx-form-input-submit.bx-btn { + width: 100%; + -webkit-justify-content: center; + justify-content: center; + text-align: center; +} +#bx-form-element-submit_text .bx-form-value { + text-align: right; +} +.sys-jf-login .bx-btn, +.sys-lf-join .bx-btn { + display: block; +} + + +/* --------------- Create Post Form */ + +.sys-create-post-form { + position: relative; +} + +.sys-create-post-form .bx-loading-ajax { + display: -webkit-flex; + display: flex; + -webkit-align-items: center; + align-items: center; + -webkit-justify-content: center; + justify-content: center; + + top: 0; + width: 100%; + height: 100%; +} + +.sys-cpf-header { + position: relative; + display: -webkit-flex; + display: flex; + -webkit-justify-content: space-between; + justify-content: space-between; + + height: 3.125rem; + + border-bottom: 2px solid rgba(0,0,0,0.1); +} +.sys-cpf-title, +.sys-cpf-submenu { + position: relative; + -webkit-flex: 0 1 auto; + -ms-flex: 0 1 auto; + flex: 1 1 auto; + line-height: 3.125rem; +} +.sys-cpf-title, +.sys-cpf-submenu-cnt { + height: 3.125rem; +} + +.sys-cpf-title { + -webkit-flex-grow: 3; + flex-grow: 3; + + max-width: 20%; + + white-space: nowrap; + font-size: 1rem; + font-weight: 400; +} +.sys-cpf-title-cnt { + white-space: nowrap; + overflow: hidden; + text-overflow:ellipsis; +} +.sys-cpf-submenu { + max-width: 80%; +} +.bx-media-phone .sys-cpf-title { + max-width: 30%; +} +.bx-media-phone .sys-cpf-submenu { + max-width: 70%; +} +.sys-cpf-submenu-cnt ul.bx-menu-custom.bx-menu-custom-hor.bx-menu-more-auto:not(.bx-menu-submenu-more-auto) { + display: -webkit-flex; + display: flex; + -webkit-justify-content: flex-end; + justify-content: flex-end; +} +.sys-cpf-submenu-cnt ul.bx-menu-submenu-more-auto { + line-height: normal; +} +.sys-cpf-submenu-cnt ul li { + border-radius: 0; + + white-space: nowrap; +} +.sys-cpf-submenu-cnt ul:not(.bx-menu-submenu-more-auto) > li { + -webkit-flex: 0 1 auto; + -ms-flex: 0 1 auto; + flex: 0 1 auto; + + height: 3.125rem; + border-bottom: 2px solid transparent; + + line-height: 3.125rem; +} +.sys-cpf-submenu-cnt ul li > span { + margin: 0; + padding: 0; +} +.sys-cpf-submenu-cnt ul li:not(.bx-menu-item-more-auto) a .sys-icon { + display: none; +} +.sys-cpf-submenu-cnt ul li:not(.bx-menu-item-more-auto) a span, +.sys-cpf-submenu-cnt ul.bx-menu-custom.bx-menu-custom-ver.bx-menu-submenu-more-auto li:not(.bx-menu-item-more-auto) a span { + margin: 0; +} +.sys-cpf-submenu-cnt ul li.bx-menu-tab-active { + border-bottom: 2px solid #364f6b; +} +.sys-cpf-form { + position: relative; +} +.sys-cpf-form:not(.sys-cpf-loading) { + -webkit-animation: sys-cpf-scale-in 0.4s cubic-bezier(0.37, 0.82, 0.2, 1); + animation: sys-cpf-scale-in 0.4s cubic-bezier(0.37, 0.82, 0.2, 1); +} +.sys-cpf-form .bx-uploader-ghost .bx-base-general-icon-wrapper img { + max-width: 9.375rem; +} +.sys-cpf-close { + position: absolute; + display: none; + + right: 0; + bottom: 0; +} + +@keyframes sys-cpf-scale-in { + 0% { + opacity: 0; + transform: scale(0.9); + } + 100% { + opacity: 1; + transform: scale(1.0); + } +} + +@-webkit-keyframes sys-cpf-scale-in { + 0% { + opacity: 0; + transform: scale(0.9); + } + 100% { + opacity: 1; + transform: scale(1.0); + } +} + +/* --------------- Account Unit */ +.bx-account-unit .bx-def-unit-img, +.bx-account-unit-wo-info .bx-def-unit-img { + position: relative; + overflow: visible; +} + + +/* --------------- Author Info */ +.sys-author-profile ul.bx-menu-custom.bx-menu-custom-hor { + webkit-align-items: center; + align-items: center; + -webkit-flex-wrap: wrap; + flex-wrap: wrap; + + line-height: 0.625rem; +} +.sys-author-profile ul.bx-menu-custom.bx-menu-custom-hor > li.bx-menu-item-nl { + display: none; +} +.sys-author-profile .bx-menu-custom.bx-menu-custom-hor > li > span { + margin-right: 0; +} +.sys-author-profile .bx-menu-custom.bx-menu-custom-hor > li > span.bx-base-profile-unit-meta-item { + padding: 0.25rem; + white-space: nowrap; +} +.sys-author-profile .bx-menu-custom.bx-menu-custom-hor > li:first-child .bx-base-general-unit-meta-div { + display: none; +} + +/* --------------- Author Info */ + +audio.bx-player-embed, +video.bx-player-embed { + width:100vw; + height:100vh; +} + +/* --------------- Search */ + +.bx-sys-search-results-pages { + text-align:left; + line-height:150%; +} + +.bx-page-block-container .bx-search-results:first-child { + padding-top:0; +} + +/* --------------- Content loader placeholder */ + +@-webkit-keyframes bxPlaceHolderShimmer { + 0% { + background-position: -468px 0; + } + 100% { + background-position: 468px 0; + } +} + +@keyframes bxPlaceHolderShimmer { + 0% { + background-position: -468px 0; + } + 100% { + background-position: 468px 0; + } +} + +.bx-cont-ph-inline, +.bx-cont-ph { + -webkit-animation-duration: 1s; + animation-duration: 1s; + -webkit-animation-fill-mode: forwards; + animation-fill-mode: forwards; + -webkit-animation-iteration-count: infinite; + animation-iteration-count: infinite; + -webkit-animation-name: bxPlaceHolderShimmer; + animation-name: bxPlaceHolderShimmer; + -webkit-animation-timing-function: linear; + animation-timing-function: linear; + background: #f6f7f8; + background: -webkit-gradient(linear, left top, right top, color-stop(8%, #eeeeee), color-stop(18%, #dddddd), color-stop(33%, #eeeeee)); + background: -webkit-linear-gradient(left, #eeeeee 8%, #dddddd 18%, #eeeeee 33%); + background: linear-gradient(to right, #eeeeee 8%, #dddddd 18%, #eeeeee 33%); + -webkit-background-size: 800px 104px; + background-size: 800px 104px; + position: relative; +} + +.bx-cont-ph-inline { + display:inline-block; +} +.bx-embeded-image{ + display: none; +} \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/css/score.css b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/css/score.css new file mode 100644 index 0000000000..d0c2f5d925 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/css/score.css @@ -0,0 +1,60 @@ +/*-- +import url(../../../../../../../template/css/score.css); +--*/ + +/*--- Voted By ---*/ +div.bx-score-by-list {} +div.bx-score-by-list-cnt { + max-height: 12.5rem; + min-width: 13.75rem; + overflow: auto; +} +div.bx-score-by-list div.bx-base-pofile-unit { + float: none; + margin-right: 0px; + margin-bottom: 0px; +} +div.bx-score-by-item { + display: -webkit-flex; + display: flex; + align-items: center; + -webkit-align-items: center; + flex-wrap: nowrap; + -webkit-flex-wrap: nowrap; +} +div.bx-score-by-item .bx-score-bi-user, +div.bx-score-by-item .bx-score-bi-info, +div.bx-score-by-item .bx-score-bi-vote { + -webkit-flex: 0 1 auto; + -ms-flex: 0 1 auto; + flex: 0 1 auto; +} +div.bx-score-by-item .bx-score-bi-info { + -webkit-flex-grow: 3; + flex-grow: 3; +} +div.bx-score-by-item .bx-score-bi-vote { + width: 1.25rem; + height: 1.25rem; +} + + +/*--- Counter Styles ---*/ +.bx-score-counter-wrapper.bx-sc-hidden { + display: none; +} +.bx-score-counter .bx-score-counter-label .bx-score-counter-text { + width: auto; + height: auto; + margin-left: 0.5rem; + margin-right: 0.5rem; +} +.bx-base-general-entity-actions .bx-menu-custom-hor.bx-menu-more-auto .bx-score-counter-holder { + border-width: 0; +} +.bx-base-general-entity-actions .bx-menu-custom-hor.bx-menu-more-auto .bx-score-counter-holder.bx-score-ch-divided { + margin-left: 0.125rem; +} +.bx-base-general-entity-actions .bx-menu-custom-hor.bx-menu-more-auto .bx-score-counter-holder .bx-score-counter-label { + padding: 0; +} \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/css/vote.css b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/css/vote.css new file mode 100644 index 0000000000..878388f115 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/css/vote.css @@ -0,0 +1,240 @@ +.bx-vote .sys-action-element-holder .sys-action-do-icon svg, +.bx-vote-counter .bx-vote-counter-label .bx-vote-counter-icon svg { + width: 1.25rem; + height: 1.25rem; +} +.bx-vote .bx-vote-counter .bx-vote-counter-label { + padding: 0; +} +.bx-vote .bx-vote-counter .bx-vote-counter-label .bx-vote-counter-text { + margin: 0; +} + +/*----------------------------------*/ +/*--- Likes based Element Styles ---*/ +/*----------------------------------*/ +.bx-vote-counter-likes span.bx-vote-counter-text { + width: auto; + height: auto; +} + +/*--------------------------------------*/ +/*--- Reactions based Element Styles ---*/ +/*--------------------------------------*/ +.bx-vote-counter-wrapper-reactions .bx-vote-counter { + display: inline-block; +} +.bx-vote-counter-wrapper-reactions.bx-vote-counter-wrapper-reactions-compound { + position: relative; +} +.bx-vote-counter-wrapper-reactions.bx-vote-counter-wrapper-reactions-compound .bx-vote-counter { + display: block; +} +.bx-vote-counter-wrapper-reactions.bx-vote-counter-wrapper-reactions-divided a.bx-vote-counter { + margin-right: 0.5rem; +} +.bx-media-phone .bx-vote-counter-wrapper-reactions.bx-vote-counter-wrapper-reactions-compound .sys-ac-link, +.bx-media-tablet .bx-layout-column-thin .bx-vote-counter-wrapper-reactions.bx-vote-counter-wrapper-reactions-compound .sys-ac-link, +.bx-media-tablet .bx-layout-column-half .bx-vote-counter-wrapper-reactions.bx-vote-counter-wrapper-reactions-compound .sys-ac-link { + padding-left: 1.0rem; +} +.bx-vote-counter-wrapper-reactions.bx-vote-counter-wrapper-reactions-compound a.bx-vote-counter.total-count, +.bx-vote-counter-wrapper-reactions.bx-vote-counter-wrapper-reactions-compound span.bx-vote-counter.total-count { + width: auto; + height: auto; + margin-left: 0.5rem; + margin-right: 0.5rem; +} +.bx-vote-counter-wrapper-reactions.bx-vote-counter-wrapper-reactions-compound a.bx-vote-counter.total-count .sys-action-counter-text:first-child, +.bx-vote-counter-wrapper-reactions.bx-vote-counter-wrapper-reactions-compound span.bx-vote-counter.total-count .sys-action-counter-text:first-child { + margin-left: 0; +} +.bx-vote-counter-wrapper-reactions.bx-vote-counter-wrapper-reactions-compound span.bx-vote-counter:not(.total-count) { + margin-left: -0.5rem; +} +.bx-media-phone .bx-vote-counter-wrapper-reactions.bx-vote-counter-wrapper-reactions-compound span.bx-vote-counter:not(.total-count), +.bx-media-tablet .bx-layout-column-thin .bx-vote-counter-wrapper-reactions.bx-vote-counter-wrapper-reactions-compound span.bx-vote-counter:not(.total-count), +.bx-media-tablet .bx-layout-column-half .bx-vote-counter-wrapper-reactions.bx-vote-counter-wrapper-reactions-compound span.bx-vote-counter:not(.total-count) { + margin-left: -0.75rem; +} +.bx-vote-counter-wrapper-reactions.bx-vote-counter-wrapper-reactions-compound .bx-vote-counter-label { + padding: 0; +} +.bx-vote-counter-wrapper-reactions.bx-vote-counter-wrapper-reactions-compound span.bx-vote-counter:not(.total-count) span.bx-vote-counter-text { + display: none; +} +.bx-vote-counter-wrapper-reactions.bx-vc-hidden, +.bx-vote-counter-wrapper-reactions .bx-vote-counter.bx-vc-hidden { + display: none; +} +.bx-menu-object-sys_vote_reactions_do li.bx-menu-item { + padding: 0.25rem; +} +.bx-menu-object-sys_vote_reactions_do li.bx-menu-item .sys-icon { + width: 2rem; + height: 2rem; + font-size: 1.5rem; +} + +/*----------------------------------*/ +/*--- Stars based Element Styles ---*/ +/*----------------------------------*/ +.bx-vote-stars { + -webkit-flex-direction: column; + flex-direction: column; + -webkit-align-items: flex-start; + align-items: flex-start; +} +.bx-vote-stars .bx-vote-element-holder a.bx-vote-button, +.bx-vote-stars .bx-vote-element-holder i.bx-vote-star, +.bx-vote-stars .bx-vote-element-holder span.bx-vote-star { + position: relative; + display: inline-block; + vertical-align: top; + height: 1rem; + width: 1rem; + margin: 0; + padding: 0; + text-align: center; +} + + +/*--- Voted By ---*/ +div.bx-vote-by-list {} +div.bx-vote-by-list-cnt { + max-height: 12.5rem; + min-width: 13.75rem; + overflow: auto; +} +div.bx-vote-by-list div.bx-base-pofile-unit { + float: none; + margin-right: 0px; + margin-bottom: 0px; +} +.bx-vote-bls-header { + display: -webkit-flex; + display: flex; + + margin: -1.25rem -1.25rem 0 -1.25rem; +} +.bx-vote-bls-content { + margin-left: -0.5rem; + margin-right: -0.5rem; +} +.bx-vote-bls-title, +.bx-vote-bls-submenu { + -webkit-flex: 0 1 auto; + -ms-flex: 0 1 auto; + flex: 0 1 auto; + line-height: 3.125rem; +} +.bx-vote-bls-title, +.bx-vote-bls-submenu-cnt, +.bx-vote-bls-filler { + height: 3.125rem; +} +.bx-vote-bls-title, +.bx-vote-bls-filler { + -webkit-flex-grow: 3; + flex-grow: 3; + + border-bottom: 2px solid rgba(232, 232, 232, 1.0); +} +.bx-vote-bls-title { + display: none; + + white-space: nowrap; + font-size: 1rem; + font-weight: 400; +} +.bx-vote-bls-submenu { + overflow-x: auto; + overflow-y: hidden; + + -webkit-overflow-scrolling: touch; +} +.bx-vote-bls-submenu-cnt { + box-sizing: border-box; + padding: 0 0.5rem; + border-bottom-width: 2px; + border-bottom-style: solid; +} +.bx-vote-bls-submenu::-webkit-scrollbar { + width: 0.5rem; +} +.bx-vote-bls-submenu::-webkit-scrollbar-track { + -webkit-border-radius: 0.5rem; + border-radius: 0.5rem; + + background-color: rgba(0, 0, 0, 0.1); +} +.bx-vote-bls-submenu::-webkit-scrollbar-thumb { + -webkit-border-radius: 0.5rem; + border-radius: 0.5rem; + + background: rgba(255, 255, 255, 0.9); + -webkit-box-shadow: inset 0 0 1px rgba(0, 0, 0, 0.5); +} +.bx-vote-bls-submenu::-webkit-scrollbar-thumb:window-inactive { + background: rgba(255, 255, 255, 0.4); +} +.bx-vote-bls-submenu-cnt ul { + display: -webkit-flex; + display: flex; +} +.bx-vote-bls-submenu-cnt ul li { + -webkit-flex: 0 1 auto; + -ms-flex: 0 1 auto; + flex: 0 1 auto; + box-sizing: border-box; + height: 3.125rem; + + border-bottom: 2px solid transparent; + border-radius: 0; + + line-height: 3.0rem; + white-space: nowrap; +} +.bx-vote-bls-submenu-cnt ul li .bx-stl-mil, +.bx-vote-bls-submenu-cnt ul li .bx-stl-mil-wo-gaps { + border-width: 0; +} +.bx-vote-bls-submenu-cnt ul li.bx-menu-inter-pas .bx-menu-item-cnt, +.bx-vote-bls-submenu-cnt ul li.bx-menu-inter-act .bx-menu-item-inter { + line-height: 3.0rem; +} +.bx-vote-bls-submenu-cnt ul li a.bx-menu-item-inter, +.bx-vote-bls-submenu-cnt ul li div.bx-menu-item-inter { + padding-top: 0; + padding-bottom: 0; +} +.bx-vote-bls-submenu-cnt ul li.bx-menu-inter-act > div { + font-weight: bold; +} +.bx-vote-bls-content .bx-vote-by-list:not(.bx-vote-bl-summary) { + display: none; +} +.bx-vote-bls-content .bx-vote-by-items { + padding-left: 0.5rem; + padding-right: 0.5rem; +} +.bx-vote-bls-content .bx-vote-by-item { + position: relative; + display: -webkit-flex; + display: flex; + -webkit-justify-content: space-between; + justify-content: space-between; + -webkit-align-items: center; + align-items: center; +} +.bx-vote-bls-content .bx-vote-by-item:first-child { + padding-top: 1rem; +} +.bx-vote-bls-content .bx-vote-by-item:last-child { + padding-bottom: 0; +} + +.bx-vote-bls-content .bx-vote-by-item:before, +.bx-vote-bls-content .bx-vote-by-item:after { + display: none; +} \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/logo_main.html b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/logo_main.html new file mode 100644 index 0000000000..0214084529 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/logo_main.html @@ -0,0 +1,8 @@ + + __logo__ + + + + + + \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/menu_icon.html b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/menu_icon.html new file mode 100644 index 0000000000..fcea8e9d9d --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/menu_icon.html @@ -0,0 +1,3 @@ + + +__icon__ \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/score_counter_wrapper.html b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/score_counter_wrapper.html new file mode 100644 index 0000000000..8238afdf1b --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/score_counter_wrapper.html @@ -0,0 +1,6 @@ + + + __counter__ + __script__ + + \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/score_element_block.html b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/score_element_block.html new file mode 100644 index 0000000000..34e12bc74e --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/score_element_block.html @@ -0,0 +1,21 @@ + + + + __do_vote__ + + style="display:none">__counter__ + + + + style="display:none">__counter__ + + + __do_vote__ + + style="display:none">__counter__ + + + + __legend__ + __script__ + \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/score_element_inline.html b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/score_element_inline.html new file mode 100644 index 0000000000..687cc216b5 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/score_element_inline.html @@ -0,0 +1,7 @@ + + + __do_vote__ style="display:none">__counter__ + style="display:none">__counter__ + __do_vote__ style="display:none">__counter__ + __script__ + \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseAuditGrid.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseAuditGrid.php new file mode 100644 index 0000000000..76492c5635 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseAuditGrid.php @@ -0,0 +1,242 @@ +_oTemplate->addCss(array_merge($aCssCalendar, ['manage_tools.css'])); + $this->_oTemplate->addJs(array_merge($aJsCalendar, ['BxDolAuditManageTools.js', 'BxDolGrid.js'])); + $this->_oTemplate->addJsTranslation(['_sys_grid_search']); + + return $this->getJsCode() . parent::getCode($isDisplayHeader); + } + + public function getJsCode() + { + $aParams = array( + 'sObjName' => $this->sJsObject, + 'aHtmlIds' => array(), + 'oRequestParams' => array(), + 'sObjNameGrid' => 'sys_audit_administration' + ); + return BxDolTemplate::getInstance()->_wrapInTagJsCode("var " . $this->sJsObject . " = new BxDolAuditManageTools(" . json_encode($aParams) . ");"); + } + + protected function _getCellAdded($mixedValue, $sKey, $aField, $aRow) + { + return parent::_getCellDefault(bx_time_js($mixedValue), $sKey, $aField, $aRow); + } + + protected function _getCellAction ($mixedValue, $sKey, $aField, $aRow) + { + return parent::_getCellDefault(_t($aRow['action_lang_key'], $aRow['action_lang_key_params']), $sKey, $aField, $aRow); + } + + protected function _getCellContentId ($mixedValue, $sKey, $aField, $aRow) + { + $mixedValue = ''; + if ($aRow['content_id'] > 0){ + $sLink = BxDolRequest::serviceExists($aRow['content_module'], 'get_link') ? BxDolService::call($aRow['content_module'], 'get_link', array($aRow['content_id'])) : ''; + $sTitle = BxDolRequest::serviceExists($aRow['content_module'], 'get_title') ? BxDolService::call($aRow['content_module'], 'get_title', array($aRow['content_id'])) : $aRow['content_title']; + if ($sLink){ + $mixedValue = BxDolTemplate::getInstance()->parseLink($sLink, $sTitle); + } + else{ + $mixedValue = $sTitle; + } + } + $sLinkExtras = ''; + $aExtras = unserialize($aRow['extras']); + if (isset($aExtras['display_info'])){ + $sLinkExtras = $this->_oTemplate->parseLink('javascript:void(0)',' ' , array( + 'title' => '', + 'bx_grid_action_single' => 'show_stat', + 'bx_grid_action_data' => json_encode($aExtras) + )); + } + + return parent::_getCellDefault($mixedValue . $sLinkExtras, $sKey, $aField, $aRow); + } + + protected function _getCellContextProfileId ($mixedValue, $sKey, $aField, $aRow) + { + if ($aRow['context_profile_id'] > 0){ + $oProfile = BxDolProfile::getInstance($aRow['context_profile_id']); + if ($oProfile){ + $mixedValue = BxDolTemplate::getInstance()->parseLink($oProfile->getUrl(), $oProfile->getDisplayName()); + } + else{ + $mixedValue = $aRow['context_profile_title']; + } + } + else{ + $mixedValue = ''; + } + return parent::_getCellDefault($mixedValue, $sKey, $aField, $aRow); + } + + protected function _getCellContentModule ($mixedValue, $sKey, $aField, $aRow) + { + $oModule = bxDolModule::getInstance($aRow['content_module']); + if($oModule && $oModule instanceof iBxDolContentInfoService){ + $mixedValue = $oModule->_aModule['title']; + } + else{ + $mixedValue = $aRow['content_module']; + } + return parent::_getCellDefault($mixedValue, $sKey, $aField, $aRow); + } + + + protected function _getCellProfileId ($mixedValue, $sKey, $aField, $aRow) + { + if ($aRow['profile_id'] > 0){ + $oProfile = BxDolProfile::getInstance($aRow['profile_id']); + if ($oProfile){ + $mixedValue = BxDolTemplate::getInstance()->parseLink($oProfile->getUrl(), $oProfile->getDisplayName()); + } + else{ + $mixedValue = $aRow['profile_title']; + } + } + else{ + $mixedValue = ''; + } + return parent::_getCellDefault($mixedValue, $sKey, $aField, $aRow); + } + + protected function _getCellAuthorId ($mixedValue, $sKey, $aField, $aRow) + { + if ($aRow['profile_id'] > 0){ + $oProfile = BxDolProfile::getInstance($aRow['profile_id']); + if ($oProfile){ + $mixedValue = BxDolTemplate::getInstance()->parseLink($oProfile->getUrl(), $oProfile->getDisplayName()); + } + else{ + $mixedValue = $aRow['profile_title']; + } + } + else{ + $mixedValue = ''; + } + return parent::_getCellDefault($mixedValue, $sKey, $aField, $aRow); + } + + function _getFilterControls() + { + parent::_getFilterControls(); + return $this->_getFilterSelectOne($this->_sFilter1Name, $this->_sFilter1Value, $this->_aFilter1Values) . + $this->_getFilterSelectOne($this->_sFilterProfileName, $this->_sFilterProfileValue, $this->_aFilterProfileValues) . + $this->_getFilterSelectOne($this->_sFilterActionName, $this->_sFilterActionValue, $this->_aFilterActionValues) . + $this->_getFilterDatePicker($this->_sFilterFromDateName, $this->_sFilterFromDateValue) . + $this->_getFilterLabel('-') . + $this->_getFilterDatePicker($this->_sFilterToDateName, $this->_sFilterToDateValue) . + $this->_getFilterButton(); + } + + protected function _getFilterSelectOne($sFilterName, $sFilterValue, $aFilterValues) + { + if(empty($sFilterName) || empty($aFilterValues)) + return ''; + + foreach($aFilterValues as $sKey => $sValue) + $aFilterValues[$sKey] = _t($sValue); + + $aInputModules = array( + 'type' => 'select', + 'name' => $sFilterName, + 'attrs' => array( + 'id' => 'bx-grid-' . $sFilterName . '-' . $this->_sObject, + // 'onChange' => 'javascript:' . $this->sJsObject . '.onChangeFilter(this)' + ), + 'value' => $sFilterValue, + 'values' => $aFilterValues + ); + + $oForm = new BxTemplFormView(array()); + return $oForm->genRow($aInputModules); + } + + protected function _getFilterLabel($sFilterValue) + { + $aInputModules = array( + 'type' => 'value', + 'value' => $sFilterValue, + 'tr_attrs' => array('class' => 'bx-grid-controls-filter-label'), + ); + + $oForm = new BxTemplFormView(array()); + return $oForm->genRow($aInputModules, true); + } + + protected function _getFilterDatePicker($sFilterName, $sFilterValue) + { + if(empty($sFilterName)) + return ''; + + $aInputModules = array( + 'type' => 'datepicker', + 'name' => $sFilterName, + 'attrs' => array( + 'id' => 'bx-grid-' . $sFilterName . '-' . $this->_sObject, + ), + 'tr_attrs' => array('class' => 'bx-grid-controls-filter-datepicker'), + 'value' => $sFilterValue, + ); + + $oForm = new BxTemplFormView(array()); + return $oForm->genRow($aInputModules, true); + } + + protected function _getFilterButton() + { + $aInputModules = array( + 'type' => 'button', + 'name' => 'button', + 'attrs' => array( + 'id' => 'bx-grid-button-' . $this->_sObject, + 'onClick' => 'javascript:' . $this->sJsObject . '.onChangeFilter(this)', + ), + 'tr_attrs' => array('class' => 'bx-grid-controls-filter-button'), + 'value' => _t('_Search'), + ); + + $oForm = new BxTemplFormView(array()); + return $oForm->genRow($aInputModules, true); + } + + public function performActionShowStat() + { + $aTmp2 = bx_get('ids'); + $sData = $aTmp2[0]; + $aData = json_decode($sData, true); + $sContentInfo = ''; + if (isset($aData['display_info'])){ + foreach($aData['display_info'] as $sKey => $sValue) + $sContentInfo .= $sKey . ': ' . $sValue; + } + + $sContent = BxTemplStudioFunctions::getInstance()->popupBox('sys-audit-content-info', _t('_sys_audit_content_info_popup_title'), $sContentInfo); + + echoJson(array('popup' => $sContent)); + } + +} + +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseCmts.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseCmts.php new file mode 100644 index 0000000000..198ce4dc38 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseCmts.php @@ -0,0 +1,1779 @@ +_sTmplNameItem = 'comment.html'; + $this->_sTmplNameItemContent = 'comment_content.html'; + + $this->_sJsObjClass = 'BxDolCmts'; + $this->_sJsObjName = 'oCmts' . bx_gen_method_name($sSystem, array('_' , '-')) . '_' .str_replace('-', 'n', $iId); + $this->_sStylePrefix = isset($this->_aSystem['root_style_prefix']) ? $this->_aSystem['root_style_prefix'] : 'cmt'; + + $sHtmlId = str_replace(array('_' , ' '), array('-', '-'), $sSystem) . '-' . $iId; + + $this->_aHtmlIds = array( + 'main' => 'bx-cmt-' . $sHtmlId, + 'counter' => 'bx-cmt-counter-' . $sHtmlId + ); + + $this->_aElementDefaults = [ + 'show_do_comment_as_button' => false, + 'show_do_comment_as_button_small' => false, + 'show_do_comment_icon' => true, + 'show_do_comment_label' => false, + 'show_counter' => true, + 'show_counter_only' => true, + 'show_counter_empty' => false, + 'show_counter_reversed' => false, + 'recalculate_counter' => false + ]; + $this->_aElementDefaultsApi = array_merge($this->_aElementDefaults, [ + 'show_counter' => true, + ]); + $this->_aElementParamsApi = []; + + $this->_aAclId2Name = array(); + $aAclLevels = BxDolAcl::getInstance()->getMemberships(false, false, false); + foreach($aAclLevels as $iAclId => $sAclName) + $this->_aAclId2Name[$iAclId] = str_replace('_', '-', str_replace('_adm_prm_txt_level_', '', $sAclName)); + + if(empty(self::$_sTmplContentElementBlock)) + self::$_sTmplContentElementBlock = $this->_oTemplate->getHtml('comment_element_block.html'); + + if(empty(self::$_sTmplContentElementInline)) + self::$_sTmplContentElementInline = $this->_oTemplate->getHtml('comment_element_inline.html'); + + if(empty(self::$_sTmplContentDoCommentLabel)) + self::$_sTmplContentDoCommentLabel = $this->_oTemplate->getHtml('comment_do_comment_label.html'); + + if(empty(self::$_sTmplContentCounter)) + self::$_sTmplContentCounter = $this->_oTemplate->getHtml('comment_counter.html'); + + $this->_oTemplate->addJsTranslation('_sys_txt_cmt_loading'); + } + + /** + * Add comments CSS/JS + */ + public function addCssJs($aBp = [], $aDp = []) + { + $bDynamicMode = isset($aDp['dynamic_mode']) && $aDp['dynamic_mode'] === true; + + $oForm = BxDolForm::getObjectInstance($this->_sFormObject, $this->_sFormDisplayPost); + $oForm->addCssJs(); + + $sResult = $this->_oTemplate->addCss([ + BX_DIRECTORY_PATH_PLUGINS_PUBLIC . 'photo-swipe/|photoswipe.css', + BX_DIRECTORY_PATH_PLUGINS_PUBLIC . 'photo-swipe/default-skin/|default-skin.css', + ], $bDynamicMode); + + $sResult .= $this->_oTemplate->addJs([ + 'photo-swipe/photoswipe.min.js', + 'photo-swipe/photoswipe-ui-default.min.js', + ], $bDynamicMode); + + return $sResult; + } + + public function getJsObjectName() + { + return $this->_sJsObjName; + } + + /** + * Get initialization section of comments box + * + * @return string + */ + public function getJsScript($aBp = [], $aDp = []) + { + $bDynamicMode = isset($aDp['dynamic_mode']) && $aDp['dynamic_mode'] === true; + $bMinPostForm = isset($aDp['min_post_form']) ? $aDp['min_post_form'] : $this->_bMinPostForm; + + $aParams = [ + 'sObjName' => $this->_sJsObjName, + 'sRootUrl' => BX_DOL_URL_ROOT, + 'sSystem' => $this->getSystemName(), + 'iAuthorId' => $this->_getAuthorId(), + 'iObjId' => $this->getId(), + 'sBaseUrl' => $this->getBaseUrl(), + 'sSocket' => $this->getSocketName(), + 'sPostFormPosition' => $this->_aSystem['post_form_position'], + 'sBrowseType' => $this->_sBrowseType, + 'sDisplayType' => $this->_sDisplayType, + 'iDisplayStructure' => isset($aDp['structure']) && !empty($aDp['structure']) ? 1 : 0, + 'iMinPostForm' => $bMinPostForm ? 1 : 0, + 'sStylePrefix' => $this->_sStylePrefix, + 'aHtmlIds' => $this->_aHtmlIds, + ]; + + if($this->_aParams) + $aParams['aParams'] = $this->_aParams; + + $sIncludes = $this->addCssJs($aBp, $aDp); + return ($bDynamicMode ? $sIncludes : '') . $this->_oTemplate->_wrapInTagJsCode("if(window['" . $this->_sJsObjName . "'] == undefined) var " . $this->_sJsObjName . " = new " . $this->_sJsObjClass . "(" . json_encode($aParams) . "); " . $this->_sJsObjName . ".cmtInit();"); + } + + function getCommentsBlockAPI($aParams, $aBp = [], $aDp = ['in_designbox' => false, 'show_empty' => false]) + { + + $mixedResult = $this->isViewAllowed(); + if($mixedResult !== CHECK_ACTION_RESULT_ALLOWED) + return $mixedResult; // TODO: error checking + + $aBp['type'] = 'head'; + $this->_getParams($aBp, $aDp); + $this->_prepareParams($aBp, $aDp); + + $aBp['order']['way'] = 'desc'; + $aBp['order_way'] = 'desc'; + $aBp['start'] = 0 ; + $aPp = $aBp['per_view']; + $aBp['per_view'] = $aBp['per_view'] + 1; + + $aCmts = []; + + if (!isset($aParams['comment_id'])) + $aCmts = $this->getCommentsArray($aBp['vparent_id'], $aBp['filter'], $aBp['order'], $aBp['start'], $aBp[($aBp['init_view'] != -1 ? 'init' : 'per') . '_view']); + else + $aCmts = [['cmt_id' => $aParams['comment_id']]]; + + $aParams['start_from'] = 0; + if (count($aCmts) == $aBp['per_view']){ + $aBp['per_view'] = $aPp; + $aCmts = array_slice($aCmts, 0, $aBp['per_view']); + $aParams['start_from'] = $aBp['start'] + $aBp['per_view']; + } + + $aCmtsRv = []; + foreach ($aCmts as $aCmt) { + $aCmtsRv[] = $this->getCommentStructure($aCmt['cmt_id'], $aBp, $aDp); + } + return [ + 'unit' => 'comments', + 'start' => 0, + 'order' => 'a', + 'module' => $this->_sSystem, + 'object_id' => $this->_iId, + 'data' => $aCmtsRv, + ]; + + } + + /** + * get full comments block with initializations + */ + function getCommentsBlock($aBp = [], $aDp = []) + { + $mixedResult = $this->isViewAllowed(); + if($mixedResult !== CHECK_ACTION_RESULT_ALLOWED) + return $mixedResult; + + $this->_getParams($aBp, $aDp); + + $oSockets = BxDolSockets::getInstance(); + $bSockets = $oSockets->isEnabled(); + + if($this->_bLiveUpdates && !$bSockets) { + //add live update + $this->actionResumeLiveUpdate(); + + if(($oLiveUpdates = BxDolLiveUpdates::getInstance())!== false) { + $sServiceCall = BxDolService::getSerializedService('system', 'get_live_update', [$this->_sSystem, $this->_iId, $this->_getAuthorId(), '{count}'], 'TemplCmtsServices'); + $oLiveUpdates->add($this->_sSystem . '_live_updates_cmts_' . $this->_iId, 1, $sServiceCall); + } + //add live update + } + + $sComments = $this->getComments($aBp, $aDp); + $sCommentsPinned = $this->getCommentsPinned(array_merge($aBp, ['pinned' => 1]), $aDp); + $sContentBefore = $this->_getContentBefore($aBp, $aDp); + $sContentAfter = $this->_getContentAfter($aBp, $aDp); + if($this->_bLiveUpdates && $bSockets) + $sContentAfter .= $this->getLiveUpdateButton(); + $sPostFormTop = $this->getFormBoxPost($aBp, array_merge($aDp, ['type' => $this->_sDisplayType, 'position' => BX_CMT_PFP_TOP])); + $sPostFormBottom = $this->getFormBoxPost($aBp, array_merge($aDp, ['type' => $this->_sDisplayType, 'position' => BX_CMT_PFP_BOTTOM])); + $sJsContent = $this->getJsScript($aBp, $aDp); + + $sBlockTitle = _t($this->_aT['block_comments_title'], $this->getCommentsCountAll(0, true)); + $sBlockMenu = $this->_getControlsBox(); + + /** + * @hooks + * @hookdef hook-system-view_comments 'system', 'view_comments' - hook to override comments block + * - $unit_name - equals `system` + * - $action - equals `view_comments` + * - $object_id - not used + * - $sender_id - not used + * - $extra_params - array of additional params with the following array keys: + * - `object` - [object] an instance of comments, @see BxDolCmts + * - `system` - [string] comments object name + * - `id` - [int] commented content id + * - `params_browse` - [array] browse params array as key&value pairs + * - `params_display` - [array] display params array as key&value pairs + * - `post_form_top` - [string] by ref, post form code for top section, can be overridden in hook processing + * - `content_before` - [string] by ref, a code to be displayed before comments list, can be overridden in hook processing + * - `comments` - [string] by ref, a comments list code, can be overridden in hook processing + * - `comments_pinned` - [string] by ref, a pinned comments list code, can be overridden in hook processing + * - `content_after` - [string] by ref, a code to be displayed after comments list, can be overridden in hook processing + * - `post_form_bottom` - [string] by ref, post form code for bottom section, can be overridden in hook processing + * - `js_content` - [string] by ref, comments JavaScript code, can be overridden in hook processing + * - `block_title` - [string] by ref, block title, can be overridden in hook processing + * - `block_menu` - [string] by ref, block submenu, can be overridden in hook processing + * + * @hook @ref hook-system-view_comments + */ + bx_alert('system', 'view_comments', 0, 0, [ + 'object' => $this, + 'system' => $this->_sSystem, + 'id' => $this->getId(), + 'params_browse' => $aBp, + 'params_display' => $aDp, + 'post_form_top' => &$sPostFormTop, + 'content_before' => &$sContentBefore, + 'comments' => &$sComments, + 'comments_pinned' => &$sCommentsPinned, + 'content_after' => &$sContentAfter, + 'post_form_bottom' => &$sPostFormBottom, + 'js_content' => &$sJsContent, + 'block_title' => &$sBlockTitle, + 'block_menu' => &$sBlockMenu, + ]); + + $sContent = $this->_oTemplate->parseHtmlByName('comments_block.html', [ + 'style_prefix' => $this->_sStylePrefix, + 'js_object' => $this->_sJsObjName, + 'system' => $this->_sSystem, + 'list_anchor' => $this->getListAnchor(), + 'id' => $this->getId(), + 'content_before' => $sContentBefore, + 'comments' => $sComments, + 'comments_pinned' => $sCommentsPinned, + 'bx_if:show_divider_hidden' => [ + 'condition' => empty($sCommentsPinned), + 'content' => [] + ], + 'content_after' => $sContentAfter, + 'post_form_top' => $sPostFormTop, + 'post_form_bottom' => $sPostFormBottom, + 'image_preview' => $this->_oTemplate->parseHtmlByName('comments_photoswipe.html', []), + 'script' => $sJsContent + ]); + + return $aDp['in_designbox'] ? DesignBoxContent($sBlockTitle, $sContent, BX_DB_DEF, $sBlockMenu) : [ + 'title' => $sBlockTitle, + 'content' => $sContent, + 'menu' => $sBlockMenu, + ]; + } + + /** + * get comments list for specified parent comment + * + * @param array $aBp - browse params array + * @param array $aDp - display params array + * + */ + function getComments($aBp = [], $aDp = []) + { + $this->_prepareParams($aBp, $aDp); + + $aCmts = $this->getCommentsArray($aBp['vparent_id'], $aBp['filter'], $aBp['order'], $aBp['start'], $aBp[($aBp['init_view'] != -1 ? 'init' : 'per') . '_view']); + if(empty($aCmts) || !is_array($aCmts)) + return isset($aDp['show_empty']) && $aDp['show_empty'] === true ? $this->_getEmpty($aDp) : ''; + + $sCmts = ''; + foreach($aCmts as $k => $aCmt) + $sCmts .= $this->getComment($aCmt, $aBp, $aDp); + $sCmts = $this->_getMoreLink($sCmts, $aBp, $aDp); + + return $sCmts; + } + + function getCommentsPinned($aBp = [], $aDp = []) + { + $this->_prepareParams($aBp, $aDp); + + $aCmts = $this->getCommentsArray($aBp['vparent_id'], BX_CMT_FILTER_PINNED, $aBp['order'], 0, -1); + if(empty($aCmts) || !is_array($aCmts)) + return ''; + + $sCmts = ''; + foreach($aCmts as $k => $aCmt) + $sCmts .= $this->getComment($aCmt, $aBp, $aDp); + + return $sCmts; + } + + public function getCommentsByStructure($aBp = array(), $aDp = array()) + { + if(empty($aDp['structure'])) + return isset($aDp['show_empty']) && $aDp['show_empty'] === true ? $this->_getEmpty($aDp) : ''; + + $aBp['count'] = count($aDp['structure']); + $this->_prepareParams($aBp, $aDp); + $aDp['structure'] = array_slice($aDp['structure'], $aBp['start'], $aBp[($aBp['init_view'] != -1 ? 'init' : 'per') . '_view'], true); + + $sCmts = ''; + foreach($aDp['structure'] as $iCmtId => $aCmt) + $sCmts .= $this->getComment($iCmtId, $aBp, $aDp); + + $sCmts = $this->_getMoreLink($sCmts, $aBp, $aDp); + return $sCmts; + } + + /** + * get comment view block with initializations + */ + function getCommentBlock($iCmtId = 0, $aBp = array(), $aDp = array()) + { + $mixedResult = $this->isViewAllowed(); + if($mixedResult !== CHECK_ACTION_RESULT_ALLOWED) + return $mixedResult; + + $aBp = array_merge(array('type' => $this->_sBrowseType), $aBp); + $aDp = array_merge(array('type' => BX_CMT_DISPLAY_THREADED), $aDp); + + //--- Beg: Using pregenerated structure + $mixedStructure = $this->getCommentStructure((int)$iCmtId, $aBp, $aDp); + if($mixedStructure !== false) + $aDp['structure'] = $mixedStructure; + //--- End: Using pregenerated structure + + $sComment = $this->getComment($iCmtId, $aBp, $aDp); + if (!$sComment) + return ''; + + BxDolTemplate::getInstance()->addInjection ('injection_footer', 'text', $this->_oTemplate->parseHtmlByName('comments_photoswipe.html', [])); + + return $this->_oTemplate->parseHtmlByName('comment_block.html', array( + 'style_prefix' => $this->_sStylePrefix, + 'js_object' => $this->_sJsObjName, + 'system' => $this->_sSystem, + 'id' => $this->getId(), + 'comment' => $sComment, + 'script' => $this->getJsScript($aBp, $aDp) + )); + } + + /** + * get one just posted comment + * + * @param int $iCmtId - comment id + * @return string + */ + function getComment($mixedCmt, $aBp = array(), $aDp = array()) + { + $iUserId = $this->_getAuthorId(); + $aCmt = !is_array($mixedCmt) ? $this->getCommentRow((int)$mixedCmt) : $mixedCmt; + if (!$aCmt) + return ''; + + list($sAuthorName, $sAuthorLink, $sAuthorIcon) = $this->_getAuthorInfo($aCmt['cmt_author_id']); + + $sClass = $sClassCnt = ''; + if(isset($aCmt['vote_rate']) && (float)$aCmt['vote_rate'] < $this->_aSystem['viewing_threshold']) { + $this->_oTemplate->pareseHtmlByName('comment_hidden.html', array( + 'js_object' => $this->_sJsObjName, + 'id' => $aCmt['cmt_id'], + 'title' => bx_process_output(_t('_hidden_comment', $sAuthorName)), + 'bx_if:show_replies' => array( + 'condition' => $aCmt['cmt_replies'] > 0, + 'content' => array( + 'replies' => _t('_Show N replies', $aCmt['cmt_replies']) + ) + ) + )); + + $sClass = ' ' . $this->_sStylePrefix . '-hidden'; + } + + if($aCmt['cmt_author_id'] == $iUserId) + $sClass .= ' ' . $this->_sStylePrefix . '-mine'; + + $aAuthorAcl = BxDolAcl::getInstance()->getMemberMembershipInfo($aCmt['cmt_author_id']); + if(!empty($aAuthorAcl) && isset($this->_aAclId2Name[$aAuthorAcl['id']])) + $sClass .= ' ' . $this->_sStylePrefix . '-aml-' . $this->_aAclId2Name[$aAuthorAcl['id']]; + + if(!empty($aDp['blink']) && in_array($aCmt['cmt_id'], $aDp['blink'])) + $sClass .= ' ' . $this->_sStylePrefix . '-blink'; + + if(!empty($aDp['class_comment'])) + $sClass .= ' ' . $aDp['class_comment']; + + if(!empty($aDp['class_comment_content'])) + $sClassCnt .= ' ' . $aDp['class_comment_content']; + + $sActions = $this->_getActionsBox($aCmt, $aBp, $aDp); + + $aTmplReplyTo = array(); + if((int)$aCmt['cmt_parent_id'] != 0) { + $aParent = $this->getCommentRow($aCmt['cmt_parent_id']); + + if(!empty($aParent) && is_array($aParent)) { + $oProfile = $this->_getAuthorObject($aParent['cmt_author_id']); + $sParAuthorName = $oProfile->getDisplayName(); + $sParAuthorUnit = $oProfile->getUnit(0, array('template' => array('name' => 'unit_wo_info_links', 'size' => 'icon'))); + + $aTmplReplyTo = array( + 'style_prefix' => $this->_sStylePrefix, + 'par_cmt_link' => $this->getItemUrl($aCmt['cmt_parent_id']), + 'par_cmt_title' => bx_html_attribute(_t('_in_reply_to_x', $sParAuthorName)), + 'par_cmt_author' => $sParAuthorName, + 'par_cmt_author_unit' => $sParAuthorUnit + ); + } + } + + $sReplies = ''; + if(!(isset($aBp['pinned']) && (int)$aBp['pinned'] != 0 && (int)$aCmt['cmt_pinned'] != 0) && !empty($aDp)) { + $aDp['show_empty'] = false; + + if(!empty($aDp['structure'][$aCmt['cmt_id']]) && is_array($aDp['structure'][$aCmt['cmt_id']])) { + if(!empty($aDp['structure'][$aCmt['cmt_id']]['items'])) { + $aDp['structure'] = $aDp['structure'][$aCmt['cmt_id']]['items']; + $sReplies = $this->getCommentsByStructure(array('parent_id' => $aCmt['cmt_id'], 'type' => $aBp['type']), $aDp); + } + } + else if((int)$aCmt['cmt_replies'] > 0 && $aDp['type'] == BX_CMT_DISPLAY_THREADED) + $sReplies = $this->getComments(['parent_id' => $aCmt['cmt_id'], 'vparent_id' => $aCmt['cmt_id'], 'type' => $aBp['type'], 'order_way' => BX_CMT_ORDER_WAY_ASC], $aDp); + } + + $aTmplVarsMeta = array(); + if(!empty($this->_sMenuObjMeta)) { + $oMenuMeta = BxDolMenu::getObjectInstance($this->_sMenuObjMeta, $this->_oTemplate); + if($oMenuMeta) { + $oMenuMeta->setCmtsData($this, $aCmt['cmt_id']); + + $aTmplVarsMeta = array( + 'style_prefix' => $this->_sStylePrefix, + 'meta' => $oMenuMeta->getCode() + ); + } + } + + if($this->_isShowContent($aCmt)) { + $sContent = $this->_getContent($aCmt, $aBp, $aDp); + } + else { + $sClass .= ' cmt-author-not-active'; + $sContent = _t('_hidden_comment', BxDolProfileUndefined::getInstance()->getDisplayName()); + } + + $aVars = array_merge(array( + 'system' => $this->_sSystem, + 'style_prefix' => $this->_sStylePrefix, + 'js_object' => $this->_sJsObjName, + 'id' => $aCmt['cmt_id'], + 'anchor' => $this->getItemAnchor($aCmt['cmt_id']), + 'class' => $sClass, + 'class_cnt' => $sClassCnt, + 'bx_if:show_reply_to' => array( + 'condition' => !empty($aTmplReplyTo), + 'content' => $aTmplReplyTo + ), + 'bx_if:meta' => array( + 'condition' => !empty($aTmplVarsMeta), + 'content' => $aTmplVarsMeta + ), + 'bx_if:show_pinned' => array( + 'condition' => (int)$aCmt['cmt_pinned'] > 0, + 'content' => array( + 'style_prefix' => $this->_sStylePrefix, + ) + ), + 'content' => $sContent, + 'actions' => $sActions, + 'replies' => $sReplies, + ), $this->_getTmplVarsAuthor($aCmt), $this->_getTmplVarsNotes($aCmt)); + + $sResult = $this->_oTemplate->parseHtmlByName($this->_sTmplNameItem, $aVars); + + /** + * @hooks + * @hookdef hook-system-view_comment 'system', 'view_comment' - hook on get comment + * - $unit_name - equals `system` + * - $action - equals `view_comment` + * - $object_id - comment_id + * - $sender_id - not used + * - $extra_params - array of additional params with the following array keys: + * - `comment` - [array] comment's data + * - `system` - [string] comment's system name + * - `tmpl_name` - [string] template file path + * - `tmpl_vars` - [string] params for template file parsing + * - `override_result` - [string] by ref, if account confirmed = true, otherwise false, can be overridden in hook processing + * @hook @ref hook-system-view_comment + */ + bx_alert('system', 'view_comment', $aCmt['cmt_id'], 0, array('comment' => $aCmt, 'system' => $this->_sSystem, 'tmpl_name' => $this->_sTmplNameItem, 'tmpl_vars' => $aVars, 'override_result' => &$sResult)); + + return $sResult; + } + + public function getCommentStructure($iCmtId, $aBp = array(), $aDp = array()) + { + $aRoot = $this->getCommentRow((int)$iCmtId); + + $aBps = $aBp; + if(!empty($aRoot)) + $aBps['parent_id'] = $aRoot['cmt_id']; + $this->_prepareStructureBp($aDp['type'], $aBps); + + $iLevel = 0; + $aStructure = array(); + $this->{'_getStructure' . ($this->_bIsApi ? 'API' : '')}($aRoot, $aBps, $iLevel, $aStructure); + + return !empty($aStructure) && is_array($aStructure) ? $aStructure : false; + } + + function getCommentSearch($iCmtId, &$sAddon) + { + $aBp = array(); + $aDp = array( + 'type' => BX_CMT_DISPLAY_FLAT, + 'view_only' => true + ); + + if(empty($sAddon)) + $sAddon = $this->getJsScript($aBp, $aDp); + + BxDolTemplate::getInstance()->addInjection ('injection_footer', 'text', $this->_oTemplate->parseHtmlByName('comments_photoswipe.html', [])); + + return $this->_oTemplate->parseHtmlByName('comment_search.html', array( + 'comment' => $this->getComment($iCmtId, $aBp, $aDp), + )); + } + + /** + * get one comment for "Live Search" + * + * @param int $iCmtId - comment id + * @return string + */ + function getCommentLiveSearch($mixedCmt, $aParams = array()) + { + $aCmt = !is_array($mixedCmt) ? $this->getCommentRow((int)$mixedCmt) : $mixedCmt; + + list($sAuthorName, $sAuthorLink, $sAuthorIcon) = $this->_getAuthorInfo($aCmt['cmt_author_id']); + $bAuthorIcon = !empty($sAuthorIcon); + + $sViewLink = $this->getViewUrl($aCmt['cmt_id']); + if(empty($sViewLink)) + $sViewLink = '#'; + + return $this->_oTemplate->parseHtmlByName('comment_live_search.html', array( + 'bx_if:show_icon' => array( + 'condition' => $bAuthorIcon, + 'content' => array( + 'author_icon' => $sAuthorIcon, + 'view_link' => $sViewLink + ) + ), + 'bx_if:show_icon_empty' => array( + 'condition' => !$bAuthorIcon, + 'content' => array() + ), + 'view_link' => $sViewLink, + 'text' => BxTemplFunctions::getInstance()->getStringWithLimitedLength(strip_tags($aCmt['cmt_text']), $this->_sSnippetLenthLiveSearch), + 'sample' => isset($aParams['txt_sample_single']) ? _t($aParams['txt_sample_single']) : '' + )); + } + + function getFormBoxPost($aBp = array(), $aDp = array()) + { + return $this->_getFormBox(BX_CMT_ACTION_POST, $aBp, $aDp); + } + + function getFormBoxEdit($aBp = array(), $aDp = array()) + { + return $this->_getFormBox(BX_CMT_ACTION_EDIT, $aBp, $aDp); + } + + function getFormPost($iCmtParentId = 0, $aDp = array()) + { + return $this->_getFormPost($iCmtParentId, $aDp); + } + + function getFormEdit($iCmtId, $aDp = array()) + { + return $this->_getFormEdit($iCmtId, $aDp); + } + + function getControlsBox() + { + return $this->_getControlsBox(); + } + + function getLiveUpdate($iCountOld = 0, $iCountNew = 0) + { + $iCount = (int)$iCountNew - (int)$iCountOld; + if($iCount < 0) + return ''; + + $aComments = $this->_oQuery->getCommentsBy(array('type' => 'latest', 'object_id' => $this->_iId, 'author' => $this->_getAuthorId(), 'others' => 1, 'start' => '0', 'per_page' => $iCount)); + if(empty($aComments) || !is_array($aComments)) + return ''; + + $aComment = array_shift($aComments); + if(empty($aComment) || !is_array($aComment)) + return ''; + + return $this->getLiveUpdateButton($aComment['cmt_id']); + } + + function getLiveUpdateButton($iCommentId = 0) + { + $sJsObject = $this->getJsObjectName(); + + $bComment = is_numeric($iCommentId) && (int)$iCommentId != 0; + return $this->_oTemplate->parseHtmlByName('comments_lu_button.html', array( + 'style_prefix' => $this->_sStylePrefix, + 'class' => !$bComment ? 'hidden' : '', + 'onclick_show' => "javascript:" . $sJsObject . ".goToBtn(this, '" . ($bComment ? $this->getItemAnchor($iCommentId) : '{cmt_anchor}') . "', '" . ($bComment ? $iCommentId : '{cmt_id}') . "');", + )); + } + + function getLiveUpdates($iCountOld = 0, $iCountNew = 0) + { + $bShowAll = true; + $bShowActions = false; + + $iCount = (int)$iCountNew - (int)$iCountOld; + if($iCount < 0) + return ''; + + $aComments = $this->_oQuery->getCommentsBy(array('type' => 'latest', 'object_id' => $this->_iId, 'author' => $this->_getAuthorId(), 'others' => 1, 'start' => '0', 'per_page' => $iCount)); + if(empty($aComments) || !is_array($aComments)) + return ''; + + $sJsObject = $this->getJsObjectName(); + + $iUserId = $this->_getAuthorId(); + $bModerator = $this->isModerator(); + + $aComments = array_reverse($aComments); + $iComments = count($aComments); + + $aTmplVarsNotifs = array(); + foreach($aComments as $iIndex => $aComment) { + $iCommentId = $aComment['cmt_id']; + + $sShowOnClick = "javascript:" . $sJsObject . ".goTo(this, '" . $this->getItemAnchor($iCommentId) . "', '" . $iCommentId . "');"; + $sReplyOnClick = "javascript:" . $sJsObject . ".goToAndReply(this, '" . $this->getItemAnchor($iCommentId) . "', '" . $iCommentId . "');"; + + $iAuthorId = (int)$aComment['cmt_author_id']; + if($iAuthorId < 0) { + if(abs($iAuthorId) == $iUserId) + continue; + else if($bModerator) + $iAuthorId *= -1; + } + + $oAuthor = $this->_getAuthorObject($iAuthorId); + $sAuthorName = $oAuthor->getDisplayName(); + + $aTmplVarsNotifs[] = array( + 'bx_if:show_as_hidden' => array( + 'condition' => !$bShowAll && $iIndex < ($iComments - 1), + 'content' => array(), + ), + 'item' => $this->_oTemplate->parseHtmlByName('comments_lu_notifications.html', array( + 'style_prefix' => $this->_sStylePrefix, + 'onclick_show' => $sShowOnClick, + 'onclick_reply' => $sReplyOnClick, + 'author_link' => $oAuthor->getUrl(), + 'author_title' => bx_html_attribute($sAuthorName), + 'author_name' => $sAuthorName, + 'author_unit' => $oAuthor->getUnit(0, array('template' => 'unit_wo_info_links')), + 'text' => _t('_cmt_txt_added_sample') + )), + 'bx_if:show_previous' => array( + 'condition' => $bShowActions && $iIndex > 0, + 'content' => array( + 'onclick_previous' => $sJsObject . '.previousLiveUpdate(this)' + ) + ), + 'bx_if:show_close' => array( + 'condition' => $bShowActions, + 'content' => array( + 'onclick_close' => $sJsObject . '.hideLiveUpdate(this)' + ) + ) + ); + } + + return $this->_oTemplate->parseHtmlByName('popup_chain.html', array( + 'html_id' => $this->getNotificationId(), + 'bx_repeat:items' => $aTmplVarsNotifs + )); + } + + public function getElementBlock($aParams = array()) + { + $aParams['usage'] = BX_CMT_USAGE_BLOCK; + + return $this->getElement($aParams); + } + + public function getElementInline($aParams = array()) + { + $aParams['usage'] = BX_CMT_USAGE_INLINE; + + return $this->getElement($aParams); + } + + public function getElement($aParams = array()) + { + $aParams = array_merge($this->_aElementDefaults, $aParams); + + $bShowDoCommentAsButtonSmall = isset($aParams['show_do_comment_as_button_small']) && $aParams['show_do_comment_as_button_small'] == true; + $bShowDoCommentAsButton = !$bShowDoCommentAsButtonSmall && isset($aParams['show_do_comment_as_button']) && $aParams['show_do_comment_as_button'] == true; + $bShowCounterEmpty = isset($aParams['show_counter_empty']) && $aParams['show_counter_empty'] == true; + $bRecalculateCounter = isset($aParams['recalculate_counter']) && $aParams['recalculate_counter'] == true; + + $iObjectId = $this->getId(); + $iAuthorId = $this->_getAuthorId(); + $iAuthorIp = $this->_getAuthorIp(); + + $iCount = $this->getCommentsCountAll(0, $bRecalculateCounter); + $bCount = (int)$iCount != 0; + + $isAllowedComment = $this->isPostAllowed(); + + //--- Do Comment + $bTmplVarsDoComment = $this->_isShowDoComment($aParams, $isAllowedComment, $bCount); + $aTmplVarsDoComment = []; + if($bTmplVarsDoComment) + $aTmplVarsDoComment = [ + 'style_prefix' => $this->_sStylePrefix, + 'do_comment' => $this->_getDoComment($aParams, $isAllowedComment), + ]; + + //--- Counter + $bTmplVarsCounter = $this->_isShowCounter($aParams, $isAllowedComment, $bCount); + + $aTmplVarsCounter = array(); + if($bTmplVarsCounter) + $aTmplVarsCounter = array( + 'style_prefix' => $this->_sStylePrefix, + 'bx_if:show_hidden' => array( + 'condition' => !$bShowCounterEmpty && !$bCount, + 'content' => array() + ), + 'counter' => $this->getCounter(array_merge($aParams, [ + 'show_counter_only' => false + ])) + ); + + if(!$bTmplVarsDoComment && !$bTmplVarsCounter) + return ''; + + $sTmplName = $this->{'_getTmplElement' . bx_gen_method_name(!empty($aParams['usage']) ? $aParams['usage'] : BX_CMT_USAGE_DEFAULT)}(); + return $this->_oTemplate->parseHtmlByContent($sTmplName, array( + 'style_prefix' => $this->_sStylePrefix, + 'html_id' => $this->_aHtmlIds['main'], + 'class' => $this->_sStylePrefix . ($bShowDoCommentAsButton ? '-button' : '') . ($bShowDoCommentAsButtonSmall ? '-button-small' : ''), + 'count' => $iCount, + 'bx_if:show_do_comment' => array( + 'condition' => $bTmplVarsDoComment, + 'content' => $aTmplVarsDoComment + ), + 'bx_if:show_counter' => array( + 'condition' => $bTmplVarsCounter, + 'content' => $aTmplVarsCounter + ), + 'script' => '' + )); + } + + public function getElementAPI($aParams = []) + { + if(!$this->_bIsApi) + return; + + if(!$this->isEnabled()) + return bx_api_get_msg('_cmt_err_not_enabled'); + + $aParams = array_merge($this->_aElementDefaultsApi, $aParams); + + $bRecalculateCounter = isset($aParams['recalculate_counter']) && $aParams['recalculate_counter'] == true; + + $iObjectId = $this->getId(); + $iAuthorId = $this->_getAuthorId(); + + $iCount = $this->getCommentsCountAll(0, $bRecalculateCounter); + $bCount = (int)$iCount != 0; + + $isAllowedComment = $this->isPostAllowed(); + $aParams['count'] = $iCount; + + //--- Do Comment + $bDoComment = $this->_isShowDoComment($aParams, $isAllowedComment, $bCount); + $aDoComment = $bDoComment ? $this->_getDoComment($aParams, $isAllowedComment) : []; + + //--- Counter + $bCounter = $this->_isShowCounter($aParams, $isAllowedComment, $bCount); + $aCounter = $bCounter ? $this->getCounterAPI(array_merge($aParams, [ + 'show_counter_only' => false, + ])) : []; + + + if(!$bDoComment && !$bCounter) + return bx_api_get_msg(''); + + return [ + 'type' => $this->_sType, + 'system' => $this->_sSystem, + 'object_id' => $this->_iId, + 'params' => array_intersect_key($aParams, array_flip($this->_aElementParamsApi)), + 'action' => $aDoComment, + 'counter' => $aCounter + ]; + } + + public function getCounter($aParams = []) + { + $aParams = array_merge($this->_aElementDefaults, $aParams); + + $bShowDoCommentAsButtonSmall = isset($aParams['show_do_comment_as_button_small']) && $aParams['show_do_comment_as_button_small'] == true; + $bShowDoCommentAsButton = !$bShowDoCommentAsButtonSmall && isset($aParams['show_do_comment_as_button']) && $aParams['show_do_comment_as_button'] == true; + $bShowEmpty = isset($aParams['show_counter_empty']) && $aParams['show_counter_empty'] == true; + $bShowReversed = isset($aParams['show_counter_reversed']) && $aParams['show_counter_reversed'] == true; + $bShowScript = !isset($aParams['show_script']) || (bool)$aParams['show_script'] === true; + $bRecalculateCounter = isset($aParams['recalculate_counter']) && $aParams['recalculate_counter'] == true; + + $sClass = 'sys-action-counter'; + if(isset($aParams['show_counter_only']) && (bool)$aParams['show_counter_only'] === true) + $sClass .= ' sys-ac-only'; + + $iCount = (int)$this->getCommentsCountAll(0, $bRecalculateCounter); + if($iCount == 0 && !$bShowEmpty) + $sClass .= ' sys-ac-hidden'; + + $sClass .= ' ' . $this->_sStylePrefix . '-counter'; + if($bShowDoCommentAsButtonSmall) + $sClass .= ' bx-btn-small-height'; + if($bShowDoCommentAsButton) + $sClass .= ' bx-btn-height'; + + $iCmtsLimit = 5; + $aCmts = $this->_getCounterItems($iCmtsLimit); + if(!$bShowReversed) + $aCmts = array_reverse($aCmts); + + $aTmplVarsProfiles = []; + foreach($aCmts as $aCmt) { + $iAuthor = (int)$aCmt['cmt_author_id']; + if(array_key_exists($iAuthor, $aTmplVarsProfiles)) + continue; + + $oAuthor = BxDolProfile::getInstanceMagic($iAuthor); + if(!$oAuthor) + continue; + + $aTmplVarsProfiles[$iAuthor] = [ + 'icon' => $oAuthor->getUnit(0, ['template' => ['name' => 'unit_wo_info_links', 'size' => 'icon']]) + ]; + + if(count($aTmplVarsProfiles) >= $iCmtsLimit) + break; + } + $aTmplVarsProfiles = array_values($aTmplVarsProfiles); + + $sHref = !empty($aParams['overwrite_counter_link_href']) ? $aParams['overwrite_counter_link_href'] : $this->getListUrl(); + $sOnclick = ''; + if(!empty($aParams['overwrite_counter_link_onclick'])) + $sOnclick = $aParams['overwrite_counter_link_onclick']; + + return $this->_oTemplate->parseHtmlByContent($this->_getTmplCounter(), [ + 'style_prefix' => $this->_sStylePrefix, + 'id' => $this->_aHtmlIds['counter'], + 'class' => $sClass, + 'href' => $sHref, + 'bx_if:show_onclick' => [ + 'condition' => !empty($sOnclick), + 'content' => [ + 'onclick' => $sOnclick + ] + ], + 'content' => $this->_getCounterLabel($iCount, $aParams), + 'bx_repeat:profiles' => $aTmplVarsProfiles, + 'bx_if:show_icon' => [ + 'condition' => ($bShowEmpty || !empty($aTmplVarsProfiles)) && (!isset($aParams['show_icon']) || $aParams['show_icon']), + 'content' => [ + 'style_prefix' => $this->_sStylePrefix, + 'icon' => !empty($aParams['custom_icon']) ? $aParams['custom_icon'] : $this->_oTemplate->getImageAuto('comment|' . $this->_sStylePrefix . '-counter-icon') + ] + ], + 'script' => $this->getJsScript() + ]); + } + + public function getCounterApi($aParams = []) + { + $aParams = array_merge($this->_aElementDefaultsApi, $aParams); + + $bShowReversed = isset($aParams['show_counter_reversed']) && $aParams['show_counter_reversed'] == true; + $bRecalculateCounter = isset($aParams['recalculate_counter']) && $aParams['recalculate_counter'] == true; + + $iCount = (int)$this->getCommentsCountAll(0, $bRecalculateCounter); + + $iCmtsLimit = 5; + $aCmts = $this->_getCounterItems($iCmtsLimit); + if(!$bShowReversed) + $aCmts = array_reverse($aCmts); + + $aCmtsAuthors = []; + foreach($aCmts as $aCmt) { + $iAuthor = (int)$aCmt['cmt_author_id']; + if(array_key_exists($iAuthor, $aCmtsAuthors)) + continue; + + $aCmtsAuthors[$iAuthor] = BxDolProfile::getData($iAuthor); + + if(count($aCmtsAuthors) >= $iCmtsLimit) + break; + } + $aCmtsAuthors = array_values($aCmtsAuthors); + + return [ + 'count' => $iCount, + 'authors' => $aCmtsAuthors + ]; + } + + protected function _getCounterItems($iCmtsLimit, $iCmtsStart = 0) + { + return $this->_oQuery->getCommentsBy(array('type' => 'object_id', 'object_id' => $this->getId(), 'order_way' => 'desc', 'start' => $iCmtsStart, 'per_page' => $iCmtsLimit * 4)); + } + + protected function _getLabelDo($aParams = []) + { + return $this->_oTemplate->parseHtmlByContent($this->_getTmplLabelDo(), [ + 'style_prefix' => $this->_sStylePrefix, + 'bx_if:show_icon' => [ + 'condition' => isset($aParams['show_do_comment_icon']) && $aParams['show_do_comment_icon'] == true, + 'content' => [ + 'style_prefix' => $this->_sStylePrefix, + 'icon' => $this->_oTemplate->getImageAuto($this->_getIconDo()) + ] + ], + 'bx_if:show_text' => [ + 'condition' => isset($aParams['show_do_comment_label']) && $aParams['show_do_comment_label'] == true, + 'content' => [ + 'style_prefix' => $this->_sStylePrefix, + 'text' => _t($this->_getTitleDo()) + ] + ] + ]); + } + + protected function _getCounterLabel($iCount, $aParams = []) + { + $aParams = array_merge($this->_aElementDefaults, $aParams); + + $sResult = ''; + if((int)$iCount != 0) + $sResult = _t(isset($aParams['caption']) ? $aParams['caption'] : '_cmt_txt_counter', $iCount); + else + $sResult = _t(isset($aParams['caption_empty']) ? $aParams['caption_empty'] : '_cmt_txt_counter_empty'); + + return $sResult; + } + + protected function _getTmplElementBlock() + { + return self::$_sTmplContentElementBlock; + } + + protected function _getTmplElementInline() + { + return self::$_sTmplContentElementInline; + } + + protected function _getTmplLabelDo() + { + return self::$_sTmplContentDoCommentLabel; + } + + protected function _getTmplCounter() + { + return self::$_sTmplContentCounter; + } + + protected function _isShowContent($aCmt) + { + $oProfileAuthor = BxDolProfile::getInstance(abs($aCmt['cmt_author_id'])); + return (int)$aCmt['cmt_author_id'] == 0 || ($oProfileAuthor && $oProfileAuthor->isActive()) || isAdmin() || BxDolAcl::getInstance()->isMemberLevelInSet([MEMBERSHIP_ID_MODERATOR, MEMBERSHIP_ID_ADMINISTRATOR]); + } + + protected function _getContentBefore($aBp = array(), $aDp = array()) + { + return ''; + } + + protected function _getContentAfter($aBp = array(), $aDp = array()) + { + return ''; + } + + protected function _getControlsBox() + { + $sDisplay = ''; + $bDisplay = (int)$this->_aSystem['is_display_switch'] == 1; + if($bDisplay) { + $aDisplayLinks = array( + array('id' => $this->_sSystem . '-flat', 'name' => $this->_sSystem . '-flat', 'class' => '', 'title' => '_cmt_display_flat', 'target' => '_self', 'onclick' => 'javascript:' . $this->_sJsObjName . '.cmtChangeDisplay(this, \'flat\');'), + array('id' => $this->_sSystem . '-threaded', 'name' => $this->_sSystem . '-threaded', 'class' => '', 'title' => '_cmt_display_threaded', 'target' => '_self', 'onclick' => 'javascript:' . $this->_sJsObjName . '.cmtChangeDisplay(this, \'threaded\');') + ); + + $oMenu = new BxTemplMenuInteractive(array('template' => 'menu_interactive_vertical.html', 'menu_id'=> $this->_sSystem . '-display', 'menu_items' => $aDisplayLinks)); + $oMenu->setSelected('', $this->_sSystem . '-' . $this->_sDisplayType); + $sDisplay = $oMenu->getCode(); + } + + $sBrowseType = ''; + $bBrowseType = (int)$this->_aSystem['is_browse_switch'] == 1; + if($bBrowseType) { + $aBrowseLinks = array( + array('id' => $this->_sSystem . '-tail', 'name' => $this->_sSystem . '-tail', 'class' => '', 'title' => '_cmt_browse_tail', 'target' => '_self', 'onclick' => 'javascript:' . $this->_sJsObjName . '.cmtChangeBrowse(this, \'tail\');'), + array('id' => $this->_sSystem . '-head', 'name' => $this->_sSystem . '-head', 'class' => '', 'title' => '_cmt_browse_head', 'target' => '_self', 'onclick' => 'javascript:' . $this->_sJsObjName . '.cmtChangeBrowse(this, \'head\');'), + array('id' => $this->_sSystem . '-popular', 'name' => $this->_sSystem . '-popular', 'class' => '', 'title' => '_cmt_browse_popular', 'target' => '_self', 'onclick' => 'javascript:' . $this->_sJsObjName . '.cmtChangeBrowse(this, \'popular\');'), + ); + + $oMenu = new BxTemplMenuInteractive(array('template' => 'menu_interactive_vertical.html', 'menu_id'=> $this->_sSystem . '-browse', 'menu_items' => $aBrowseLinks)); + $oMenu->setSelected('', $this->_sSystem . '-' . $this->_sBrowseType); + $sBrowseType = $oMenu->getCode(); + } + + $sBrowseFilter = ''; + $bBrowseFilter = (int)$this->_aSystem['is_browse_filter'] == 1; + if($bBrowseFilter) { + $aFilterLinks = array( + array('id' => $this->_sSystem . '-all', 'name' => $this->_sSystem . '-all', 'class' => '', 'title' => '_cmt_browse_all', 'target' => '_self', 'onclick' => 'javascript:' . $this->_sJsObjName . '.cmtChangeFilter(this, \'all\');'), + array('id' => $this->_sSystem . '-friends', 'name' => $this->_sSystem . '-friends', 'class' => '', 'title' => '_cmt_browse_friends', 'target' => '_self', 'onclick' => 'javascript:' . $this->_sJsObjName . '.cmtChangeFilter(this, \'friends\');'), + array('id' => $this->_sSystem . '-subscriptions', 'name' => $this->_sSystem . '-subscriptions', 'class' => '', 'title' => '_cmt_browse_subscriptions', 'target' => '_self', 'onclick' => 'javascript:' . $this->_sJsObjName . '.cmtChangeFilter(this, \'subscriptions\');') + ); + + $oMenu = new BxTemplMenuInteractive(array('template' => 'menu_interactive_vertical.html', 'menu_id'=> $this->_sSystem . '-filter', 'menu_items' => $aFilterLinks)); + $oMenu->setSelected('', $this->_sSystem . '-' . $this->_sBrowseFilter); + $sBrowseFilter = $oMenu->getCode(); + } + + return $this->_oTemplate->parseHtmlByName('comments_controls.html', array( + 'display_switcher' => $bDisplay ? $sDisplay : '', + 'bx_if:is_divider_1' => array( + 'condition' => $bDisplay && $bBrowseType, + 'content' => array( + 'style_prefix' => $this->_sStylePrefix, + ) + ), + 'browse_switcher' => $bBrowseType ? $sBrowseType : '', + 'bx_if:is_divider_2' => array( + 'condition' => $bBrowseType && $bBrowseFilter, + 'content' => array( + 'style_prefix' => $this->_sStylePrefix, + ) + ), + 'filter_switcher' => $bBrowseFilter ? $sBrowseFilter : '', + )); + } + + protected function _getActionsBox(&$aCmt, $aBp = [], $aDp = []) + { + $bViewOnly = isset($aDp['view_only']) && $aDp['view_only'] === true; + $bDynamicMode = isset($aDp['dynamic_mode']) && $aDp['dynamic_mode'] === true; + + $sMenuActions = ''; + if(!$bViewOnly) { + $oMenuActions = BxDolMenu::getObjectInstance($this->_sMenuObjActions); + $oMenuActions->setCmtsData($this, $aCmt['cmt_id'], $aBp, $aDp); + $oMenuActions->setDynamicMode($bDynamicMode); + $sMenuActions = $oMenuActions->getCode(); + } + + return $this->_oTemplate->parseHtmlByName('comment_actions.html', array( + 'id' => $aCmt['cmt_id'], + 'js_object' => $this->_sJsObjName, + 'style_prefix' => $this->_sStylePrefix, + 'menu_actions' => $sMenuActions, + )); + } + + protected function _getCountersBox(&$aCmt, $aBp = [], $aDp = []) + { + $bDynamicMode = isset($aDp['dynamic_mode']) && $aDp['dynamic_mode'] === true; + + $oMenuCounters = BxDolMenu::getObjectInstance($this->_sMenuObjCounters); + if(!$oMenuCounters) + return ''; + + $oMenuCounters->setCmtsData($this, $aCmt['cmt_id'], $aBp, $aDp); + $oMenuCounters->setDynamicMode($bDynamicMode); + return $oMenuCounters->getCode(); + } + + protected function _getFormBox($sType, $aBp, $aDp) + { + $iCmtParentId = isset($aBp['parent_id']) ? (int)$aBp['parent_id'] : 0; + $sPosition = isset($aDp['position']) ? $aDp['position'] : ''; + $bQuote = isset($aDp['quote']) && (bool)$aDp['quote']; + $bFormMin = $iCmtParentId == 0 && isset($aDp['min_post_form']) && (bool)$aDp['min_post_form']; + + $sPositionSystem = $this->_aSystem['post_form_position']; + if(!empty($sPosition) && $sPositionSystem != $sPosition) + return ''; + + $sClass = ''; + if(!empty($sPosition)) + $sClass .= ' ' . $this->_sStylePrefix . '-reply-' . $sPosition; + if($bQuote) + $sClass .= ' ' . $this->_sStylePrefix . '-reply-quote'; + if($bFormMin) + $sClass .= ' ' . $this->_sStylePrefix . '-reply-min'; + if(!empty($aDp['class'])) + $sClass .= ' ' . $aDp['class']; + + $sClassBody = ''; + if(!empty($aDp['class_body'])) + $sClassBody .= ' ' . $aDp['class_body']; + + $aTmplVarsFormMin = array(); + if($bFormMin) { + list($sAuthorName, $sAuthorLink, $sAuthorIcon, $sAuthorUnit) = $this->_getAuthorInfo($this->_getAuthorId()); + + $oForm = new BxTemplFormView(array()); + $aInputPlaceholder = array( + 'type' => 'text', + 'name' => 'comment', + 'caption' => '', + 'attrs' => array( + 'onclick' => 'javascript:' . $this->_sJsObjName . '.cmtShowForm(this)', + 'placeholder' => _t($this->_aT['txt_min_form_placeholder'], $sAuthorName), + 'autocomplete' => 'off', + 'readonly' => 'readonly' + ), + 'value' => '', + ); + + $sClassBodyMin = ''; + if(!empty($aDp['class_body_min'])) + $sClassBodyMin .= ' ' . $aDp['class_body_min']; + + $aTmplVarsFormMin = array( + 'js_object' => $this->_sJsObjName, + 'class_body_min' => $sClassBodyMin, + 'style_prefix' => $this->_sStylePrefix, + 'author_unit' => $sAuthorUnit, + 'placeholder' => $oForm->genRow($aInputPlaceholder) + ); + } + + $aForm = $this->{'_getForm' . ucfirst($sType)}($iCmtParentId, $aDp); + if(empty($aForm['form'])) + return !empty($aForm['msg']) ? MsgBox($aForm['msg']) : ''; + + return $this->_oTemplate->parseHtmlByName('comment_reply_box.html', array( + 'js_object' => $this->_sJsObjName, + 'style_prefix' => $this->_sStylePrefix, + 'class' => $sClass, + 'class_body' => $sClassBody, + 'bx_if:show_form_min' => array( + 'condition' => $bFormMin, + 'content' => $aTmplVarsFormMin + ), + 'form' => $aForm['form'], + 'form_id' => $aForm['form_id'], + )); + } + + protected function _getFormAdd($aValues) + { + $iCmtAuthorId = isset($aValues['cmt_author_id']) ? (int)$aValues['cmt_author_id'] : $this->_getAuthorId(); + $iCmtParentId = isset($aValues['cmt_parent_id']) ? (int)$aValues['cmt_parent_id'] : 0; + + $oForm = $this->_getForm(BX_CMT_ACTION_POST, $iCmtParentId); + $oForm->aFormAttrs['method'] = BX_DOL_FORM_METHOD_SPECIFIC; + $oForm->aParams['csrf']['disable'] = true; + $oForm->aInputs['cmt_parent_id']['value'] = $iCmtParentId; + if(!empty($oForm->aParams['db']['submit_name'])) { + $sSubmitName = false; + if(is_array($oForm->aParams['db']['submit_name'])) + foreach($oForm->aParams['db']['submit_name'] as $sVal) { + if(isset($oForm->aInputs[$sVal])) { + $sSubmitName = $sVal; + break; + } + } + else + $sSubmitName = $oForm->aParams['db']['submit_name']; + + if($sSubmitName && isset($oForm->aInputs[$sSubmitName])) + $aValues[$sSubmitName] = $oForm->aInputs[$sSubmitName]['value']; + } + + $oForm->initChecker(array(), $aValues); + if(!$oForm->isSubmittedAndValid()) + return array('code' => 1, 'message' => '_sys_txt_error_occured'); + + $iLevel = 0; + $iCmtVisualParentId = 0; + if((int)$iCmtParentId > 0) { + $aParent = $this->getCommentRow($iCmtParentId); + + $iLevel = (int)$aParent['cmt_level'] + 1; + $iCmtVisualParentId = $iLevel > $this->getMaxLevel() ? $aParent['cmt_vparent_id'] : $iCmtParentId; + } + + $iCmtId = (int)$oForm->insert(array('cmt_vparent_id' => $iCmtVisualParentId, 'cmt_object_id' => $this->_iId, 'cmt_author_id' => $iCmtAuthorId, 'cmt_level' => $iLevel, 'cmt_time' => time())); + if(!$iCmtId) { + if(!$oForm->isValid()) + return array('code' => 1, 'message' => '_sys_txt_error_occured'); + else + return array('code' => 2, 'message' => '_cmt_err_cannot_perform_action'); + } + + $iCmtUniqId = $this->_oQuery->getUniqId($this->_aSystem['system_id'], $iCmtId, [ + 'author_id' => $iCmtAuthorId, + 'status_admin' => $this->getStatusAdmin() + ]); + + if($iCmtParentId) { + $this->_oQuery->updateRepliesCount($iCmtParentId, 1); + + if(!BxDolModuleQuery::getInstance()->isEnabledByName('bx_notifications')) + $this->_sendNotificationEmail($iCmtId, $iCmtParentId); + } + + $this->_triggerComment(); + + if($this->_sMetatagsObj && ($oMetatags = BxDolMetatags::getObjectInstance($this->_sMetatagsObj)) !== false) + $oMetatags->metaAdd($iCmtUniqId, $aValues['cmt_text']); + + $mixedResult = $this->onPostAfter($iCmtId); + if($mixedResult === false) + return array('code' => 2, 'message' => '_cmt_err_cannot_perform_action'); + + return $mixedResult; + } + + protected function _getFormPost($iCmtParentId = 0, $aDp = []) + { + $bCmtParentId = !empty($iCmtParentId); + + if(!$bCmtParentId && !$this->isPostAllowed()) { + $sMsg = ''; + if(!isLogged()) { + $oPermalink = BxDolPermalinks::getInstance(); + $sMsg = _t('_cmt_msg_login_required', $oPermalink->permalink('page.php?i=login'), $oPermalink->permalink('page.php?i=create-account')); + } + else + $sMsg = $this->msgErrPostAllowed(); + + return bx_is_api() ? bx_api_get_msg($sMsg) : ['msg' => $sMsg]; + } + + if($bCmtParentId && !$this->isReplyAllowed($iCmtParentId)) + return bx_is_api() ? bx_api_get_msg($sMsg) : ['msg' => $this->msgErrReplyAllowed()]; + + $bDynamic = isset($aDp['dynamic_mode']) && (bool)$aDp['dynamic_mode']; + $bQuote = isset($aDp['quote']) && (bool)$aDp['quote']; + + $oForm = $this->_getForm(BX_CMT_ACTION_POST, $iCmtParentId, $aDp); + $oForm->aInputs['cmt_parent_id']['value'] = $iCmtParentId; + + if($bQuote) { + $aCmtParent = $this->getCommentRow((int)$iCmtParentId); + if(!empty($aCmtParent['cmt_text'])) + $oForm->aInputs['cmt_text']['value'] = $this->_oTemplate->parseHtmlByName('comment_quote.html', [ + 'content' => $aCmtParent['cmt_text'] + ]); + } + + $oForm->initChecker(); + if($oForm->isSubmittedAndValid()) { + $iCmtAuthorId = $this->_getAuthorId(); + $iCmtParentId = (int)$oForm->getCleanValue('cmt_parent_id'); + + //--- Process Text ---// + $sCmtText = $oForm->getCleanValue('cmt_text'); + $bCmtText = !empty($sCmtText); + + //--- Process Media ---// + $aImageIds = $oForm->getCleanValue('cmt_image'); + $bImageIds = !empty($aImageIds) && is_array($aImageIds); + + if(!$bCmtText && !$bImageIds) { + $oForm->aInputs['cmt_text']['error'] = _t('_Please enter characters'); + $oForm->setValid(false); + return bx_is_api() ? ['form' => $oForm, 'res' => 0] : ['form' => $oForm->getCode($bDynamic), 'form_id' => $oForm->id]; + } + + $aParent = []; + if($iCmtParentId > 0) { + $aParent = $this->getCommentRow($iCmtParentId); + if(empty($aParent) || !is_array($aParent)) { + $iCmtParentId = 0; + $oForm->setSubmittedValue('cmt_parent_id', $iCmtParentId, $oForm->aFormAttrs['method']); + } + } + + $iLevel = 0; + $iCmtVisualParentId = 0; + if($iCmtParentId > 0) { + $iLevel = (int)$aParent['cmt_level'] + 1; + $iCmtVisualParentId = $iLevel > $this->getMaxLevel() ? $aParent['cmt_vparent_id'] : $iCmtParentId; + } + + $iCmtId = (int)$oForm->insert(['cmt_vparent_id' => $iCmtVisualParentId, 'cmt_object_id' => $this->_iId, 'cmt_author_id' => $iCmtAuthorId, 'cmt_level' => $iLevel, 'cmt_time' => time()]); + if($iCmtId != 0) { + $iCmtUniqId = $this->_oQuery->getUniqId($this->_aSystem['system_id'], $iCmtId, [ + 'author_id' => $iCmtAuthorId, + 'status_admin' => $this->getStatusAdmin() + ]); + + if($this->isAttachImageEnabled()) + $oForm->processImages($this, 'cmt_image', $iCmtUniqId, $iCmtId, $iCmtAuthorId, true); + + if($iCmtParentId > 0) { + $this->_oQuery->updateRepliesCount($iCmtParentId, 1); + + if(!BxDolModuleQuery::getInstance()->isEnabledByName('bx_notifications')) + $this->_sendNotificationEmail($iCmtId, $iCmtParentId); + } + + $this->_triggerComment(); + + if($iCmtParentId > 0) + $this->isReplyAllowed($iCmtParentId, true); + else + $this->isPostAllowed(true); + + if($this->_sMetatagsObj && ($oMetatags = BxDolMetatags::getObjectInstance($this->_sMetatagsObj)) !== false) + $oMetatags->metaAdd($iCmtUniqId, $sCmtText); + + if(($mixedResult = $this->onPostAfter($iCmtId, $aDp)) !== false){ + if (bx_is_api()){ + $this->_unsetFormObject(BX_CMT_ACTION_POST); + return ['form' => $this->_getForm(BX_CMT_ACTION_POST, $iCmtParentId), 'res' => $iCmtId]; + } + else{ + return $mixedResult; + } + } + } + return bx_is_api() ? bx_api_get_msg('_cmt_err_cannot_perform_action') : ['msg' => _t('_cmt_err_cannot_perform_action')]; + } + return bx_is_api() ? ['form' => $oForm, 'res' => 0] : ['form' => $oForm->getCode($bDynamic), 'form_id' => $oForm->id]; + } + + protected function _getFormEdit($iCmtId, $aDp = []) + { + $bDynamic = isset($aDp['dynamic_mode']) && (bool)$aDp['dynamic_mode']; + + $aCmt = $this->getCommentSimple($iCmtId); + if(!$aCmt) + return bx_is_api() ? bx_api_get_msg(_t('_No such comment')) : array('msg' => _t('_No such comment')); + + $iCmtAuthorId = $this->_getAuthorId(); + if(!$this->isEditAllowed($aCmt)){ + $sMsg = $aCmt['cmt_author_id'] == $iCmtAuthorId ? strip_tags($this->msgErrEditAllowed()) : _t('_Access denied'); + return bx_is_api() ? bx_api_get_msg($sMsg) : array('msg' => $sMsg); + } + + $oForm = $this->_getForm(BX_CMT_ACTION_EDIT, $aCmt['cmt_id'], $aDp); + + $oForm->initChecker($aCmt); + if($oForm->isSubmittedAndValid()) { + $sCmtText = $oForm->getCleanValue('cmt_text'); + + if($oForm->update($iCmtId) !== false) { + $iCmtUniqId = $this->_oQuery->getUniqId($this->_aSystem['system_id'], $iCmtId, [ + 'author_id' => (int)$aCmt['cmt_author_id'] + ]); + + $sStatusAdmin = $this->getStatusAdmin(); + if($sStatusAdmin !== BX_CMT_STATUS_ACTIVE) + $this->_oQuery->updateUniqId(['status_admin' => $sStatusAdmin], ['id' => $iCmtUniqId]); + + if($this->isAttachImageEnabled()) + $oForm->processImages($this, 'cmt_image', $iCmtUniqId, $iCmtId, $iCmtAuthorId, false); + + $this->isEditAllowed($aCmt, true); + + if($this->_sMetatagsObj && ($oMetatags = BxDolMetatags::getObjectInstance($this->_sMetatagsObj)) !== false) + $oMetatags->metaAdd($iCmtUniqId, $sCmtText); + + if(($mixedResult = $this->onEditAfter($iCmtId, $aDp)) !== false){ + if (bx_is_api()){ + $this->_unsetFormObject(BX_CMT_ACTION_POST); + return ['form' => $this->_getForm(BX_CMT_ACTION_POST, $iCmtParentId), 'res' => $iCmtId]; + } + else{ + return $mixedResult; + } + } + + } + return bx_is_api() ? bx_api_get_msg(_t('_cmt_err_cannot_perform_action')) : array('msg' => _t('_cmt_err_cannot_perform_action')); + } + + return bx_is_api() ? ['form' => $oForm, 'res' => 0] : array('form' => $oForm->getCode($bDynamic), 'form_id' => $oForm->id); + } + + protected function _getForm($sAction, $iId, $aDp = []) + { + $oForm = $this->_getFormObject($sAction); + $oForm->setId(sprintf($oForm->getAttributeMask('id'), $sAction, $this->_sSystem, $this->_iId, $iId)); + $oForm->setName(sprintf($oForm->getAttributeMask('name'), $sAction, $this->_sSystem, $this->_iId, $iId)); + $oForm->aParams['db']['table'] = $this->_aSystem['table']; + $oForm->aInputs['sys']['value'] = $this->_sSystem; + $oForm->aInputs['id']['value'] = $this->_iId; + $oForm->aInputs['action']['value'] = 'Submit' . ucfirst($sAction) . 'Form'; + + if($this->_aParams) + $oForm->aInputs = ['params' => [ + 'name' => 'params', + 'type' => 'hidden', + 'value' => json_encode($this->_aParams) + ]] + $oForm->aInputs; + + if(!$this->isAttachImageEnabled()) + unset($oForm->aInputs['cmt_image']); + + if(isset($oForm->aInputs['cmt_text'])) { + $oForm->aInputs['cmt_text']['html'] = $this->_aSystem['html']; + $oForm->aInputs['cmt_text']['db']['pass'] = $this->isHtml() ? 'XssHtml' : 'XssMultiline'; + + if(isset($oForm->aInputs['cmt_text']['checker']['func']) && strtolower($oForm->aInputs['cmt_text']['checker']['func']) == 'length') { + $iCmtTextMin = (int)$this->_aSystem['chars_post_min']; + $iCmtTextMax = (int)$this->_aSystem['chars_post_max']; + $oForm->aInputs['cmt_text']['checker']['params'] = array($iCmtTextMin, $iCmtTextMax); + $oForm->aInputs['cmt_text']['checker']['error'] = _t('_Please enter n1-n2 characters', $iCmtTextMin, $iCmtTextMax); + } + } + + if($sAction == BX_CMT_ACTION_EDIT && isset($oForm->aInputs['cmt_controls'])) + foreach($oForm->aInputs['cmt_controls'] as $mixedKey => $mixedValue) { + if(!is_numeric($mixedKey) || empty($mixedValue['name']) || $mixedValue['name'] != 'cmt_cancel') + continue; + + if(!isset($oForm->aInputs['cmt_controls'][$mixedKey]['attrs'])) + $oForm->aInputs['cmt_controls'][$mixedKey]['attrs'] = array(); + + $oForm->aInputs['cmt_controls'][$mixedKey]['attrs']['onclick'] = $this->_sJsObjName . '.cmtEdit(this, ' . $iId . ', false)'; + } + + return $oForm; + } + + protected function _getContent($aCmt, $aBp = [], $aDp = []) + { + $sAttachments = $this->_getAttachments($aCmt); + + return $this->_oTemplate->parseHtmlByName($this->_sTmplNameItemContent, array_merge(array( + 'style_prefix' => $this->_sStylePrefix, + 'js_object' => $this->_sJsObjName, + 'bx_if:show_attached' => array( + 'condition' => !empty($sAttachments), + 'content' => array( + 'style_prefix' => $this->_sStylePrefix, + 'attached' => $sAttachments + ) + ), + 'counters' => $this->_getCountersBox($aCmt, $aBp, $aDp), + ), $this->_getTmplVarsText($aCmt))); + } + + protected function _getMoreLink($sCmts, $aBp = array(), $aDp = array()) + { + $iStart = $iPerView = 0; + switch($aBp['type']) { + case BX_CMT_BROWSE_HEAD: + case BX_CMT_BROWSE_POPULAR: + case BX_CMT_BROWSE_CONNECTION: + $iPerView = $aBp['per_view']; + + $iStart = $aBp['start'] + $iPerView; + if($iStart >= $aBp['count']) + return $sCmts; + + break; + + case BX_CMT_BROWSE_TAIL: + $iPerView = $aBp['per_view']; + + $iStart = $aBp['start'] - $iPerView; + if($iStart < 0) { + $iPerView += $iStart; + $iStart = 0; + } + + if($iStart == 0 && $iPerView == 0) + return $sCmts; + + break; + } + + $sParentKey = isset($aBp['vparent_id']) ? 'vparent_id' : 'parent_id'; + $bRoot = (int)$aBp[$sParentKey] <= 0; + + $sMore = $this->_oTemplate->parseHtmlByName('comment_more.html', array( + 'js_object' => $this->_sJsObjName, + 'style_prefix' => $this->_sStylePrefix, + 'bx_if:is_root' => array( + 'condition' => $bRoot, + 'content' => array() + ), + 'parent_id' => $aBp[$sParentKey], + 'start' => $iStart, + 'per_view' => $iPerView, + 'title' => _t('_cmt_load_more_' . ($aBp[$sParentKey] == 0 ? 'comments' : 'replies') . '_' . $aBp['type']) + )); + + switch($aBp['type']) { + case BX_CMT_BROWSE_HEAD: + case BX_CMT_BROWSE_POPULAR: + case BX_CMT_BROWSE_CONNECTION: + $sCmts .= $sMore; + break; + + case BX_CMT_BROWSE_TAIL: + $sCmts = $sMore . $sCmts; + break; + } + + return $sCmts; + } + + protected function _getEmpty($aDp = array()) + { + $sClass = ''; + if(!empty($aDp['class'])) + $sClass .= ' ' . $aDp['class']; + + return $this->_oTemplate->parseHtmlByName('comment_empty.html', array( + 'style_prefix' => $this->_sStylePrefix, + 'class' => $sClass, + 'content' => MsgBox(_t('_Empty')) + )); + } + + protected function _getAttachments($aCmt) + { + $aTmplImages = array(); + if(!$this->isAttachImageEnabled()) + return ''; + + $aFiles = $this->_oQuery->getFiles($this->_aSystem['system_id'], $aCmt['cmt_id']); + if(!empty($aFiles) && is_array($aFiles)) { + $oStorage = BxDolStorage::getObjectInstance($this->getStorageObjectName()); + $oTranscoder = BxDolTranscoderImage::getObjectInstance($this->getTranscoderPreviewName()); + + foreach($aFiles as $aFile) { + $sFile = $oStorage->getFileUrlById($aFile['image_id']); + $bImage = $oTranscoder && $oTranscoder->isMimeTypeSupported($aFile['mime_type']); + + $sPreview = ''; + $iWidth = $iHeight = 0; + + if($bImage) { + if(!$this->_bIsApi && $oTranscoder) + $sPreview = $oTranscoder->getFileUrl($aFile['image_id']); + + if(empty($aFile['dimensions'])) { + $aFileInfo = $oStorage->getFile($aFile['image_id']); + if(!empty($aFileInfo['dimensions'])) + $aFile['dimensions'] = $aFileInfo['dimensions']; + } + + if(!empty($aFile['dimensions'])) + list($iWidth, $iHeight) = explode('x', $aFile['dimensions']); + } + + if(!$this->_bIsApi && !$sPreview) + $sPreview = $this->_oTemplate->getIconUrl($oStorage->getIconNameByFileName($aFile['file_name'])); + + $aTmplVarsFile = array( + 'js_object' => $this->_sJsObjName, + 'preview' => $sPreview, + 'file' => $sFile, + 'file_id' => $aFile['id'], + 'file_name' => $aFile['file_name'], + 'file_icon' => $oStorage->getFontIconNameByFileName($aFile['file_name']), + 'file_size' => _t_format_size($aFile['size']), + 'w' => $iWidth, + 'h' => $iHeight + ); + + if($this->_bIsApi){ + $aTmplImages[] = array( + 'is_image' => $bImage, + 'file' => $aTmplVarsFile['file'], + 'file_id' => $aTmplVarsFile['file_id'], + 'file_name' => $aTmplVarsFile['file_name'], + 'file_icon' => $aTmplVarsFile['file_icon'], + 'file_size' => $aTmplVarsFile['file_size'], + 'width' => $aTmplVarsFile['w'], + 'height' => $aTmplVarsFile['h'], + ); + } + else{ + $aTmplImages[] = array( + 'style_prefix' => $this->_sStylePrefix, + 'bx_if:show_image' => array( + 'condition' => $bImage, + 'content' => $aTmplVarsFile + ), + 'bx_if:show_file' => array( + 'condition' => !$bImage, + 'content' => $aTmplVarsFile + ), + ); + } + } + } + + if (bx_is_api()){ + return $aTmplImages; + } + + return $this->_oTemplate->parseHtmlByName('comment_attachments.html', array( + 'bx_repeat:attached' => $aTmplImages + )); + } + + protected function _getTmplVarsNotes($aCmt) + { + $aTmplVars = array(); + + //--- Pending status related notes. + if($aCmt['cmt_status_admin'] == BX_CMT_STATUS_PENDING) + $aTmplVars[] = [ + 'style_prefix' => $this->_sStylePrefix, + 'bx_if:show_note_color' => [ + 'condition' => true, + 'content' => [ + 'item_note_color' => 'red3' + ] + ], + 'item_note' => _t('_cmt_txt_note_approve_pending') + ]; + + return [ + 'bx_if:show_notes' => [ + 'condition' => !empty($aTmplVars), + 'content' => [ + 'style_prefix' => $this->_sStylePrefix, + 'bx_repeat:notes' => $aTmplVars + ] + ], + ]; + } + + protected function _getTmplVarsAuthor($aCmt) + { + list($sAuthorName, $sAuthorLink, $sAuthorIcon, $sAuthorUnit) = $this->_getAuthorInfo($aCmt['cmt_author_id']); + $bAuthorIcon = !empty($sAuthorIcon); + + return array( + 'author_unit' => $sAuthorUnit, + 'bx_if:show_icon' => array( + 'condition' => $bAuthorIcon, + 'content' => array( + 'author_icon' => $sAuthorIcon + ) + ), + 'bx_if:show_icon_empty' => array( + 'condition' => !$bAuthorIcon, + 'content' => array() + ), + 'bx_if:show_author_link' => array( + 'condition' => !empty($sAuthorLink), + 'content' => array( + 'author_link' => $sAuthorLink, + 'author_title' => bx_html_attribute($sAuthorName), + 'author_name' => $sAuthorName + ) + ), + 'bx_if:show_author_text' => array( + 'condition' => empty($sAuthorLink), + 'content' => array( + 'author_name' => $sAuthorName + ) + ), + ); + } + + protected function _getTmplVarsText($aCmt) + { + return [ + 'style_prefix' => $this->_sStylePrefix, + 'text' => $this->_prepareTextForOutput($aCmt['cmt_text'], $aCmt['cmt_id']) + ]; + } + + protected function _getDoComment($aParams = [], $isAllowedComment = true) + { + $bShowDoCommentAsButtonSmall = isset($aParams['show_do_comment_as_button_small']) && $aParams['show_do_comment_as_button_small'] == true; + $bShowDoCommentAsButton = !$bShowDoCommentAsButtonSmall && isset($aParams['show_do_comment_as_button']) && $aParams['show_do_comment_as_button'] == true; + + $iCount = isset($aParams['count']) ? (int)$aParams['count'] : 0; + $bDisabled = !$isAllowedComment; + + $sClass = ''; + if($bShowDoCommentAsButton) + $sClass = 'bx-btn'; + else if ($bShowDoCommentAsButtonSmall) + $sClass = 'bx-btn bx-btn-small'; + + if(!$isAllowedComment) + $sClass .= $bShowDoCommentAsButton || $bShowDoCommentAsButtonSmall ? ' bx-btn-disabled' : 'bx-cmts-disabled'; + + if($this->_bIsApi) + return [ + 'is_disabled' => $bDisabled, + 'count' => $iCount, + 'link' => bx_api_get_relative_url($this->getListUrl()), + 'title' => _t($this->_getTitleDo(), $iCount) + ]; + + return $this->_oTemplate->parseLink($this->getListUrl(), $this->_getLabelDo($aParams), [ + 'class' => $this->_sStylePrefix . '-do-comment ' . $this->_sStylePrefix . '-dc ' . $sClass, + 'title' => _t($this->_getTitleDo(), $iCount) + ]); + } +} + +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseCmtsMenuManage.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseCmtsMenuManage.php new file mode 100644 index 0000000000..0aac953a65 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseCmtsMenuManage.php @@ -0,0 +1,56 @@ +setCmtsData($oCmts, (int)bx_get('cmt_id')); + } + + $this->_bDynamicMode = true; + $this->_bShowTitles = true; + } + + public function initContentParams() + { + parent::initContentParams(); + + $this->_aContentParams = array_merge($this->_aContentParams, [ + 'cmt_system' => $this->_oCmts->getSystemName(), + 'cmt_object_id' => $this->_oCmts->getId(), + 'cmt_id' => (int)$this->_aCmt['cmt_id'] + ]); + } + + public function setContentParams($aParams) + { + if(!isset($aParams['cmt_system'], $aParams['cmt_object_id'], $aParams['cmt_id'])) + return false; + + $oCmts = BxTemplCmts::getObjectInstance($aParams['cmt_system'], (int)$aParams['cmt_object_id']); + if(!$oCmts) + return false; + + $this->setCmtsData($oCmts, (int)$aParams['cmt_id']); + + return parent::setContentParams($aParams); + } +} + +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseCmtsNotes.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseCmtsNotes.php new file mode 100644 index 0000000000..351ea1989f --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseCmtsNotes.php @@ -0,0 +1,31 @@ +aInputs['cmt_cf'])) + unset($oForm->aInputs['cmt_cf']); + + return $oForm; + } +} + +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseCmtsReviews.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseCmtsReviews.php new file mode 100644 index 0000000000..2663c063f0 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseCmtsReviews.php @@ -0,0 +1,164 @@ +_sTmplNameItemContent = 'review_content.html'; + + $this->_sJsObjClass = 'BxDolCmtsReviews'; + } + + public function getStylePrefix() + { + return $this->_sStylePrefix; + } + + public function getComment($mixedCmt, $aBp = array(), $aDp = array()) + { + $sResult = parent::getComment($mixedCmt, $aBp, $aDp); + if(empty($sResult)) + return $sResult; + + $sMood = $this->_getMood($mixedCmt, $aDp); + return $this->_oTemplate->parseHtmlByContent($sResult, array( + 'bx_if:show_mood' => array( + 'condition' => !empty($sMood), + 'content' => array( + 'style_prefix' => $this->_sStylePrefix, + 'mood' => $sMood + ) + ) + )); + } + + function getRatingBlock($aDp = array()) + { + $mixedResult = $this->isViewAllowed(); + if($mixedResult !== CHECK_ACTION_RESULT_ALLOWED) + return $mixedResult; + + $aBp = array(); + $this->_getParams($aBp, $aDp); + + $iId = $this->getId(); + $aStats = $this->_oQuery->getReviewsStats($iId); + + if(!empty($aStats) && is_array($aStats) && (int)$aStats['count'] > 0) + $sContent = $this->_oTemplate->parseHtmlByName('reviews_rating_block.html', array( + 'style_prefix' => $this->_sStylePrefix, + 'system' => $this->_sSystem, + 'id' => $iId, + 'content' => $this->_oTemplate->parseHtmlByName('review_mood_legend.html', array_merge(array( + 'style_prefix' => $this->_sStylePrefix, + 'html_id' => $this->getRatingLegendId(), + 'value' => (float)$aStats['avg'], + 'bx_if:show_init' => array( + 'condition' => false, + 'content' => array() + ) + ), $this->_getTmplVarsStars())), + 'script' => $this->getJsScript($aBp, $aDp) + )); + else + $sContent = MsgBox(_t('_cmt_rvw_txt_empty')); + + $sCaption = _t($this->_aT['block_rating_title']); + return $aDp['in_designbox'] ? DesignBoxContent($sCaption, $sContent) : array( + 'title' => $sCaption, + 'content' => $sContent + ); + } + + protected function _getForm($sAction, $iId, $aDp = []) + { + $oForm = parent::_getForm($sAction, $iId, $aDp); + + switch($sAction) { + case BX_CMT_ACTION_POST: + if(!empty($iId)) + unset($oForm->aInputs['cmt_mood']); + break; + + case BX_CMT_ACTION_EDIT: + $aCmt = $this->getCommentSimple($iId); + if(!empty($aCmt['cmt_parent_id'])) + unset($oForm->aInputs['cmt_mood']); + break; + } + + return $oForm; + } + + protected function _getContent($aCmt, $aBp = [], $aDp = []) + { + $sMood = $this->_getMood($aCmt, $aDp); + $sContent = parent::_getContent($aCmt, $aBp, $aDp); + return $this->_oTemplate->parseHtmlByContent($sContent, [ + 'bx_if:show_mood' => [ + 'condition' => !empty($sMood), + 'content' => [ + 'style_prefix' => $this->_sStylePrefix, + 'mood' => $sMood + ] + ] + ]); + } + + protected function _getMood(&$aCmt, $aDp = array()) + { + if(!is_array($aCmt)) + $aCmt = $this->getCommentSimple((int)$aCmt); + + if((int)$aCmt['cmt_parent_id'] > 0) + return ''; + + $sHtmlId = $this->getMoodLegendId($aCmt['cmt_id']); + return $this->_oTemplate->parseHtmlByName('review_mood_legend.html', array_merge(array( + 'style_prefix' => $this->_sStylePrefix, + 'html_id' => $sHtmlId, + 'value' => (int)$aCmt['cmt_mood'], + 'bx_if:show_init' => array( + 'condition' => isset($aDp['dynamic_mode']) && (bool)$aDp['dynamic_mode'], + 'content' => array( + 'style_prefix' => $this->_sStylePrefix, + 'js_object' => $this->_sJsObjName, + 'html_id' => $sHtmlId, + ) + ) + ), $this->_getTmplVarsStars())); + } + + protected function _getTmplVarsStars() { + $aTmplVarsStars = $aTmplVarsSlider = array(); + for($i = $this->_iMoodMinValue; $i <= $this->_iMoodMaxValue; $i++) { + $aTmplVarsStars[] = array( + 'style_prefix' => $this->_sStylePrefix, + 'value' => $i + ); + + $aTmplVarsSlider[] = array( + 'style_prefix' => $this->_sStylePrefix + ); + } + + return array( + 'bx_repeat:stars' => $aTmplVarsStars, + 'bx_repeat:slider' => $aTmplVarsSlider + ); + } +} + +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseCmtsReviewsForm.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseCmtsReviewsForm.php new file mode 100644 index 0000000000..c90a18e155 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseCmtsReviewsForm.php @@ -0,0 +1,86 @@ +_sSystem = ''; + $this->_iId = 0; + } + + protected function genCustomInputCmtMood ($aInput) + { + if(bx_is_api()) { + $aInput['type'] = 'mood'; + return $aInput; + } + + $oSystem = $this->_getSystemObject(); + + $sStylePrefix = $oSystem->getStylePrefix(); + $sJsObject = $oSystem->getJsObjectName(); + + $iMoodMinValue = $oSystem->getMoodMinValue(); + $iMoodMaxValue = $oSystem->getMoodMaxValue(); + + $aTmplVarsStars = $aTmplVarsSlider = $aTmplVarsButtons = array(); + for($i = $iMoodMinValue; $i <= $iMoodMaxValue; $i++) { + $aTmplVarsStars[] = array( + 'style_prefix' => $sStylePrefix, + 'value' => $i + ); + + $aTmplVarsSlider[] = array( + 'style_prefix' => $sStylePrefix + ); + + $aTmplVarsButtons[] = array( + 'style_prefix' => $sStylePrefix, + 'js_object' => $sJsObject, + 'value' => $i + ); + } + + return $this->oTemplate->parseHtmlByName('review_mood_form_field.html', array( + 'style_prefix' => $sStylePrefix, + 'name' => $aInput['name'], + 'value' => !empty($aInput['value']) ? $aInput['value'] : 0, + 'bx_repeat:stars' => $aTmplVarsStars, + 'bx_repeat:slider' => $aTmplVarsSlider, + 'bx_repeat:buttons' => $aTmplVarsButtons, + 'bx_if:show_init' => array( + 'condition' => $this->_bDynamicMode, + 'content' => array( + 'style_prefix' => $sStylePrefix, + 'js_object' => $sJsObject, + 'form_id' => $this->getId(), + ) + ) + )); + } + + protected function _getSystemObject() + { + if(empty($this->_sSystem)) + $this->_sSystem = $this->aInputs['sys']['value']; + + if(empty($this->_iId)) + $this->_iId = (int)$this->aInputs['id']['value']; + + return BxDolCmts::getObjectInstance($this->_sSystem, $this->_iId); + } +} + +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseCmtsServices.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseCmtsServices.php new file mode 100644 index 0000000000..38de662414 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseCmtsServices.php @@ -0,0 +1,709 @@ +serviceGetAuthor((int)$aCmt['cmt_id']); + } + + public function serviceGetBlockAuthor($sSystem = '', $iObjectId = 0, $iCommentId = 0) + { + if(empty($sSystem) && ($sSystem = bx_get('sys')) !== false) + $sSystem = bx_process_input($sSystem); + + if(empty($iObjectId) && ($iObjectId = bx_get('id')) !== false) + $iObjectId = bx_process_input($iObjectId, BX_DATA_INT); + + if(empty($iCommentId) && ($iCommentId = bx_get('cmt_id')) !== false) + $iCommentId = bx_process_input($iCommentId, BX_DATA_INT); + + if(bx_is_api()) { + $oCmts = BxDolCmts::getObjectInstance($sSystem, $iObjectId, true); + $aCmt = $oCmts->getCommentRow($iCommentId); + + return [bx_api_get_block('entity_author', [ + 'author_data' => BxDolProfile::getData($aCmt['cmt_author_id']), + 'entry_date' => $aCmt['cmt_time'], + 'menu_manage' => [], + 'text' => bx_process_output(strip_tags($oCmts->getObjectTitle($iObjectId))), + 'url' => bx_api_get_relative_url($oCmts->getBaseUrl()) + ])]; + } + + return ''; + } + + public function serviceGetInfo($iCmtUniqId, $bSearchableFieldsOnly = true) + { + $oCmts = BxDolCmts::getObjectInstanceByUniqId($iCmtUniqId); + if(!$oCmts) + return []; + + $aCmt = BxDolCmtsQuery::getCommentExtendedByUniqId($iCmtUniqId); + if(empty($aCmt) || !is_array($aCmt)) + return []; + + return $oCmts->serviceGetInfo((int)$aCmt['cmt_id'], $bSearchableFieldsOnly); + } + + public function serviceGetBlockView($sSystem = '', $iObjectId = 0, $iCommentId = 0, $iParentsDepthMax = false) + { + $bIsApi = bx_is_api(); + + if(empty($sSystem) && ($sSystem = bx_get('sys')) !== false) + $sSystem = bx_process_input($sSystem); + + if(empty($iObjectId) && ($iObjectId = bx_get('id')) !== false) + $iObjectId = bx_process_input($iObjectId, BX_DATA_INT); + + if(empty($iCommentId) && ($iCommentId = bx_get('cmt_id')) !== false) + $iCommentId = bx_process_input($iCommentId, BX_DATA_INT); + + $oCmts = BxDolCmts::getObjectInstance($sSystem, $iObjectId, true); + if(!$oCmts) + return $bIsApi ? [] : ''; + + $iCmtStartFrom = $iCommentId; + if($iParentsDepthMax !== false) { + $aCmtParents = $oCmts->getCommentParents($iCommentId, $iParentsDepthMax); + if(!empty($aCmtParents) && is_array($aCmtParents)) + $iCmtStartFrom = array_pop($aCmtParents); + } + + if($bIsApi) { + $aRv = $this->serviceGetDataApi([ + 'module' => $sSystem, + 'object_id' => $iObjectId, + 'comment_id' => $iCmtStartFrom + ]); + + if(isset($aRv['browse']) && is_array($aRv['browse'])) { + $aRv['browse']['data']['total_count'] = 0; + + if($iParentsDepthMax !== false) + $aRv['browse']['data']['highlighted'] = $iCommentId; + } + + return [$aRv]; + } + + return $oCmts->getCommentBlock($iCmtStartFrom); + } + + public function serviceAlertResponseSysCmtsImagesFileDeleted($oAlert) + { + $iUniqId = (int)$oAlert->aExtras['ghost']['content_id']; + + $aCmt = BxDolCmts::getGlobalInfo($iUniqId); + if(empty($aCmt) || !is_array($aCmt)) + return; + + $oCmts = BxDolCmts::getObjectInstance($aCmt['system_name'], 0, false); + if(!$oCmts) + return; + + $oCmts->getQueryObject()->deleteImages($aCmt['system_id'], false, $oAlert->iObject); + } + + public function serviceGetMenuItemAddonVote($sSystem, $iId, $iCmtId) + { + $oCmts = BxDolCmts::getObjectInstance($sSystem, $iId); + + $oVote = $oCmts->getVoteObject($oCmts->getCommentUniqId($iCmtId)); + if($oVote !== false) + return $oVote->getCounter(); + + return ''; + } + + public function serviceGetLiveUpdate($sSystem, $iContentId, $iProfileId, $iCount = 0) + { + $oCmts = BxDolCmts::getObjectInstance($sSystem, $iContentId); + if(!$oCmts || !$oCmts->isEnabled()) + return false; + + $sKey = $oCmts->getNotificationId(); + + bx_import('BxDolSession'); + if((int)BxDolSession::getInstance()->getValue($sKey) == 1) + return false; + + $iCountNew = $oCmts->getCommentsCount($iContentId, -1, BX_CMT_FILTER_OTHERS); + if($iCountNew == $iCount) + return false; + + return array( + 'count' => $iCountNew, // required + 'method' => $oCmts->getJsObjectName() . '.showLiveUpdate(oData)', // required + 'data' => array( + 'code' => $oCmts->getLiveUpdate($iCount, $iCountNew) + ), // optional, may have some additional data to be passed in JS method provided using 'method' param above. + ); + } + + public function serviceGetLiveUpdates($sSystem, $iContentId, $iProfileId, $iCount = 0) + { + $oCmts = BxDolCmts::getObjectInstance($sSystem, $iContentId); + if(!$oCmts || !$oCmts->isEnabled()) + return false; + + $sKey = $oCmts->getNotificationId(); + + bx_import('BxDolSession'); + if((int)BxDolSession::getInstance()->getValue($sKey) == 1) + return false; + + $iCountNew = $oCmts->getCommentsCount($iContentId, -1, BX_CMT_FILTER_OTHERS); + if($iCountNew == $iCount) + return false; + + return array( + 'count' => $iCountNew, // required + 'method' => $oCmts->getJsObjectName() . '.showLiveUpdates(oData)', // required + 'data' => array( + 'code' => $oCmts->getLiveUpdates($iCount, $iCountNew) + ), // optional, may have some additional data to be passed in JS method provided using 'method' param above. + ); + } + + public function serviceManageTools($sType = 'common') + { + $oGrid = BxDolGrid::getObjectInstance('sys_cmts_administration'); + if(!$oGrid) + return ''; + + $oTemplate = BxDolTemplate::getInstance(); + $oTemplate->addJs(array('BxDolCmtsManageTools.js')); + $oTemplate->addCss(array('cmts_manage_tools.css')); + $oTemplate->addJsTranslation(array('_sys_grid_search')); + return array( + 'content' => $oGrid->getCode() + ); + } + + public function serviceGetMenuAddonManageTools() + { + $iNumTotal = BxDolCmts::getGlobalNumByParams(); + + $iNum1 = BxDolCmts::getGlobalNumByParams([[ + 'key' => 'status_admin', + 'value' => 'pending', + 'operator' => '=' + ]]); + + $iNum2 = BxDolCmts::getGlobalNumByParams([[ + 'key' => 'reports', + 'value' => '0', + 'operator' => '>' + ]]); + + return [ + 'counter1_value' => $iNum1, + 'counter1_caption' => _t('_sys_menu_dashboard_manage_tools_addon_counter1_caption_profile_default'), + 'counter2_value' => $iNum2, + 'counter3_value' => $iNumTotal + ]; + } + + /** + * Comment Added for Timeline module + */ + public function serviceGetTimelinePost($aEvent, $aBrowseParams = array()) + { + $bCache = true; + + $iCmtUniqId = $aEvent['object_id']; + $oCmts = BxDolCmts::getObjectInstanceByUniqId($iCmtUniqId); + if(!$oCmts) + return false; + + $aCmt = BxDolCmtsQuery::getCommentExtendedByUniqId($iCmtUniqId); + if(empty($aCmt) || !is_array($aCmt)) + return false; + + $iCmtId = (int)$aCmt['cmt_id']; + + $iUserId = bx_get_logged_profile_id(); + $iAuthorId = (int)$aCmt['cmt_author_id']; + $iAuthorIdAbs = abs($iAuthorId); + if($iAuthorId < 0 && ((is_numeric($aEvent['owner_id']) && $iAuthorIdAbs == (int)$aEvent['owner_id']) || (is_array($aEvent['owner_id']) && in_array($iAuthorIdAbs, $aEvent['owner_id']))) && $iAuthorIdAbs != $iUserId) + return false; + + $sCmtUrl = $oCmts->getViewUrl($iCmtId); + + $sSample = '_cmt_txt_sample_comment_single_with_article'; + $sSampleWoArticle = '_cmt_txt_sample_comment_single'; + $sAction = ''; + $sActionCustom = '_cmt_txt_added_sample_custom'; + $aActionCustomMarkers = array( + 'sample' => $sSample, + 'sample_url' => $sCmtUrl, + 'psample' => strip_tags($oCmts->getObjectTitle()), + 'psample_url' => $oCmts->getBaseUrl(), + ); + + $iOwnerId = $iAuthorIdAbs; + if(isset($aEvent['object_privacy_view']) && (int)$aEvent['object_privacy_view'] < 0) + $iOwnerId = abs($aEvent['object_privacy_view']); + + //--- Votes + $aVotes = array(); + if(($oVotes = $oCmts->getVoteObject($iCmtUniqId)) !== false) + $aVotes = array( + 'system' => $oVotes->getSystemName(), + 'object_id' => $iCmtUniqId, + 'count' => $aCmt['votes'] + ); + + //--- Reactions + $aReactions = array(); + if(($oReactions = $oCmts->getReactionObject($iCmtUniqId)) !== false) + $aReactions = array( + 'system' => $oReactions->getSystemName(), + 'object_id' => $iCmtUniqId, + 'count' => $aCmt['rvotes'] + ); + + //--- Scores + $aScores = array(); + if(($oScores = $oCmts->getScoreObject($iCmtUniqId)) !== false) + $aScores = array( + 'system' => $oScores->getSystemName(), + 'object_id' => $iCmtUniqId, + 'score' => $aCmt['score'] + ); + + //--- Reports + $aReports = array(); + if(($oReports = $oCmts->getReportObject($iCmtUniqId)) !== false) + $aReports = array( + 'system' => $oReports->getSystemName(), + 'object_id' => $iCmtUniqId, + 'count' => $aCmt['reports'] + ); + + return array( + '_cache' => $bCache, + 'owner_id' => $iOwnerId, + 'object_owner_id' => $iAuthorId, + 'icon' => 'comments', + 'sample' => $sSample, + 'sample_wo_article' => $sSampleWoArticle, + 'sample_action' => $sAction, + 'sample_action_custom' => array( + 'content' => $sActionCustom, + 'markers' => $aActionCustomMarkers + ), + 'url' => $sCmtUrl, + 'content' => array( + 'sample' => $sSample, + 'sample_wo_article' => $sSampleWoArticle, + 'sample_action' => $sAction, + 'url' => $sCmtUrl, + 'title' => '', + 'text' => $oCmts->getViewText($aCmt), + 'images' => array(), + 'images_attach' => array(), + 'videos' => array(), + 'videos_attach' => array(), + 'files' => array(), + 'files_attach' => $oCmts->getAttachments($iCmtId) + ), //a string to display or array to parse default template before displaying. + 'date' => $aCmt['cmt_time'], + 'views' => array(), + 'votes' => $aVotes, + 'reactions' => $aReactions, + 'scores' => $aScores, + 'reports' => $aReports, + 'comments' => array(), + 'title' => !empty($aCmt['cmt_text']) ? $aCmt['cmt_text'] : '', //may be empty. + 'description' => '' //may be empty. + ); + } + + /** + * Comment added for Notifications module + */ + public function serviceGetNotificationsCommentAdded($aEvent) + { + $aCommentGi = BxDolCmts::getGlobalInfo($aEvent['subobject_id']); + if(empty($aCommentGi) || !is_array($aCommentGi)) + return []; + + $iContentId = (int)$aEvent['object_id']; + + $oComment = BxDolCmts::getObjectInstance($aCommentGi['system_name'], $iContentId); + if(!$oComment) + return []; + + $aCommentSystem = $oComment->getSystemInfo(); + + $oContentModule = BxDolModule::getInstance($aCommentSystem['module']); + if(!$oContentModule) + return []; + + $aContentInfo = $oContentModule->_oDb->getContentInfoById($iContentId); + if(empty($aContentInfo) || !is_array($aContentInfo)) + return []; + + $CNF = &$oContentModule->_oConfig->CNF; + if(empty($CNF['FIELD_ID']) || empty($CNF['FIELD_AUTHOR']) || !(isset($CNF['FIELD_TITLE']) || isset($CNF['FIELD_TEXT'])) || empty($CNF['URI_VIEW_ENTRY'])) + return []; + + $sEntryUrl = '{bx_url_root}' . BxDolPermalinks::getInstance()->permalink('page.php?i=' . $CNF['URI_VIEW_ENTRY'] . '&id=' . $aContentInfo[$CNF['FIELD_ID']]); + $sEntryCaption = isset($aContentInfo[$CNF['FIELD_TITLE']]) ? $aContentInfo[$CNF['FIELD_TITLE']] : strmaxtextlen($aContentInfo[$CNF['FIELD_TEXT']], 20, '...'); + + return array( + 'entry_sample' => $CNF['T']['txt_sample_single'], + 'entry_url' => $sEntryUrl, + 'entry_caption' => $sEntryCaption, + 'subentry_sample' => $CNF['T']['txt_sample_comment_single'], + 'subentry_url' => '{bx_url_root}' . $oComment->getViewUrl((int)$aCommentGi['cmt_id'], false), + 'lang_key' => '', //may be empty or not specified. In this case the default one from Notification module will be used. + ); + } + + /** + * Comment vote for Notifications module + */ + public function serviceGetNotificationsVote($aEvent) + { + $iCmtIdUnique = (int)$aEvent['object_id']; + + $aCmtInfo = BxDolCmts::getGlobalInfo($iCmtIdUnique); + if(empty($aCmtInfo) || !is_array($aCmtInfo)) + return array(); + + $oCmts = BxDolCmts::getObjectInstance($aCmtInfo['system_name'], 0, false); + if(!$oCmts || !$oCmts->isEnabled()) + return array(); + + $oVote = $oCmts->getVoteObject($iCmtIdUnique); + if(!$oVote) + return array(); + + $iCmtId = (int)$aCmtInfo['cmt_id']; + $sCmtUrl = str_replace(BX_DOL_URL_ROOT, '{bx_url_root}', $oCmts->serviceGetLink($iCmtId)); + $sCmtCaption = strmaxtextlen($oCmts->serviceGetText($iCmtId), 20, '...'); + + return array( + 'entry_sample' => $oCmts->getLanguageKey('txt_sample_single'), + 'entry_url' => $sCmtUrl, + 'entry_caption' => $sCmtCaption, + 'entry_author' => $aCmtInfo['author_id'], + 'subentry_sample' => $oCmts->getLanguageKey('txt_sample_vote_single'), + 'lang_key' => '', //may be empty or not specified. In this case the default one from Notification module will be used. + ); + } + + /** + * Comment reaction for Notifications module + */ + public function serviceGetNotificationsReaction($aEvent) + { + $iCmtIdUnique = (int)$aEvent['object_id']; + + $aCmtInfo = BxDolCmts::getGlobalInfo($iCmtIdUnique); + if(empty($aCmtInfo) || !is_array($aCmtInfo)) + return array(); + + $oCmts = BxDolCmts::getObjectInstance($aCmtInfo['system_name'], 0, false); + if(!$oCmts || !$oCmts->isEnabled()) + return array(); + + $oReaction = $oCmts->getReactionObject($iCmtIdUnique); + if(!$oReaction) + return array(); + + $aSubentry = $oReaction->getTrackBy(array('type' => 'id', 'id' => (int)$aEvent['subobject_id'])); + if(empty($aSubentry) || !is_array($aSubentry)) + return array(); + + $aSubentrySampleParams = array(); + $aReaction = $oReaction->getReaction($aSubentry['reaction']); + if(!empty($aReaction['title'])) + $aSubentrySampleParams[] = $aReaction['title']; + else + $aSubentrySampleParams[] = '_undefined'; + + $iCmtId = (int)$aCmtInfo['cmt_id']; + $sCmtUrl = str_replace(BX_DOL_URL_ROOT, '{bx_url_root}', $oCmts->serviceGetLink($iCmtId)); + $sCmtCaption = strmaxtextlen($oCmts->serviceGetText($iCmtId), 20, '...'); + + return array( + 'entry_sample' => $oCmts->getLanguageKey('txt_sample_single'), + 'entry_url' => $sCmtUrl, + 'entry_caption' => $sCmtCaption, + 'entry_author' => $aCmtInfo['author_id'], + 'subentry_sample' => $oCmts->getLanguageKey('txt_sample_reaction_single'), + 'subentry_sample_params' => $aSubentrySampleParams, + 'lang_key' => '', //may be empty or not specified. In this case the default one from Notification module will be used. + ); + } + + /** + * Comment score -> vote up for Notifications module + */ + public function serviceGetNotificationsScoreUp($aEvent) + { + return $this->_serviceGetNotificationsScore('up', $aEvent); + } + + /** + * Comment score -> vote down for Notifications module + */ + public function serviceGetNotificationsScoreDown($aEvent) + { + return $this->_serviceGetNotificationsScore('down', $aEvent); + } + + protected function _serviceGetNotificationsScore($sType, $aEvent) + { + $iCmtIdUnique = (int)$aEvent['object_id']; + + $aCmtInfo = BxDolCmts::getGlobalInfo($iCmtIdUnique); + if(empty($aCmtInfo) || !is_array($aCmtInfo)) + return array(); + + $oCmts = BxDolCmts::getObjectInstance($aCmtInfo['system_name'], 0, false); + if(!$oCmts || !$oCmts->isEnabled()) + return array(); + + $oScore = $oCmts->getScoreObject($iCmtIdUnique); + if(!$oScore) + return array(); + + $iCmtId = (int)$aCmtInfo['cmt_id']; + $sCmtUrl = str_replace(BX_DOL_URL_ROOT, '{bx_url_root}', $oCmts->serviceGetLink($iCmtId)); + $sCmtCaption = strmaxtextlen($oCmts->serviceGetText($iCmtId), 20, '...'); + + return array( + 'entry_sample' => $oCmts->getLanguageKey('txt_sample_single'), + 'entry_url' => $sCmtUrl, + 'entry_caption' => $sCmtCaption, + 'entry_author' => $aCmtInfo['author_id'], + 'subentry_sample' => $oCmts->getLanguageKey('txt_sample_score_' . $sType . '_single'), + 'lang_key' => '', //may be empty or not specified. In this case the default one from Notification module will be used. + ); + } + + /** + * @page service Service Calls + * @section bx_system_cmts System Services + * @subsection bx_system_cmts-general General + * @subsubsection bx_system_cmts-get_data_api get_data_api + * + * @code bx_srv('system', 'get_data_api', [], 'TemplCmtsServices'); @endcode + * + * Get comments data + * @param $aParams array with paramenters : + * "module":"bx_posts","object_id":3,"start_from":5,"order_way":"desc","is_form":false + * + * @see TemplCmtsServices::serviceGetDataApi + */ + /** + * @ref bx_system_cmts-get_data_api "get_data_api" + * @api @ref bx_system_cmts-get_data_api "get_data_api" + */ + + public function serviceGetDataApi($aParams) + { + if(is_string($aParams)) + $aParams = json_decode($aParams, true); + + if (isset($aParams['action']) && isset($aParams['id']) && $aParams['action'] == 'remove'){ + $iCmtId = $aParams['id']; + $oCmts = BxDolCmts::getObjectInstance($aParams['module'], $aParams['object_id']); + $oCmts->remove($iCmtId); + return 'Ok'; + } + + if (isset($aParams['action']) && isset($aParams['id']) && $aParams['action'] == 'edit'){ + $iCmtId = $aParams['id']; + $oCmts = BxDolCmts::getObjectInstance($aParams['module'], $aParams['object_id']); + $oForm = $oCmts->getFormEdit($iCmtId); + if($oForm['form']->isSubmittedAndValid()){ + $aParams['comment_id'] = $oForm['res']; + $aRv['browse'] = $this->serviceGetCommentsApi($oCmts, $aParams); + return $aRv; + } + $aForm = $oForm['form']->getCodeAPI(); + $aForm['inputs']['cmt_text']['numLines'] = 1; + $aForm['inputs']['cmt_text']['autoheight'] = true; + $aForm['inputs']['cmt_submit'] = $aForm['inputs']['cmt_controls'][0]; + unset($aForm['inputs']['cmt_controls']); + + $aForm['inputs']['cmt_submit']['icon'] = 'contact'; + $aForm['inputs']['cmt_submit']['variant'] = 'text'; + $aForm['inputs']['cmt_submit']['icon_only'] = true; + $aRv['form'] = ['id' => 'cmt_form', 'type' => 'form', 'name' => 'comment', 'data' => $aForm, 'request' => ['immutable' => true]]; + return $aRv; + } + + + $aParams['parent_id'] = !isset($aParams['parent_id']) ? 0 : $aParams['parent_id']; + $aParams['start_from'] = !isset($aParams['start_from']) ? 0 : $aParams['start_from']; + $aParams['order_way'] = !isset($aParams['order_way']) ? 'asc' : $aParams['order_way']; + $aParams['is_form'] = !isset($aParams['is_form']) ? true : $aParams['is_form']; + $aParams['insert'] = 'before'; + + $oCmts = BxDolCmts::getObjectInstance($aParams['module'], $aParams['object_id']); + + if (!$oCmts || !$oCmts->isEnabled()) + return false; + + $aRv = [ + 'id' => '1', + 'url' => '/api.php?r=system/get_data_api/TemplCmtsServices/¶ms[]=', + 'type' => 'comments' + ]; + + $oForm = $oCmts->getFormPost($aParams['parent_id']); + $bIsList = false; + if (isset($oForm['form']) && $aParams['is_form']){ + $aForm = $oForm['form']->getCodeAPI(); + $aForm['inputs']['cmt_text']['numLines'] = 1; + $aForm['inputs']['cmt_text']['autoheight'] = true; + $aForm['inputs']['cmt_submit']['icon'] = 'contact'; + $aForm['inputs']['cmt_submit']['variant'] = 'text'; + $aForm['inputs']['cmt_submit']['icon_only'] = true; + + // add view (form + new comment) + if($oForm['form']->isSubmittedAndValid()){ + $sInsert = $aParams['order_way'] == 'desc' ? 'after' : 'before'; + if (bx_get('cmt_parent_id') > 0) + $sInsert = 'after'; + $aParams['insert'] = $sInsert; + $aParams['comment_id'] = $oForm['res']; + $bIsList = true; + $aForm['inputs']['cmt_parent_id']['value'] = 0; + } + + $aRv['form'] = ['id' => 'cmt_form', 'type' => 'form', 'name' => 'comment', 'data' => $aForm, 'request' => ['immutable' => true]]; + + // default view (form + list) + if (!$oForm['form']->isSubmitted()){ + $bIsList = true; + } + } + else{ + // list only view + $bIsList = true; + $aParams['insert'] = 'before'; + } + if ($bIsList) + $aRv['browse'] = $this->serviceGetCommentsApi($oCmts, $aParams); + + return $aRv; + } + + public function serviceGetCommentsApi($oCmts, $aParams) + { + $mixedResult = $oCmts->isViewAllowed(); + if($mixedResult !== CHECK_ACTION_RESULT_ALLOWED) + return $mixedResult; // TODO: error checking + + if (isset($aParams['comment_id'])) + $aParams['comment_id'] = explode(',', $aParams['comment_id']); + + $aBp = !isset($aParams['aBp']) ? [] : $aParams['aBp']; + $aDp = ['in_designbox' => false, 'show_empty' => false]; + + $aDp['type'] = !getParam('sys_api_comments_flat') ? 'threaded' : 'flat'; + $aBp['type'] = 'head'; + $oCmts->getParams($aBp, $aDp); + $oCmts->prepareParams($aBp, $aDp); + + $aBp['order']['way'] = $aParams['order_way']; + $aBp['order_way'] = $aParams['order_way']; + $aBp['start'] = $aParams['start_from'] ; + $aPp = $aBp['per_view']; + $aBp['per_view'] = $aBp['per_view'] + 1; + if (isset($aParams['per_view'])){ + $aBp['per_view'] = $aParams['per_view']; + } + + $aCmts = isset($aParams['comment_id']) ? array_map(function($value) {return ['cmt_id' => $value];}, $aParams['comment_id']) : $oCmts->getCommentsArray($aBp['vparent_id'], $aBp['filter'], $aBp['order'], $aBp['start'], $aBp[($aBp['init_view'] != -1 ? 'init' : 'per') . '_view']); + + + $aParams['start_from'] = 0; + if (count($aCmts) == $aBp['per_view']){ + $aBp['per_view'] = $aPp; + $aCmts = array_slice($aCmts, 0, $aBp['per_view']); + $aParams['start_from'] = $aBp['start'] + $aBp['per_view']; + } + $aCmtsRv = []; + foreach ($aCmts as $aCmt) { + $aBp['order_way'] = 'asc'; + $oCmt = $oCmts->getCommentStructure($aCmt['cmt_id'], $aBp, $aDp); + if($oCmt === false) + continue; + + if(($sKey = array_shift(array_keys($oCmt))) && $oCmt[$sKey]['data']['cmt_parent_id'] > 0){ + $aParent = $oCmts->getCommentSimple((int)$oCmt[$sKey]['data']['cmt_parent_id']); + $oCmt[$sKey]['data']['cmt_parent'] = [ + 'data' => $aParent, + 'author_data' => BxDolProfile::getData($aParent['cmt_author_id']) + ]; + } + + $aCmtsRv[] = $oCmt; + } + + $aData = [ + 'unit' => 'comments', + 'start' => $aParams['start_from'], + 'count' => count($aCmts), + 'per_view' => $aBp['per_view'], + 'total_count' => $oCmts->getCommentsCount(), + 'order' => $aParams['order_way'], + 'view' => $aDp['type'], + 'module' => $oCmts->getSystemName(), + 'object_id' => $oCmts->getId(), + 'max_level' => $oCmts->getSystemInfo()['number_of_levels'], + 'highlighted' => 0, + 'data' => $aCmtsRv, + ]; + if (isset($aParams['mode']) && $aParams['mode'] == 'feed') + return $aData; + + $aRv = [ + 'id' => 'cmt_list', + 'type' => 'browse', + 'insert' => $aParams['insert'], + 'data' => $aData + ]; + + if (isset($aParams['comment_id'])){ + $aRv['new'] = $aParams['comment_id']; + } + + return $aRv; + } +} + +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseEditorQuill.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseEditorQuill.php new file mode 100644 index 0000000000..33c1fd342b --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseEditorQuill.php @@ -0,0 +1,223 @@ +_oTemplate = $oTemplate; + else + $this->_oTemplate = BxDolTemplate::getInstance(); + } + + /** + * Attach editor to HTML element, in most cases - textarea. + * @param $sSelector - jQuery selector to attach editor to. + * @param $iViewMode - editor view mode: BX_EDITOR_STANDARD, BX_EDITOR_MINI, BX_EDITOR_FULL + * @param $bDynamicMode - is AJAX mode or not, the HTML with editor area is loaded dynamically. + */ + public function attachEditor ($sSelector, $iViewMode = BX_EDITOR_STANDARD, $bDynamicMode = false, $aAttrs = []) + { + $sAllowedTags = ''; + $sToolbarItems = ''; + // set visual mode + switch ($iViewMode) { + case BX_EDITOR_MINI: + $sToolbarItems = getParam('sys_quill_toolbar_mini'); + $sAllowedTags = getParam('sys_quill_allowed_tags_mini'); + $sCustomInit = self::$CONF_MINI; + break; + + case BX_EDITOR_FULL: + $sToolbarItems = getParam('sys_quill_toolbar_full'); + $sAllowedTags = getParam('sys_quill_allowed_tags_full'); + $sCustomInit = self::$CONF_FULL; + break; + + case BX_EDITOR_STANDARD: + default: + $sToolbarItems = getParam('sys_quill_toolbar_standard'); + $sAllowedTags = getParam('sys_quill_allowed_tags_standard'); + $sCustomInit = self::$CONF_STANDARD; + } + + if ($this->_sButtonsCustom !== false) { + $sToolbarItems = $this->_sButtonsCustom; + } + + $sEditorName = 'quill_' . str_replace(['-', ' '], '_', $aAttrs['form_id'] . '_' . $aAttrs['element_name'] . '_' . $aAttrs['uniq']); + $this->_oTemplate->addJsTranslation([ + '_sys_txt_quill_tooltip_bold', + '_sys_txt_quill_tooltip_italic', + '_sys_txt_quill_tooltip_underline', + '_sys_txt_quill_tooltip_clean', + '_sys_txt_quill_tooltip_list_ordered', + '_sys_txt_quill_tooltip_list_bullet', + '_sys_txt_quill_tooltip_indent_1', + '_sys_txt_quill_tooltip_indent_2', + '_sys_txt_quill_tooltip_blockquote', + '_sys_txt_quill_tooltip_direction', + '_sys_txt_quill_tooltip_script_sub', + '_sys_txt_quill_tooltip_script_super', + '_sys_txt_quill_tooltip_link', + '_sys_txt_quill_tooltip_image', + '_sys_txt_quill_tooltip_code_block', + '_sys_txt_quill_tooltip_color', + '_sys_txt_quill_tooltip_background', + '_sys_txt_quill_tooltip_align', + '_sys_txt_quill_tooltip_header', + '_sys_txt_quill_tooltip_embed', + '_sys_txt_quill_tooltip_embed_popup_header', + '_sys_txt_quill_tooltip_link_popup_header', + ]); + // initialize editor + $sInitEditor = $this->_replaceMarkers(self::$CONF_COMMON, array( + 'bx_var_custom_init' => $sCustomInit, + 'bx_var_selector' => bx_js_string($sSelector. '.' . $aAttrs['uniq'], BX_ESCAPE_STR_APOS), + 'bx_var_query_params' => isset($aAttrs['query_params']) ? json_encode($aAttrs['query_params']) : "''", + 'bx_var_form_id' => $aAttrs['form_id'], + 'toolbar' => $sToolbarItems ? '[' . $sToolbarItems . ']' : 'false', + 'insert_as_plain_text' => getParam('sys_quill_insert_as_plain_text') == 'on' ? 'true' : 'false', + 'empty_tags' => getParam('sys_quill_allow_empty_tags') == 'on' ? 'true' : 'false', + 'allowed_tags' => $sAllowedTags == '' ? 'false' : $sAllowedTags, + 'bx_var_css_additional_class' => $sToolbarItems ? '' : 'bx-form-input-html-quill-empty', + 'bx_var_element_name' => str_replace(['-', ' '], '_', $aAttrs['element_name']), + 'bx_var_editor_name' => $sEditorName, + 'bx_var_skin' => bx_js_string($this->_aObject['skin'], BX_ESCAPE_STR_APOS), + 'bx_url_root' => bx_js_string(BX_DOL_URL_ROOT, BX_ESCAPE_STR_APOS) + )); + $sInitEditor = " + if(!Quill.imports['modules/imageUploader']) + Quill.register('modules/imageUploader', ImageUploader); + " . $sInitEditor; + + $sInitCallBack = " + bQuillEditorInited = true; + " . $sInitEditor; + + if ($bDynamicMode) { + list($aJs, $aCss) = $this->_getJsCss(true); + + $sScript = "var " . $sEditorName . ";"; + $sScript .= $this->_oTemplate->addJsPreloaded($aJs, $sInitCallBack, "typeof bQuillEditorInited === 'undefined'", $sInitEditor.';'); + + $sScript = $this->_oTemplate->_wrapInTagJsCode($sScript); + $sScript = $this->_oTemplate->addCss($aCss, true) . $sScript; + + } else { + $sScript = "var " . $sEditorName . "; " . $this->_oTemplate->addJsCodeOnLoad($sInitCallBack); + $sScript = $this->_oTemplate->_wrapInTagJsCode($sScript); + } + + return $this->_addJsCss($bDynamicMode) . $sScript; + } + + + /** + * Add css/js files which are needed for editor display and functionality. + */ + protected function _addJsCss($bDynamicMode = false, $sInitEditor = '') + { + if ($bDynamicMode) + return ''; + + if ($this->_bJsCssAdded) + return ''; + + list($aJs, $aCss) = $this->_getJsCss(); + + $this->_oTemplate->addJs($aJs); + $this->_oTemplate->addCss($aCss); + + $this->_bJsCssAdded = true; + + return ''; + } + + protected function _getJsCss($bUseUrlsForJs = false) + { + $sJsPrefix = $bUseUrlsForJs ? BX_DOL_URL_PLUGINS_PUBLIC : BX_DIRECTORY_PATH_PLUGINS_PUBLIC; + $sJsPrefixRoot = $bUseUrlsForJs ? BX_DOL_URL_ROOT .'inc/js/' : BX_DIRECTORY_PATH_INC . 'js/'; + $sJsSuffix = $bUseUrlsForJs ? '' : '|'; + + $aJs = array( + $sJsPrefix . 'highlight/' . $sJsSuffix . 'highlight.min.js', + $sJsPrefix . 'quill/' . $sJsSuffix . 'quill.min.js', + $sJsPrefix . 'quill/' . $sJsSuffix . 'quill.mention.js', + $sJsPrefix . 'quill/' . $sJsSuffix . 'quill.imageUploader.min.js', + $sJsPrefix . 'quill/' . $sJsSuffix . 'image-resize.min.js', + $sJsPrefix . 'quill/' . $sJsSuffix . 'quill-emoji.js', + $sJsPrefixRoot . $sJsSuffix . 'editor.quill.js', + + ); + + $sCss = 'editor.less'; + $aCss = BxDolTemplate::getInstance()->_lessCss(array( + 'path' => $this->_oTemplate->getCssPath($sCss), + 'url' => $this->_oTemplate->getCssUrl($sCss) + )); + + $aCss = array_merge($aCss, array( + BX_DIRECTORY_PATH_BASE . 'css/|editor_snow.quill.css', + BX_DIRECTORY_PATH_PLUGINS_PUBLIC . 'quill/|quill.mention.css', + BX_DIRECTORY_PATH_PLUGINS_PUBLIC . 'quill/|quill-emoji.css', + BX_DIRECTORY_PATH_PLUGINS_PUBLIC . 'highlight/|default.min.css', + BX_DIRECTORY_PATH_PLUGINS_PUBLIC . 'quill/quill.imageUploader.min.css', + BX_DIRECTORY_PATH_BASE . 'css/|editor.quill.css', + )); + + return array($aJs, $aCss); + } +} + +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseEmbedSystem.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseEmbedSystem.php new file mode 100644 index 0000000000..4569771be7 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseEmbedSystem.php @@ -0,0 +1,142 @@ +_sTableName = 'sys_embeded_data'; + parent::__construct ($aObject); + + if ($oTemplate) + $this->_oTemplate = $oTemplate; + else + $this->_oTemplate = BxDolTemplate::getInstance(); + } + + public function getLinkHTML ($sLink, $sTitle = '', $sMaxWidth = '') + { + $aData = $this->getData($sLink, ''); + + if(bx_is_api()) { + if(bx_get('mode') == 'alt') + return json_encode($aData); + + return $aData; + } + + $aAttrs = [ + 'title' => bx_html_attribute($sTitle), + ]; + + // check for external link + if(strncmp(BX_DOL_URL_ROOT, $sLink, strlen(BX_DOL_URL_ROOT)) !== 0) { + $aAttrs['target'] = '_blank'; + + if(getParam('sys_add_nofollow') == 'on') + $aAttrs['rel'] = 'nofollow'; + } + + return $this->_oTemplate->parseHtmlByName('embed_system_link.html', [ + 'link' => $aData['url'], + 'attrs' => bx_convert_array2attrs($aAttrs), + 'width' => $sMaxWidth, + 'image' => $aData['image'] ? $aData['image'] : $aData['logo'], + 'logo' => $aData['logo'], + 'title' => $aData['title'], + 'description' => $aData['description'], + 'domain' => $aData['domain'], + ]); + } + + public function getDataFromApi ($sUrl, $sTheme) + { + $a = bx_get_site_info($sUrl, [ + 'thumbnailUrl' => ['tag' => 'link', 'content_attr' => 'href'], + 'OGImage' => ['name_attr' => 'property', 'name' => 'og:image'], + 'icon' => ['tag' => 'link', 'name_attr' => 'rel', 'name' => 'shortcut icon', 'content_attr' => 'href'], + 'icon2' => ['tag' => 'link', 'name_attr' => 'rel', 'name' => 'icon', 'content_attr' => 'href'], + 'icon3' => ['tag' => 'link', 'name_attr' => 'rel', 'name' => 'apple-touch-icon', 'content_attr' => 'href'], + ]); + + + + + $a = array_merge($a, [ + 'image' => $a['OGImage'] ? $a['OGImage'] : $a['thumbnailUrl'], + 'logo' => $a['icon2'] ? $a['icon2'] : ($a['icon3'] ? $a['icon3'] : $a['icon']), + 'url' => $sUrl + ]); + + unset($a['OGImage'], $a['thumbnailUrl'], $a['icon'], $a['icon2'], $a['icon3']); + + + + if($a['image'] == '') { + $c = []; + if (getParam('sys_embed_microlink_key') != ''){ + $c = bx_file_get_contents("https://pro.microlink.io/?url=" . $sUrl, [], 'get', ['x-api-key: ' . getParam('sys_embed_microlink_key')]); + } + else{ + $c = bx_file_get_contents("https://api.microlink.io/?url=" . $sUrl); + } + + $b = json_decode($c, true); + $a = [ + 'title' => $b['data']['title'], + 'description' => $b['data']['description'], + 'image' => $b['data']['image']['url'], + 'logo' => $b['data']['logo']['url'], + 'url' => $sUrl, + ]; + } + + if($a['image'] && ($oStorage = BxDolStorage::getObjectInstance('sys_images')) !== false) { + $iMediaId = $oStorage->storeFileFromUrl($a['image'], false); + if($iMediaId) + $a['image'] = $oStorage->getFileUrlById($iMediaId); + } + + if($a['logo'] && ($oStorage = BxDolStorage::getObjectInstance('sys_images')) !== false) { + $iMediaId = $oStorage->storeFileFromUrl($a['logo'], false); + if($iMediaId) + $a['logo'] = $oStorage->getFileUrlById($iMediaId); + } + + + $aUrl = parse_url($sUrl); + $a['domain'] = $aUrl['host']; + + return json_encode($a); + } + + public function parseLinks(&$aLinks) + { + $aResult = []; + + if($aLinks && is_array($aLinks)) { + $oEmbera = $this->getEmberaInstance(); + + foreach ($aLinks as $sLink) { + $sHtml = $oEmbera->autoEmbed($sLink); + //if nothing to change/embed then return empty string to not replace anything on a frontend + $aResult[] = ['html' => $sHtml != $sLink ? $sHtml : '']; + } + } + + return $aResult; + } +} + +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseFunctions.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseFunctions.php new file mode 100644 index 0000000000..49f0640f15 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseFunctions.php @@ -0,0 +1,938 @@ +_oTemplate = $oTemplate ? $oTemplate : BxDolTemplate::getInstance(); + + $this->_sDesignBoxMenuTmplDefault = 'menu_block_submenu_ver.html'; + + $this->_sDesignBoxMenuIcon = 'ellipsis-v'; + $this->_sDesignBoxMenuIconType = 'icon'; + $this->_sDesignBoxMenuClick = "bx_menu_popup_inline('#{design_box_menu}', this, " . json_encode(array( + 'moveToDocRoot' => false + )) . ")"; + } + + /** + * Prevent cloning the instance + */ + public function __clone() + { + if (isset($GLOBALS['bxDolClasses'][get_class($this)])) + trigger_error('Clone is not allowed for the class: ' . get_class($this), E_USER_ERROR); + } + + public static function getInstanceWithTemplate($oTemplate) + { + $sClassName = 'BxTemplFunctions'; + if ($oTemplate){ + $sClassName .= get_class($oTemplate); + } + if(!isset($GLOBALS['bxDolClasses'][$sClassName])) + $GLOBALS['bxDolClasses'][$sClassName] = new BxTemplFunctions($oTemplate); + + return $GLOBALS['bxDolClasses'][$sClassName]; + } + + public static function getInstance() + { + return self::getInstanceWithTemplate(null); + } + + function TemplPageAddComponent($sKey) + { + $mixedResult = false; // if you have not such component, return false! + + switch($sKey) { + case 'sys_header_width': + $mixedResult = 'bx-def-page-width'; + break; + + case 'sys_toolbar_search': + $oSearch = new BxTemplSearch(); + $oSearch->setLiveSearch(true); + + $mixedResult = $this->_oTemplate->parseHtmlByName('_page_toolbar_search.html', [ + 'sys_site_search' => $oSearch->getForm(BX_DB_PADDING_DEF, false, true) . $oSearch->getResultsContainer() + ]); + break; + } + + return $mixedResult; + } + + function msgBox($sText, $iTimer = 0, $sOnClose = "") + { + $iId = time() . mt_rand(1, 1000); + + if($iTimer > 0) + BxDolTemplate::getInstance()->addJs(array('jquery.anim.js')); + + return $this->_oTemplate->parseHtmlByName('messageBox.html', array( + 'id' => $iId, + 'msgText' => $sText, + 'bx_if:timer' => array( + 'condition' => $iTimer > 0, + 'content' => array( + 'id' => $iId, + 'time' => 1000 * $iTimer, + 'on_close' => $sOnClose, + ) + ) + )); + } + + /** + * Get standard popup box with title. + * + * @param string $sName - unique name + * @param string $sTitle - translated title + * @param string $sContent - content of the box + * @return HTML string + */ + function popupBox($sName, $sTitle, $sContent, $isHiddenByDefault = false) + { + $iId = !empty($sName) ? $sName : time(); + + return $this->_oTemplate->parseHtmlByName('popup_box.html', array( + 'id' => $iId, + 'wrapper_style' => $isHiddenByDefault ? 'display:none;' : '', + 'title' => $sTitle, + 'content' => $sContent + )); + } + + /** + * Get popup box without title. + * + * @param string $sName - unique name + * @param string $sContent - content of the box + * @return HTML string + */ + function transBox($sName, $sContent, $isHiddenByDefault = false, $isPlaceInCenter = false) + { + return $this->simpleBox($sName, $sContent, $isHiddenByDefault, $isPlaceInCenter, 'popup_trans.html'); + } + + function slideBox($sName, $sContent, $isHiddenByDefault = false) + { + return $this->simpleBox($sName, $sContent, $isHiddenByDefault, false, 'popup_slide.html'); + } + + function inlineBox($sName, $sContent, $isHiddenByDefault = false) + { + return $this->simpleBox($sName, $sContent, $isHiddenByDefault, false, 'popup_inline.html'); + } + + protected function simpleBox($sName, $sContent, $isHiddenByDefault, $isPlaceInCenter, $sTemplate) + { + $iId = !empty($sName) ? $sName : time(); + + if(!is_array($sContent)) + $sContent = array('content' => $sContent); + + $sContent = $this->_oTemplate->parseHtmlByName($sTemplate, array_merge(array( + 'id' => $iId, + 'wrapper_class' => '', + 'wrapper_style' => $isHiddenByDefault ? 'display:none;' : '', + 'content' => '' + ), $sContent)); + + if($isPlaceInCenter) + $sContent = '' . $sContent . ''; + + return $sContent; + } + + function simpleBoxContent($sContent, $bWithIndent = true) + { + if(!$bWithIndent) + return $sContent; + + return $this->_oTemplate->parseHtmlByName('popup_content_indent.html', array( + 'content' => $sContent + )); + } + + function getIcon($sCode, $aAttrs = array()) + { + $sIconFont = false; + $sIconA = false; + $sIconUrl = false; + $sIconHtml = false; + $sIconFontWithHtml = false; + + $sClass = ''; + if(!empty($aAttrs['class'])) { + $sClass = ' ' . $aAttrs['class'] .' '; + unset($aAttrs['class']); + } + + $sAttrs = ''; + foreach($aAttrs as $sKey => $sValue) + $sAttrs .= ' ' . $sKey . '="' . bx_html_attribute($sValue) . '"'; + + if (!empty($sCode)) { + if (is_numeric($sCode) && (int)$sCode > 0) { + $oStorage = BxDolStorage::getObjectInstance(BX_DOL_STORAGE_OBJ_IMAGES); + $sIconUrl = $oStorage ? $oStorage->getFileUrlById((int)$sCode) : false; + } + else { + + if (strpos($sCode, '<img') !== false || strpos($sCode, ''); + if ($sClass != '' && strpos($sIconHtmlClear, 'class="') !== false) + $sIconHtml = str_replace('class="', 'class="' . $sClass, $sIconHtml); + else + $sIconHtml = str_replace('_oTemplate->parseHtmlByName('icon_emoji.html', array( + 'icon' => $sCode, + 'class' => $sClass, + 'attrs' => $sAttrs + )); + else { + if (strpos($sCode, '.') === false) { + //--- Process animated icon + if (strncmp($sCode, 'a:', 2) === 0) + $sIconA = substr($sCode, 2); + //--- Process font icons + else { + $sIconFont = $sCode; + $sIconFontWithHtml = $this->getFontIconAsHtml($sIconFont, $sClass, $sAttrs); + } + } + else { + //--- Process common image + if((!preg_match('/^https?:\/\//', $sCode))) + $sIconUrl = $this->_oTemplate->getIconUrl($sCode); + else + $sIconUrl = $sCode; + } + } + } + } + } + + return array ($sIconFont, $sIconUrl, $sIconA, $sIconHtml, $sIconFontWithHtml); + } + + function getFontIconAsHtml($sIconFont, $sClass = '', $sAttrs = '') + { + return ''; + } + + function getIconAsHtml($sCode, $aAttrs = array()) + { + $aIcons = $this->getIcon($sCode, $aAttrs); + return $aIcons[3] . $aIcons[4]; + } + + function getTemplateIcon($sName) + { + $sUrl = $this->_oTemplate->getIconUrl($sName); + return !empty($sUrl) ? $sUrl : $this->_oTemplate->getIconUrl('spacer.gif'); + } + + function getTemplateImage($sName) + { + $sUrl = $this->_oTemplate->getImageUrl($sName); + return !empty($sUrl) ? $sUrl : $this->_oTemplate->getImageUrl('spacer.gif'); + } + + function sysIcon ($sIcon, $sName, $sUrl = '', $iWidth = 0) + { + return '' . ($sUrl ? '' : '') . '' . ($sUrl ? '' : '') . ''; + } + + /** + * functions for limiting maximal string length + */ + function getStringWithLimitedLength($sString, $iWidth = 45, $isPopupOnOverflow = false, $bReturnString = true) + { + if (empty($sString) || mb_strlen($sString, 'UTF-8') <= $iWidth) + return $bReturnString ? $sString : array($sString); + + $sResult = ''; + $aWords = mb_split("[\s\r\n]", $sString); + $iPosition = 0; + $iWidthReal = $iWidth - 3; + $iWidthMin = $iWidth - 15; + foreach($aWords as $sWord) { + $sWord = trim($sWord); + $iWord = mb_strlen($sWord, 'UTF-8'); + if ($iPosition + $iWord > $iWidthReal) + break; + + // add word and continue + $sResult .= ' ' . $sWord; + $iPosition += 1 + $iWord; + } + + // last word is too long, cut it + if(!$iPosition || $iPosition < $iWidthMin) + $sResult .= ' ' . mb_substr($sWord, 0, $iWidthReal - $iPosition - $iWord, 'UTF-8'); + $sResult = trim($sResult); + + // add tripple dot + if(!$isPopupOnOverflow) { + $sResult .= '...'; + return $bReturnString ? $sResult : array($sResult); + } + + // add button width popup + $sId = 'bx-str-limit-' . rand(1, PHP_INT_MAX); + $sPopup = ''; + $sPopup .= '' . BxTemplFunctions::getInstance()->transBox('', ''.$sString.'') . ''; + + return $bReturnString ? $sResult . $sPopup : array($sResult, $sPopup); + } + + /** + * Display design box with specified title, template, content and menu. + * @param $sTitle - design box title, please note that some templates don't use title. + * @param $sContent - design box content. + * @param $iTemplateNum - number of design box template, use predefined contants only, default is BX_DB_DEF. + * @param $mixedMenu - design box menu, it can be: + * - object: instance of BxTemplMenu class + * - string: menu object identifier + * - array: array of menu links to create menu from + * @param $mixedButtons - design box menu representation, it can be: + * - false: design box menu will be used as horizontal menu (tabs) + * - array: array of menu links to create menu from. If empty array is used and 'design box menu' isn't empty, then 'design box menu' will be added as one of menu items automatically. If non-empty array is used and 'design box menu' isn't empty then it should be added as one of menu items. Use array('menu' => 1) to define menu item for 'design box menu'. + * @return string + * + * @see BX_DB_CONTENT_ONLY + * @see BX_DB_DEF + * @see BX_DB_EMPTY + * @see BX_DB_NO_CAPTION + * @see BX_DB_PADDING_CONTENT_ONLY + * @see BX_DB_PADDING_DEF + * @see BX_DB_PADDING_NO_CAPTION + */ + function designBoxContent ($sTitle, $sContent, $iTemplateNum = BX_DB_DEF, $mixedMenu = false, $mixedButtons = array()) + { + return $this->_oTemplate->parseHtmlByName('designbox_' . (int)$iTemplateNum . '.html', array( + 'title' => $sTitle, + 'designbox_content' => $sContent, + 'caption_item' => $this->designBoxMenu($mixedMenu, $mixedButtons), + )); + } + + function designBoxMenu ($mixedMenu, $mixedButtons = array()) + { + $bUseTabs = is_bool($mixedButtons) && $mixedButtons === true; + + $sClass = $sMenu = ''; + if(!empty($mixedMenu)) { + if(is_string($mixedMenu)) { + if(($oMenu = BxTemplMenu::getObjectInstance($mixedMenu)) !== false) { + $oMenu->setTemplateById($bUseTabs ? BX_DB_MENU_TEMPLATE_TABS : BX_DB_MENU_TEMPLATE_POPUP); + + $sMenu = $oMenu->getCode(); + } + else + $sMenu = $mixedMenu; + } + else if(is_array($mixedMenu)) { + if(isset($mixedMenu['template']) && isset($mixedMenu['menu_items'])) + $aMenu = $mixedMenu; + else + $aMenu = array('template' => $this->_sDesignBoxMenuTmplDefault, 'menu_items' => $mixedMenu); + + if(($oMenu = new BxTemplMenu($aMenu, $this->_oTemplate)) !== false) { + $oMenu->setTemplateById($bUseTabs ? BX_DB_MENU_TEMPLATE_TABS : BX_DB_MENU_TEMPLATE_POPUP); + + $sMenu = $oMenu->getCode(); + } + else + $sMenu = ''; + } + else if(is_object($mixedMenu) && is_a($mixedMenu, 'BxTemplMenu')) { + $mixedMenu->setTemplateById($bUseTabs ? BX_DB_MENU_TEMPLATE_TABS : BX_DB_MENU_TEMPLATE_POPUP); + if(($mixedMenu instanceof BxBaseMenuMoreAuto) && $mixedMenu->isMoreAuto()) + $sClass = ' bx-db-menu-tab-more-auto'; + + $sMenu = $mixedMenu->getCode(); + } + } + $bMenu = !empty($sMenu); + + $sResult = ''; + if($bUseTabs && $bMenu) + $sResult = $sMenu; + else if(is_array($mixedButtons)) { + $sPopup = ''; + + if($bMenu) { + $aButton = array(); + if(empty($mixedButtons)) + list($aButton, $sPopup) = $this->_designBoxMenuButton($sMenu); + //--- For backward compatibility + else if(!empty($mixedButtons['menu']) && is_array($mixedButtons['menu'])) { + list($aButton, $sPopup) = $this->_designBoxMenuButton($sMenu, $mixedButtons['menu']); + unset($mixedButtons['menu']); + } + + if(!empty($aButton)) + $mixedButtons[] = $aButton; + } + + foreach($mixedButtons as $aButton) { + if($bMenu && isset($aButton['menu'])) { + if(is_numeric($aButton['menu']) && (int)$aButton['menu'] == 1) + list($aButton, $sPopup) = $this->_designBoxMenuButton($sMenu); + else if(is_array($aButton['menu'])) + list($aButton, $sPopup) = $this->_designBoxMenuButton($sMenu, $aButton['menu']); + + if(isset($aButton['menu'])) + continue; + } + + $aAttrs = array(); + if(!empty($aButton['onclick'])) + $aAttrs['onclick'] = $aButton['onclick']; + + $aAttrs['class'] = 'bx-btn bx-btn-small'; + if(!empty($aButton['class'])) + $aAttrs['class'] .= ' ' . trim($aButton['class']); + + $bTmplVarsButtonIcon = !empty($aButton['icon']); + $aTmplVarsButtonIcon = !$bTmplVarsButtonIcon ? array() : array( + 'icon' => $aButton['icon'] + ); + + $bTmplVarsButtonIconA = !empty($aButton['icon-a']); + $aTmplVarsButtonIconA = !$bTmplVarsButtonIconA ? array() : array( + 'icon_a' => $aButton['icon-a'] + ); + + $bTmplVarsButtonTitle = !empty($aButton['title']); + $aTmplVarsButtonTitle = !$bTmplVarsButtonTitle ? array() : array( + 'title' => $aButton['title'] + ); + + $sResult .= $this->_oTemplate->parseHtmlByName('designbox_menu_button.html', array( + 'attrs' => bx_convert_array2attrs($aAttrs), + 'bx_if:show_icon' => array( + 'condition' => $bTmplVarsButtonIcon, + 'content' => $aTmplVarsButtonIcon + ), + 'bx_if:show_icon_a' => array( + 'condition' => $bTmplVarsButtonIconA, + 'content' => $aTmplVarsButtonIconA + ), + 'bx_if:show_title' => array( + 'condition' => $bTmplVarsButtonTitle, + 'content' => $aTmplVarsButtonTitle + ) + )); + } + + $sResult .= $sPopup; + } + + if(!empty($sResult)) + $sResult = $this->_oTemplate->parseHtmlByName('designbox_menu.html', array( + 'class' => $sClass, + 'content' => $sResult + )); + + return $sResult; + } + + protected function _designBoxMenuId () + { + return 'bx-menu-db-' . time() . rand(0, PHP_INT_MAX); + } + + protected function _designBoxMenuButton ($sMenu, $aParams = array()) + { + $sId = $this->_designBoxMenuId(); + $aButton = array($this->_sDesignBoxMenuIconType => $this->_sDesignBoxMenuIcon, 'onclick' => $this->_sDesignBoxMenuClick); + + if(!empty($aParams)) { + if(!empty($aParams['id'])) + $sId = $aParams['id']; + + $aButton = array_merge($aButton, $aParams); + } + + $aButton['onclick'] = bx_replace_markers($aButton['onclick'], array( + 'design_box_menu' => $sId + )); + + $sMenu = $this->_oTemplate->parseHtmlByName('designbox_menu_popup.html', array( + 'content' => $sMenu + )); + + return array($aButton, $this->transBox($sId, $sMenu, true)); + } + + /** + * Get logo URL. + * @return string + */ + function getMainLogoUrl() + { + return BxDolDesigns::getInstance()->getSiteLogoUrl(); + } + + /** + * Get mark URL. + * @return string + */ + function getMainMarkUrl() + { + return BxDolDesigns::getInstance()->getSiteMarkUrl(); + } + + /** + * Get logo HTML. + * @return string + */ + function getMainLogo($aParams = array()) + { + $oDesigns = BxDolDesigns::getInstance(); + + $sAlt = $oDesigns->getSiteLogoAlt(); + if(empty($sAlt)) + $sAlt = getParam('site_title'); + + $aLogoImages = []; + if(($mixedFileUrl = $this->getMainLogoUrl()) && !empty($mixedFileUrl)) { + if(!is_array($mixedFileUrl)) + $mixedFileUrl = ['light' => $mixedFileUrl]; + + foreach($mixedFileUrl as $sName => $sFileUrl) { + $iLogoWidth = (int)$oDesigns->getSiteLogoWidth(); + $sWidth = $iLogoWidth > 0 ? 'width:' . round($iLogoWidth/16, 3) . 'rem;' : ''; + + $iLogoHeight = (int)$oDesigns->getSiteLogoHeight(); + $sHeight = $iLogoHeight > 0 ? 'height:' . round($iLogoHeight/16, 3) . 'rem;' : ''; + + $aLogoImages[] = [ + 'id' => 'bx-logo', + 'src' => $sFileUrl, + 'alt' => bx_html_attribute($sAlt, BX_ESCAPE_STR_QUOTE), + 'style' => $sWidth . ' ' . $sHeight + ]; + } + } + $bLogoImages = !empty($aLogoImages) && is_array($aLogoImages); + + $aAttrs = array( + 'class' => 'bx-def-font-contrasted', + 'href' => BX_DOL_URL_ROOT, + 'title' => bx_html_attribute($sAlt, BX_ESCAPE_STR_QUOTE) + ); + if(!empty($aParams['attrs']) && is_array($aParams['attrs'])) + $aAttrs = array_merge($aAttrs, $aParams['attrs']); + + $sTmplName = 'logo_main.html'; + $aTmplVars = [ + 'attrs' => bx_convert_array2attrs($aAttrs), + 'bx_if:show_title' => [ + 'condition' => !$bLogoImages, + 'content' => [ + 'logo' => $sAlt, + ] + ], + 'bx_if:show_logo' => [ + 'condition' => $bLogoImages, + 'content' => [ + 'bx_repeat:images' => $aLogoImages, + ] + ], + ]; + + bx_alert('system', 'get_logo', 0, 0, [ + 'tmpl_name' => &$sTmplName, + 'tmpl_vars' => &$aTmplVars + ]); + + return $this->_oTemplate->parseHtmlByName($sTmplName, $aTmplVars); + } + + /** + * Get HTML code for manifests. + * @return HTML string to insert into HEAD section + */ + function getManifests() + { + return ''; + } + + /** + * Get HTML code for meta icons. + * @return HTML string to insert into HEAD section + */ + function getMetaIcons() + { + // favicon icon + $sImageUrlFav = ''; + if(($iId = (int)getParam('sys_site_icon')) != 0) + $sImageUrlFav = BxDolStorage::getObjectInstance(BX_DOL_STORAGE_OBJ_FILES)->getFileUrlById($iId); + + // svg icon + $sImageUrlSvg = ''; + if(($iId = (int)getParam('sys_site_icon_svg')) != 0) + $sImageUrlSvg = BxDolStorage::getObjectInstance(BX_DOL_STORAGE_OBJ_IMAGES)->getFileUrlById($iId); + + if(empty($sImageUrlFav) && empty($sImageUrlSvg)) + $sImageUrlFav = $sImageUrlSvg = $this->_oTemplate->getIconUrl('favicon.svg'); + + // apple device icon + $sImageUrlApl = ''; + if(($iId = (int)getParam('sys_site_icon_apple')) != 0) + $sImageUrlApl = BxDolTranscoderImage::getObjectInstance(BX_DOL_TRANSCODER_OBJ_ICON_APPLE)->getFileUrl($iId); + if(empty($sImageUrlApl)) + $sImageUrlApl = $this->_oTemplate->getIconUrl('apple-touch-icon.png'); + +/* + * TODO: + * 1. Remove commented code later if it won't be used. + * 2. Remove 'sys_icon_favicon' and 'sys_icon_facebook' transcoders and related transcoder filters. + * + // facebook icon + $sImageUrlFcb = ''; + $oTranscoder = BxDolTranscoderImage::getObjectInstance(BX_DOL_TRANSCODER_OBJ_ICON_FACEBOOK); + $sImageUrlFcb = $oTranscoder->getFileUrl($iId); + if(empty($sImageUrlFcb)) + $sImageUrlFcb = $this->_oTemplate->getIconUrl('facebook-icon.png'); +*/ + + $sRet = ''; + if($sImageUrlFav) + $sRet .= ''; + if($sImageUrlFav) + $sRet .= ''; + $sRet .= ''; + +/* + $sRet .= ''; +*/ + + return $sRet; + } + + function getInjectionHead() + { + return $this->getInjection('getInjHead'); + } + + function getInjectionHeader() + { + return $this->getInjection('getInjHeader'); + } + + function getInjectionFooter() + { + return $this->getInjection('getInjFooter'); + } + + public function getPopupAlert() + { + return $this->transBox('bx-popup-alert', $this->_oTemplate->parseHtmlByName('popup_trans_alert_cnt.html', array()), true); + } + + public function getPopupConfirm() + { + return $this->transBox('bx-popup-confirm', $this->_oTemplate->parseHtmlByName('popup_trans_confirm_cnt.html', array()), true); + } + + public function getPopupPrompt() + { + $sInputText = 'bx-popup-prompt-value'; + $aInputText = array( + 'type' => 'text', + 'name' => $sInputText, + 'attrs' => array( + 'id' => $sInputText, + ), + 'value' => '', + 'caption' => '' + ); + + $oForm = new BxTemplFormView(array(), $this->_oTemplate); + return $this->transBox('bx-popup-prompt', $this->_oTemplate->parseHtmlByName('popup_trans_prompt_cnt.html', array( + 'input' => $oForm->genRow($aInputText) + )), true); + } + + /** + * Output time wrapped in tag in HTML. + * Then time is autoformatted using JS upon page load, this is aumatically converted to user's timezone and + * updated in realtime in case of short periods of 'from now' time format. + * + * Short version of this function: + * @see bx_time_js + * + * @param $iUnixTimestamp time as unixtimestamp + * @param $sFormatIdentifier output format identifier + * @see BX_FORMAT_DATE + * @see BX_FORMAT_TIME + * @see BX_FORMAT_DATE_TIME + * @param $bForceFormat force provided format and don't use "from now" time autoformat. + */ + function timeForJs ($iUnixTimestamp, $sFormatIdentifier = BX_FORMAT_DATE, $bForceFormat = false) + { + $sDateUTC = bx_time_utc ($iUnixTimestamp); + return $this->timeForJsFullDate ($sDateUTC, $sFormatIdentifier, $bForceFormat); + } + + /** + * Same as @see timeForJs but instead of unxtimestamp full date format is used (ex: 2005-08-15T15:52:01) as passec date param + */ + function timeForJsFullDate ($sDateUTC, $sFormatIdentifier = BX_FORMAT_DATE, $bForceFormat = false, $bUTC = false) + { + return '' . $sDateUTC . ''; + } + + function statusOnOff ($mixed, $isMsg = false) + { + if ((is_bool($mixed) && !$mixed) || (is_string($mixed) && 'fail' == $mixed)) + return ' ' . ($isMsg ? _t('_sys_off') : ''); + elseif (is_string($mixed) && 'warn' == $mixed) + return ' ' . ($isMsg ? _t('_sys_warn') : ''); + elseif (is_string($mixed) && 'undef' == $mixed) + return ' ' . ($isMsg ? _t('_undefined') : ''); + else + return ' ' . ($isMsg ? _t('_sys_on') : ''); + } + + /** + * Ouputs HTML5 video player. + * @param $sUrlPoster video poster image + * @param $sUrlMP4 .mp4 video + * @param $sUrlMP4Hd .mp4 video in better quality + * @param $aAttrs custom attributes, defaults are: controls="" preload="none" autobuffer="" + * @param $sStyles custom styles, defaults are: width:100%; height:auto; + */ + function videoPlayer ($sUrlPoster, $sUrlMP4, $sUrlMP4Hd = '', $aAttrs = false, $sStyles = false, $bDynamicMode = false) + { + $oPlayer = BxDolPlayer::getObjectInstance(); + if(!$oPlayer) + return ''; + + if($sStyles === false) + $sStyles = 'width:100%; height:auto;'; + + return $oPlayer->getCodeVideo (BX_PLAYER_STANDARD, array( + 'poster' => $sUrlPoster, + 'mp4' => array('sd' => $sUrlMP4, 'hd' => $sUrlMP4Hd), + 'attrs' => $aAttrs, + 'styles' => $sStyles, + ), $bDynamicMode); + } + + protected function getInjection($sPrefix) + { + $sContent = ''; + + $aMethods = get_class_methods($this); + foreach($aMethods as $sMethod) + if(preg_match("/^(" . $sPrefix . ")[A-Z].+$/", $sMethod)) + $sContent .= $this->$sMethod(); + + return $sContent; + } + + protected function getInjHeadLiveUpdates() + { + $sContent = ''; + + if(($oLiveUpdates = BxDolLiveUpdates::getInstance()) !== false) + $sContent .= $oLiveUpdates->init(); + + return $sContent; + } + + protected function getInjHeaderPushNotifications() + { + $iProfileId = bx_get_logged_profile_id(); + if(empty($iProfileId)) + return ''; + + $sAppId = getParam('sys_push_app_id'); + if(empty($sAppId)) + return ''; + + $aTags = BxDolPush::getTags($iProfileId); + if (!$aTags) + return ''; + + $sShortName = getParam('sys_push_short_name'); + $sSafariWebId = getParam('sys_push_safari_id'); + + $sSubfolder = '/plugins_public/onesignal/'; + $aUrl = parse_url(BX_DOL_URL_ROOT); + if(!empty($aUrl['path'])) { + $sPath = trim($aUrl['path'], '/'); + if(!empty($sPath)) + $sSubfolder = '/' . $sPath . $sSubfolder; + } + + $this->_oTemplate->addJs(array( + 'https://cdn.onesignal.com/sdks/OneSignalSDK.js', + 'BxDolPush.js', + )); + + $sJsClass = 'BxDolPush'; + $sJsObject = 'oBxDolPush'; + + $sContent = "var " . $sJsObject . " = new " . $sJsClass . "(" . json_encode(array( + 'sObjName' => $sJsObject, + 'sSiteName' => getParam('site_title'), + 'aTags' => $aTags, + 'sAppId' => $sAppId, + 'sShortName' => $sShortName, + 'sSafariWebId' => $sSafariWebId, + 'sSubfolder' => $sSubfolder, + 'sNotificationUrl' => BX_DOL_URL_ROOT, + 'sTxtNotificationRequest' => _t('_sys_push_notification_request', getParam('site_title')), + 'sTxtNotificationRequestYes' => _t('_sys_push_notification_request_yes'), + 'sTxtNotificationRequestNo' => _t('_sys_push_notification_request_no'), + )) . ");"; + + return $this->_oTemplate->_wrapInTagJsCode($sContent); + } + + protected function getInjHeaderPopupLoading() + { + return $this->transBox('bx-popup-loading', $this->_oTemplate->parsePageByName('popup_loading.html', array()), true); + } + + protected function getInjFooterMenuLoading() + { + return $this->_oTemplate->parsePageByName('menu_loading.html', array()); + } + + protected function getInjFooterPopupMenus() + { + $sContent = ''; + + $oSearch = new BxTemplSearch(); + $oSearch->setLiveSearch(true); + $sContent .= $this->_oTemplate->parsePageByName('search.html', array( + 'search_form' => $oSearch->getForm(BX_DB_CONTENT_ONLY), + 'results' => $oSearch->getResultsContainer(), + )); + + $sContent .= $this->_oTemplate->getMenu ('sys_site'); + if(isLogged()) { + $sContent .= $this->_oTemplate->getMenu ('sys_add_content'); + $sContent .= $this->_oTemplate->getMenu ('sys_account_popup'); + } + + return $sContent; + } + + protected function getInjFooterPopupApps() + { + if($this->_oTemplate->getPageType() != BX_PAGE_TYPE_APPLICATION) + return ''; + + $oMenu = BxDolMenu::getObjectInstance('sys_homepage'); + if(!$oMenu) + return ''; + + $this->_oTemplate->addJs(['popper.js']); + return $this->_oTemplate->parsePageByName('menu_apps.html', [ + 'name' => 'sys-menu-apps', + 'title' => _t('_apps'), + 'bx_repeat:menu_items' => $oMenu->getMenuItems(), + ]); + } + + protected function getInjFooterPopups() + { + $sContent = ''; + + $sContent .= $this->getPopupAlert(); + $sContent .= $this->getPopupConfirm(); + $sContent .= $this->getPopupPrompt(); + + return $sContent; + } + + protected function getInjFooterEmbed() + { + // Load embed files + $oEmbed = BxDolEmbed::getObjectInstance(false); + if ($oEmbed) + return $oEmbed->addJsCss() . $oEmbed->addProcessLinkMethod(); + + return ''; + } +} + +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseMenu.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseMenu.php new file mode 100644 index 0000000000..02650656f4 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseMenu.php @@ -0,0 +1,464 @@ + '', 'onclick' => ''); + protected $_bDisplayAddons = false; + + protected $_aSelected; // Selected menu item. + + public function __construct ($aObject, $oTemplate) + { + parent::__construct ($aObject); + + if ($oTemplate) + $this->_oTemplate = $oTemplate; + else + $this->_oTemplate = BxDolTemplate::getInstance(); + + $this->_iPageType = false; + $this->_aSelected = []; + } + + public function getDisplayAddons() + { + return $this->_bDisplayAddons; + } + + public function setDisplayAddons($b) + { + $bRet = $this->_bDisplayAddons; + $this->_bDisplayAddons = $b; + return $bRet; + } + + /** + * Get menu code. + * @return string + */ + public function getCode () + { + $sMenuTitle = isset($this->_aObject['title']) ? _t($this->_aObject['title']) : 'Menu-' . rand(0, PHP_INT_MAX); + if (isset($GLOBALS['bx_profiler'])) $GLOBALS['bx_profiler']->beginMenu($sMenuTitle); + + if(!$this->_iPageType) + $this->_iPageType = BxDolTemplate::getInstance()->getPageType(); + + $s = ''; + $aVars = $this->_getTemplateVars (); + if (!empty($aVars['bx_repeat:menu_items'])) { + $this->_addJsCss(); + $s = $this->_getCode($this->_aObject['template'], $aVars); + } + + if (isset($GLOBALS['bx_profiler'])) $GLOBALS['bx_profiler']->endMenu($sMenuTitle); + + return $s; + } + + /** + * Get menu code API. + * @return array + */ + public function getCodeAPI () + { + $aItems = []; + + $aVars = $this->_getTemplateVars(); + if(!empty($aVars['bx_repeat:menu_items'])) + $aItems = $aVars['bx_repeat:menu_items']; + + return [ + 'object' => $this->_sObject, + 'persistent' => $this->_aObject['persistent'], + 'params' => $this->getContentParams(), + 'items' => $aItems + ]; + } + + /** + * Get menu short code API. + * @return array + */ + public function getShortCodeAPI () + { + return [ + 'object' => $this->_sObject, + 'params' => $this->getContentParams() + ]; + } + + protected function _getCode($sTmplName, $aTmplVars) + { + return $this->_oTemplate->parseHtmlByName($this->getTemplateName($sTmplName), $aTmplVars); + } + + public function getCodeItem ($sName) + { + if(empty($sName)) + return ''; + + $sCode = $this->_oTemplate->getHtml(str_replace('.html', '_item.html', $this->_aObject['template'])); + if(empty($sCode)) + return ''; + + $mixedTmplVars = $this->getMenuItem($sName); + if($mixedTmplVars === false) + return ''; + + return $this->_oTemplate->parseHtmlByContent($sCode, $mixedTmplVars); + } + + /** + * Get template variables array + * @return array + */ + protected function _getTemplateVars () + { + $aMenuItems = $this->getMenuItems(); + $sMenuItemSelected = _t($aMenuItems && $this->_aSelected && !empty($this->_aSelected['title']) ? $this->_aSelected['title'] : '_Contents'); + + return [ + 'object' => $this->_sObject, + 'menu_item_selected' => $sMenuItemSelected, + 'bx_repeat:menu_items' => $aMenuItems, + ]; + } + + /** + * Get menu items array, which is ready to pass to menu template. + * @return array or false + */ + public function getMenuItems () + { + if (!isset($this->_aObject['menu_items'])) + $this->_aObject['menu_items'] = $this->getMenuItemsRaw (); + + $aItems = array(); + foreach ($this->_aObject['menu_items'] as $aItem) { + $aItem = $this->_getMenuItem ($aItem); + if($aItem !== false) + $aItems[] = $aItem; + } + + return $aItems; + } + + /** + * Get menu item array, which is ready to pass to whole menu or + * single menu item template. May return false if single menu item + * is requested but cannot be shown by circumstances. + * @return array or false + */ + public function getMenuItem ($sName) + { + if (!isset($this->_aObject['menu_items'])) + $this->_aObject['menu_items'] = $this->getMenuItemsRaw (); + + if(!empty($sName)) + return $this->_getMenuItem($this->_aObject['menu_items'][$sName]); + } + + /** + * Get menu items array, this is just a wrapper for DB function for make it easier to override. + * It is used in @see BxBaseMenu::getMenuItems + * @return array + */ + protected function getMenuItemsRaw () + { + if($this->_bMultilevel) + return $this->_oQuery->getMenuItemsHierarchy(); + else + return $this->_oQuery->getMenuItems(); + } + + protected function _getMenuItem ($a) + { + if (!$this->_isActive($a) || !$this->_isVisible($a)) + return false; + + if ($this->_bIsApi) { + list ($sIcon, $sIconUrl) = $this->_getMenuIcon($a); + + $aResult = [ + 'id' => $a['id'], + 'name' => $a['name'], + 'title' => _t($a['title']), + 'link' => isset($a['link']) ? $a['link'] : '', + 'icon' => $sIcon ? $sIcon : '', + 'image' => $sIconUrl ? $sIconUrl : '', + 'submenu' => !empty($a['submenu_object']) ? $a['submenu_object'] : '', + 'addon' => $this->_bDisplayAddons ? $this->_getMenuAddon($a) : '', + 'primary' => $a['primary'], + ]; + + if(($aMarkers = $this->_getMenuMarkers($a)) && is_array($aMarkers)) + $this->addMarkers($aMarkers); + $aResult = $this->_replaceMarkers($aResult); + + if(!empty($aResult['link'])) + $aResult['link'] = $this->_oPermalinks->permalink($aResult['link']); + + return $aResult; + } + + $bIsSelected = $this->_isSelected($a); + if($bIsSelected) + $this->_aSelected = $a; + + $a['object'] = $this->_sObject; + + $a['title'] = _t($a['title']); + $a['bx_if:title'] = array( + 'condition' => !empty($a['title']), + 'content' => array( + 'title' => $a['title'] + ) + ); + + $this->removeMarker('addon'); + + $a = $this->_replaceMarkers($a); + + if ($this->_bDisplayAddons) { + $mixedAddon = $this->_getMenuAddon($a); + if (!is_array($mixedAddon)) { + $this->addMarkers(array('addon' => $mixedAddon)); + $a = $this->_replaceMarkers($a); + } + } + + $aMarkers = $this->_getMenuMarkers($a); + if ($aMarkers && is_array($aMarkers)) { + $this->addMarkers($aMarkers); + $a = $this->_replaceMarkers($a); + } + + list ($sIcon, $sIconUrl, $sIconA, $sIconHtml) = $this->_getMenuIcon($a); + + $a['class_add'] = $bIsSelected ? 'bx-menu-tab-active' : ''; + $a['class_add'] .= $this->_getVisibilityClass($a); + $a['class_link'] = ''; + + $a['link'] = isset($a['link']) ? $this->_oPermalinks->permalink($a['link']) : 'javascript:void(0);'; + $a['title_attr'] = bx_html_attribute(strip_tags($a['title'])); + + $a['attrs'] = $this->_getMenuAttrs($a); + $a['attrs_wrp'] = ''; + + if($this->_bHx && !empty($a['link']) && strpos($a['link'], 'javascript:') === false) { + $this->_aHx['get'] = $a['link']; + $a['attrs'] .= bx_get_htmx_attrs($this->_aHx, $this->_mHxPreload); + + if(!bx_is_htmx_request() && !$bIsSelected) + $a['attrs_wrp'] .= bx_get_htmx_attrs([ + 'get' => $a['link'], + 'trigger' => 'load', + 'target' => '#bx-content-preload', + 'swap' => 'beforeend', + ]); + } + + $a['bx_if:image'] = array ( + 'condition' => (bool)$sIconUrl, + 'content' => array('icon_url' => $sIconUrl), + ); + $a['bx_if:image_inline'] = array ( + 'condition' => false, + 'content' => array('image' => ''), + ); + $a['bx_if:icon'] = array ( + 'condition' => (bool)$sIcon, + 'content' => array('icon' => $sIcon), + ); + $a['bx_if:icon-html'] = array ( + 'condition' => (bool)$sIconHtml, + 'content' => array('icon' => $sIconHtml), + ); + $a['bx_if:icon-a'] = array ( + 'condition' => (bool)$sIconA, + 'content' => array('icon-a' => $sIconA), + ); + $a['bx_if:title'] = array ( + 'condition' => (bool)$a['title'], + 'content' => array( + 'title' => $a['title'], + 'title_attr' => $a['title_attr'] + ), + ); + + $bOnClick = !empty($a['onclick']); + $aOnClick = $bOnClick ? [ + 'onclick' => $a['onclick'], + ] : []; + + $a['bx_if:onclick'] = [ + 'condition' => $bOnClick, + 'content' => $aOnClick + ]; + + $aTmplVarsAddon = $this->_bDisplayAddons ? $this->_getTmplVarsAddon($mixedAddon, $a) : array('addon' => '', 'addonf' => ''); + $a['bx_if:addon'] = array ( + 'condition' => $this->_bDisplayAddons && !empty($aTmplVarsAddon['addon']), + 'content' => $aTmplVarsAddon + ); + + $aTmplVarsSubitems = array('subitems' => ''); + $bTmplVarsSubitems = $this->_bMultilevel && !empty($a['subitems']); + if($bTmplVarsSubitems) { + $sClassCollpsed = 'bx-mi-collapsed'; + if(($iCollapsed = $this->getUserChoiceCollapsedSubmenu($a)) !== false) + $a['class_add'] .= $iCollapsed ? ' ' . $sClassCollpsed : ''; + else if(isset($a['collapsed']) && $a['collapsed']) + $a['class_add'] .= ' ' . $sClassCollpsed; + + $aSubitems = array(); + foreach($a['subitems'] as $aSubitem) { + $aSubitem = $this->_getMenuItem($aSubitem); + if($aSubitem !== false) + $aSubitems[] = $aSubitem; + } + + if(!$bOnClick) + $a['bx_if:onclick'] = [ + 'condition' => true, + 'content' => [ + 'onclick' => "javascript:return bx_menu_toggle(this, '" . $this->_sObject . "', '" . $a['name'] . "')" + ] + ]; + + $aTmplVarsSubitems['subitems'] = $this->_oTemplate->parseHtmlByName(str_replace('.html', '_subitems.html', $this->getTemplateName()), array( + 'bx_repeat:menu_items' => $aSubitems, + )); + } + + $a['bx_if:show_toggler'] = [ + 'condition' => $bTmplVarsSubitems, + 'content' => [] + ]; + $a['bx_if:show_subitems'] = array ( + 'condition' => $bTmplVarsSubitems, + 'content' => $aTmplVarsSubitems + ); + + unset($a['subitems']); + + foreach ($this->_aOptionalParams as $sName => $sDefaultValue) + if (!isset($a[$sName])) + $a[$sName] = $sDefaultValue; + + return $a; + } + + protected function _getMenuIcon ($a) + { + return BxTemplFunctions::getInstanceWithTemplate($this->_oTemplate)->getIcon(!empty($a['icon']) ? $a['icon'] : ''); + } + + public function getMenuIconHtml($sIcon) + { + list ($sIcon, $sIconUrl, $sIconA, $sIconHtml) = BxTemplFunctions::getInstanceWithTemplate($this->_oTemplate)->getIcon($sIcon); + + $a['bx_if:image'] = array ( + 'condition' => (bool)$sIconUrl, + 'content' => array('icon_url' => $sIconUrl), + ); + $a['bx_if:icon'] = array ( + 'condition' => (bool)$sIcon, + 'content' => array('icon' => $sIcon), + ); + $a['bx_if:icon-a'] = array ( + 'condition' => (bool)$sIconA, + 'content' => array('icon-a' => $sIconA), + ); + $a['bx_if:icon-html'] = array ( + 'condition' => (bool)$sIconHtml, + 'content' => array('icon' => $sIconHtml), + ); + + return $this->_oTemplate->parseHtmlByName('menu_icon.html', $a); + } + + protected function _getMenuAddon ($aMenuItem) + { + if (empty($aMenuItem['addon'])) + return ''; + + if (isset($aMenuItem['addon_cache']) && $aMenuItem['addon_cache']) { + $oCache = BxDolDb::getInstance()->getDbCacheObject(); + $sKey = 'menu_' . $this->_sObject . '_' . $aMenuItem['name'] . '_' . bx_get_logged_profile_id() . '_' . bx_site_hash() . '.php'; + $s = $oCache->getData($sKey); + if ($s !== null) { + return $s; + } + else { + $s = BxDolService::callSerialized($aMenuItem['addon'], $this->_aMarkers); + $oCache->setData($sKey, $s); + } + + return $s; + } + else { + return BxDolService::callSerialized($aMenuItem['addon'], $this->_aMarkers); + } + } + + protected function _getMenuMarkers ($aMenuItem) + { + if (empty($aMenuItem['markers'])) + return ''; + + return BxDolService::callSerialized($aMenuItem['markers'], $this->_aMarkers); + } + + protected function _getMenuAttrs ($aMenuItem) + { + $sAttrs = ''; + if(!empty($aMenuItem['target'])) + $sAttrs .= ' target="' . $aMenuItem['target'] . '"'; + + if($this->_bAddNoFollow && !empty($aMenuItem['link']) && preg_match('@^https?://@', $aMenuItem['link']) && strncmp($aMenuItem['link'], BX_DOL_URL_ROOT, strlen(BX_DOL_URL_ROOT)) !== 0) + $sAttrs .= ' rel="noreferrer"'; + + return $sAttrs; + } + + /** + * Add css/js files which are needed for menu display and functionality. + */ + protected function _addJsCss() + { + $this->_oTemplate->addCss('menu.css'); + } + + protected function _getTmplVarsAddon($mixedAddon, $aMenuItem) + { + $sAddon = ''; + if(!is_array($mixedAddon)) + $sAddon = $mixedAddon; + else if(!empty($mixedAddon['addon'])) + $sAddon = $mixedAddon['addon']; + + return array( + 'addon' => $sAddon, + 'addonf' => '' + ); + } +} + +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBasePage.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBasePage.php new file mode 100644 index 0000000000..dcb9f39838 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBasePage.php @@ -0,0 +1,1387 @@ +_oTemplate = $oTemplate; + else + $this->_oTemplate = BxDolTemplate::getInstance(); + + $this->_sStorage = 'sys_images'; + + $this->_sJsClassName = 'BxDolPage'; + $this->_sJsObjectName = 'oBxDolPage'; + + $this->_bStickyColumns = isset($this->_aObject['sticky_columns']) && $this->_aObject['sticky_columns'] == 1; + + $sHtmlId = str_replace(array('_' , ' '), array('-', '-'), $this->_sObject); + $this->_aHtmlIds = array( + 'help_popup' => $sHtmlId . '-help-popup-', + ); + $this->addMarkers(array('site_title' => getParam('site_title'))); + } + + public function performActionGetHelp () + { + $iBlockId = (int)bx_get('block_id'); + if(empty($iBlockId)) + return; + + $aBlock = $this->_oQuery->getPageBlock($iBlockId); + if(empty($aBlock) || !is_array($aBlock) || empty($aBlock['help'])) + return; + + echo $this->_oTemplate->parseHtmlByName('designbox_help_popup.html', array( + 'content' => _t($aBlock['help']) + )); + } + + public function performActionGetShare () + { + $aEmbedData = BxDolPage::getEmbedData(bx_get('url')); + if(!isset($aEmbedData['url'])) + return; + + $sMenu = ''; + if(getParam('sys_a2a_enable') != 'on') { + if(($oMenu = BxDolMenu::getObjectInstance('sys_social_sharing')) !== false) { + $oMenu->addMarkers([ + 'url' => $aEmbedData['url'], + 'img_url_encoded' => '', + 'title_encoded' => '' + ]); + $sMenu = $oMenu->getCode(); + } + } + else + $sMenu = getParam('sys_a2a_code'); + + echo PopupBox('sys_share_popup', _t('_sys_txt_share_popup_header'), $this->_oTemplate->parseHtmlByName('designbox_share_popup.html', [ + 'url' => bx_process_output($aEmbedData['url']), + 'menu' => $sMenu, + 'code' => htmlspecialchars($aEmbedData['html']), + ]), true); + } + + public function performActionEmbed () + { + $aCover = $this->getPageCoverImage(); + $sTitle = $this->_getPageTitle(); + $this->_oTemplate->getEmbed($this->_oTemplate->parseHtmlByName('embed_card.html', [ + 'title' => $sTitle, + 'url' => BxDolPermalinks::getInstance()->permalink($this->_aObject['url']), + 'bx_if:thumb' => [ + 'condition' => $this->isPageCover() && count($aCover) > 0, + 'content' => [ + 'title' => $sTitle, + 'url' => BxDolPermalinks::getInstance()->permalink($this->_aObject['url']), + 'background' => BxDolCover::getInstance(BxDolTemplate::getInstance())->getCoverImageUrl($aCover) + ], + ], + 'bx_if:no_thumb' => [ + 'condition' => count($aCover) == 0 || !$this->isPageCover(), + 'content' => [ + 'title' => $sTitle, + 'url' => BxDolPermalinks::getInstance()->permalink($this->_aObject['url']), + ] + ] + ] + )); + } + + public function performActionCreativeSave() + { + if(!$this->isAllowedCreativeManage()) + return echoJson(['code' => 1]); + + $iId = 0; + $sContent = ''; + if(($iId = bx_get('b')) === false || ($sContent = bx_get('c')) === false) + return echoJson(['code' => 2]); + + $iId = bx_process_input($iId, BX_DATA_INT); + $sContent = bx_process_input($sContent, BX_DATA_HTML); + if(!$this->_oQuery->setPageBlockContent($iId, $sContent)) + return echoJson(['code' => 3]); + + return echoJson(['code' => 0]); + } + + public function isAllowedCreativeManage() + { + return isAdmin(); + } + + /** + * Very similar to BxBasePage::getCode + * but adds css and js files which are needed for the corect page display + */ + public function getCodeDynamic () + { + // TODO: remake to use use collect* template methods + + $oTemplate = BxDolTemplate::getInstance(); + + // get js&css before the page code is generated + $aCssBefore = $oTemplate->getCss(); + $aJsBefore = $oTemplate->getJs(); + + // generate page code + $sContent = $this->getCode(); + + // get js&css after the page code is generated + $aCssAfter = $oTemplate->getCss(); + $aJsAfter = $oTemplate->getJs(); + + // compare files which were added before and after page code is generated + $f = function ($a1, $a2) { + return strcasecmp($a1['url'], $a2['url']); + }; + $aCssNew = array_udiff($aCssAfter, $aCssBefore, $f); + $aJsNew = array_udiff($aJsAfter, $aJsBefore, $f); + + // add newly added js&css files in static mode + $sCss = $sJs = ''; + foreach ($aCssNew as $a) + $sCss .= $oTemplate->addCss($a['url'], true); + foreach ($aJsNew as $a) + $sJs .= $oTemplate->addJs($a['url'], true); + + return $sJs . $sCss . $sContent; + } + + public function getIncludes () + { + $oTemplate = BxDolTemplate::getInstance(); + + // generate page code + $this->getCode(); + + // get js&css after the page code is generated + $aCss = $oTemplate->getCss(); + $aJs = $oTemplate->getJs(); + + // add js&css files in static mode + $sResult = ''; + foreach ($aCss as $a) + $sResult .= $oTemplate->addCss($a['url'], true); + foreach ($aJs as $a) + $sResult .= $oTemplate->addJs($a['url'], true); + + // add js translations + $sResult .= $oTemplate->getJsTranslation(true); + + return $sResult; + } + + /** + * Get page code with automatic caching, adding necessary css/js files and system template vars. + * @return string. + */ + public function getCode () + { + if (bx_get('dynamic') && ($iBlockId = (int)bx_get('pageBlock'))) { + + if (self::isLockedFromUnauthenticated($this->_aObject['uri']) || !$this->_isVisiblePage($this->_aObject)) { + header('HTTP/1.0 403 Forbidden'); + exit; + } + + /** + * @hooks + * @hookdef hook-system-page_output_block 'system', 'page_output_block' - hook with page block data to be output + * - $unit_name - equals `system` + * - $action - equals `page_output_block` + * - $object_id - not used + * - $sender_id - not used + * - $extra_params - array of additional params with the following array keys: + * - `page_name` - [string] page object name + * - `page_object` - [object] an instance of page class, @see BxDolPage + * - `page_query` - [object] an instance of page related query class + * - `block_id` - [int] block id + * @hook @ref hook-system-page_output_block + */ + bx_alert('system', 'page_output_block', 0, false, [ + 'page_name' => $this->_sObject, + 'page_object' => $this, + 'page_query' => $this->_oQuery, + 'block_id' => (int)$iBlockId, + ]); + + header( 'Content-type:text/html;charset=utf-8' ); + + BxDolTemplate::getInstance()->collectingStart(); + + $s = $this->_getBlockOnlyCode($iBlockId); + + $sCss = bx_get('includedCss'); + $sJs = bx_get('includedJs'); + echo BxDolTemplate::getInstance()->collectingEndGetCode($sCss ? @json_decode($sCss) : [], $sJs ? @json_decode($sJs) : []); + + echo $s; + exit; + } + + if (($mixedAvailable = $this->_isAvailablePage($this->_aObject)) !== true) + return $this->_getPageNotFoundMsg($mixedAvailable); + + if (($mixedVisible = $this->_isVisiblePage($this->_aObject)) !== true) + return $this->_getPageAccessDeniedMsg($mixedVisible); + + $this->_addJsCss(); + + if (!$this->_bSubPage) { + $this->_addSysTemplateVars(); + + $this->_selectMenu(); + + $this->_setSubmenu(array()); + } + + if (bx_is_dbg() || !getParam('sys_page_cache_enable') || !$this->_aObject['cache_lifetime'] || (isset($_SERVER['REQUEST_METHOD']) && $_SERVER['REQUEST_METHOD'] === 'POST')) { + $sPageCode = $this->_getPageCode(); + } + else { + $oCache = $this->_getPageCacheObject(); + $sKey = $this->_getPageCacheKey(); + $sKeyCssJs = 'cssjs_' . $sKey; + + $mixedRet = $oCache->getData($sKey, $this->_aObject['cache_lifetime']); + $aRetCssJs = $oCache->getData($sKeyCssJs, $this->_aObject['cache_lifetime']); + + if ($mixedRet !== null && $aRetCssJs !== null) { + BxDolTemplate::getInstance()->collectingStart(); + BxDolTemplate::getInstance()->collectingInject($aRetCssJs['css'], $aRetCssJs['js']); + $sPageCode = BxDolTemplate::getInstance()->collectingEndGetCode(); + $sPageCode .= $mixedRet; + } else { + + BxDolTemplate::getInstance()->collectingStart(); + + $sPageCode = $this->_getPageCode(); + + $aPageCssJs = BxDolTemplate::getInstance()->collectingEndGetCode(array(), array(), 'array'); + + $oCache->setData($sKey, $sPageCode, $this->_aObject['cache_lifetime']); + $oCache->setData($sKeyCssJs, $aPageCssJs, $this->_aObject['cache_lifetime']); + } + } + + /** + * @hooks + * @hookdef hook-system-page_output 'system', 'page_output' - hook with page data to be output + * - $unit_name - equals `system` + * - $action - equals `page_output` + * - $object_id - not used + * - $sender_id - not used + * - $extra_params - array of additional params with the following array keys: + * - `page_name` - [string] page object name + * - `page_object` - [object] an instance of page class, @see BxDolPage + * - `page_query` - [object] an instance of page related query class + * - `page_code` - [string] by ref, final page code to be output, can be overridden in hook processing + * - `sub_page` - [boolean] if the page is used as subpage of some parent page + * @hook @ref hook-system-page_output + */ + bx_alert('system', 'page_output', 0, false, [ + 'page_name' => $this->_sObject, + 'page_object' => $this, + 'page_query' => $this->_oQuery, + 'page_code' => &$sPageCode, + 'sub_page' => $this->_bSubPage, + ]); + + if (!$this->_bSubPage) + $sPageCode .= $this->getJsScript(); + + return $sPageCode; + } + + public function getJsClassName() + { + return $this->_sJsClassName; + } + + public function getJsObjectName() + { + return $this->_sJsObjectName; + } + + function _wrapInTagJsCode($sCode) + { + return ""; + } + + public function getJsScript() + { + $sJsObjName = $this->getJsObjectName(); + $sJsObjClass = $this->getJsClassName(); + $sCode = "if(window['" . $sJsObjName . "'] == undefined) var " . $sJsObjName . " = new " . $sJsObjClass . "(" . json_encode(array( + 'sObjName' => $sJsObjName, + 'sObject' => $this->_sObject, + 'sRootUrl' => BX_DOL_URL_ROOT, + 'aHtmlIds' => $this->_aHtmlIds, + 'isStickyColumns' => $this->_bStickyColumns + )) . ");"; + + return $this->_wrapInTagJsCode($sCode); + } + + /** + * Is page cover enabled. + * @return string + */ + public function isPageCover() + { + $bResult = false; + switch((int)$this->_aObject['cover']) { + case 1: //--- Enabled for all + $bResult = true; + break; + + case 2: //--- Enabled for visitors only + $bResult = !isLogged(); + break; + + case 3: //--- Enabled for members only + $bResult = isLogged(); + break; + } + + return $bResult; + } + + public function setSubPage($b = true) + { + $this->_bSubPage = $b; + } + + public function setPageCover($bCover = true) + { + $this->_aObject['cover'] = (bool)$bCover; + } + + public function getPageCoverImage($bTranscoder = true) + { + $iId = (int)$this->_aObject['cover_image']; + if(empty($iId)) { + $iId = (int)getParam('sys_site_cover_common'); + if(empty($iId)) + return array(); + } + + $aResult = array( + 'id' => $iId + ); + if($bTranscoder) + $aResult['transcoder'] = BX_DOL_TRANSCODER_OBJ_COVER; + else + $aResult['object'] = $this->_sStorage; + + return $aResult; + } + + public function getPageCoverParams() + { + $aParams = [ + 'title' => $this->_getPageTitle(), + 'actions' => '', + 'bx_if:image' => [ + 'condition' => false, + 'content' => [] + ], + 'bx_if:icon' => [ + 'condition' => false, + 'content' => [] + ], + ]; + + if(($oMenuSubmenu = BxDolMenu::getObjectInstance('sys_site_submenu')) !== false) { + $aCoverParams = $oMenuSubmenu->getPageCoverParams(); + if(!empty($aCoverParams) && is_array($aCoverParams)) + $aParams = $aCoverParams; + } + + if(!empty($this->_aObject['cover_title'])) { + $sCoverTitle = _t($this->_aObject['cover_title']); + if($sCoverTitle && strcmp($sCoverTitle, $this->_aObject['cover_title']) != 0) + $aParams['title'] = $sCoverTitle; + } + + return $aParams; + } + + /** + * Get block title. + * @return string + */ + public function getBlockTitle ($aBlock) + { + return $this->_replaceMarkers(_t($aBlock['title']), array('block_id' => $aBlock['id'])); + } + + /** + * Get help control if help is available for the block. + * @return string + */ + public function getBlockHelp ($aBlock) + { + if(empty($aBlock['help']) || empty(strip_tags(_t($aBlock['help'])))) + return ''; + + return $this->_oTemplate->parseHtmlByName('designbox_help.html', array( + 'js_object' => $this->_sJsObjectName, + 'block_id' => $aBlock['id'] + )); + } + + /** + * Get code to load block asyncroniously + * @param $aBlock block code + * @param $iAsync if greater than 0 the it defines loading indicator for the block + * @return HTML code string + */ + public function getBlockAsyncCode($aBlock, $iAsync) + { + $aContentPlaceholder = $this->_oQuery->getPageBlockContentPlaceholder($iAsync); + if (!$aContentPlaceholder) + return _t('_sys_txt_error_occured'); + $oTemplate = $this->_oTemplate; + if ('system' != $aContentPlaceholder['module']) { + $oModule = BxDolModule::getInstance($aContentPlaceholder['module']); + if (!$oModule) + return _t('_sys_txt_error_occured'); + $oTemplate = $oModule->_oTemplate; + } + return $oTemplate->parseHtmlByName($aContentPlaceholder['template'], $aBlock); + } + + /** + * Get page array with all cells and blocks + */ + public function getPageAPI ($aBlocks = []) + { + define('BX_API_PAGE', true); + $query_string = ''; + + if (isset(bx_get('params')[2]) && bx_get('params')[2] != ''){ + $array = json_decode(bx_get('params')[2], true); + $query_string = http_build_query($array); + parse_str($query_string, $a); + $_GET = array_merge($_GET, $a); + } + + $bIsAvailable = $this->_isAvailablePage($this->_aObject); + $bIsVisible = $this->_isVisiblePage($this->_aObject); + //TODO: If page isn't Available or isn't Visible then we should exit with related Error Codes immediately. + + $sMetaTitle = $this->_getPageMetaTitle(); + $sName = $this->_getPageTitle(); + $a = [ + 'id' => $this->_aObject['id'], + 'title' => $sMetaTitle ? $sMetaTitle : $sName, + 'name' => $sName, + 'uri' => $this->_aObject['uri'], + 'url' => ((bx_get('params')[0] ? bx_get('params')[0] : $this->_aObject['uri'] ) . ($query_string != '' ? '?' . $query_string : '')), + 'author' => $this->_aObject['author'], + 'added' => $this->_aObject['added'], + 'module' => $this->getModule(), + 'type' => $this->getType (), + 'layout' => str_replace('.html', '', $this->_aObject['template']), + 'cover_block' => '', + 'menu_top' => '', + 'menu' => '', + 'menu_bottom' => '', + 'menu_add' => '', + 'elements' => $this->getPageBlocksAPI($aBlocks), + ]; + + $sMenuTop = getParam('sys_api_menu_top'); + if (!empty($sMenuTop) && ($oMenuTop = BxDolMenu::getObjectInstance($sMenuTop)) !== false) + $a['menu_top'] = $oMenuTop->getCodeAPI(); + + if (($oMenuSubmenu = BxDolMenu::getObjectInstance('sys_site_submenu')) !== false) { + if(($sSubmenu = $this->getSubMenu()) !== '') + $oMenuSubmenu->setObjectSubmenu($sSubmenu, []); + + $a['menu'] = $oMenuSubmenu->getCodeAPI(); + } + + /** + * Profile/Context view page. + */ + if(isset($this->_aProfileInfo)) { + $oProfileModule = BxDolModule::getInstance($this->_aProfileInfo['type']); + if($oProfileModule !== null) + $aProfileContentInfo = $oProfileModule->_oDb->getContentInfoById($this->_aProfileInfo['content_id']); + + if(!empty($aProfileContentInfo) && is_array($aProfileContentInfo)) { + $CNF = &$oProfileModule->_oConfig->CNF; + + /** + * Process page cover with related menus and lists. + */ + if(BxDolCover::getInstance($this)->isCover()) { + $a['cover_block'] = [ + 'profile' => BxDolProfile::getData($this->_aProfileInfo['id'], [ + 'get_avatar' => 'getAvatarBig', + 'with_info' => true + ]), + 'actions_menu' => '', + 'meta_menu' => '', + 'badges' => BxDolProfile::getInstance($this->_aProfileInfo['id'])->getBadges(), + 'cover' => $oProfileModule->serviceGetCover($this->_aProfileInfo['content_id']), + 'allow_edit' => $oProfileModule->checkAllowedChangeCover($aProfileContentInfo) === CHECK_ACTION_RESULT_ALLOWED + ]; + + if(!empty($CNF['OBJECT_MENU_VIEW_ENTRY_META']) && ($oMetaMenu = BxTemplMenu::getObjectInstance($CNF['OBJECT_MENU_VIEW_ENTRY_META'])) !== false) + $a['cover_block']['meta_menu'] = $oMetaMenu->getCodeAPI(); + + if(!empty($CNF['OBJECT_CONNECTIONS']) && ($oConnection = BxDolConnection::getObjectInstance($CNF['OBJECT_CONNECTIONS'])) !== false) + $a['cover_block']['members_list'] = $oConnection->getConnectedListAPI($this->_aProfileInfo['id'], false, BX_CONNECTIONS_CONTENT_TYPE_INITIATORS, 10); + + if(!empty($CNF['OBJECT_MENU_ACTIONS_VIEW_ENTRY_ALL']) && ($oActionMenu = BxTemplMenu::getObjectInstance($CNF['OBJECT_MENU_ACTIONS_VIEW_ENTRY_ALL'])) !== false) + $a['cover_block']['actions_menu'] = $oActionMenu->getCodeAPI(); + } + + /** + * Process page mange menu. + */ + if(($oMenuManage = BxDolMenu::getObjectInstance('sys_site_manage')) !== false) { + if(!empty($CNF['FIELD_ID'])) + $oMenuManage->setContentId($aProfileContentInfo[$CNF['FIELD_ID']]); + + $aObjectManage = []; + if(!empty($CNF['OBJECT_MENU_MANAGE_VIEW_ENTRY'])) + $aObjectManage = [$CNF['OBJECT_MENU_MANAGE_VIEW_ENTRY']]; + else if(!empty($CNF['OBJECT_MENU_ACTIONS_VIEW_ENTRY_MORE'])) + $aObjectManage = [$CNF['OBJECT_MENU_ACTIONS_VIEW_ENTRY_MORE'], true]; + + call_user_func_array([$oMenuManage, 'setObjectManage'], $aObjectManage); + + $aMenuManage = $oMenuManage->getCodeAPI(); + if(!empty($aMenuManage) && is_array($aMenuManage)) { + if(isset($a['cover_block'], $a['cover_block']['actions_menu']) && is_array($a['cover_block']['actions_menu'])) + $a['cover_block']['actions_menu']['items'] = array_merge($a['cover_block']['actions_menu']['items'], $aMenuManage['items']); + else + $a['cover_block']['actions_menu'] = $aMenuManage; + } + } + } + } + + if (isLogged()) { + $o = BxDolProfile::getInstance(); + $a['user'] = BxDolProfile::getDataForPage($o); + } + + $aExtras = [ + 'page' => $this, + 'blocks' => $aBlocks, + 'data' => &$a, + ]; + + if(!$bIsAvailable) + $a['page_status'] = 404; + else if(!$bIsVisible) + $a['page_status'] = 403; + + /** + * @hooks + * @hookdef hook-system-get_page_api 'system', 'get_page_api' - hook to override page peremeters, is used in API calls + * - $unit_name - equals `system` + * - $action - equals `get_page_api` + * - $object_id - not used + * - $sender_id - not used + * - $extra_params - array of additional params with the following array keys: + * - `page` - [object] an instance of page class, @see BxDolPage + * - `blocks` - [array] array with page blocks + * - `data` - [array] by ref, page peremeters array as key&value pairs, can be overridden in hook processing + * @hook @ref hook-system-get_page_api + */ + bx_alert('system', 'get_page_api', 0, 0, $aExtras); + + return $a; + } + + public function getPageBlocksAPI($aBlocks = []) + { + $bBlocks = !empty($aBlocks) && is_array($aBlocks); + $aFieldsUnset = ['object', 'cell_id', 'title_system', 'class', 'submenu', 'tabs', 'async', 'visible_for_levels', 'hidden_on', 'type', 'text', 'text_updated', 'help', 'cache_lifetime', 'active', 'active_api', 'copyable', 'deletable', 'order']; + + $aCells = $this->_oQuery->getPageBlocks(true); + foreach($aCells as $sKey => &$aCell) { + foreach($aCell as $i => $aBlock) { + if(!$this->_isVisibleBlock($aBlock)) { + unset($aCells[$sKey][$i]); + continue; + } + + $this->processPageBlock($aCells[$sKey][$i], true); + $aBlock = $aCells[$sKey][$i]; + + $sSource = ''; + if($aBlock['type'] == 'service') { + $aContent = @unserialize($aBlock['content']); + if(isset($aContent['module'], $aContent['method'])) + $sSource = $aContent['module'] . ':' . $aContent['method']; + } + else{ + $sSource = 'system:block_' . $aBlock['id']; + } + + if($bBlocks && !in_array($sSource, $aBlocks)) { + unset($aCells[$sKey][$i]); + continue; + } + + $sFunc = '_getBlock' . bx_gen_method_name($aBlock['type']); + $mBlock = method_exists($this, $sFunc) ? $this->$sFunc($aBlock) : $aBlock['content']; + + $aCells[$sKey][$i] = array_merge($aCells[$sKey][$i], [ + 'title' => isset($mBlock['title']) ? $mBlock['title'] : $this->getBlockTitle($aBlock), + 'content' => isset($mBlock['content']) ? $mBlock['content'] : $mBlock, + 'menu' => isset($mBlock['menu']) ? $mBlock['menu'] : '', + 'source' => $sSource + ]); + $aCells[$sKey][$i] = array_diff_key($aCells[$sKey][$i], array_flip($aFieldsUnset)); + } + } + + return array_map('array_values', $aCells); + } + + /** + * Get page code vars + * @return string + */ + protected function _getPageCodeVars () + { + $aHiddenOn = array( + pow(2, BX_DB_HIDDEN_PHONE - 1) => 'bx-def-media-phone-hide', + pow(2, BX_DB_HIDDEN_TABLET - 1) => 'bx-def-media-tablet-hide', + pow(2, BX_DB_HIDDEN_DESKTOP - 1) => 'bx-def-media-desktop-hide', + pow(2, BX_DB_HIDDEN_MOBILE - 1) => 'bx-def-mobile-app-hide' + ); + + $aVars = array ( + 'page_id' => 'bx-page-' . $this->_aObject['uri'], + 'bx_if:show_layout_row_dump' => array( + 'condition' => false, + 'content' => array() + ) + ); + $aBlocks = $this->_oQuery->getPageBlocks(); + foreach ($aBlocks as $sKey => $aCell) { + $sCell = ''; + foreach ($aCell as $aBlock) { + $this->processPageBlock($aBlock, false); + + $sContentWithBox = $this->_getBlockCodeWithCache($aBlock, $aBlock['async']); + + $sClassAdd = ''; + if(!empty($aBlock['class'])) + $sClassAdd .= ' ' . $aBlock['class']; + + if(!empty($aBlock['hidden_on'])) + foreach($aHiddenOn as $iHiddenOn => $sHiddenOnClass) + if((int)$aBlock['hidden_on'] & $iHiddenOn) + $sClassAdd .= ' ' . $sHiddenOnClass; + + if ($sContentWithBox) + $sCell .= $this->_oTemplate->parseHtmlByName('designbox_container.html', array( + 'class_add' => $sClassAdd, + 'bx_if:show_html_id' => array( + 'condition' => true, + 'content' => array( + 'html_id' => 'bx-page-block-' . $aBlock['id'] + ), + ), + 'content' => $sContentWithBox + )); + } + $aVars[$sKey] = $sCell; + } + + return $aVars; + } + + /** + * Process block values, especially if someting need to be overrided + */ + protected function processPageBlock(&$aBlock, $bApi = false) + { + + } + + /** + * Get page code only. + * @return string + */ + protected function _getPageCode () + { + $aVars = $this->_getPageCodeVars (); + return $this->_oTemplate->parseHtmlByName($this->_aObject['template'], $aVars); + } + + /** + * Get one block code only. + * @return string + */ + protected function _getBlockOnlyCode ($iBlockId) + { + if (!($aBlock = $this->_oQuery->getPageBlock((int)$iBlockId))) + return ''; + return $this->_getBlockCodeWithCache($aBlock, 0); + } + + + protected function _getBlockCodeWithCache(&$aBlock, $iAsync = 0) + { + if (bx_is_dbg() || !getParam('sys_pb_cache_enable') || !$aBlock['cache_lifetime'] || $iAsync || (isset($_SERVER['REQUEST_METHOD']) && $_SERVER['REQUEST_METHOD'] === 'POST')) { + $sBlockCode = $this->_getBlockCode($aBlock, $iAsync); + } + else { + $oCache = $this->_getBlockCacheObject(); + $sKey = $this->_getBlockCacheKey(false, $aBlock); + $sKeyCssJs = 'cssjs_' . $sKey; + + $mixedRet = $oCache->getData($sKey, $aBlock['cache_lifetime']); + $aRetCssJs = $oCache->getData($sKeyCssJs, $aBlock['cache_lifetime']); + + if ($mixedRet !== null && $aRetCssJs !== null) { + BxDolTemplate::getInstance()->collectingStart(); + BxDolTemplate::getInstance()->collectingInject($aRetCssJs['css'], $aRetCssJs['js']); + $sBlockCode = BxDolTemplate::getInstance()->collectingEndGetCode(); + $sBlockCode .= $mixedRet; + } else { + BxDolTemplate::getInstance()->collectingStart(); + + $sBlockCode = $this->_getBlockCode($aBlock, $iAsync); + + $aBlockCssJs = BxDolTemplate::getInstance()->collectingEndGetCode(array(), array(), 'array'); + + $oCache->setData($sKey, $sBlockCode, $aBlock['cache_lifetime']); + $oCache->setData($sKeyCssJs, $aBlockCssJs, $aBlock['cache_lifetime']); + } + } + + return $sBlockCode; + } + + /** + * Get block code. + * @return string + */ + protected function _getBlockCode(&$aBlock, $iAsync = 0) + { + $sContentWithBox = ''; + $oFunctions = $this->_oTemplate->getTemplateFunctions(); + + if (isset($GLOBALS['bx_profiler'])) $GLOBALS['bx_profiler']->beginPageBlock(_t($aBlock['title']), $aBlock['id']); + + $aDbNoTitle = [BX_DB_CONTENT_ONLY, BX_DB_PADDING_CONTENT_ONLY, BX_DB_NO_CAPTION, BX_DB_PADDING_NO_CAPTION]; + + $sTitle = $this->getBlockTitle($aBlock); + $sHelp = $this->getBlockHelp($aBlock); + + $sFunc = '_getBlock' . ucfirst($aBlock['type']); + $bBlockVisible = $this->_isVisibleBlock($aBlock); + if ($iAsync && $bBlockVisible) { + $iDesignboxId = $aBlock['designbox_id']; + + $sHelpTitle = $sHelpContent = ''; + if(!in_array($iDesignboxId, $aDbNoTitle)) + $sHelpTitle = $sHelp; + else + $sHelpContent = $sHelp; + + $sContent = $this->getBlockAsyncCode($aBlock, $iAsync); + $aParams = array( + $sTitle . $sHelpTitle, + $sContent . $sHelpContent, + $iDesignboxId + ); + $sContentWithBox = call_user_func_array(array($oFunctions, 'designBoxContent'), $aParams); + } + elseif ($bBlockVisible && method_exists($this, $sFunc)) { + $mixedContent = $this->$sFunc($aBlock); + + if(!empty($aBlock['content_empty'])) { + $sEmpty = _t($aBlock['content_empty']); + $sRegExp = '/(<[A-Za-z0-9]+\b.[^<]*[\pPi\pPf]bx\-msg\-box\b.*[\pPi\pPf][^>]*>)(' . _t('_Empty') . ')(<\/[A-Za-z0-9]+>)/su'; + if(is_string($mixedContent)) + $mixedContent = preg_replace($sRegExp, "\${1}" . $sEmpty . "\${3}", $mixedContent); + else if(is_array($mixedContent) && !empty($mixedContent['content'])) + $mixedContent['content'] = preg_replace($sRegExp, "\${1}" . $sEmpty . "\${3}", $mixedContent['content']); + } + + $this->_oQuery->setReadOnlyMode(true); + + if(is_array($mixedContent) && !empty($mixedContent['content'])) { + $iDesignboxId = isset($mixedContent['designbox_id']) ? $mixedContent['designbox_id'] : $aBlock['designbox_id']; + + if(!empty($mixedContent['markers']) && is_array($mixedContent['markers'])) { + $this->addMarkers($mixedContent['markers']); + + $sTitle = $this->getBlockTitle($aBlock); + } + + $sHelpTitle = $sHelpContent = ''; + if(!in_array($iDesignboxId, $aDbNoTitle)) + $sHelpTitle = $sHelp; + else + $sHelpContent = $sHelp; + + $aParams = array( + (isset($mixedContent['title']) ? $mixedContent['title'] : $sTitle) . $sHelpTitle, + $mixedContent['content'] . $sHelpContent, + $iDesignboxId + ); + + $mixedMenu = false; + if(isset($mixedContent['menu'])) + $mixedMenu = $mixedContent['menu']; + else if(!empty($aBlock['submenu'])) + $mixedMenu = $aBlock['submenu']; + $aParams[] = $mixedMenu; + + if(isset($mixedContent['buttons'])) + $aParams[] = $mixedContent['buttons']; + else if($mixedMenu) + $aParams[] = (int)$aBlock['tabs'] == 1 ? true : array(); + + if(isset($mixedContent['class'])) + $aBlock['class'] = $mixedContent['class']; + } + else if(is_string($mixedContent) && !empty($mixedContent)) { + $iDesignboxId = $aBlock['designbox_id']; + + $sHelpTitle = $sHelpContent = ''; + if(!in_array($iDesignboxId, $aDbNoTitle)) + $sHelpTitle = $sHelp; + else + $sHelpContent = $sHelp; + + $aParams = array( + $sTitle . $sHelpTitle, + $mixedContent . $sHelpContent, + $iDesignboxId + ); + + $mixedMenu = !empty($aBlock['submenu']) ? $aBlock['submenu'] : false; + $aParams[] = $mixedMenu; + + if($mixedMenu) + $aParams[] = (int)$aBlock['tabs'] == 1 ? true : array(); + } + + if(!empty($aParams)) + $sContentWithBox = call_user_func_array(array($oFunctions, 'designBoxContent'), $aParams); + } + + if (isset($GLOBALS['bx_profiler'])) $GLOBALS['bx_profiler']->endPageBlock($aBlock['id'], $sContentWithBox ? false : true, false ); + + return $sContentWithBox; + } + + /** + * Add necessary js and css files. + */ + protected function _addJsCss() + { + $this->_oTemplate->addJs(array('BxDolPage.js', 'theia-sticky-sidebar/theia-sticky-sidebar.min.js', 'theia-sticky-sidebar/ResizeSensor.min.js')); + $this->_oTemplate->addCss('page_layouts.css'); + } + + /** + * Set system template variables, like page title, meta description, meta keywords and meta robots. + */ + protected function _addSysTemplateVars () + { + $oTemplate = BxDolTemplate::getInstance(); + + $sPageTitle = $this->_getPageTitle(); + if ($sPageTitle) + $oTemplate->setPageHeader ($sPageTitle); + + $sMetaTitle = $this->_getPageMetaTitle(); + if ($sMetaTitle) + $oTemplate->setPageMetaTitle ($sMetaTitle); + + $sMetaDesc = $this->_getPageMetaDesc(); + if ($sMetaDesc) + $oTemplate->setPageDescription ($sMetaDesc); + + $sMetaRobots = $this->_getPageMetaRobots(); + if ($sMetaRobots) + $oTemplate->setPageMetaRobots ($sMetaRobots); + + $sMetaImage = $this->_getPageMetaImage(); + if ($sMetaImage) + $oTemplate->addPageMetaImage($sMetaImage); + + $sMetaKeywords = $this->_getPageMetaKeywords(); + if ($sMetaKeywords) + $oTemplate->addPageKeywords ($sMetaKeywords); + } + + /** + * Select menu from page properties. + */ + protected function _selectMenu () + { + BxDolMenu::setSelectedGlobal ($this->_aObject['module'], $this->_aObject['uri']); + } + + /** + * Set page submenu if it's specified + */ + protected function _setSubmenu ($aParams) + { + if(empty($this->_aObject['submenu']) || $this->_aObject['submenu'] == 'disabled') + return; + + $oMenuSubmenu = BxDolMenu::getObjectInstance('sys_site_submenu'); + if(!$oMenuSubmenu) + return; + + $oMenuSubmenu->setObjectSubmenu($this->_aObject['submenu'], $aParams); + } + + /** + * Get content for 'raw' block type. + * @return string + */ + protected function _getBlockRaw ($aBlock) + { + if (bx_is_api()){ + return [bx_api_get_block('raw', ['title' => _t($aBlock['title']), 'content' => BxDolTemplate::getInstance()->parseHtmlByContent($aBlock['content'], array())])]; + } + + $s = '' . BxDolTemplate::getInstance()->parseHtmlByContent($aBlock['content'], array()) . ''; + $s = $this->_replaceMarkers($s, array('block_id' => $aBlock['id'])); + $s = bx_process_macros($s); + return $s; + } + + /** + * Get content for 'custom' block type. + * @return string + */ + protected function _getBlockCustom ($aBlock) + { + if (bx_is_api()){ + return [bx_api_get_block('custom', ['title' => _t($aBlock['title']), 'content' => BxDolTemplate::getInstance()->parseHtmlByContent($aBlock['content'], array())])]; + } + + $s = '' . BxDolTemplate::getInstance()->parseHtmlByContent($aBlock['content'], array()) . ''; + $s = $this->_replaceMarkers($s, array('block_id' => $aBlock['id'])); + $s = bx_process_macros($s); + return $s; + } + + /** + * Get content for 'html' block type. + * @return string + */ + protected function _getBlockHtml ($aBlock) + { + if (bx_is_api()){ + return [bx_api_get_block('html', ['title' => _t($aBlock['title']), 'content' => $aBlock['content']])]; + } + + $s = '' . $aBlock['content'] . ''; + $s = $this->_replaceMarkers($s, array('block_id' => $aBlock['id'])); + $s = bx_process_macros($s); + return $s; + } + + /** + * Get content for 'creative' block type. + * @return string + */ + protected function _getBlockCreative ($aBlock) + { + if(bx_is_api()) + return [bx_api_get_block('creative', ['title' => _t($aBlock['title']), 'content' => $aBlock['content']])]; + + $s = $this->_replaceMarkers($aBlock['content'], ['block_id' => $aBlock['id']]); + $s = bx_process_macros($s); + + $bCanManage = $this->isAllowedCreativeManage(); + + if($bCanManage) { + $this->_oTemplate->addCss([ + BX_DIRECTORY_PATH_PLUGINS_PUBLIC . 'grapesjs/|grapes.min.css', + ]); + + $this->_oTemplate->addJs([ + 'grapesjs/grapes.min.js', + 'grapesjs/grapesjs-blocks-basic.js', + 'grapesjs/grapesjs-style-bg.js', + 'grapesjs/grapesjs-preset-webpage.min.js', + ]); + } + + return $this->_oTemplate->parseHtmlByName('block_creative.html', [ + 'block_id' => $aBlock['id'], + 'content' => $s, + 'bx_if:show_controls' => [ + 'condition' => $bCanManage, + 'content' => [ + 'onclick_edit' => $this->_sJsObjectName . '.creativeEdit(this, ' . $aBlock['id'] . ')', + 'onclick_save' => $this->_sJsObjectName . '.creativeSave(this, ' . $aBlock['id'] . ')' + ] + ] + ]); + } + + /** + * Get content for 'bento_grid' block type. + * @return string + */ + protected function _getBlockBentoGrid ($aBlock) + { + if(bx_is_api()) { + $iBlockId = (int)$aBlock['id']; + + $iContentId = 0; + if(($mContentId = bx_get('id')) !== false) + $iContentId = (int)$mContentId; + + $sContentModule = ''; + if(!empty($this->_aObject['module']) && !in_array($this->_aObject['module'], ['system', 'custom'])) + $sContentModule = $this->_aObject['module']; + + $bIsAllowedEdit = false; + if(!empty($sContentModule) && bx_is_srv($sContentModule, 'check_allowed_with_content')) + $bIsAllowedEdit = bx_srv($sContentModule, 'check_allowed_with_content', ['edit', $iContentId]) === CHECK_ACTION_RESULT_ALLOWED; + else + $bIsAllowedEdit = isAdmin(); + + return [bx_api_get_block('bento_grid', [ + 'title' => _t($aBlock['title']), + 'content' => self::getPageBlockData($iBlockId, $iContentId, $sContentModule) + ], ['ext' => [ + 'block_id' => $iBlockId, + 'content_id' => $iContentId, + 'content_module' => $sContentModule, + 'is_allowed_edit' => $bIsAllowedEdit + ]])]; + } + + /** + * Isn't supported for now. + */ + return ''; + } + + /** + * Get content for 'wiki' block type. + * @return string + */ + protected function _getBlockWiki ($aBlock) + { + $oWiki = BxDolWiki::getObjectInstance($this->_aObject['module']); + if (!$oWiki) { + $sContent = _t('_sys_wiki_error_missing_wiki_object', $this->_aObject['module']); + } + else { + $sContent = $oWiki->getBlockContent($aBlock['id'], false, (int)bx_get($aBlock['id'].'rev') ? (int)bx_get($aBlock['id'].'rev') : false); + } + + $s = '' . $sContent . ''; + $s = $this->_replaceMarkers($s, array('block_id' => $aBlock['id'])); + $s = bx_process_macros($s); + return $s; + } + + /** + * Get content for 'lang' block type. + * @return string + */ + protected function _getBlockLang ($aBlock) + { + if (bx_is_api()){ + return [bx_api_get_block('lang', ['title' => _t($aBlock['title']), 'content' => bx_process_macros(_t(trim($aBlock['content'])))])]; + } + + $s = '' . _t(trim($aBlock['content'])) . ''; + $s = $this->_replaceMarkers($s, array('block_id' => $aBlock['id'])); + $s = bx_process_macros($s); + return $s; + } + + /** + * Get content for 'image' block type. + * @return string + */ + protected function _getBlockImage ($aBlock) + { + if (empty($aBlock['content'])) + return false; + + list($iFileId, $sAlign ) = explode('#', $aBlock['content']); + $iFileId = (int)$iFileId; + if (!$iFileId) + return false; + + $oStorage = BxDolStorage::getObjectInstance(BX_DOL_STORAGE_OBJ_IMAGES); + if (!$oStorage) + return false; + + $sUrl = $oStorage->getFileUrlById($iFileId); + if (!$sUrl) + return false; + + $sStyleAdd = ''; + $sClassAdd = 'bx-page-image-container'; + $aAlign = ['left' => 'start', 'center' => 'center', 'right' => 'end']; + if(array_key_exists($sAlign, $aAlign)) { + $sClassAdd .= ' flex justify-' . $aAlign[$sAlign]; + + $sStyleAdd = 'style="text-align:' . $sAlign . '"'; + } + + return ''; + } + + /** + * Get content for 'rss' block type. + * @return string + */ + protected function _getBlockRss ($aBlock) + { + if (empty($aBlock['content'])) + return false; + + list( $sUrl, $iNum ) = explode('#', $aBlock['content']); + $iNum = (int)$iNum; + + return BxDolRss::getObjectInstance('sys_page_block')->getHolder($aBlock['id'], $iNum); + } + + /** + * Get content for 'menu' block type. + * @return string + */ + protected function _getBlockMenu ($aBlock) + { + $oMenu = BxTemplMenu::getObjectInstance($aBlock['content']); + return $oMenu ? $oMenu->getCode () : ''; + } + + /** + * Get content for 'service' block type. + * @return string + */ + protected function _getBlockService ($aBlock) + { + $aMarkers = array_merge($this->_aMarkers, [ + 'block_id' => $aBlock['id'] + ]); + + return BxDolService::callSerialized($aBlock['content'], $aMarkers); + } + + /** + * Get page title. + * @return string + */ + protected function _getPageTitle() + { + return $this->_replaceMarkers(_t($this->_aObject['title'])); + } + + /** + * Get page meta description. + * @return string + */ + protected function _getPageMetaDesc() + { + return $this->_replaceMarkers(_t($this->_aObject['meta_description'])); + } + + /** + * Get page meta title. + * @return string + */ + protected function _getPageMetaTitle() + { + return $this->_replaceMarkers(_t($this->_aObject['meta_title'])); + } + + /** + * Get page meta image. + * @return string + */ + protected function _getPageMetaImage() + { + return ''; + } + + /** + * Get page meta keywords. + * @return string + */ + protected function _getPageMetaKeywords() + { + return $this->_replaceMarkers(_t($this->_aObject['meta_keywords'])); + } + + /** + * Get page meta robots. + * @return string + */ + protected function _getPageMetaRobots() + { + return _t($this->_aObject['meta_robots']); + } + + /** + * Get page not found message. + * @return string + */ + protected function _getPageNotFoundMsg ($mixedMsg = false) + { + $this->_oTemplate->displayPageNotFound(); + exit; + } + + /** + * Get access denied message. + * @return string + */ + protected function _getPageAccessDeniedMsg ($mixedMsg = false) + { + return MsgBox($mixedMsg !== false ? $mixedMsg : _t('_Access denied')); + } + + /** + * Get page cache object. + * @return cache object instance + */ + protected function _getPageCacheObject () + { + return $this->_getCacheObject (); + } + + /** + * Get block cache object. + * @return cache object instance + */ + protected function _getBlockCacheObject () + { + return $this->_getCacheObject ('Block', 'pb'); + } + + protected function _getCacheObject ($sSuffixObj = 'Page', $sSuffixParam = 'page') + { + $sObj = '_o' . $sSuffixObj . 'CacheObject'; + $sParam = 'sys_' . $sSuffixParam . '_cache_engine'; + + if ($this->{$sObj} != null) { + return $this->{$sObj}; + } else { + $sEngine = getParam($sParam); + $this->{$sObj} = bx_instance ('BxDolCache' . $sEngine); + if (!$this->{$sObj}->isAvailable()) + $this->{$sObj} = bx_instance ('BxDolCacheFile'); + return $this->{$sObj}; + } + } + + /** + * Get page cache key. + * @param $isPrefixOnly return key prefix only. + * @return string + */ + protected function _getPageCacheKey ($isPrefixOnly = false) + { + $s = 'page_' . $this->_aObject['object'] . '_'; + if ($isPrefixOnly) + return $s; + $s .= $this->_getPageCacheParams (); + $s .= bx_site_hash() . '.php'; + return $s; + } + + /** + * Get block cache key. + * @param $isPrefixOnly return key prefix only. + * @return string + */ + protected function _getBlockCacheKey ($isPrefixOnly = false, $aBlock = array()) + { + $s = $this->_getPageCacheKey(true) . 'block_'; + if ($isPrefixOnly) + return $s; + $s .= ($aBlock ? $aBlock['id'] : 0) . '_' . $this->_getPageCacheParams (); + $s .= bx_site_hash() . '.php'; + return $s; + } + + /** + * Additional cache key. In the case of dynamic page. + * For example - profile page, where each profile has own page. + * @return string + */ + protected function _getPageCacheParams () + { + return md5(serialize($_GET) . bx_lang_name()); + } + + /** + * Clean page cache. + * @param $isDelAllWithPagePrefix delete cache by prefix, it can be used for dynamic pages, like profile view, where for each profile separate cache is generated. + * @return string + */ + protected function cleanCache ($isDelAllWithPagePrefix = false) + { + $a = ['Page', 'Block']; + $bRet = false; + foreach ($a as $s) { + $oCache = $this->{'_get' . $s . 'CacheObject'} (); + $sKey = $this->{'_get'. $s . 'CacheKey'} ($isDelAllWithPagePrefix); + + if ($isDelAllWithPagePrefix) + $bRet = $bRet && $oCache->removeAllByPrefix($sKey); + else + $bRet = $bRet && $oCache->delData($sKey); + } + return $bRet; + } +} + +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseScore.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseScore.php new file mode 100644 index 0000000000..46469cd32c --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseScore.php @@ -0,0 +1,561 @@ +_bCssJsAdded = false; + + $this->_sJsObjName = 'oScore' . bx_gen_method_name($sSystem, array('_' , '-')) . $iId; + $this->_sStylePrefix = 'bx-score'; + + $sHtmlId = str_replace(array('_' , ' '), array('-', '-'), $sSystem) . '-' . $iId; + $this->_aHtmlIds = array( + 'main' => 'bx-score-' . $sHtmlId, + 'counter' => 'bx-score-counter-' . $sHtmlId, + 'by_popup' => 'bx-score-by-popup-' . $sHtmlId, + 'legend' => 'bx-score-legend-' . $sHtmlId, + ); + + $this->_aElementDefaults = [ + 'show_do_vote_as_button' => false, + 'show_do_vote_as_button_small' => false, + 'show_do_vote_icon' => true, + 'show_do_vote_label' => false, + 'show_counter' => true, + 'show_counter_only' => true, + 'show_counter_empty' => true, + 'show_counter_style' => self::$_sCounterStyleSimple, //--- Alloved styles are 'simple', 'divided' + 'show_counter_label_icon' => false, + 'show_counter_label_text' => true, + 'show_legend' => false, + 'show_script' => true + ]; + $this->_aElementDefaultsApi = array_merge($this->_aElementDefaults, [ + 'show_counter' => true, + ]); + $this->_aElementParamsApi = ['is_voted']; + + $this->_sTmplNameLegend = 'score_legend.html'; + $this->_sTmplNameByList = 'score_by_list.html'; + + $this->_sTmplContentElementBlock = $this->_oTemplate->getHtml('score_element_block.html'); + $this->_sTmplContentElementInline = $this->_oTemplate->getHtml('score_element_inline.html'); + $this->_sTmplContentDoActionLabel = $this->_oTemplate->getHtml('score_do_vote_label.html'); + $this->_sTmplContentCounterLabel = $this->_oTemplate->getHtml('score_counter_label.html'); + } + + public function getJsObjectName() + { + return $this->_sJsObjName; + } + + public function getJsScript($aParams = []) + { + $sJsObjName = $this->getJsObjectName(); + + $bDynamicMode = isset($aParams['dynamic_mode']) && (bool)$aParams['dynamic_mode'] === true; + + $aParamsJs = array( + 'sObjName' => $sJsObjName, + 'sSystem' => $this->getSystemName(), + 'iAuthorId' => $this->_getAuthorId(), + 'iObjId' => $this->getId(), + 'sRootUrl' => BX_DOL_URL_ROOT, + 'sSocket' => $this->getSocketName(), + 'sStylePrefix' => $this->_sStylePrefix, + 'aHtmlIds' => $this->_aHtmlIds, + 'aRequestParams' => $this->_prepareRequestParamsData($aParams) + ); + $sCode = "if(window['" . $sJsObjName . "'] == undefined) var " . $sJsObjName . " = new BxDolScore(" . json_encode($aParamsJs) . ");"; + + return $this->_oTemplate->_wrapInTagJsCode($sCode); + } + + public function getJsClick($sType) + { + return $this->getJsObjectName() . '.vote' . ucfirst($sType) . '(this)'; + } + + public function getJsClickCounter($aParams = []) + { + $sJsObject = $this->getJsObjectName(); + $sJsMethod = 'toggleByPopup'; + + if(!isset($aParams['type'], $aParams['show_counter_style']) || $aParams['show_counter_style'] == self::$_sCounterStyleSimple) + return $sJsObject . '.' . $sJsMethod . '(this)'; + + return $sJsObject . '.' . $sJsMethod . '(this, \'' . $aParams['type'] . '\')'; + } + + public function getCounter($aParams = []) + { + $aParams = array_merge($this->_aElementDefaults, $aParams); + + $sDefault = $this->_aElementDefaults['show_counter_style']; + $sCounterStyle = !empty($aParams['show_counter_style']) ? $aParams['show_counter_style'] : $sDefault; + + $sMethodPrefix = '_getCounter'; + $sMethod = $sMethodPrefix . bx_gen_method_name($sCounterStyle); + if(!method_exists($this, $sMethod)) + $sMethod = $sMethodPrefix . bx_gen_method_name($sDefault); + + return $this->$sMethod($aParams); + } + + public function _getCounterSimple($aParams = []) + { + $aScore = $this->_oQuery->getScore($this->getId()); + + $iCup = (int)$aScore['count_up']; + $iCdown = (int)$aScore['count_down']; + + return $this->_getCounterItem(array_merge($aParams, [ + 'allowed_view_voters' => $this->isAllowedVoteViewVoters(), + 'value' => $iCup - $iCdown, + 'value_empty' => $iCup == 0 && $iCdown == 0, + ])); + } + + public function _getCounterDivided($aParams = []) + { + $bShowCounterEmpty = isset($aParams['show_counter_empty']) && (bool)$aParams['show_counter_empty'] === true; + $bShowCounterOnly = isset($aParams['show_counter_only']) && (bool)$aParams['show_counter_only'] === true; + $bShowScript = !isset($aParams['show_script']) || (bool)$aParams['show_script'] === true; + + $bAllowedViewVoters = $this->isAllowedVoteViewVoters(); + + $bScore = $this->_isVote(); + $aScore = $this->_getVote(); + + $aCounters = [ + BX_DOL_SCORE_DO_UP => (int)$aScore['count_up'], + BX_DOL_SCORE_DO_DOWN => (int)$aScore['count_down'] + ]; + + $sCounters = ''; + foreach($aCounters as $sType => $iValue) + $sCounters .= $this->_getCounterItem(array_merge($aParams, [ + 'show_counter_label_icon' => $bShowCounterOnly, + 'show_script' => false, + 'allowed_view_voters' => $bAllowedViewVoters, + 'type' => $sType, + 'value_html_id' => $this->_aHtmlIds['counter'] . '-' . $sType, + 'value' => $iValue, + 'value_empty' => !$bScore, + ])); + + return $this->_oTemplate->parseHtmlByName('score_counter_wrapper.html', [ + 'html_id' => $this->_aHtmlIds['counter'], + 'style_prefix' => $this->_sStylePrefix, + 'class' => $this->_aHtmlIds['counter'] . (!$bScore && !$bShowCounterEmpty ? ' bx-sc-hidden' : ''), + 'style' => self::$_sCounterStyleDivided, + 'counter' => $sCounters, + 'script' => $bShowScript ? $this->getJsScript($aParams) : '' + ]); + } + + public function _getCounterItem($aParams = []) + { + $aParams = array_merge($this->_aElementDefaults, $aParams); + + $bDynamicMode = isset($aParams['dynamic_mode']) && (bool)$aParams['dynamic_mode'] === true; + $bShowEmpty = isset($aParams['show_counter_empty']) && (bool)$aParams['show_counter_empty'] === true; + $bShowDoVoteAsButtonSmall = isset($aParams['show_do_vote_as_button_small']) && (bool)$aParams['show_do_vote_as_button_small'] === true; + $bShowDoVoteAsButton = !$bShowDoVoteAsButtonSmall && isset($aParams['show_do_vote_as_button']) && (bool)$aParams['show_do_vote_as_button'] === true; + $bShowScript = !isset($aParams['show_script']) || (bool)$aParams['show_script'] === true; + + $sClass = 'sys-action-counter'; + if(isset($aParams['show_counter_only']) && (bool)$aParams['show_counter_only'] === true) + $sClass .= ' sys-ac-only'; + + $sClass .= ' ' . $this->_sStylePrefix . '-counter'; + if($bShowDoVoteAsButtonSmall) + $sClass .= ' bx-btn-small-height'; + if($bShowDoVoteAsButton) + $sClass .= ' bx-btn-height'; + + $bLink = $aParams['allowed_view_voters'] && !$aParams['value_empty']; + $sCounter = !$aParams['value_empty'] || $bShowEmpty ? $this->_getCounterLabel($aParams['value'], $aParams) : ''; + + $aTmplVarsText = [ + 'id' => isset($aParams['value_html_id']) ? $aParams['value_html_id'] : $this->_aHtmlIds['counter'], + 'class' => $sClass, + 'content' => $sCounter, + 'title' => _t($this->_getTitleDoBy()), + ]; + + $aTmplVarsLink = array_merge($aTmplVarsText, [ + 'onclick' => $bLink ? 'javascript:' . $this->getJsClickCounter($aParams) : '' + ]); + + return $this->_oTemplate->parseHtmlByName('score_counter.html', array( + 'bx_if:show_link' => array( + 'condition' => $bLink, + 'content' => $aTmplVarsLink + ), + 'bx_if:show_text' => array( + 'condition' => !$bLink, + 'content' => $aTmplVarsText + ), + 'script' => $bShowScript ? $this->getJsScript($aParams) : '' + )); + } + + public function getCounterAPI($aParams = []) + { + $aParams = array_merge($this->_aElementDefaultsApi, $aParams); + + return $this->_getVote(); + } + + public function getLegend($aParams = array()) + { + $aLegend = $this->_oQuery->getLegend($this->_iId); + $aTypes = array( + BX_DOL_SCORE_DO_UP, + BX_DOL_SCORE_DO_DOWN + ); + + $aTmplVarsItems = array(); + foreach($aTypes as $sType) + $aTmplVarsItems[] = array( + 'style_prefix' => $this->_sStylePrefix, + 'value' => $this->_getLabelDo($sType, $aParams), + 'label' => isset($aLegend[$sType]['count']) ? (int)$aLegend[$sType]['count'] : 0 + ); + + return $this->_oTemplate->parseHtmlByName($this->_sTmplNameLegend, array( + 'style_prefix' => $this->_sStylePrefix, + 'html_id' => $this->_aHtmlIds['legend'], + 'bx_repeat:items' => $aTmplVarsItems + )); + } + + public function getElementBlock($aParams = array()) + { + $aParams['usage'] = BX_DOL_SCORE_USAGE_BLOCK; + + return $this->getElement($aParams); + } + + public function getElementInline($aParams = array()) + { + $aParams['usage'] = BX_DOL_SCORE_USAGE_INLINE; + + return $this->getElement($aParams); + } + + public function getElement($aParams = array()) + { + $aParams = array_merge($this->_aElementDefaults, $aParams); + + $bShowDoVoteAsButtonSmall = isset($aParams['show_do_vote_as_button_small']) && (bool)$aParams['show_do_vote_as_button_small'] === true; + $bShowDoVoteAsButton = !$bShowDoVoteAsButtonSmall && isset($aParams['show_do_vote_as_button']) && (bool)$aParams['show_do_vote_as_button'] === true; + $bShowCounterEmpty = isset($aParams['show_counter_empty']) && (bool)$aParams['show_counter_empty'] === true; + $bShowCounterSimple = $bShowCounterDivided = false; + if(isset($aParams['show_counter_style'])) { + if($aParams['show_counter_style'] == self::$_sCounterStyleSimple) + $bShowCounterSimple = true; + if($aParams['show_counter_style'] == self::$_sCounterStyleDivided) + $bShowCounterDivided = true; + } + + $iObjectId = $this->getId(); + $iAuthorId = $this->_getAuthorId(); + $iAuthorIp = $this->_getAuthorIp(); + $isAllowedVote = $this->isAllowedVote(); + $isAllowedVoteView = $this->isAllowedVoteView(); + $isAllowedVoteViewVoters = $this->isAllowedVoteViewVoters(); + + $aScore = $this->_oQuery->getScore($iObjectId); + $bCount = $this->_isCount($aScore); + $bCounter = $this->_isShowCounter($aParams, $isAllowedVote, $isAllowedVoteView, $bCount); + + $aParams['is_voted'] = $this->isPerformed($iObjectId, $iAuthorId, $iAuthorIp) ? true : false; + + //--- Do Vote + $bTmplVarsDoVote = $this->_isShowDoVote($aParams, $isAllowedVote, $bCount); + $aTmplVarsDoVoteUp = $aTmplVarsDoVoteDown = []; + if($bTmplVarsDoVote) + foreach([BX_DOL_SCORE_DO_UP, BX_DOL_SCORE_DO_DOWN] as $sType) + ${'aTmplVarsDoVote' . ucfirst($sType)} = [ + 'style_prefix' => $this->_sStylePrefix, + 'style' => $aParams['show_counter_style'], + 'do_vote' => $this->_getDoVote($sType, $aParams, $isAllowedVote), + 'bx_if:show_counter_' . $sType => [ + 'condition' => $bShowCounterDivided && $bCounter, + 'content' => [ + 'style_prefix' => $this->_sStylePrefix, + 'style' => $aParams['show_counter_style'], + 'bx_if:show_c' . $sType . '_hidden' => [ + 'condition' => !$bShowCounterEmpty && !$bCount, + 'content' => [] + ], + 'counter' => $this->_getCounterItem(array_merge($aParams, [ + 'show_do_vote_as_button' => false, + 'show_do_vote_as_button_small' => false, + 'show_counter_only' => false, + 'show_counter_label_icon' => false, + 'show_script' => false, + 'allowed_view_voters' => $isAllowedVoteViewVoters, + 'type' => $sType, + 'value_html_id' => $this->_aHtmlIds['counter'] . '-' . $sType, + 'value' => isset($aScore['count_' . $sType]) ? (int)$aScore['count_' . $sType] : 0, + 'value_empty' => !$bCount, + ])) + ] + ] + ]; + + //--- Counter (Simple) + $bTmplVarsCounter = $bShowCounterSimple && $bCounter; + $aTmplVarsCounter = array(); + if($bTmplVarsCounter) + $aTmplVarsCounter = array( + 'style_prefix' => $this->_sStylePrefix, + 'bx_if:show_hidden' => array( + 'condition' => !$bShowCounterEmpty && !$bCount, + 'content' => array() + ), + 'counter' => $this->getCounter(array_merge($aParams, [ + 'show_counter_only' => false, + 'show_script' => false + ])) + ); + + //--- Legend + $bTmplVarsLegend = $this->_isShowLegend($aParams, $isAllowedVote, $isAllowedVoteView, $bCount); + $aTmplVarsLegend = array(); + if($bTmplVarsLegend) + $aTmplVarsLegend = array( + 'legend' => $this->getLegend($aParams) + ); + + if(!$bTmplVarsDoVote && !$bTmplVarsCounter && !$bTmplVarsLegend) + return ''; + + $sTmplName = $this->{'_getTmplContentElement' . bx_gen_method_name(!empty($aParams['usage']) ? $aParams['usage'] : BX_DOL_SCORE_USAGE_DEFAULT)}(); + return $this->_oTemplate->parseHtmlByContent($sTmplName, array( + 'style_prefix' => $this->_sStylePrefix, + 'html_id' => $this->_aHtmlIds['main'], + 'class' => $this->_sStylePrefix . ($bShowDoVoteAsButton ? '-button' : '') . ($bShowDoVoteAsButtonSmall ? '-button-small' : ''), + 'score' => $aScore['score'], + 'cup' => $aScore['count_up'], + 'cdown' => $aScore['count_down'], + 'bx_if:show_do_vote_up' => array( + 'condition' => $bTmplVarsDoVote, + 'content' => $aTmplVarsDoVoteUp + ), + 'bx_if:show_counter' => array( + 'condition' => $bTmplVarsCounter, + 'content' => $aTmplVarsCounter + ), + 'bx_if:show_do_vote_down' => array( + 'condition' => $bTmplVarsDoVote, + 'content' => $aTmplVarsDoVoteDown + ), + 'bx_if:show_legend' => array( + 'condition' => $bTmplVarsLegend, + 'content' => $aTmplVarsLegend + ), + 'script' => $this->getJsScript($aParams) + )); + } + + public function getElementAPI($aParams = []) + { + if(!($this->_bApi = bx_is_api())) + return; + + if(!$this->isEnabled()) + return bx_api_get_msg('_sys_score_err_not_enabled'); + + $aParams = array_merge($this->_aElementDefaultsApi, $aParams); + + $iObjectId = $this->getId(); + $iAuthorId = $this->_getAuthorId(); + + $bCount = $this->_isCount(); + $isAllowedVote = $this->isAllowedVote(); + $isAllowedVoteView = $this->isAllowedVoteView(); + $aParams['is_voted'] = $this->isPerformed($iObjectId, $iAuthorId); + $aParams['track'] = $aParams['is_voted'] ? $this->_getTrack($iObjectId, $iAuthorId) : []; + + //--- Do Vote + $bDoVote = $this->_isShowDoVote($aParams, $isAllowedVote, $bCount); + $aDoVoteUp = $bDoVote ? $this->_getDoVote(BX_DOL_SCORE_DO_UP, $aParams, $isAllowedVote) : []; + $aDoVoteDown = $bDoVote ? $this->_getDoVote(BX_DOL_SCORE_DO_DOWN, $aParams, $isAllowedVote) : []; + + //--- Counter + $bCounter = $this->_isShowCounter($aParams, $isAllowedVote, $isAllowedVoteView, $bCount); + $aCounter = $bCounter ? $this->getCounterAPI(array_merge($aParams, [ + 'show_counter_only' => false, + 'show_script' => false + ])) : []; + + if(!$bDoVote && !$bCounter) + return bx_api_get_msg(''); + + return [ + 'type' => 'scores', + 'system' => $this->_sSystem, + 'object_id' => $this->_iId, + 'params' => array_intersect_key($aParams, array_flip($this->_aElementParamsApi)), + 'action' => [ + BX_DOL_SCORE_DO_UP => $aDoVoteUp, + BX_DOL_SCORE_DO_DOWN => $aDoVoteDown + ], + 'counter' => $aCounter, + ]; + } + + protected function _getDoVote($sType, $aParams = [], $isAllowedVote = true) + { + $bUndo = $this->isUndo(); + $bVoted = isset($aParams['is_voted']) && (bool)$aParams['is_voted'] === true; + $bShowDoVoteAsButtonSmall = isset($aParams['show_do_vote_as_button_small']) && (bool)$aParams['show_do_vote_as_button_small'] === true; + $bShowDoVoteAsButton = !$bShowDoVoteAsButtonSmall && isset($aParams['show_do_vote_as_button']) && (bool)$aParams['show_do_vote_as_button'] === true; + $bDisabled = !$isAllowedVote || ($bVoted && !$bUndo); + + $sClass = ''; + if($bShowDoVoteAsButton) + $sClass = 'bx-btn'; + else if ($bShowDoVoteAsButtonSmall) + $sClass = 'bx-btn bx-btn-small'; + + if($bDisabled) + $sClass .= $bShowDoVoteAsButton || $bShowDoVoteAsButtonSmall ? ' bx-btn-disabled' : 'bx-score-disabled'; + + if($this->_bApi) + return [ + 'is_undo' => $bUndo, + 'is_voted' => $bVoted, + 'is_disabled' => $bDisabled, + 'title' => _t($this->_getTitleDo($sType)), + ]; + + return $this->_oTemplate->parseLink('javascript:void(0)', $this->_getLabelDo($sType, $aParams), array( + 'class' => $this->_sStylePrefix . '-do-vote ' . $this->_sStylePrefix . '-dv-' . $sType . ' ' . $sClass, + 'title' => _t($this->_getTitleDo($sType)), + 'onclick' => !$bDisabled ? $this->getJsClick($sType) : '' + )); + } + + protected function _getCounterLabel($iCount, $aParams = []) + { + return $this->_oTemplate->parseHtmlByContent($this->_getTmplContentCounterLabel(), array( + 'style_prefix' => $this->_sStylePrefix, + 'bx_if:show_icon' => array( + 'condition' => !isset($aParams['show_counter_label_icon']) || (bool)$aParams['show_counter_label_icon'] === true, + 'content' => array( + 'style_prefix' => $this->_sStylePrefix, + 'icon' => $this->_oTemplate->getImageAuto($this->_getIconDo(isset($aParams['type']) ? $aParams['type'] : '')) + ) + ), + 'bx_if:show_text' => array( + 'condition' => !isset($aParams['show_counter_label_text']) || (bool)$aParams['show_counter_label_text'] === true, + 'content' => array( + 'style_prefix' => $this->_sStylePrefix, + 'text' => _t('_sys_score_counter', $iCount) + ) + ) + )); + } + + protected function _getLabelDo($sType, $aParams = array()) + { + return $this->_oTemplate->parseHtmlByContent($this->_getTmplContentDoActionLabel(), array( + 'style_prefix' => $this->_sStylePrefix, + 'bx_if:show_icon' => array( + 'condition' => isset($aParams['show_do_vote_icon']) && (bool)$aParams['show_do_vote_icon'] === true, + 'content' => array( + 'style_prefix' => $this->_sStylePrefix, + 'icon' => $this->_oTemplate->getImageAuto($this->_getIconDo($sType)) + ) + ), + 'bx_if:show_text' => array( + 'condition' => isset($aParams['show_do_vote_label']) && (bool)$aParams['show_do_vote_label'] === true, + 'content' => array( + 'style_prefix' => $this->_sStylePrefix, + 'text' => _t($this->_getTitleDo($sType)) + ) + ) + )); + } + + protected function _getVotedBy($aParams) + { + $aParams = array_merge($this->_aElementDefaults, $aParams, [ + 'show_do_vote_icon' => true, + 'show_do_vote_label' => false + ]); + + $aParamsDb = []; + if(!empty($aParams['type'])) + $aParamsDb['type'] = $aParams['type']; + $aUsers = $this->_oQuery->getPerformedBy($this->getId(), $aParamsDb); + + $aTmplUsers = []; + foreach($aUsers as $aUser) { + list($sUserName, $sUserLink, $sUserIcon, $sUserUnit, $sUserUnitWoInfo) = $this->_getAuthorInfo($aUser['id']); + $aTmplUsers[] = [ + 'style_prefix' => $this->_sStylePrefix, + 'user_name' => $sUserName, + 'user_link' => $sUserLink, + 'user_unit' => $sUserUnitWoInfo, + 'vote' => $this->_getLabelDo($aUser['vote_type'], $aParams), + 'date' => bx_time_js($aUser['vote_date']), + ]; + } + + if(empty($aTmplUsers)) + $aTmplUsers = MsgBox(_t('_Empty')); + + return $this->_oTemplate->parseHtmlByName($this->_sTmplNameByList, [ + 'style_prefix' => $this->_sStylePrefix, + 'bx_repeat:list' => $aTmplUsers + ]); + } + + protected function _isShowDoVote($aParams, $isAllowedVote, $bCount) + { + $bShowDoVote = !isset($aParams['show_do_vote']) || (bool)$aParams['show_do_vote'] === true; + + return $bShowDoVote && ($isAllowedVote || $bCount); + } + + protected function _isShowCounter($aParams, $isAllowedVote, $isAllowedVoteView, $bCount) + { + return isset($aParams['show_counter']) && (bool)$aParams['show_counter'] === true && $isAllowedVoteView && ($isAllowedVote || $bCount); + } + + protected function _isShowLegend($aParams, $isAllowedVote, $isAllowedVoteView, $bCount) + { + return isset($aParams['show_legend']) && (bool)$aParams['show_legend'] === true && $isAllowedVoteView; + } +} + +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseSearch.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseSearch.php new file mode 100644 index 0000000000..7d62213d47 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseSearch.php @@ -0,0 +1,175 @@ +_oTemplate = $oTemplate ? $oTemplate : BxDolTemplate::getInstance(); + + $this->_sIdLoading = $this->_sIdForm; + + $this->_iSearchLenth = (int)getParam('sys_live_search_limit'); + $this->_sSearchFunctionParams = "%d, '%s', '%s', '%s', %d, %d"; + } + + public function setLiveSearch($bLiveSearch) + { + parent::setLiveSearch($bLiveSearch); + + if($this->_bLiveSearch) { + $this->_sIdForm .= $this->_sSuffixLiveSearch; + $this->_sIdResults .= $this->_sSuffixLiveSearch; + $this->_sIdLoading = $this->_sIdResults; + } + } + + public function getForm($iDesignBoxTemplate = BX_DB_PADDING_DEF, $sTitle = false, $bOnlyForm = false) + { + if ($this->_sMetaType || $this->_sCategoryObject) + return ''; + + if (false === $sTitle) + $sTitle = _t( "_Search"); + + $aSection = ''; + if (bx_get('type')) + $aSection = bx_process_input(bx_get('type')); + else if (bx_get('section')) + $aSection = bx_process_input(bx_get('section')); + + $aForm = $this->_getForm([ + 'section' => $aSection, + 'keyword' => bx_get('keyword') ? bx_process_input(bx_get('keyword')) : '' + ]); + + $oForm = new BxTemplFormView($aForm); + $sForm = $oForm->getCode(); + + if (!$this->_bLiveSearch) { + $o = new BxTemplPaginate(array()); + $o->addCssJs(); + } + if ($bOnlyForm) + return $sForm; + + return $this->_oTemplate->parseHtmlByName('designbox_container.html', array( + 'class_add' => '', + 'bx_if:show_html_id' => array( + 'condition' => false, + 'content' => array(), + ), + 'content' => DesignBoxContent($sTitle, $sForm, $iDesignBoxTemplate) + )); + } + + public function getResultsContainer($sCode = '') + { + return $this->_oTemplate->parseHtmlByName('search_result.html', [ + 'html_id' => $this->_sIdResults, + 'class' => str_replace('_', '-', $this->_sIdResults), + 'content' => $sCode + ]); + } + + protected function _getForm($aValues = array()) + { + $aForm = array( + 'form_attrs' => array( + 'id' => $this->_sIdForm, + 'action' => BX_DOL_URL_ROOT . 'searchKeyword.php', + 'method' => 'post', + ), + 'params' => array( + 'csrf' => array( + 'disable' => true, + ), + ), + 'inputs' => array( + 'live_search' => array( + 'type' => 'hidden', + 'name' => 'live_search', + 'value' => $this->_bLiveSearch ? 1 : 0, + ), + 'section' => array( + 'type' => 'select', + 'name' => 'section', + 'caption' => _t('_Section'), + 'values' => array_merge(array('' => _t('_search_in_all_section')), $this->getKeyTitlesPairs()), + 'value' => $aValues['section'], + ), + 'keyword' => array( + 'type' => 'text', + 'name' => 'keyword', + 'caption' => _t('_Keyword'), + 'value' => $aValues['keyword'], + ), + 'search' => array( + 'type' => 'submit', + 'name' => 'search', + 'value' => _t('_Search'), + ) + ) + ); + + if ($this->_bLiveSearch) { + $sJsParams = sprintf($this->_sSearchFunctionParams, $this->_iSearchLenth, '#' . $this->_sIdForm, '#' . $this->_sIdResults, '#' . $this->_sIdLoading, $this->_bLiveSearch, (int)getParam('sys_search_keyword_min_len')); + + unset($aForm['inputs']['section']); + unset($aForm['inputs']['search']); + unset($aForm['inputs']['keyword']['caption']); + $aForm['inputs']['keyword']['attrs']['placeholder'] = _t('_sys_search' . (BxDolAI::getAssistantForLiveSearch() ? '_or_ask' : '') . '_placeholder'); + $aForm['inputs']['keyword']['attrs']['onkeydown'] = "return bx_search_on_type(event, $sJsParams);"; + $aForm['inputs']['keyword']['attrs']['onpaste'] = $aForm['inputs']['keyword']['attrs']['onkeydown']; + } + + /** + * @hooks + * @hookdef hook-search-get_form 'search', 'get_form' - hook in create search form + * - $unit_name - equals `search` + * - $action - equals `get_form` + * - $object_id - not used + * - $sender_id - not used + * - $extra_params - array of additional params with the following array keys: + * - `object` - [object] current search object + * - `override_result` - [array] by ref, form arrray defenition, can be overridden in hook processing + * @hook @ref hook-search-get_form + */ + bx_alert('search', 'get_form', 0, 0, array('object' => $this, 'override_result' => &$aForm)); + + return $aForm; + } + + protected function getKeyTitlesPairs () + { + $a = array(); + foreach ($this->aClasses as $sKey => $r) + if ($this->_sMetaType || $r['GlobalSearch']) + $a[$sKey] = _t($r['title']); + return $a; + } +} + +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseSearchExtended.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseSearchExtended.php new file mode 100644 index 0000000000..256b78e711 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseSearchExtended.php @@ -0,0 +1,435 @@ +_oTemplate = $oTemplate; + else if(!empty($this->_aObject['module'])) + $this->_oTemplate = BxDolModule::getInstance($this->_aObject['module'])->_oTemplate; + else + $this->_oTemplate = BxDolTemplate::getInstance(); + + $this->_sFormClassName = ''; + $this->_sFormClassPath = ''; + + $this->_oForm = null; + + $this->_bJsMode = false; + + $this->_iAgeMin = 1; + $this->_iAgeMax = 75; + } + + public function getForm($aParams = array()) + { + if(!$this->isEnabled()) + return ''; + + $oForm = $this->prepareForm($aParams); + + return bx_is_api() ? bx_api_get_block('form', $oForm->getCodeAPI(), ['id' => 2, 'ext' => ['name' => $this->_aObject['module'] . '_serach', 'request' => ['url' => '/api.php?r=system/get_form/TemplSearchExtendedServices¶ms[]=' . $this->_aObject['module'], 'immutable' => true]]]) : $oForm->getCode(); + } + + public function getResultsAPI($aData, $iPerPage, $iStart, $aParamsSearch = '') + { + return bx_api_get_block('browse', [ + 'nocache' => true, + 'module' => $this->_aObject['module'], + 'unit' => 'general-content-list', + 'request_url' => '/api.php?r=system/get_results/TemplSearchExtendedServices¶ms[]=', + 'data' => defined('BX_API_PAGE') ? [] : $aData, + 'params' => ['per_page' => $iPerPage, 'start' => $iStart, 'object' => $this->_aObject['module'], 'search_params' => $aParamsSearch], + ]); + } + + /** + * Get search results from search form or from custom condition + * + * @param $aParams['cond'] custom condition to pass instead of form submission, + * conditions are key&value pair, where 'key' is form input name and + * 'value' is the term to search for + * @param $aParams['start'] position of first record to display + * @param $aParams['per_page'] number of items per page + * @param $aParams['template'] custom unit templates to use + * @return HTML string with search results + */ + public function getResults($aParams = array()) + { + if(!$this->isEnabled()) + return ''; + + $bJsMode = isset($aParams['js_mode']) ? (bool)$aParams['js_mode'] : $this->_bJsMode; + $bCondition = !empty($aParams['cond']) && is_array($aParams['cond']); + + $iStart = !empty($aParams['start']) ? $aParams['start'] : 0; + $iPerPage = !empty($aParams['per_page']) ? $aParams['per_page'] : 0; + unset($aParams['start'], $aParams['per_page']); + + $sUnitTemplate = !empty($aParams['template']) ? $aParams['template'] : ''; + + $oForm = $this->prepareForm($aParams); + if($bCondition) { + $mixedSubmitName = $oForm->aParams['db']['submit_name']; + if(is_array($mixedSubmitName)) + $mixedSubmitName = array_pop($mixedSubmitName); + $aParams['cond'][$mixedSubmitName] = 1; + + $oForm->aFormAttrs['method'] = BX_DOL_FORM_METHOD_SPECIFIC; + $oForm->aParams['csrf']['disable'] = true; + + $oForm->initChecker(array(), $aParams['cond']); + } + + if(!$oForm->isSubmittedAndValid() && !$this->_bFilterMode && (!$this->_bIsApi || !isset($aParams['search_params']))) + return ''; + + $oContentInfo = BxDolContentInfo::getObjectInstance($this->_aObject['object_content_info']); + + if(!$oContentInfo) + return ''; + + $aParamsSearch = []; + if(empty($aParams['search_params'])) { + foreach($this->_aObject['fields'] as $aField) { + $mixedValue = $oForm->getCleanValue($aField['name']); + if(empty($mixedValue) || (is_array($mixedValue) && bx_is_empty_array($mixedValue))) + continue; + + $aParamsSearch[$aField['name']] = array( + 'type' => $aField['search_type'], + 'value' => $mixedValue, + 'operator' => $aField['search_operator'] + ); + + if(!$bCondition) { + if(!isset($aParams['cond'])) + $aParams['cond'] = array(); + + switch($oForm->aInputs[$aField['name']]['type']) { + case 'location': + case 'location_radius': + $aParams['cond'][$aField['name']] = $mixedValue['string']; + + $aLocationComponents = BxDolMetatags::locationsParseComponents($mixedValue['array'], $aField['name']); + if($oForm->aInputs[$aField['name']]['type'] == 'location_radius' && count($mixedValue['array']) > count($aLocationComponents)) + $aLocationComponents[$aField['name'] . '_rad'] = array_pop($mixedValue['array']); + + $aParams['cond'] = array_merge($aParams['cond'], $aLocationComponents); + break; + + default: + $aParams['cond'][$aField['name']] = $mixedValue; + } + } + } + } + else + $aParamsSearch = $aParams['search_params']; + + if((empty($aParamsSearch) || !is_array($aParamsSearch)) && !$this->_bFilterMode) + return $this->_bIsApi ? bx_api_get_msg(_t('Not Found'), ['ext' => ['msg_type' => 'result']]) : ''; + + if (!$iPerPage) { + bx_import('BxDolSearch'); + $iPerPage = BX_DOL_SEARCH_RESULTS_PER_PAGE_DEFAULT; + } + + $aResults = false; + + if (bx_get('sort')){ + $aTmp = explode(':', bx_get('sort')); + $aParamsSearch['order'] = [['field' => $aTmp[0], 'direction' => $aTmp[1]]]; + } + + /** + * @hooks + * @hookdef hook-search-get_data 'search', 'get_data' - hook in get data for serach + * - $unit_name - equals `search` + * - $action - equals `get_data` + * - $object_id - not used + * - $sender_id - not used + * - $extra_params - array of additional params with the following array keys: + * - `object` - [array] by ref, object info for current search, can be overridden in hook processing + * - `search_params` - [string] by ref, search params, can be overridden in hook processing + * - `search_results` - [string] by ref, html for block, can be overridden in hook processing + * @hook @ref hook-search-get_data + */ + bx_alert('search', 'get_data', 0, false, array('object' => $this->_aObject, 'search_params' => &$aParamsSearch, 'search_results' => &$aResults)); + + if($aResults === false) + $aResults = $oContentInfo->getSearchResultExtended($aParamsSearch, $iStart, $iPerPage + 1, $this->_bFilterMode); + + if(empty($aResults) || !is_array($aResults)) + return $this->_bIsApi ? [bx_api_get_msg(_t('Nothing found'), ['ext' => ['msg_type' => 'result']])] : _t('Nothing found'); + + if(!empty($aParams['cond']) && is_array($aParams['cond'])) + $aParams['cond'] = self::encodeConditions($aParams['cond']); + + $aPaginate = ['start' => $iStart, 'per_page' => $iPerPage]; + if(!empty($aParams['total'])) { + if(is_numeric($aParams['total'])) + $aPaginate['total'] = (int)$aParams['total']; + else + $aPaginate['total'] = count($oContentInfo->getSearchResultExtended($aParamsSearch, 0, 0, $this->_bFilterMode)); + } + + if(!$bJsMode) { + $aParams['start'] = '{start}'; + $aParams['per_page'] = '{per_page}'; + + list($sPageLink, $aPageParams) = bx_get_base_url_inline($aParams); + if(!$this->_bIsApi) + $aPaginate['page_url'] = BxDolPermalinks::getInstance()->permalink(bx_append_url_params($sPageLink, $aPageParams, true, ['{start}', '{per_page}'])); + } + else + $aPaginate['on_change_page'] = "return !loadDynamicBlockAutoPaginate(this, '{start}', '{per_page}', " . bx_js_string(json_encode($aParams)) . ");"; + + $oPaginate = new BxTemplPaginate($aPaginate); + $oPaginate->setNumFromDataArray($aResults); + + $bTmplVarsPaginate = $iStart || $oPaginate->getNum() > $iPerPage; + $aTmplVarsPaginate = $bTmplVarsPaginate ? array('paginate' => $oPaginate->getSimplePaginate()) : array(); + + $mixedResults = $this->_bIsApi ? [] : ''; + foreach($aResults as $iId) { + $mixedResult = $oContentInfo->getContentSearchResultUnit($iId, $sUnitTemplate); + + if($this->_bIsApi) + $mixedResults[] = $mixedResult; + else + $mixedResults .= $mixedResult; + } + + if($this->_bIsApi) { + if(isset($aParams['search_params'])) + return [$this->getResultsAPI($mixedResults, $iPerPage, $iStart, $aParamsSearch)]; + else + return [$this->getResultsAPI($mixedResults, $iPerPage, $iStart, $aParamsSearch)]; + } + + $aTxtDirection = [ + 'asc' => _t('_order_asc'), + 'desc' => _t('_order_desc') + ]; + + $sSort = ''; + if($mixedResults != '') { + $aData = $this->_aObject['sortable_fields']; + + $aValues = []; + foreach($aData as $aField) { + if ($aField['active'] == 0) + continue; + + $sLangKey = $aField['caption'] . '_' . $aField['direction']; + $sLangVal = _t($sLangKey); + + $aValues[$aField['name'] . ':' . $aField['direction']] = strcmp($sLangKey, $sLangVal) != 0 ? $sLangVal : _t($aField['caption']) . ' ' . $aTxtDirection[$aField['direction']]; + } + + if (!empty($aValues)){ + $aValues = array_merge(['' => _t('_sys_txt_search_sort_by_default')], $aValues); + } + $oForm = new BxTemplFormView(array()); + + $sOnChange = ''; + if(!$bJsMode) { + unset($aParams['start']); + unset($aParams['per_page']); + list($sPageLink, $aPageParams) = bx_get_base_url_inline($aParams); + $sOnChange = "bx_search_extnded_sort(this,'" . BxDolPermalinks::getInstance()->permalink(bx_append_url_params($sPageLink, $aPageParams)) . "')"; + } + else{ + $sOnChange = "return !loadDynamicBlockAutoSort(this, $(this).val()," . bx_js_string(json_encode($aParams)) . ");"; + } + + $sSort = ''; + if (!empty($aValues)){ + $aInputSort = array( + 'type' => 'select', + 'name' => 'sort', + 'value' => bx_get('sort') ? bx_get('sort') : '', + 'values' => $aValues, + 'caption' => _t('_sys_txt_search_sort_by'), + 'attrs' => array( + 'onChange' => $sOnChange, + ), + 'tr_attrs' => array( + 'class' => 'sort' + ) + ); + $sSort = $oForm->genRow($aInputSort); + } + } + + return $this->_oTemplate->parseHtmlByName('search_extended_results.html', [ + 'class' => str_replace('_', '-', $this->_sObject), + 'sort' => $sSort, + 'code' => $mixedResults, + 'bx_if:show_paginate' => [ + 'condition' => $bTmplVarsPaginate, + 'content' => $aTmplVarsPaginate + ] + ]); + } + + protected function &prepareForm($aParams = array()) + { + if(!empty($this->_oForm) && $this->_oForm instanceof BxDolForm) + return $this->_oForm; + + $sForm = 'sys_search_extended_' . $this->_sObject; + $sFormSubmit = 'search' . $this->_sObject; + + list($sPageLink, $aPageParams) = bx_get_base_url_inline(); + + $mDefValues = bx_get('filters'); + + if ($mDefValues){ + $mDefValues = json_decode($mDefValues, true); + } + + $aForm = array( + 'form_attrs' => array( + 'id' => $sForm, + 'name' => $sForm, + 'action' => BxDolPermalinks::getInstance()->permalink(bx_append_url_params($sPageLink, array('i' => $aPageParams['i']))), + 'method' => 'post' + ), + 'params' => array( + 'db' => array( + 'table' => '', + 'key' => '', + 'uri' => '', + 'uri_title' => '', + 'submit_name' => $sFormSubmit + ), + 'checker_helper' => 'BxBaseSearchExtendedFormCheckerHelper', + ), + 'inputs' => array() + ); + + foreach ($this->_aObject['fields'] as $aField) { + if((int)$aField['active'] == 0) + continue; + + if(in_array($aField['search_type'], array('checkbox_set', 'select_multiple'))) { + if(isset($aField['values'][''])) + unset($aField['values']['']); + + if(isset($aField['values'][0]) && !is_array($aField['values'][0])) + unset($aField['values'][0]); + } + + $aAttrs = array(); + + if(in_array($aField['search_type'], array('datepicker_range_age')) && !empty($aField['search_value'])) { + $aFieldParams = BxDolService::callSerialized($aField['search_value']); + $iMin = isset($aFieldParams['min']) && is_numeric($aFieldParams['min']) ? $aFieldParams['min'] : $this->_iAgeMin; + $iMax = isset($aFieldParams['max']) && is_numeric($aFieldParams['max']) ? $aFieldParams['max'] : $this->_iAgeMax; + + $aField['search_value'] = $iMin . '-' . $iMax; + $aAttrs = array('min' => $iMin, 'max' => $iMax, 'step' => 1); + } + + if(in_array($aField['search_type'], array('datepicker_range')) && !empty($aField['search_value'])) { + $aField['search_value'] = ''; + } + + $aForm['inputs'][$aField['name']] = array( + 'type' => $aField['search_type'], + 'name' => $aField['name'], + 'caption' => _t($aField['caption']), + 'info' => _t($aField['info']), + 'values' => $aField['values'], + 'value' => $aField['search_value'] == '' && isset($mDefValues) && isset($mDefValues[$aField['name']]) ? $mDefValues[$aField['name']] : $aField['search_value'], + 'attrs' => $aAttrs, + 'db' => array( + 'pass' => 'datepicker_range_age' === $aField['search_type'] ? 'AgeRange' : (!empty($aField['pass']) ? $aField['pass'] : 'Xss') + ) + ); + + if(in_array($aField['search_type'], array('location', 'location_radius'))) + $aForm['inputs'][$aField['name']]['manual_input'] = true; + } + + $aForm['inputs']['search'] = array( + 'type' => 'submit', + 'name' => $sFormSubmit, + 'value' => _t($this->_bFilterMode ? '_Apply' : '_Search') + ); + + $sClass = 'BxTemplSearchExtendedForm'; + if(!empty($this->_sFormClassName)) { + $sClass = $this->_sFormClassName; + if(!empty($this->_sFormClassPath)) + require_once(BX_DIRECTORY_PATH_ROOT . $this->_sFormClassPath); + } + + $bJsMode = isset($aParams['js_mode']) ? (bool)$aParams['js_mode'] : $this->_bJsMode; + $bCondition = !empty($aParams['cond']) && is_array($aParams['cond']); + $aValues = !$bJsMode && $bCondition ? $aParams['cond'] : array(); + + $this->_oForm = new $sClass($aForm, $this->_oTemplate); + $this->_oForm->initChecker($aValues, $aValues); + + return $this->_oForm; + } +} + +class BxBaseSearchExtendedFormCheckerHelper extends BxDolFormCheckerHelper +{ + static public function passAgeRange ($s) + { + if (is_array($s)) { + $a = array (); + foreach ($s as $k => $v) + $a[$k] = self::_passAgeRange ($v); + return $a; + } + return self::_passAgeRange ($s); + } + + static public function _passAgeRange ($s) + { + $a = explode ('-', $s); + if (!$a || count($a) != 2) + return $s; + $i0 = new \DateInterval("P".(int)$a[0]."Y"); + $i1 = new \DateInterval("P".(int)$a[1]."Y"); + + return [ + (new DateTime("now", new DateTimeZone('UTC')))->sub($i1)->format("Y-m-d"), + (new DateTime("now", new DateTimeZone('UTC')))->sub($i0)->format("Y-m-d"), + ]; + } +} + +/** @} */ \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseSearchExtendedServices.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseSearchExtendedServices.php new file mode 100644 index 0000000000..b525dd19f5 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseSearchExtendedServices.php @@ -0,0 +1,117 @@ +prepareParams($aParams); + + if(empty($aParams['object'])) + return ''; + + $oSearch = BxDolSearchExtended::getObjectInstance($aParams['object']); + if(!$oSearch || !$oSearch->isEnabled()) + return ''; + + $mForm = $oSearch->getForm($aParams); + if(bx_is_api()) + $mForm = [$mForm]; + + return $mForm; + } + + public function serviceGetResults($mParams) + { + $aParams = []; + $fProcessDefValues = function($aValues) { + if(empty($aValues) || !is_array($aValues)) + return; + + foreach($aValues as $sKey => $sValue) { + if(empty($sValue)) + continue; + + $_POST[$sKey] = $sValue; + } + }; + + if(($mDefValues = bx_get('filters')) !== false) + $fProcessDefValues(json_decode($mDefValues, true)); + + if(is_string($mParams)) { + $mParams = json_decode($mParams, true); + if(!empty($mParams['params']) && is_array($mParams['params'])) + $aParams = $mParams['params']; + + if(isset($aParams['filters'])) + $fProcessDefValues($aParams['filters']); + } + else + $aParams = $mParams; + + $this->prepareParams($aParams); + + if(empty($aParams['object'])) + return ''; + + $oSearch = BxDolSearchExtended::getObjectInstance($aParams['object']); + if(!$oSearch || !$oSearch->isEnabled()) + return ''; + + $sResults = $oSearch->getResults($aParams); + + if (bx_is_api()){ + return $sResults; + } + + return !empty($sResults) ? $sResults : (isset($aParams['show_empty']) && (bool)$aParams['show_empty'] ? MsgBox(_t('_Empty')) : ''); + } + + public function prepareParams(&$aParams) + { + if(empty($aParams['object']) && bx_get('object') !== false) + $aParams['object'] = bx_process_input(bx_get('object'), BX_DATA_TEXT); + + if(!isset($aParams['show_empty']) && bx_get('show_empty') !== false) + $aParams['show_empty'] = (bool)bx_get('show_empty'); + + if(empty($aParams['template']) && bx_get('template') !== false) + $aParams['template'] = bx_process_input(bx_get('template'), BX_DATA_TEXT); + + if(empty($aParams['cond']) && bx_get('cond') !== false) + $aParams['cond'] = BxDolSearchExtended::decodeConditions(bx_process_input(bx_get('cond'), BX_DATA_TEXT)); + + if(!isset($aParams['start']) && bx_get('start') !== false) + $aParams['start'] = (int)bx_get('start'); + + if(!isset($aParams['per_page']) && bx_get('per_page') !== false) + $aParams['per_page'] = (int)bx_get('per_page'); + + if(!isset($aParams['total']) && ($mixedTotal = bx_get('total')) !== false) + $aParams['total'] = is_numeric($mixedTotal) ? (int)$mixedTotal : $mixedTotal == 'true'; + } +} + +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseServiceAccount.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseServiceAccount.php new file mode 100644 index 0000000000..10e57df32c --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseServiceAccount.php @@ -0,0 +1,895 @@ +_oAccountForms = new BxTemplAccountForms(); + $this->_oAccountQuery = BxDolAccountQuery::getInstance(); + } + + /** + * @page service Service Calls + * @section bx_system_general System Services + * @subsection bx_system_general-account Account + * @subsubsection bx_system_general-create_account_form create_account_form + * + * @code bx_srv('system', 'create_account_form', [], 'TemplServiceAccount'); @endcode + * @code {{~system:create_account_form:TemplServiceAccount[{"no_login_text":true, "no_auth_buttons":true}]~}} @endcode + * + * Join form. + * @param $aParams array of additional params, such as: + * - no_login_text + * - no_auth_buttons + * + * @see BxBaseServiceAccount::serviceGetCreatePostForm + */ + /** + * @ref bx_system_general-create_account_form "create_account_form" + */ + public function serviceCreateAccountForm ($aParams = array()) + { + $bApi = bx_is_api(); + + if (isLogged() && 'create-account' == bx_get('i')) { + if (!$bApi) { + header('Location: ' . BX_DOL_URL_ROOT); + exit; + } + else + return [ + ['id' => 2, 'type' => 'redirect', 'data' => ['uri' => '/']], + ]; + } + + if($bApi) { + $mixedResult = $this->_oAccountForms->createAccountForm($aParams); + if(is_array($mixedResult)) + return [bx_api_get_block('form', $mixedResult, [ + 'ext' => [ + 'request' => ['url' => '/api.php?r=system/create_account_form/TemplServiceAccount', 'immutable' => true] + ] + ])]; + else if($mixedResult === true){ + $sRedirectUrl = BxDolForm::getSubmittedValue('relocate','post'); + if(empty($sRedirectUrl)){ + $sRedirectUrl = '/'; + } + else{ + $parts = parse_url($sRedirectUrl); + parse_str($parts['query'], $query); + unset($query['_q']); + $parts['query'] = http_build_query($query); + $sRedirectUrl = $parts['path'] . (!empty($parts['query']) ? '?' . $parts['query'] : ''); + } + return [ + bx_api_get_block('redirect', ['uri' => $sRedirectUrl]), + //bx_api_get_block('login', ['session' => BxDolSession::getInstance()->getId()], ['id' => 2]), + ]; + } + else + return [bx_api_get_msg($mixedResult)]; + } + + $oPemalink = BxDolPermalinks::getInstance(); + + if (isset($_SERVER['HTTP_REFERER']) && 0 === mb_stripos($_SERVER['HTTP_REFERER'], BX_DOL_URL_ROOT)) { // remember referrer + $sJoinReferrer = $_SERVER['HTTP_REFERER']; + $aNoRelocatePages = array('forgot-password', 'login', 'create-account', 'logout'); + foreach ($aNoRelocatePages as $s) { + if (false !== mb_stripos($sJoinReferrer, $s)) { + $sJoinReferrer = ''; + break; + } + } + if ($sJoinReferrer) + BxDolSession::getInstance()->setValue('join-referrer', $sJoinReferrer); + } + + $aTmplVarsAuth = []; + if(!isset($aParams['no_auth_buttons']) || false === (bool)$aParams['no_auth_buttons']) + $aTmplVarsAuth['content'] = BxDolService::call('system', 'member_auth_code', array(), 'TemplServiceLogin'); + + $aTmplVarsForm = []; + if(!(bool)getParam('sys_account_disable_join_form')) + $aTmplVarsForm['content'] = $this->_oAccountForms->createAccountForm($aParams); + + $aTmplVarsLogin = []; + if(!isset($aParams['no_login_text']) || false === (bool)$aParams['no_login_text']) + $aTmplVarsLogin['url'] = bx_absolute_url($oPemalink->permalink('page.php?i=login')); + + return BxDolTemplate::getInstance()->parseHtmlByName('block_join.html', [ + 'bx_if:show_auth' => [ + 'condition' => !empty($aTmplVarsAuth), + 'content' => $aTmplVarsAuth + ], + 'bx_if:show_form' => [ + 'condition' => !empty($aTmplVarsForm), + 'content' => $aTmplVarsForm, + ], + 'bx_if:show_login' => [ + 'condition' => !empty($aTmplVarsLogin), + 'content' => $aTmplVarsLogin + ], + 'agreement' => _t('_sys_form_account_input_agreement_value', bx_absolute_url($oPemalink->permalink('page.php?i=terms')), bx_absolute_url($oPemalink->permalink('page.php?i=privacy'))), + ]); + } + + public function serviceAccountSettingsEmail ($iAccountId = false) + { + if (false === $iAccountId) + $iAccountId = getLoggedId(); + + $bApi = bx_is_api(); + + $mixedResult =$this->_oAccountForms->editAccountEmailSettingsForm($iAccountId); + + if($bApi) { + if(is_array($mixedResult)){ + if (isset($mixedResult['form'] )){ + return [ + bx_api_get_msg($mixedResult['msg']), + bx_api_get_block('form', $mixedResult['form'], [ + 'ext' => [ + 'request' => ['url' => '/api.php?r=system/account_settings_email/TemplServiceAccount', 'immutable' => true] + ] + ])]; + } + else{ + return [bx_api_get_block('form', $mixedResult, [ + 'ext' => [ + 'request' => ['url' => '/api.php?r=system/account_settings_email/TemplServiceAccount', 'immutable' => true] + ] + ])]; + } + } + else + return [bx_api_get_msg($mixedResult)]; + } + + return $mixedResult; + } + + public function serviceAccountSettingsPassword ($iAccountId = false) + { + if (false === $iAccountId) + $iAccountId = getLoggedId(); + + $bApi = bx_is_api(); + + $mixedResult =$this->_oAccountForms->editAccountPasswordSettingsForm($iAccountId); + if($bApi) { + if(is_array($mixedResult)){ + if (isset($mixedResult['form'] )){ + return [ + bx_api_get_msg($mixedResult['msg']), + bx_api_get_block('form', $mixedResult['form'], [ + 'ext' => [ + 'request' => ['url' => '/api.php?r=system/account_settings_password/TemplServiceAccount', 'immutable' => true] + ] + ])]; + } + else{ + return [bx_api_get_block('form', $mixedResult, [ + 'ext' => [ + 'request' => ['url' => '/api.php?r=system/account_settings_password/TemplServiceAccount', 'immutable' => true] + ] + ])]; + } + } + else + return [bx_api_get_msg($mixedResult)]; + } + + return $mixedResult; + } + + public function serviceAccountSettingsInfo ($iAccountId = false) + { + if (false === $iAccountId) + $iAccountId = getLoggedId(); + + $bApi = bx_is_api(); + + $mixedResult =$this->_oAccountForms->editAccountInfoForm($iAccountId); + + if($bApi) { + if(is_array($mixedResult)){ + if (isset($mixedResult['form'] )){ + return [ + bx_api_get_msg($mixedResult['msg']), + bx_api_get_block('form', $mixedResult['form'], [ + 'ext' => [ + 'request' => ['url' => '/api.php?r=system/account_settings_info/TemplServiceAccount', 'immutable' => true] + ] + ])]; + } + else{ + return [bx_api_get_block('form', $mixedResult, [ + 'ext' => [ + 'request' => ['url' => '/api.php?r=system/account_settings_info/TemplServiceAccount', 'immutable' => true] + ] + ])]; + } + } + else + return [bx_api_get_msg($mixedResult)]; + } + return $mixedResult; + } + + public function serviceAccountSettingsDelAccount ($iAccountId = false) + { + if (!$iAccountId) + $iAccountId = bx_process_input(bx_get('id'), BX_DATA_INT); + if (!$iAccountId) + $iAccountId = getLoggedId(); + + $bApi = bx_is_api(); + + $mixedResult = $this->_oAccountForms->deleteAccountForm($iAccountId); + + if($bApi) { + if(is_array($mixedResult)){ + if (isset($mixedResult['form'] )){ + return [ + bx_api_get_msg($mixedResult['msg']), + bx_api_get_block('form', $mixedResult['form'], [ + 'ext' => [ + 'request' => ['url' => '/api.php?r=system/account_settings_del_account/TemplServiceAccount', 'immutable' => true] + ] + ])]; + } + else{ + return [bx_api_get_block('form', $mixedResult, [ + 'ext' => [ + 'request' => ['url' => '/api.php?r=system/account_settings_del_account/TemplServiceAccount', 'immutable' => true] + ] + ])]; + } + } + else if(is_string($mixedResult)) + return [ + bx_api_get_msg($mixedResult) + ]; + else + return []; + } + + return $mixedResult; + } + + /** + * Display unsubscribe from newsletters form + */ + public function serviceUnsubscribeNews() + { + return $this->_unsubscribeForm('sys_unsubscribe_news'); + } + + /** + * Display unsubscribe from notifications form + */ + public function serviceUnsubscribeNotifications() + { + return $this->_unsubscribeForm('sys_unsubscribe_updates'); + } + + /** + * Display confirmation statuses list + */ + public function serviceGetConfirmationTypes() + { + $aResult = array(); + $aChoices = array(BX_ACCOUNT_CONFIRMATION_NONE, BX_ACCOUNT_CONFIRMATION_EMAIL, BX_ACCOUNT_CONFIRMATION_PHONE, BX_ACCOUNT_CONFIRMATION_EMAIL_PHONE, BX_ACCOUNT_CONFIRMATION_EMAIL_OR_PHONE); + foreach($aChoices as $sChoice) + $aResult[$sChoice] = _t('_sys_acc_confirmation_type_' . $sChoice); + + return $aResult; + } + + protected function _unsubscribeForm($sDisplay) + { + $iAccountId = bx_process_input(bx_get('id')); + $sCode = bx_process_input(bx_get('code')); + + // validate input params + + $oAccount = BxDolAccount::getInstance($iAccountId); + if (!$oAccount) + return MsgBox(_t('_sys_txt_unsubscribe_wrong_link')); + + if ($sCode != $oAccount->getEmailHash()) + return MsgBox(_t('_sys_txt_unsubscribe_wrong_link')); + + $oForm = BxDolForm::getObjectInstance('sys_unsubscribe', $sDisplay); + if (!$oForm) + return MsgBox(_t('_sys_txt_unsubscribe_error_occured')); + + // show form + + $aAccountInfo = $oAccount->getInfo(); + $aAccountInfo['code'] = $sCode; + $oForm->initChecker($aAccountInfo); + + if ($oForm->isSubmittedAndValid()) { + + if (!$oForm->update($oAccount->id())) + return MsgBox(_t('_sys_txt_unsubscribe_error_occured')); + + return MsgBox(_t('_sys_txt_unsubscribe_email_settings_update_success')); + } + + return '' . _t("_sys_txt_unsubscribe_info", $aAccountInfo['email']) . '' . $oForm->getCode(); + } + + /** + * Display email confirmation form, if confirmation code is provided then try to confirm profile + */ + public function serviceEmailConfirmation($sMsg = false) + { + $bApi = bx_is_api(); + // if user is logged in and email is confirmed then just display a message + if (isLogged() && !bx_get('code')) { + $oAccount = BxDolAccount::getInstance(); + if ($oAccount->isConfirmedEmail()) + return $bApi ? [bx_api_get_msg(_t("_sys_txt_confirm_email_already_confirmed"))] : MsgBox(_t("_sys_txt_confirm_email_already_confirmed")); + } + + // if confirmation code is provided in the URL - perform email confirmation right away + if (bx_get('code') !== false) + return $this->confirmEmail(bx_process_input(bx_get('code'))); + + // if user requested to resend verification letter then send letter and display message + if (bx_process_input(bx_get('resend')) && isLogged()) { + $oAccount = BxDolAccount::getInstance(); + if ($oAccount->sendConfirmationEmail()) + $sMsg = _t('_sys_txt_confirm_email_sent'); + else + $sMsg = _t('_sys_txt_confirm_email_sent_failed'); + return $bApi ? [bx_api_get_msg($sMsg)] : MsgBox($sMsg); + } + + // show and process code verification form + + $oForm = BxDolForm::getObjectInstance('sys_confirm_email', 'sys_confirm_email'); + if (!$oForm) + return $bApi ? [bx_api_get_msg(_t("_sys_txt_confirm_email_error_occured"))] : MsgBox(_t("_sys_txt_confirm_email_error_occured")); + + $oForm->initChecker(); + + if ($oForm->isSubmittedAndValid()) { + + $oKey = BxDolKey::getInstance(); + if (!$oKey){ + return $bApi ? [bx_api_get_msg(_t("_sys_txt_confirm_email_error_occured"))] : MsgBox(_t("_sys_txt_confirm_email_error_occured")); + } + else{ + $oRv = $this->confirmEmail(trim($oForm->getCleanValue('code'))); + if (!$bApi) + return $oRv; + + return $oRv; + } + + } + + if ($bApi){ + return [bx_api_get_block('form', $oForm->getCodeAPI(), [ + 'ext' => [ + 'request' => ['url' => '/api.php?r=system/email_confirmation/TemplServiceAccount', 'immutable' => true] + ] + ])]; + } + + return '' . _t("_sys_txt_confirm_email_desc") . '' . $oForm->getCode(); + } + + /** + * Display phone confirmation forms, if confirmation code is provided then try to confirm profile + */ + public function servicePhoneConfirmation($sMsg = false) + { + // if user is logged in and phone is confirmed then just display a message + if (isLogged()) { + $oAccount = BxDolAccount::getInstance(); + if ($oAccount->isConfirmedPhone()) + return MsgBox(_t("_sys_txt_confirm_phone_already_confirmed")); + + $iStep = 1; + $a = $oAccount->getInfo(); + $sPhoneNumber = $a['phone']; + + $oSession = BxDolSession::getInstance(); + if ($sPhoneNumber != "" && $oSession->isValue(BX_ACCOUNT_SESSION_KEY_FOR_PHONE_ACTIVATEION_CODE)) + $iStep = 2; + + if (bx_get('step')) + $iStep = (int)bx_get('step'); + + // show and process phone set form + if ($iStep == 1){ + $oForm = BxDolForm::getObjectInstance('sys_confirm_phone', 'sys_confirm_phone_set_phone'); + if (!$oForm) + return MsgBox(_t("_sys_txt_confirm_phone_set_phone_error_occured")); + + $oForm->initChecker(['phone' => $sPhoneNumber]); + if ($oForm->isSubmittedAndValid()) { + $sPhoneNumber = trim($oForm->getCleanValue('phone')); + $oAccount->updatePhone($sPhoneNumber); + + $sActivationCode = rand(1000, 9999); + $sActivationText =_t('_sys_txt_confirm_phone_sms_text', $sActivationCode); + $mixedResult = null; + /** + * @hooks + * @hookdef hook-account-before_confirm_phone_send_sms 'account', 'before_confirm_phone_send_sms' - hook in confirm phone + * - $unit_name - equals `account` + * - $action - equals `before_confirm_phone_send_sms` + * - $object_id - account id + * - $sender_id - logged profile_id + * - $extra_params - array of additional params with the following array keys: + * - `phone_number` - [string] by ref, phone number to send sms, can be overridden in hook processing + * - `sms_text` - [string] by ref, text for sms, can be overridden in hook processing + * - `override_result` - [mixed] by ref, can be object, can be overridden in hook processing + * @hook @ref hook-account-before_confirm_phone_send_sms + */ + bx_alert('account', 'before_confirm_phone_send_sms', $oAccount->id(), bx_get_logged_profile_id(), [ + 'phone_number' => $sPhoneNumber, + 'sms_text' => $sActivationText, + 'override_result' => &$mixedResult + ]); + + if ($mixedResult === null && !BxDolTwilio::getInstance()->sendSms($sPhoneNumber, $sActivationText)) + return MsgBox(_t("_sys_txt_confirm_phone_send_sms_error_occured")); + + $oSession->setValue(BX_ACCOUNT_SESSION_KEY_FOR_PHONE_ACTIVATEION_CODE, $sActivationCode); + header('Location: ' . bx_absolute_url(BxDolPermalinks::getInstance()->permalink('page.php?i=confirm-phone'))); + } + return '' . _t("_sys_txt_confirm_phone_set_phone_desc_set_phone") . '' .$oForm->getCode(); + } + + if ($iStep == 2){ + $oForm = BxDolForm::getObjectInstance('sys_confirm_phone', 'sys_confirm_phone_confirmation'); + if (!$oForm) + return MsgBox(_t("_sys_txt_confirm_phone_set_phone_confirmation_occured")); + + $oForm->initChecker(); + + if ($oForm->isSubmittedAndValid()) { + $oAccount->updatePhoneConfirmed(true); + $oSession->unsetValue(BX_ACCOUNT_SESSION_KEY_FOR_PHONE_ACTIVATEION_CODE); + return MsgBox(_t("_sys_txt_confirm_phone_confirm_success")); + } + return '' . _t("_sys_txt_confirm_phone_set_phone_desc_phone_confirmation") . '' .$oForm->getCode(); + } + } + } + + /** + * Perform email confirmation + */ + public function confirmEmail($sKey) + { + $bApi = bx_is_api(); + + $mixedAccountId = $this->_confirmEmail($sKey); + if(is_string($mixedAccountId) && !is_numeric($mixedAccountId)) + return $bApi ? [bx_api_get_msg($mixedAccountId)] : MsgBox($mixedAccountId); + + if(($oSockets = BxDolSockets::getInstance()) && $oSockets->isEnabled()) + $oSockets->sendEvent('sys_account', $mixedAccountId, 'confirmed', ''); + + // redirect with success message + $sUrl = getParam('sys_redirect_after_email_confirmation'); + /** + * @hooks + * @hookdef hook-account-after_email_confirmation 'account', 'after_email_confirmation' - hook after email confirmed + * - $unit_name - equals `account` + * - $action - equals `after_email_confirmation` + * - $object_id - account id + * - $sender_id - not used + * - $extra_params - array of additional params with the following array keys: + * - `override_result` - [string] by ref, url for redirect after email confirmed, can be overridden in hook processing + * @hook @ref hook-account-after_email_confirmation + */ + bx_alert('account', 'after_email_confirmation', $mixedAccountId, false, ['override_result' => &$sUrl]); + if ($bApi){ + return [bx_api_get_block('redirect', ['uri' => bx_api_get_relative_url(BxDolPermalinks::getInstance()->permalink($sUrl)), 'timeout' => 1000])]; + } + + $oTemplate = BxDolTemplate::getInstance(); + $oTemplate->setPageNameIndex (BX_PAGE_TRANSITION); + $oTemplate->setPageHeader (_t('_sys_txt_confirm_email_success')); + $oTemplate->setPageContent ('page_main_code', MsgBox(_t('_sys_txt_confirm_email_success'))); + $oTemplate->setPageContent ('url_relocate', bx_absolute_url(BxDolPermalinks::getInstance()->permalink($sUrl))); + + BxDolTemplate::getInstance()->getPageCode(); + exit; + } + + public function serviceConfirmEmail($sKey) + { + $mixedAccountId = $this->_confirmEmail($sKey); + return is_int($mixedAccountId) || is_numeric($mixedAccountId); + } + + public function serviceGetOptionsResetPasswordRedirect() + { + $aResult = array(); + + $aChoices = array('home', 'profile', 'profile_edit', 'custom'); + foreach($aChoices as $sChoice) + $aResult[] = array('key' => $sChoice, 'value' => _t('_adm_stg_cpt_option_value_sys_account_reset_password_redirect_' . $sChoice)); + + return $aResult; + } + + public function serviceGetOptionsSwitchToProfileRedirect() + { + $aResult = array(); + + $aChoices = array('back', 'home', 'profile', 'custom'); + foreach($aChoices as $sChoice) + $aResult[] = array('key' => $sChoice, 'value' => _t('_adm_stg_cpt_option_value_sys_account_switch_to_profile_redirect_' . $sChoice)); + + return $aResult; + } + + public function serviceGetOptionsPruningInterval() + { + $aResult = array(); + + $aChoices = array('no_login_delete', 'no_login_suspend', 'no_confirm_delete', 'no_profile_delete'); + foreach($aChoices as $sChoice) + $aResult[] = array('key' => $sChoice, 'value' => _t('_adm_stg_cpt_option_value_sys_account_pruning_' . $sChoice)); + + return $aResult; + } + + /** + * @page service Service Calls + * @section bx_system_general System Services + * @subsection bx_system_general-account Account + * @subsubsection bx_system_general-forgot_password forgot_password + * + * @code bx_srv('system', 'forgot_password', [], 'TemplServiceAccount'); @endcode + * @code {{~system:forgot_password:TemplServiceAccount~}} @endcode + * + * Display forgot password form, + * if reset password key is provided then reset password + * + * @see BxBaseServiceAccount::serviceForgotPassword + */ + /** + * @ref bx_system_general-forgot_password "forgot_password" + */ + public function serviceForgotPassword() + { + if(isLogged()){ + header('Location: ' . BX_DOL_URL_ROOT); + exit; + } + + $bApi = bx_is_api(); + + if (bx_get('key') !== false) + return $this->resetPassword(); + + $oForm = BxDolForm::getObjectInstance('sys_forgot_password', 'sys_forgot_password'); + if (!$oForm) + return ''; + + $bNeedCheckEmailAndPhone = true; + $sCaptionKey = "_sys_txt_forgot_pasword_by_both_desc"; + if (BxDolAccount::isNeedConfirmPhone()){ + if (!BxDolAccount::isNeedConfirmEmail()){ + unset($oForm->aInputs['email']); + $sCaptionKey = "_sys_txt_forgot_pasword_by_phone_desc"; + $oForm->aInputs['phone']['checker']['func'] = 'PhoneExist'; + $bNeedCheckEmailAndPhone = false; + } + } + else{ + unset($oForm->aInputs['phone']); + $sCaptionKey = "_sys_txt_forgot_pasword_desc"; + $oForm->aInputs['email']['checker']['func'] = 'EmailExist'; + $bNeedCheckEmailAndPhone = false; + } + + if ((BxDolAccount::isNeedConfirmPhone() && BxDolAccount::isNeedConfirmEmail())){ + if (isset($oForm->aInputs['phone'])) + $oForm->aInputs['phone']['required'] = false; + if (isset($oForm->aInputs['email'])) + $oForm->aInputs['email']['required'] = false; + } + + $oForm->initChecker(); + + $bShowErrorEmptyBoth = false; + if ($oForm->isSubmitted() && $bNeedCheckEmailAndPhone && $oForm->getCleanValue('phone') == '' && $oForm->getCleanValue('email') == ''){ + $bShowErrorEmptyBoth = true; + $oForm->setValid(false); + } + + if ($oForm->isSubmittedAndValid()) { + $sEmail = $oForm->getCleanValue('email'); + $sPhone = $oForm->getCleanValue('phone'); + + if (isset($oForm->aInputs['email']) && $sEmail != '') { + $oAccount = BxDolAccount::getInstance($this->_oAccountQuery->getIdByEmail($sEmail)); + + if($oAccount && $oAccount->sendResetPasswordEmail()) + $sResultMsg = MsgBox(_t("_sys_txt_forgot_pasword_check_email")); + else + $sResultMsg = MsgBox(_t("_sys_txt_forgot_pasword_email_send_failed")); + + $sForm = ''; + } + + if (isset($oForm->aInputs['phone']) && $sPhone != '') { + $iAccountId = $this->_oAccountQuery->getIdByPhone($sPhone); + $aAccountInfo = $this->_oAccountQuery->getInfoById($iAccountId); + + $sKey = bx_get_reset_password_key($aAccountInfo['email']); + $sForgotPasswordUrl = bx_get_reset_password_link_by_key($sKey); + + $sSmsText = _t('_sys_txt_forgot_pasword_sms_text', $sForgotPasswordUrl); + + $mixedOverrideResult = null; + /** + * @hooks + * @hookdef hook-account-before_forgot_password_send_sms 'account', 'before_forgot_password_send_sms' - hook in $oAccount->isConfirmed check + * - $unit_name - equals `account` + * - $action - equals `before_forgot_password_send_sms` + * - $object_id - account id + * - $sender_id - not used + * - $extra_params - array of additional params with the following array keys: + * - `phone_number` - [string] by ref, phone number to send sms, can be overridden in hook processing + * - `sms_text` - [string] by ref, text for sms, can be overridden in hook processing + * - `override_result` - [mixed] by ref, can be object, can be overridden in hook processing + * @hook @ref hook-account-before_forgot_password_send_sms + */ + bx_alert('account', 'before_forgot_password_send_sms', $aAccountInfo['id'], false, array('phone_number' => &$sPhone, 'sms_text' => &$sSmsText, 'override_result' => &$mixedOverrideResult)); + if ($mixedOverrideResult === null) { + $oTwilio = BxDolTwilio::getInstance(); + if($oTwilio->sendSms($sPhone, $sSmsText)) + $sResultMsg = MsgBox(_t("_sys_txt_forgot_pasword_check_phone")); + else + $sResultMsg = MsgBox(_t("_sys_txt_forgot_pasword_error_occured")); + } + + $sForm = ''; + } + + if($bApi) { + return [ + bx_api_get_msg(strip_tags($sResultMsg)), + ]; + } + } + else { + $sResultMsg = _t($sCaptionKey); + $sForm = $oForm->getCode(); + + if($bApi) { + return [ + bx_api_get_msg($sResultMsg, ['ext' => ['msg_type' => 'caption']]), + bx_api_get_block('form', $oForm->getCodeAPI(), [ + 'ext' => [ + 'request' => ['url' => '/api.php?r=system/forgot_password/TemplServiceAccount', 'immutable' => true] + ] + ])]; + } + } + + return '' . $sResultMsg . '' . $sForm . ($bShowErrorEmptyBoth ? '' . _t("_sys_form_forgot_password_phone_and_email_empty_error") . '' : ''); + } + + /** + * @page service Service Calls + * @section bx_system_general System Services + * @subsection bx_system_general-account Account + * @subsubsection bx_system_general-switch_profile switch_profile + * + * @code bx_srv('system', 'switch_profile', [123], 'TemplServiceAccount'); @endcode + * @code {{~system:switch_profile:TemplServiceAccount:[123]~}} @endcode + * + * Switch current user profile. + * User can switch between profiles if multiple profiles are created. + * Also it's possible to switch to Organization profile if user is admin of Organization, + * or other module which can `actAsProfile`. + * Admin can switch to any prifile by default + * + * @param $iSwitchToProfileId profile ID to switch to + * @return true on success or error message otherwise, so make sue to make strict (===) comparision + * + * @see BxBaseServiceAccount::serviceSwitchProfile + */ + /** + * @ref bx_system_general-switch_profile "switch_profile" + */ + public function serviceSwitchProfile($iSwitchToProfileId) + { + $oProfile = BxDolProfile::getInstance($iSwitchToProfileId); + if (!$oProfile) { + return _t('_sys_txt_error_occured'); + } + + $iViewerAccountId = getLoggedId(); + $iSwitchToAccountId = $oProfile->getAccountId(); + + $iViewerProfileId = bx_get_logged_profile_id(); + $aCheck = checkActionModule($iViewerProfileId, 'switch to any profile', 'system', false); + $bAllowSwitchToAnyProfile = $aCheck[CHECK_ACTION_RESULT] === CHECK_ACTION_RESULT_ALLOWED; + + $bCanSwitch = ($iSwitchToAccountId == $iViewerAccountId || $bAllowSwitchToAnyProfile); + /** + * @hooks + * @hookdef hook-account-check_switch_context 'account', 'check_switch_context' - hook on switch profile_id + * - $unit_name - equals `account` + * - $action - equals `check_switch_context` + * - $object_id - account id + * - $sender_id - viewer profile_id + * - $extra_params - array of additional params with the following array keys: + * - `switch_to_profile` - [int] profile_id to switch + * - `viewer_account` - [int] viewer's profile_id, can be overridden in hook processing + * - `override_result` - [bool] by ref, true if allow switch profile, otherwise false, can be overridden in hook processing + * @hook @ref hook-account-check_switch_context + */ + bx_alert('account', 'check_switch_context', $iSwitchToAccountId, $iViewerProfileId, array('switch_to_profile' => $iSwitchToProfileId, 'viewer_account' => $iViewerAccountId, 'override_result' => &$bCanSwitch)); + + if (!$bCanSwitch) { + return isset($aCheck[CHECK_ACTION_MESSAGE]) ? $aCheck[CHECK_ACTION_MESSAGE] : _t('_sys_txt_error_occured'); + } + + $oAccount = BxDolAccount::getInstance(); + if (!$oAccount->updateProfileContext($iSwitchToProfileId)) { + return _t('_sys_txt_error_occured'); + } + + checkActionModule($iViewerProfileId, 'switch to any profile', 'system', true); + if (bx_is_api()){ + return BxDolProfile::getDataForPage($iSwitchToProfileId); + } + return true; + } + + /** + * Reset password procedure + */ + public function resetPassword() + { + $bApi = bx_is_api(); + $sKey = bx_process_input(bx_get('key')); + + $oForm = BxDolForm::getObjectInstance('sys_forgot_password', 'sys_forgot_password_reset'); + if(!empty($sKey) && isset($oForm->aInputs['key'])) + $oForm->aInputs['key']['value'] = $sKey; + + $oForm->initChecker(); + if($oForm->isSubmittedAndValid()) { + $sErrorUrl = bx_absolute_url(BxDolPermalinks::getInstance()->permalink('page.php?i=forgot-password')); + + // check if key exists + $oKey = BxDolKey::getInstance(); + $sKey = $oForm->getCleanValue('key'); + if(!$oKey || !$oKey->isKeyExists($sKey)) + return $bApi ? bx_api_get_msg(_t('_sys_txt_reset_pasword_error_invalid_key', $sErrorUrl)) : MsgBox(_t('_sys_txt_reset_pasword_error_invalid_key', $sErrorUrl)); + + // check if key data exists + $aKeyData = $oKey->getKeyData($sKey); + if(empty($aKeyData['email'])) + return $bApi ? [bx_api_get_msg(_t('_sys_txt_reset_pasword_error_invalid_key', $sErrorUrl))] : MsgBox(_t('_sys_txt_reset_pasword_error_invalid_key', $sErrorUrl)); + + // check if account with such email exists + $iAccountId = $this->_oAccountQuery->getIdByEmail($aKeyData['email']); + if(empty($iAccountId)) + return $bApi ? [bx_api_get_msg(_t('_sys_txt_reset_pasword_error_not_found', $sErrorUrl))] : MsgBox(_t('_sys_txt_reset_pasword_error_not_found', $sErrorUrl));; + + $sPassword = $oForm->getCleanValue('password'); + $oAccount = BxDolAccount::getInstance($iAccountId); + if (!$oAccount || !$oAccount->updatePassword($sPassword)) + return $bApi ?[ bx_api_get_msg(_t('_sys_txt_reset_pasword_error_occured', $sErrorUrl))] : MsgBox(_t('_sys_txt_reset_pasword_error_occured', $sErrorUrl)); + + $this->_oAccountQuery->unlockAccount($iAccountId); + $oKey->removeKey($sKey); + + return $bApi ? [bx_api_get_msg(_t('_sys_txt_reset_pasword_success', $sErrorUrl))] : MsgBox(_t('_sys_txt_reset_pasword_success'), 3) . bx_srv('system', 'login_form_only', array('', bx_get_reset_password_redirect($iAccountId)), 'TemplServiceLogin'); + } + + $sTitleReset = _t('_sys_page_title_forgot_password_reset'); + BxDolTemplate::getInstance()->setPageHeader($sTitleReset); + if(($oPage = BxDolPage::getObjectInstanceByURI()) !== false) + $oPage->setTitle($sTitleReset); + + if($bApi) { + return [ + bx_api_get_block('form', $oForm->getCodeAPI(), [ + 'ext' => [ + 'request' => ['url' => '/api.php?r=system/forgot_password/TemplServiceAccount', 'immutable' => true] + ] + ])]; + } + + return $oForm->getCode(); + } + + /** + * Generate new password. + */ + public function generateUserNewPwd($iAccountId) + { + $sPwd = genRndPwd(8, false); + $sSalt = genRndSalt(); + $sPasswordHash = encryptUserPwd($sPwd, $sSalt); + + $oAccount = BxDolAccount::getInstance($iAccountId); + $iPasswordExpired = $oAccount->getPasswordExpiredDateByAccount($iAccountId); + + $this->_oAccountQuery->updatePassword($sPasswordHash, $sSalt, $iAccountId, $iPasswordExpired); + + /** + * @hooks + * @hookdef hook-account-edited 'account', 'edited' - hook on account edited + * - $unit_name - equals `account` + * - $action - equals `edited` + * - $object_id - account id + * - $sender_id - account id + * - $extra_params - array of additional params with the following array keys: + * - `action` - [string] can be forgot_password/change_password or $sDisplayName (display name for current form) + * @hook @ref hook-account-edited + */ + bx_alert('account', 'edited', $iAccountId, $iAccountId, array('action' => 'forgot_password')); + + return $sPwd; + } + + protected function _confirmEmail($sKey) + { + // check if key exists + $oKey = BxDolKey::getInstance(); + if (!$oKey || !$oKey->isKeyExists($sKey)) + return _t("_sys_txt_confirm_email_error_occured"); + + // check if key data exists + $aData = $oKey->getKeyData($sKey); + if (!isset($aData['account_id'])) + return _t("_sys_txt_confirm_email_error_occured"); + + // check if account exists + $oAccount = BxDolAccount::getInstance($aData['account_id']); + if (!$oAccount) + return _t("_sys_txt_confirm_email_error_occured"); + + // remove key + $oKey->removeKey($sKey); + + // confirm email + if (!$oAccount->updateEmailConfirmed(true)) + return _t("_sys_txt_confirm_email_error_occured"); + + // login to user's account automatically + bx_login($aData['account_id']); + + return (int)$aData['account_id']; + } +} + +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseServiceMetatags.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseServiceMetatags.php new file mode 100644 index 0000000000..1ec3349702 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseServiceMetatags.php @@ -0,0 +1,141 @@ + $bMenuView]; + if ($aContextInfo !== false) + $aParams['context_id'] = $aContextInfo['context_profile_id']; + + $sResult = BxDolMetatags::getObjectInstance($sObject)->getKeywordsCloud($mixedSection, $iMaxCount, false, $aParams); + + if(empty($sResult)) + return $bShowEmpty ? MsgBox(_t('_Empty')) : ''; + + return $sResult; + } + + public function serviceBrowseLabels($aParams = array()) + { + return BxDolLabel::getInstance()->getLabelsBrowse($aParams); + } + + /** + * Get location map. + * @param $sObject metatgs object to get keywords cloud for + * @param $iId content id + * @return map HTML string + */ + public function serviceLocationsMap($sObject, $iId, $aParams = array()) + { + $oMetatags = BxDolMetatags::getObjectInstance($sObject); + if($oMetatags === false) + return false; + + $sModule = $oMetatags->getModule(); + + $aContentInfo = bx_srv($sModule, 'get_info', [$iId, false]); + if(empty($aContentInfo) || !is_array($aContentInfo)) + return false; + + $oFormsHelper = bx_srv($sModule, 'forms_helper'); + $oFormView = $oFormsHelper->getObjectFormView(); + if(!$oFormView) + return false; + + $CNF = &BxDolModule::getInstance($sModule)->_oConfig->CNF; + + $oFormView->initChecker($aContentInfo); + if(empty($CNF['FIELD_LOCATION']) || !$oFormView->isInputVisible($CNF['FIELD_LOCATION'])) + return false; + + return $oMetatags->getLocationsMap($iId, $aParams); + } + + /** + * Get notification data for Notifications module - action Mention. + */ + public function serviceGetNotificationsPostMention($aEvent) + { + $iProfile = (int)$aEvent['object_owner_id']; + $oProfile = BxDolProfile::getInstance($iProfile); + if(!$oProfile) + return []; + + $sEntryUrl = ''; + if (isset($aEvent['content']['module']) && isset($aEvent['content']['content_id'])) { + if ('sys_cmts' == $aEvent['content']['module']) { + $oCmts = BxDolCmts::getObjectInstanceByUniqId($aEvent['content']['content_id']); + $aCmt = BxDolCmtsQuery::getCommentExtendedByUniqId($aEvent['content']['content_id']); + if ($oCmts && $aCmt) + $sEntryUrl = $oCmts->getViewUrl($aCmt['cmt_id']); + } elseif (BxDolRequest::serviceExists($aEvent['content']['module'], 'get_link')) { + $sEntryUrl = str_replace(BX_DOL_URL_ROOT, '{bx_url_root}', bx_srv($aEvent['content']['module'], 'get_link', [$aEvent['content']['content_id']])); + } + } + + if(!$sEntryUrl) + $sEntryUrl = '{bx_url_root}' . bx_append_url_params('searchKeyword.php', ['type' => 'mention', 'keyword' => $iProfile]); + + return [ + 'entry_sample' => '_sys_profile_sample_single', + 'entry_url' => $sEntryUrl, + 'entry_caption' => $oProfile->getDisplayName(), + 'entry_author' => $iProfile, + 'lang_key' => '_sys_metatags_mention_added', + ]; + } +} + +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseServices.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseServices.php new file mode 100644 index 0000000000..2275496760 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/scripts/BxBaseServices.php @@ -0,0 +1,1489 @@ +serviceGetPublicServices(); + return isset($aServices[$sService]); + } + + public function serviceGetPublicServices() + { + return array ( + 'GetProductsNames' => 'BxBaseServices', + 'GetPageByRequest' => 'BxBaseServicePages', + ); + } + + public function serviceIsSafeService($s) + { + $sService = bx_gen_method_name($s); + $aSafeServices = $this->serviceGetSafeServices(); + return isset($aSafeServices[$sService]); + } + + public function serviceGetSafeServices() + { + return array( + 'GetMenu' => 'BxBaseServices', + 'GetCreatePostForm' => 'BxBaseServices', + 'GetProductsNames' => 'BxBaseServices', + 'KeywordSearch' => 'BxBaseServices', + 'GetDataSearchApi' => 'BxBaseServices', + 'Cmts' => 'BxBaseServices', + 'GetFooter' => 'BxBaseServices', + + 'GetPageBlockData' => 'BxBaseServicePages', + 'SetPageBlockData' => 'BxBaseServicePages', + 'GetUrlInfo' => 'BxBaseServicePages', + + 'CreateAccountForm' => 'BxBaseServiceAccount', + 'AccountSettingsEmail' => 'BxBaseServiceAccount', + 'AccountSettingsPassword' => 'BxBaseServiceAccount', + 'AccountSettingsDelAccount' => 'BxBaseServiceAccount', + 'AccountSettingsInfo' => 'BxBaseServiceAccount', + 'ForgotPassword' => 'BxBaseServiceAccount', + 'SwitchProfile' => 'BxBaseServiceAccount', + 'AccountProfileSwitcher' => 'BxBaseServiceAccount', + 'EmailConfirmation' => 'BxBaseServiceAccount', + 'ConfirmEmail' => 'BxBaseServiceAccount', + + 'CategoriesList' => 'BxBaseServiceCategory', + + 'Test' => 'BxBaseServiceLogin', + 'MemberAuthCode' => 'BxBaseServiceLogin', + 'LoginForm' => 'BxBaseServiceLogin', + 'LoginFormOnly' => 'BxBaseServiceLogin', + 'Logout' => 'BxBaseServiceLogin', + + 'KeywordsCloud' => 'BxBaseServiceMetatags', + + 'AccountProfileSwitcher' => 'BxBaseServiceProfiles', + 'ProfileMembership' => 'BxBaseServiceProfiles', + 'ProfileNotifications' => 'BxBaseServiceProfiles', + 'GetCountOnlineProfiles' => 'BxBaseServiceProfiles', + 'BrowseRecommendationsFriends' => 'BxBaseServiceProfiles', + 'BrowseRecommendationsSubscriptions' => 'BxBaseServiceProfiles', + 'BrowseFriends' => 'BxBaseServiceProfiles', + 'SetMembership' => 'BxBaseServiceProfiles', + 'BrowseFriendRequests' => 'BxBaseServiceProfiles', + 'BrowseFriendRequested' => 'BxBaseServiceProfiles', + 'BrowseSubscribedMe' => 'BxBaseServiceProfiles', + 'BrowseSubscriptions' => 'BxBaseServiceProfiles', + 'BrowseMembers' => 'BxBaseServiceProfiles', + 'UpdateSettings' => 'BxBaseServiceProfiles', + 'Befriend' => 'BxBaseServiceProfiles', + + 'GetChartGrowth' => 'BxBaseChartServices', + 'GetChartStats' => 'BxBaseChartServices', + 'GetDataByInterval' => 'BxBaseChartServices', + + 'GetCartItemsCount' => 'BxBasePaymentsServices', + 'GetOrdersCount' => 'BxBasePaymentsServices', + + 'Do' => 'BxBaseReportServices', + 'GetPerformedBy' => 'BxBaseReportServices', + + 'Do' => 'BxBaseVoteServices', + 'GetPerformedBy' => 'BxBaseVoteServices', + + 'Perform' => 'BxBaseFeatureServices', + + 'Perform' => 'BxBaseServiceConnections', + 'Perform' => 'BxBaseServiceRecommendations', + 'GetDataApi' => 'BxBaseCmtsServices', + + 'GetDataApi' => 'BxBaseUploaderServices', + + 'GetStatBlock' => 'BxBaseDashboardServices', + + 'PerfomActionApi' => 'BxBaseServiceGrid', + + 'GetLabels' => 'BxBaseLabelsServices', + 'GetForm' => 'BxBaseSearchExtendedServices', + 'GetResults' => 'BxBaseSearchExtendedServices' + ); + } + + public function serviceGetPreloaderContent($sName) { + $sResult = ''; + + switch($sName) { + case 'icons': + $sResult = getParam('sys_css_icons_default'); + break; + + case 'tailwind': + $sFile = getParam('sys_css_tailwind_default'); + if(empty($sFile)) + $sFile = 'tailwind.min.css'; + + $sResult = '{dir_plugins_public}tailwind/css/|' . $sFile; + break; + } + + return $sResult; + } + + /** + * @page service Service Calls + * @section bx_system_general System Services + * @subsection bx_system_general-general General + * @subsubsection bx_system_general-module_check_for_update module_check_for_update + * + * @code bx_srv('system', 'module_check_for_update', ["bx_posts"]); @endcode + * @code bx_srv('system', 'module_check_for_update', ["bx_posts"], 'TemplServices'); @endcode + * @code {{~system:module_check_for_update:TemplServices["bx_posts"]~}} @endcode + * + * Checks whether an update is available for requested module or not. + * @param $mixedModule - module ID/name to check the updates for. + * @return array with information about the update, false if nothing was found + * + * @see BxBaseServices::serviceModuleCheckForUpdate + */ + /** + * @ref bx_system_general-module_check_for_update "module_check_for_update" + */ + public function serviceModuleCheckForUpdate($mixedModule) + { + $aModule = BxDolModuleQuery::getInstance()->{'getModuleBy' . (is_numeric($mixedModule) ? 'Id' : 'Name')}($mixedModule, false); + if(empty($aModule) || !is_array($aModule)) + return false; + + $aUpdates = BxDolStudioInstallerUtils::getInstance()->checkUpdatesByModule($aModule['name']); + if(empty($aUpdates) || !is_array($aUpdates)) + return false; + + $aUpdate = array_shift($aUpdates); + return array( + 'version_from' => $aUpdate['file_version'], + 'version_to' => $aUpdate['file_version_to'], + 'file_id' => $aUpdate['file_id'] + ); + } + + /** + * @page service Service Calls + * @section bx_system_general System Services + * @subsection bx_system_general-general General + * @subsubsection bx_system_general-module_update module_update + * + * @code bx_srv('system', 'module_update', ["bx_posts"]); @endcode + * @code bx_srv('system', 'module_update', ["bx_posts"], 'TemplServices'); @endcode + * @code {{~system:module_update:TemplServices["bx_posts"]~}} @endcode + * + * Download and install an update for requested module. The operation may be performed + * immediately or by Transient Cron task. The second way is more common. + * @param $mixedModule - module ID/name to check the updates for. + * @return integer value determining the result of the operation. It can be one of the following values: + * BX_DOL_STUDIO_IU_RC_SUCCESS, BX_DOL_STUDIO_IU_RC_FAILED or BX_DOL_STUDIO_IU_RC_SCHEDULED. + * + * @see BxBaseServices::serviceModuleUpdate + */ + /** + * @ref bx_system_general-module_update "module_update" + */ + public function serviceModuleUpdate($mixedModule) + { + $aModule = BxDolModuleQuery::getInstance()->{'getModuleBy' . (is_numeric($mixedModule) ? 'Id' : 'Name')}($mixedModule, false); + if(empty($aModule) || !is_array($aModule)) + return BX_DOL_STUDIO_IU_RC_FAILED; + + $aResult = BxDolStudioInstallerUtils::getInstance()->downloadUpdatePublic($aModule['name'], true); + return $aResult['code']; + } + + /** + * @page service Service Calls + * @section bx_system_general System Services + * @subsection bx_system_general-general General + * @subsubsection bx_system_general-module_delete module_delete + * + * @code bx_srv('system', 'module_delete', ["bx_posts"]); @endcode + * @code bx_srv('system', 'module_delete', ["bx_posts", true], 'TemplServices'); @endcode + * @code {{~system:module_delete:TemplServices["bx_posts"]~}} @endcode + * + * Delete the requested module. By default only uninstalled module can be deleted. + * The operation may be performed immediately or by Transient Cron task. The second way is more common. + * @param $sModule - module name to delete. + * @param $bForceUninstall - if 'true' is passed the module will be uninstalled before deletion. + * @return integer value determining the result of the operation. It can be one of the following values: + * BX_DOL_STUDIO_IU_RC_SUCCESS, BX_DOL_STUDIO_IU_RC_FAILED or BX_DOL_STUDIO_IU_RC_SCHEDULED. + * + * @see BxBaseServices::serviceModuleDelete + */ + /** + * @ref bx_system_general-module_delete "module_delete" + */ + public function serviceModuleDelete($sModule, $bForceUninstall = false) + { + $sModulePath = ''; + $oInstallerUtils = BxDolStudioInstallerUtils::getInstance(); + + $aModule = BxDolModuleQuery::getInstance()->getModuleByName($sModule, false); + if(!empty($aModule) && is_array($aModule)) { + if(!$bForceUninstall) + return BX_DOL_STUDIO_IU_RC_FAILED; + + $sModulePath = $aModule['path']; + + $aResult = $oInstallerUtils->perform($sModulePath, 'uninstall', array('auto_disable' => $bForceUninstall)); + if($aResult['code'] != BX_DOL_STUDIO_IU_RC_SUCCESS) + return BX_DOL_STUDIO_IU_RC_FAILED; + } + else { + $aModules = $oInstallerUtils->getModules(false); + if(!isset($aModules[$sModule])) + return BX_DOL_STUDIO_IU_RC_FAILED; + + $sModulePath = $aModules[$sModule]['dir']; + } + + $aResult = $oInstallerUtils->perform($sModulePath, 'delete'); + return $aResult['code']; + } + + /** + * @page service Service Calls + * @section bx_system_general System Services + * @subsection bx_system_general-general General + * @subsubsection bx_system_general-module_install module_install + * + * @code bx_srv('system', 'module_install', ["bx_posts"]); @endcode + * @code bx_srv('system', 'module_install', ["bx_posts", true], 'TemplServices'); @endcode + * @code {{~system:module_install:TemplServices["bx_posts"]~}} @endcode + * + * Install the requested module. By default the module will be installed only. + * @param $sModule - module name to install. + * @param $bForceEnable - if 'true' is passed the module will be automatically enabled after installation. + * @return boolean value determining the result of the operation. + * + * @see BxBaseServices::serviceModuleInstall + */ + /** + * @ref bx_system_general-module_install "module_install" + */ + public function serviceModuleInstall($sModule, $bForceEnable = false) + { + $oInstallerUtils = BxDolStudioInstallerUtils::getInstance(); + + $aModules = $oInstallerUtils->getModules(false); + if(!isset($aModules[$sModule])) + return false; + + $aResult = $oInstallerUtils->perform($aModules[$sModule]['dir'], 'install', array('auto_enable' => $bForceEnable)); + if($aResult['code'] != BX_DOL_STUDIO_IU_RC_SUCCESS) + return false; + + return true; + } + + /** + * @page service Service Calls + * @section bx_system_general System Services + * @subsection bx_system_general-general General + * @subsubsection bx_system_general-module_uninstall module_uninstall + * + * @code bx_srv('system', 'module_uninstall', ["bx_posts"]); @endcode + * @code bx_srv('system', 'module_uninstall', ["bx_posts", true], 'TemplServices'); @endcode + * @code {{~system:module_uninstall:TemplServices["bx_posts"]~}} @endcode + * + * Uninstall the requested module. By default only disabled module can be uninstalled. + * @param $mixedModule - module ID/name to uninstall. + * @param $bForceDisable - if 'true' is passed the module will be automatically disabled before uninstallation. + * @return boolean value determining the result of the operation. + * + * @see BxBaseServices::serviceModuleUninstall + */ + /** + * @ref bx_system_general-module_uninstall "module_uninstall" + */ + public function serviceModuleUninstall($mixedModule, $bForceDisable = false) + { + $aModule = BxDolModuleQuery::getInstance()->{'getModuleBy' . (is_numeric($mixedModule) ? 'Id' : 'Name')}($mixedModule, false); + if(empty($aModule) || !is_array($aModule)) + return false; + + if((int)$aModule['enabled'] != 0 && !$bForceDisable) + return false; + + $aResult = BxDolStudioInstallerUtils::getInstance()->perform($aModule['path'], 'uninstall', array('auto_disable' => $bForceDisable)); + if($aResult['code'] != BX_DOL_STUDIO_IU_RC_SUCCESS) + return false; + + return true; + } + + /** + * @page service Service Calls + * @section bx_system_general System Services + * @subsection bx_system_general-general General + * @subsubsection bx_system_general-module_enable module_enable + * + * @code bx_srv('system', 'module_enable', ["bx_posts"]); @endcode + * @code bx_srv('system', 'module_enable', ["bx_posts"], 'TemplServices'); @endcode + * @code {{~system:module_enable:TemplServices["bx_posts"]~}} @endcode + * + * Enable the requested module. + * @param $mixedModule - module ID/name to enable. + * @return boolean value determining the result of the operation. + * + * @see BxBaseServices::serviceModuleEnable + */ + /** + * @ref bx_system_general-module_enable "module_enable" + */ + public function serviceModuleEnable($mixedModule) + { + $aModule = BxDolModuleQuery::getInstance()->{'getModuleBy' . (is_numeric($mixedModule) ? 'Id' : 'Name')}($mixedModule, false); + if(empty($aModule) || !is_array($aModule)) + return false; + + if((int)$aModule['enabled'] != 0) + return false; + + $aResult = BxDolStudioInstallerUtils::getInstance()->perform($aModule['path'], 'enable'); + if($aResult['code'] != BX_DOL_STUDIO_IU_RC_SUCCESS) + return false; + + return true; + } + + /** + * @page service Service Calls + * @section bx_system_general System Services + * @subsection bx_system_general-general General + * @subsubsection bx_system_general-module_disable module_disable + * + * @code bx_srv('system', 'module_disable', ["bx_posts"]); @endcode + * @code bx_srv('system', 'module_disable', ["bx_posts"], 'TemplServices'); @endcode + * @code {{~system:module_disable:TemplServices["bx_posts"]~}} @endcode + * + * Disable the requested module. + * @param $mixedModule - module ID/name to disable. + * @return boolean value determining the result of the operation. + * + * @see BxBaseServices::serviceModuleDisable + */ + /** + * @ref bx_system_general-module_disable "module_disable" + */ + public function serviceModuleDisable($mixedModule) + { + $aModule = BxDolModuleQuery::getInstance()->{'getModuleBy' . (is_numeric($mixedModule) ? 'Id' : 'Name')}($mixedModule, false); + if(empty($aModule) || !is_array($aModule)) + return false; + + if((int)$aModule['enabled'] == 0) + return false; + + $aResult = BxDolStudioInstallerUtils::getInstance()->perform($aModule['path'], 'disable'); + if($aResult['code'] != BX_DOL_STUDIO_IU_RC_SUCCESS) + return false; + + return true; + } + + /** + * @page service Service Calls + * @section bx_system_general System Services + * @subsection bx_system_general-general General + * @subsubsection bx_system_general-is_module_installed is_module_installed + * + * @code bx_srv('system', 'is_module_installed', ["bx_posts"]); @endcode + * @code bx_srv('system', 'is_module_installed', ["bx_posts"], 'TemplServices'); @endcode + * @code {{~system:is_module_installed:TemplServices["bx_posts"]~}} @endcode + * + * Checks whether the requested module is installed or not. + * @param $mixedModule - module ID/name to check. + * @return boolean value determining the result of the operation. + * + * @see BxBaseServices::serviceIsModuleInstalled + */ + /** + * @ref bx_system_general-is_module_installed "is_module_installed" + */ + public function serviceIsModuleInstalled($mixedModule) + { + $aModule = BxDolModuleQuery::getInstance()->{'getModuleBy' . (is_numeric($mixedModule) ? 'Id' : 'Name')}($mixedModule, false); + return !empty($aModule) && is_array($aModule); + } + + /** + * @page service Service Calls + * @section bx_system_general System Services + * @subsection bx_system_general-general General + * @subsubsection bx_system_general-is_module_enabled is_module_enabled + * + * @code bx_srv('system', 'is_module_enabled', ["bx_posts"]); @endcode + * @code bx_srv('system', 'is_module_enabled', ["bx_posts"], 'TemplServices'); @endcode + * @code {{~system:is_module_enabled:TemplServices["bx_posts"]~}} @endcode + * + * Checks whether the requested module is enabled or not. + * @param $mixedModule - module ID/name to check. + * @return boolean value determining the result of the operation. + * + * @see BxBaseServices::serviceIsModuleEnabled + */ + /** + * @ref bx_system_general-is_module_enabled "is_module_enabled" + */ + public function serviceIsModuleEnabled($mixedModule) + { + $aModule = BxDolModuleQuery::getInstance()->{'getModuleBy' . (is_numeric($mixedModule) ? 'Id' : 'Name')}($mixedModule, false); + return !empty($aModule) && is_array($aModule) && (int)$aModule['enabled'] != 0; + } + + /** + * Checks whether a module is a 'Content' module or not. + * + * @param string $mixedModule - module name or an instance of Module class. + * @return boolean result of operation. + */ + public function serviceIsModuleContent($mixedModule) + { + if($mixedModule instanceof BxDolModule) + $mixedModule = $mixedModule->getName(); + + return BxDolModuleQuery::getInstance()->isModuleContent($mixedModule); + } + + /** + * Checks whether a module is a 'Context' module or not. + * + * @param string $mixedModule - module name or an instance of Module class. + * @return boolean result of operation. + */ + public function serviceIsModuleContext($mixedModule) + { + if($mixedModule instanceof BxDolModule) + $mixedModule = $mixedModule->getName(); + + return BxDolModuleQuery::getInstance()->isModuleContext($mixedModule); + } + + /** + * Checks whether a module is a 'Profile' module or not. + * + * @param string $mixedModule - module name or an instance of Module class. + * @return boolean result of operation. + */ + public function serviceIsModuleProfile($mixedModule) + { + if($mixedModule instanceof BxDolModule) + $mixedModule = $mixedModule->getName(); + + return BxDolModuleQuery::getInstance()->isModuleProfile($mixedModule); + } + + /** + * Get modules by type. Available types are 'content', 'context', 'profile'. + * + * @param type $sType - string with type. + * @return array of modules. + */ + public function serviceGetModulesByType($sType, $aParams = []) + { + $oModuleQuery = BxDolModuleQuery::getInstance(); + + if(!$oModuleQuery->checkModulesSubtypes()) { + $oInstallerUtils = new BxDolInstallerUtils(); + $aModules = $oModuleQuery->getModulesBy(['type' => 'modules']); + foreach($aModules as $aModule) + if(($iModuleSubtypes = $oInstallerUtils->getSubtypes($aModule['name'])) != 0) + $oModuleQuery->updateModule(['subtypes' => $iModuleSubtypes], ['id' => $aModule['id']]); + } + + $iSubtypes = 0; + switch($sType) { + case 'content'; + $iSubtypes = BX_DOL_MODULE_SUBTYPE_TEXT; + break; + + case 'context'; + $iSubtypes = BX_DOL_MODULE_SUBTYPE_CONTEXT; + break; + + case 'profile'; + $iSubtypes = BX_DOL_MODULE_SUBTYPE_PROFILE; + break; + } + + $aResults = $oModuleQuery->getModulesBy(array_merge([ + 'type' => 'modules_subtypes', + 'value' => $iSubtypes, + 'active' => 1 + ], array_intersect_key($aParams, array_flip(['id_as_key', 'name_as_key'])))); + + return $aResults; + } + + public function serviceProfileUnit ($iContentId, $aParams = array()) + { + return $this->_serviceProfileFunc('getUnit', $iContentId, $aParams); + } + + public function serviceHasImage ($iContentId) + { + return false; + } + + public function serviceProfilePicture ($iContentId) + { + return BxDolTemplate::getInstance()->getImageUrl('account.svg'); + } + + public function serviceProfileAvatar ($iContentId) + { + return BxDolTemplate::getInstance()->getImageUrl('account.svg'); + } + + public function serviceProfileCover ($iContentId) + { + return ''; + } + + public function serviceProfileEditUrl ($iContentId) + { + return bx_absolute_url(BxDolPermalinks::getInstance()->permalink('page.php?i=account-settings-info')); + } + + public function serviceProfileThumb ($iContentId) + { + return $this->_serviceProfileFunc('getThumb', $iContentId); + } + + public function serviceProfileIcon ($iContentId) + { + return $this->_serviceProfileFunc('getIcon', $iContentId); + } + + public function serviceProfileName ($iContentId) + { + return $this->_serviceProfileFunc('getDisplayName', $iContentId); + } + + public function serviceProfileUrl ($iContentId) + { + return $this->_serviceProfileFunc('getUrl', $iContentId); + } + + /** + * @see iBxDolProfileService::serviceCheckAllowedProfileView + */ + public function serviceCheckAllowedProfileView($iContentId) + { + return _t('_Access denied'); + } + + /** + * @see iBxDolProfileService::serviceCheckAllowedProfileContact + */ + public function serviceCheckAllowedProfileContact($iContentId) + { + return _t('_Access denied'); + } + + /** + * @see iBxDolProfileService::serviceCheckAllowedPostInProfile + */ + public function serviceCheckAllowedPostInProfile($iContentId, $sPostModule = '') + { + return _t('_Access denied'); + } + + /** + * @see iBxDolProfileService::serviceCheckAllowedModuleActionInProfile + */ + public function serviceCheckAllowedModuleActionInProfile($iContentId, $sPostModule, $sActionName) + { + return _t('_Access denied'); + } + + /** + * @see iBxDolProfileService::serviceGetSpaceTitle + */ + public function serviceGetSpaceTitle() + { + return ''; + } + + /** + * @see iBxDolProfileService::serviceGetParticipatingProfiles + */ + public function serviceGetParticipatingProfiles($iProfileId, $aConnectionObject = false) + { + return array(); + } + + /** + * @page service Service Calls + * @section bx_system_general System Services + * @subsection bx_system_general-general General + * @subsubsection bx_system_general-get_create_post_form get_create_post_form + * + * @code bx_srv('system', 'get_create_post_form', [false, "bx_posts"], 'TemplServices'); @endcode + * @code {{~system:get_create_post_form:TemplServices[false,"bx_posts"]~}} @endcode + * + * Get United Create Post form. + * @param $mixedContextId - context which the post will be created in: + * - false = 'Public' post form; + * - 0 = 'Profile' post form, which allows to post in your own profile and connections; + * - n = 'Context' post form, which allows to post in context (3d party profile, group, event, etc). + * @param $sDefault - tab selected by default. + * @param $aCustom - an array with custom paramaters. + * @return string with form content + * + * @see BxBaseServices::serviceGetCreatePostForm + */ + /** + * @ref bx_system_general-get_create_post_form "get_create_post_form" + */ + public function serviceGetCreatePostForm($mixedContextId = false, $sDefault = '', $aCustom = array()) + { + if(!isLogged() || ($mixedContextId !== false && !is_numeric($mixedContextId))) + return ''; + + $oProfile = BxDolProfile::getInstance(); + if(!$oProfile) + return ''; + + if($mixedContextId !== false) + $mixedContextId = (int)(!empty($mixedContextId) ? -$mixedContextId : $oProfile->id()); + + $oMenu = BxDolMenu::getObjectInstance('sys_create_post'); + if(!$oMenu) + return ''; + + $oMenu->setContextId($mixedContextId); + $aMenuItems = $oMenu->getMenuItems(); + if(empty($aMenuItems) || !is_array($aMenuItems)) + return ''; + + if(empty($sDefault)) { + $aDefault = array_shift($aMenuItems); + $sDefault = !empty($aDefault['module']) ? $aDefault['module'] : $aDefault['name']; + } + $oMenu->setSelected($sDefault, $sDefault); + + $bContext = $mixedContextId !== false; + if($bContext && ($aContextInfo = BxDolProfileQuery::getInstance()->getInfoById(abs($mixedContextId)))) + if(bx_srv($aContextInfo['type'], 'check_allowed_post_in_profile', [$aContextInfo['content_id'], $sDefault]) !== CHECK_ACTION_RESULT_ALLOWED) + return ''; + + $sTitle = _t('_sys_page_block_title_create_post' . (!$bContext ? '_public' : ($mixedContextId < 0 ? '_context' : ''))); + $sPlaceholder = _t('_sys_txt_create_post_placeholder', $oProfile->getDisplayName()); + + $oDbModules = BxDolModuleQuery::getInstance(); + $oTemplate = BxDolTemplate::getInstance(); + $oTemplate->addJs(['BxDolCreatePost.js']); + + $aPreloadingList = []; + $aModules = explode(',', getParam('sys_create_post_form_preloading_list')); + if(!empty($aModules)) + foreach($aModules as $sModule) { + $aModule = $oDbModules->getModuleByName($sModule); + if(empty($aModule) || !is_array($aModule)) + continue; + + $aPreloadingList[$sModule] = $aModule['uri']; + } + + if(bx_is_api()) { + return [ + 'title' => $sTitle, + 'content' => '', + 'menu' => $oMenu->getCodeAPI() + ]; + } + + $sJsObject = 'oBxDolCreatePost'; + $sJsContent = $oTemplate->_wrapInTagJsCode("var " . $sJsObject . " = new BxDolCreatePost(" . json_encode([ + 'sObjName' => $sJsObject, + 'sRootUrl' => BX_DOL_URL_ROOT, + 'sDefault' => $sDefault, + 'iContextId' => $bContext ? $mixedContextId : 0, + 'oPreloadingList' => $aPreloadingList, + 'oCustom' => $aCustom + ]) . ");"); + + return [ + 'title' => $sTitle, + 'content' => $oTemplate->parseHtmlByName('create_post_form.html', [ + 'default' => $sDefault, + 'placeholder' => $sPlaceholder, + 'user_thumb' => $oProfile->getUnit(0, ['template' => 'unit_wo_info_links']), + 'form' => bx_srv($sDefault, 'get_create_post_form', [[ + 'context_id' => $mixedContextId, + 'ajax_mode' => true, + 'absolute_action_url' => true, + 'custom' => $aCustom + ]]), + 'js_object' => $sJsObject, + 'js_content' => $sJsContent + ]), + 'menu' => $oMenu + ]; + } + + public function serviceGetOptionsCreatePostFormPreloadingList() + { + $oMenu = BxDolMenu::getObjectInstance('sys_create_post'); + if(!$oMenu) + return []; + + $aMenuItems = $oMenu->getMenuItems(); + + $aResult = []; + foreach($aMenuItems as $aMenuItem) { + $sModule = !empty($aMenuItem['module']) ? $aMenuItem['module'] : $aMenuItem['name']; + if(!bx_srv('system', 'is_module_enabled', [$sModule])) + continue; + + $aResult[] = [ + 'key' => $sModule, + 'value' => _t('_' . $sModule) + ]; + } + + return $aResult; + } + + public function serviceGetBlockAuthor($sModule, $iContentId = 0) + { + if(!$iContentId && bx_get('id') !== false) + $iContentId = (int)bx_get('id'); + + $sMethodGetAuthor = 'get_author'; + if(!$sModule || !$iContentId || !BxDolRequest::serviceExists($sModule, $sMethodGetAuthor)) + return ''; + + $iAuthor = bx_srv($sModule, $sMethodGetAuthor, [$iContentId]); + if(!$iAuthor) + return ''; + + $oAuthor = BxDolProfile::getInstance($iAuthor); + if(!$oAuthor) + return ''; + + $sModuleAuthor = $oAuthor->getModule(); + $sMethodGetCover = 'entity_cover'; + if(!BxDolRequest::serviceExists($sModuleAuthor, $sMethodGetCover)) + return ''; + + return bx_srv($sModuleAuthor, $sMethodGetCover, [$oAuthor->getContentId(), [ + 'use_as_author' => true, + 'show_text' => false + ]]); + } + + public function serviceGetBlockAskAssistant($aParams = []) + { + $iAssistant = BxDolAI::getAssistantForAskBlock(); + if(!$iAssistant) + return ''; + + return BxDolAIAssistant::getObjectInstance($iAssistant)->getAskBlock($aParams); + } + + public function serviceGetMenu($aParams) + { + $bIsApi = bx_is_api(); + $mixedResulEmpty = $bIsApi ? [] : ''; + + if($bIsApi && is_string($aParams)) + $aParams = bx_api_get_browse_params($aParams); + + if(!isset($aParams['object'])) + return $mixedResulEmpty; + + $oMenu = BxDolMenu::getObjectInstance($aParams['object']); + if(!$oMenu) + return $mixedResulEmpty; + + if(!empty($aParams['params']) && is_array($aParams['params'])) + $oMenu->setContentParams($aParams['params']); + + return $bIsApi ? $oMenu->getCodeAPI() : $oMenu->getCode(); + } + + /** + * @page service Service Calls + * @section bx_system_general System Services + * @subsection bx_system_general-general General + * @subsubsection bx_system_general-get_site_submenu get_site_submenu + * + * @code bx_srv('system', 'get_site_submenu', [], 'TemplServices'); @endcode + * @code {{~system:get_site_submenu:TemplServices[]~}} @endcode + * + * Get Site Submenu code. + * @see BxBaseServices::serviceGetSiteSubmenu + */ + /** + * @ref bx_system_general-get_site_submenu "get_site_submenu" + */ + public function serviceGetSiteSubmenu() + { + $oMenu = BxDolMenu::getObjectInstance('sys_site_submenu'); + return $oMenu ? $oMenu->getCode() : ''; + } + + /** + * @page service Service Calls + * @section bx_system_general System Services + * @subsection bx_system_general-general General + * @subsubsection bx_system_general-get_products_names get_products_names + * + * @code bx_srv('system', 'get_products_names', [], 'TemplServices'); + * + * @code http://example.com/m/oauth2/com/get_products_names?module=system&class=BaseServices @endcode + * @code http://hihi.una.io/modules/?r=oauth2/com/get_products_names&module=system&class=BaseServices @endcode + * + * Get an array of products names from all modules with payments functionality. + * @param $iVendorId filter products by vendor ID. + * @param $iLimit limit number of records from one module. + * @return array of products where key id product name and value is module name + * + * @see BxBaseServices::serviceGetProductsNames + */ + /** + * @ref bx_system_general-get_products_names "get_products_names" + */ + public function serviceGetProductsNames($iVendorId = 0, $iLimit = 1000) + { + $o = BxDolPayments::getInstance(); + if (!$o) + return array(); + return $o->getProductsNames($iVendorId, $iLimit); + } + + /** + * @see iBxDolProfileService::serviceCheckSpacePrivacy + */ + public function serviceCheckSpacePrivacy($iContentId) + { + return _t('_Access denied'); + } + + public function serviceFormsHelper () + { + return new BxTemplAccountForms(); + } + + public function serviceActAsProfile () + { + return false; + } + + public function servicePrepareFields ($aFieldsProfile) + { + return $aFieldsProfile; + } + + public function serviceProfilesSearch ($sTerm, $iLimit) + { + $oDb = BxDolAccountQuery::getInstance(); + $aRet = array(); + $a = $oDb->searchByTerm($sTerm, $iLimit); + foreach ($a as $r) + $aRet[] = array ('label' => $this->serviceProfileName($r['content_id']), 'value' => $r['profile_id']); + return $aRet; + } + + /** + * @page service Service Calls + * @section bx_system_general System Services + * @subsection bx_system_general-general General + * @subsubsection bx_system_general-keyword_search keyword_search + * + * @code bx_srv('system', 'keyword_search', ["bx_posts", ["keyword" => "test"}], 'TemplServices'); @endcode + * + * @code {{~system:keyword_search:TemplServices["bx_posts", {"keyword":"test"}]~}} @endcode + * @code {{~system:keyword_search:TemplServices["bx_albums", {"meta_type": "location_country", "keyword": "AU"}, "unit.html"]~}} @endcode + * @code {{~system:keyword_search:TemplServices["bx_albums", {"meta_type": "location_country_state", "state":"NSW", "keyword": "AU"}, "unit.html"]~}} @endcode + * @code {{~system:keyword_search:TemplServices["bx_albums", {"meta_type": "location_country_city", "state":"NSW", "city":"Manly", "keyword": "AU"}, "unit.html"]~}} @endcode + * @code {{~system:keyword_search:TemplServices["bx_posts", {"meta_type": "mention", "keyword": 2}, "unit_gallery.html"]~}} @endcode + * @code {{~system:keyword_search:TemplServices["bx_posts", {"cat": "bx_posts_cats", "keyword": 3}, "unit_gallery.html"]~}} @endcode + * + * Search by keyword + * @param $sSection - search object to search in, usually module name, for example: bx_posts + * @param $aCondition - condition for search, supported conditions: + * - search by keyword: ["keyword" => "test"] + * - search by country: ["meta_type" => "location_country", "keyword" => "AU"] + * - search by country and state: ["meta_type": "location_country_state", "state":"NSW", "keyword": "AU"] + * - search by country, state and city: ["meta_type": "location_country_city", "state":"NSW", "city":"Manly", "keyword": "AU"] + * - search for mentions: ["meta_type" => "mention", "keyword" => 2] + * - search in category: ["cat": "bx_posts_cats", "keyword": 3] + * @param $sTemplate - template for displaying search results, for example: unit.html + * @param $iStart - paginate, display records starting from this number + * @param $iPerPage - paginate, display this number of records per page + * @param $bLiveSearch - search results like in live search + * + * @see BxBaseServices::serviceKeywordSearch + */ + /** + * @ref bx_system_general-keyword_search "keyword_search" + */ + public function serviceKeywordSearch ($sSection, $aCondition, $sTemplate = '', $iStart = 0, $iPerPage = 0, $bLiveSearch = 0, $bPaginate = false) + { + if (!$sSection || !isset($aCondition['keyword'])) + return ''; + + $sClass = 'BxTemplSearch'; + + $sElsName = 'bx_elasticsearch'; + $sElsMethod = 'is_configured'; + if(BxDolRequest::serviceExists($sElsName, $sElsMethod) && BxDolService::call($sElsName, $sElsMethod)) { + $oModule = BxDolModule::getInstance($sElsName); + + bx_import('Search', $oModule->_aModule); + $sClass = 'BxElsSearch'; + } + + $oSearch = new $sClass(array($sSection)); + $oSearch->setLiveSearch($bLiveSearch); + $oSearch->setMetaType(isset($aCondition['meta_type']) ? $aCondition['meta_type'] : ''); + $oSearch->setCategoryObject(isset($aCondition['cat']) ? $aCondition['cat'] : ''); + $oSearch->setCustomSearchCondition($aCondition); + if (!$bPaginate) + $oSearch->setRawProcessing(true); + $oSearch->setCustomCurrentCondition(array( + 'paginate' => array ( + 'start' => $iStart, + 'perPage' => $iPerPage ? $iPerPage : BX_DOL_SEARCH_RESULTS_PER_PAGE_DEFAULT, + ))); + if ($sTemplate) + $oSearch->setUnitTemplate($sTemplate); + + return $oSearch->response(); + } + + /** + * @page service Service Calls + * @section bx_system_general System Services + * @subsection bx_system_general-general General + * @subsubsection bx_system_general-keyword_search keyword_search + * + * @code bx_srv('system', 'search_keyword_form', 'TemplServices'); @endcode + * + * Block with Search by Keywords Form + * + * @see BxBaseServices::serviceSearchKeywordForm + */ + /** + * @ref bx_system_general-keyword_search "keyword_search" + */ + public function serviceSearchKeywordForm () + { + return $this->_getSearchObject()->getForm(BX_DB_PADDING_DEF, false, true); + } + + /** + * @page service Service Calls + * @section bx_system_general System Services + * @subsection bx_system_general-general General + * @subsubsection bx_system_general-keyword_search keyword_search + * + * @code bx_srv('system', 'search_keyword_result', 'TemplServices'); @endcode + * + * Block with Search by Keywords Results + * + * @see BxBaseServices::serviceSearchKeywordResult + */ + /** + * @ref bx_system_general-keyword_search "keyword_search" + */ + public function serviceSearchKeywordResult () + { + $sKeyword = bx_process_input(bx_get('keyword')); + $bKeyword = $sKeyword !== false; + + if(bx_is_api()) + return $this->serviceGetDataSearchApi(['params' => + [ + 'keyword' => $sKeyword, + 'section' => bx_process_input(bx_get('section')), + 'cat' => bx_process_input(bx_get('cat')) + ] + ]); + + $sCode = ''; + if($bKeyword) { + $oSearch = $this->_getSearchObject(); + + $sCode = $oSearch->response(); + if(!$sCode) + $sCode = $oSearch->getEmptyResult(); + } + + return $sCode; + } + + /** + * @ref bx_system_general-get_date_search_api "get_date_search_api" + * @api @ref bx_system_general-get_date_search_api "get_date_search_api" + */ + public function serviceGetDataSearchApi ($aParams) + { + if(!bx_is_api()) + return false; + + if(is_string($aParams)) + $aParams = json_decode($aParams, true); + + $aSections = []; + $aSectionsAll = BxDolDb::getInstance()->fromCache( + 'sys_global_search_pairs', + 'getPairs', + 'SELECT `ObjectName` AS `name`, `Title` AS `title` FROM `sys_objects_search` WHERE `GlobalSearch`=\'1\' ORDER BY `Order` ASC', + 'name', 'title' + ); + + $aSectionNames = explode(',', getParam('sys_api_search_sections')); + foreach($aSectionNames as $sSectionName) { + if(!isset($aSectionsAll[$sSectionName])) + continue; + + $aSections[$sSectionName] = [ + 'name' => $sSectionName, + 'title' => _t($aSectionsAll[$sSectionName]) + ]; + } + + $aParamsBrowse = array_merge([ + 'keyword' => '', + 'section' => '', + 'sections' => array_values($aSections), + 'start' => 0, + 'per_page' => 12 + ], !empty($aParams['params']) && is_array($aParams['params']) ? $aParams['params'] : []); + + if(empty($aParamsBrowse['section'])) + $aParamsBrowse['section'] = array_keys($aSections); + else if(is_string($aParamsBrowse['section'])) + $aParamsBrowse['section'] = explode(',', $aParamsBrowse['section']); + + $sClass = 'BxTemplSearch'; + $oSearch = new $sClass($aParamsBrowse['section']); + $oSearch->setLiveSearch(true); + $oSearch->setDataProcessing(true); + $oSearch->setCustomSearchCondition(['keyword' => $aParamsBrowse['keyword']]); + $oSearch->setCustomCurrentCondition([ + 'paginate' => [ + 'forceStart' => $aParamsBrowse['start'], + 'perPage' => $aParamsBrowse['per_page'], + ] + ]); + + $aData = $oSearch->response(); + if(count($aData) > $aParamsBrowse['per_page']) + $aData = array_slice($aData, $aParamsBrowse['start'], $aParamsBrowse['per_page']); + + return [ + bx_api_get_block('browse', [ + 'unit' => 'search-results', + 'request_url' => '/api.php?r=system/get_data_search_api/TemplServices¶ms[]=', + 'params' => $aParamsBrowse, + 'data' => $aData + ]) + ]; + } + + /** + * @page service Service Calls + * @section bx_system_general System Services + * @subsection bx_system_general-general General + * @subsubsection bx_system_general-cmts cmts + * + * @code bx_srv('system', 'cmts', ["sys_blocks", 1], 'TemplServices'); @endcode + * + * @code {{~system:cmts:TemplServices["sys_blocks", 1]~}} @endcode + * + * Comments block + * @param $sObject - comments object name + * @param $sId - content id assiciated tith the comments + * + * @see BxBaseServices::serviceCmts + */ + /** + * @ref bx_system_general-cmts "cmts" + */ + public function serviceCmts ($sObject, $sId) + { + $o = BxDolCmts::getObjectInstance($sObject, $sId); + if (!$o || !$o->isEnabled()) + return ''; + return $o->getCommentsBlock(array(), array('in_designbox' => false, 'show_empty' => true)); + } + + public function _serviceProfileFunc ($sFunc, $iContentId, $aParams = array()) + { + if (!$iContentId) + return false; + if (!($oAccount = BxDolAccount::getInstance($iContentId))) + return false; + + return $oAccount->$sFunc(false, $aParams); + } + + public function serviceAlertResponseProcessInstalled() + { + BxDolTranscoderImage::registerHandlersSystem(); + } + + public function serviceAlertResponseProcessStorageChange ($oAlert) + { + if ('sys_storage_default' != $oAlert->aExtras['option']) + return; + + $aStorages = BxDolStorageQuery::getStorageObjects(); + foreach ($aStorages as $r) { + if (0 == $r['current_size'] && 0 == $r['current_number'] && ($oStorage = BxDolStorage::getObjectInstance($r['object']))) + $oStorage->changeStorageEngine($oAlert->aExtras['value']); + } + + } + + public function serviceGetOptionsProfileBot() + { + $aResult = array( + array('key' => '', 'value' => _t('_Select_one')) + ); + + $aAccountsIds = BxDolAccountQuery::getInstance()->getOperators(); + foreach($aAccountsIds as $iAccountId) { + $aProfilesIds = BxDolAccount::getInstance($iAccountId)->getProfilesIds(true, false); + foreach($aProfilesIds as $iProfileId) { + $oProfile = BxDolProfile::getInstance($iProfileId); + $aResult[] = array( + 'key' => $iProfileId, + 'value' => _t('_sys_profile_with_type', $oProfile->getDisplayName(), $oProfile->getModule()), + ); + } + } + + return $aResult; + } + + public function serviceGetOptionsModuleListForPrivacySelector() + { + $aResult = array(); + $BxDolModuleQuery = BxDolModuleQuery::getInstance(); + $aModules = $BxDolModuleQuery->getModulesBy(array('type' => 'modules', 'active' => 1)); + foreach($aModules as $aModule){ + $oModule = BxDolModule::getInstance($aModule['name']); + if($oModule instanceof iBxDolContentInfoService){ + if (!BxDolRequest::serviceExists($aModule['name'], 'act_as_profile')) + continue; + $aResult[$aModule['name']] = $aModule['title']; + } + } + return $aResult; + } + + + public function serviceGetOptionsCaptchaDefault() + { + $aResults = []; + $aObjects = BxDolCaptchaQuery::getObjects(); + foreach($aObjects as $aObject) + $aResults[$aObject['object']] = $aObject['title']; + + return $aResults; + } + + public function serviceGetOptionsEmbedDefault() + { + $aResults = array( + '' => _t('_None') + ); + + $aObjects = BxDolEmbedQuery::getObjects(); + foreach($aObjects as $aObject) + $aResults[$aObject['object']] = $aObject['title']; + + return $aResults; + } + + public function serviceGetOptionsLocationFieldDefault() + { + $aResults = array(); + + $aObjects = BxDolLocationFieldQuery::getObjects(); + foreach($aObjects as $aObject) + $aResults[$aObject['object']] = _t($aObject['title']); + + return $aResults; + } + + public function serviceGetOptionsLocationMapDefault() + { + $aResults = array(); + + $aObjects = BxDolLocationMapQuery::getObjects(); + foreach($aObjects as $aObject) + $aResults[$aObject['object']] = _t($aObject['title']); + + return $aResults; + } + + public function serviceGetOptionsSocketsFieldDefault() + { + $aResults = []; + $aObjects = ['sys_sockets_disabled', 'sys_sockets_soketi']; + foreach($aObjects as $sObject) + $aResults[$sObject] = _t('_adm_stg_cpt_option_sys_sockets_type_' . $sObject); + return $aResults; + } + + public function serviceGetOptionsLocationLeafletGetProviders() + { + return BxDolLocationMapLeaflet::getProviders(); + } + + public function serviceGetOptionsRelations() + { + $aModules = BxDolModuleQuery::getInstance()->getModulesBy(array('type' => 'modules', 'active' => 1)); + + $aProfiles = array(); + foreach($aModules as $aModule) { + $sMethod = 'act_as_profile'; + if(!BxDolRequest::serviceExists($aModule['name'], $sMethod) || !BxDolService::call($aModule['name'], $sMethod)) + continue; + + $aProfiles[$aModule['name']] = _t('_' . $aModule['name']); + } + + $aResults = array(); + foreach($aProfiles as $sName1 => $sTitle1) + foreach($aProfiles as $sName2 => $sTitle2) + $aResults[$sName1 . '_' . $sName2] = $sTitle1 . ' - ' . $sTitle2; + + return $aResults; + } + + public function serviceGetOptionsCfProhibited() + { + return BxDolFormQuery::getDataItems('sys_content_filter'); + } + + public function serviceGetOptionsCfUnauthenticated() + { + return BxDolFormQuery::getDataItems('sys_content_filter'); + } + + public function serviceGetOptionsTaiwindDefault() + { + $sPath = BX_DIRECTORY_PATH_PLUGINS_PUBLIC . 'tailwind/css'; + $aExcludes = ['.', '..', 'tailwind.css']; + + $aResults = []; + if(($oHandle = opendir($sPath)) !== false) { + while(($sFile = readdir($oHandle)) !== false) { + if(in_array($sFile, $aExcludes)) + continue; + + if(($oHandlerFile = fopen($sPath . '/' . $sFile, 'r')) === false) + continue; + + if(($sContent = fread($oHandlerFile, 1024)) !== false && strpos($sContent, '@tailwind base') === false) + $aResults[$sFile] = $sFile; + + fclose($oHandlerFile); + } + + closedir($oHandle); + } + + return $aResults; + } + + public function serviceGetOptionsApiMenuTop() + { + $aMenus = BxDolMenuQuery::getMenuObjects(); + + $aResults = ['' => _t('_sys_please_select')]; + foreach($aMenus as $aMenu) + if($aMenu['module'] == 'system') + $aResults[$aMenu['object']] = _t($aMenu['title']); + + return $aResults; + } + + public function serviceGetOptionsAgentsModel() + { + return ['' => _t('_Select_one')] + BxDolAI::getInstance()->getModels(['active' => true, 'hidden' => false]); + } + + public function serviceGetOptionsAgentsProfile($bSelectOne = true) + { + $aResult = []; + if($bSelectOne) + $aResult[] = ['key' => '', 'value' => _t('_Select_one')]; + + $aAccountsIds = BxDolAccountQuery::getInstance()->getOperators(); + foreach($aAccountsIds as $iAccountId) { + $aProfilesIds = BxDolAccount::getInstance($iAccountId)->getProfilesIds(true, false); + foreach($aProfilesIds as $iProfileId) + if(($oProfile = BxDolProfile::getInstance($iProfileId)) !== false && ($sProfileModule = $oProfile->getModule()) != 'system') + $aResult[] = [ + 'key' => $iProfileId, + 'value' => _t('_sys_profile_with_type', $oProfile->getDisplayName(), _t('_' . $sProfileModule)) + ]; + } + + return $aResult; + } + + public function serviceGetOptionsStudioAssistant() + { + return ['' => _t('_Select_one')] + BxDolAI::getInstance()->getAssistants(['active' => true, 'hidden' => false]); + } + + public function serviceGetOptionsLiveSearchAssistant() + { + return ['' => _t('_Select_one')] + BxDolAI::getInstance()->getAssistants(['active' => true, 'hidden' => false]); + } + + public function serviceGetOptionsAskBlockAssistant() + { + return ['' => _t('_Select_one')] + BxDolAI::getInstance()->getAssistants(['active' => true, 'hidden' => false]); + } + + public function serviceRedirect($sUrl = false) + { + if (!getParam('sys_confirmation_before_redirect')) { + BxDolTemplate::getInstance()->displayPageNotFound(); + exit; + } + + if (false === $sUrl) + $sUrl = bx_get('url'); + + if (!$sUrl || !preg_match('@^https?://@', $sUrl)) { + http_response_code(500); + return MsgBox(_t('_error occured')); + } + else { + + $bSpam = null; + /** + * @hooks + * @hookdef hook-system-check_spam_url 'system', 'check_spam_url' - hook to override sClass for search + * - $unit_name - equals `system` + * - $action - equals `check_spam_url` + * - $object_id - not used + * - $sender_id - logged account id + * - $extra_params - array of additional params with the following array keys: + * - `is_spam` - [bool] by ref, spam url or not, can be overridden in hook processing + * - `content` - [string] by ref, url of link, can be overridden in hook processing + * - `where` - [string] equal redirect + * @hook @ref hook-system-check_spam_url + */ + bx_alert('system', 'check_spam_url', 0, getLoggedId(), array('is_spam' => &$bSpam, 'content' => &$sUrl, 'where' => 'redirect')); + + $sLangKey = $bSpam ? '_sys_redirect_confirmation_harmful' : '_sys_redirect_confirmation'; + return BxDolTemplate::getInstance()->parseHtmlByName('redirect.html', [ + 'text' => _t($sLangKey, bx_process_output($sUrl), getParam('site_title')), + 'url' => bx_js_string($sUrl, BX_ESCAPE_STR_APOS), + ]); + } + } + + public function serviceGetBadge($aBadge, $bIsCompact = false) + { + $sClass = ''; + $sStyleFont = ''; + $sStyleBg = ''; + if ($aBadge['color'] == '') + $aBadge['color'] = 'purple-600'; + + if ($bIsCompact && $aBadge['icon'] != ''){ + $aBadge['is_icon_only'] = 1; + } + if ($aBadge['is_icon_only'] == 1){ + $sClass .= ' bx-badge-compact'; + if (substr_count($aBadge['color'], 'rgb(')) + $sStyleFont = 'color: ' . $aBadge['color']; + else + $sClass .= ' text-' . $aBadge['color']; + } + else{ + if (substr_count($aBadge['color'], 'rgb(')) + $sStyleBg = 'background-color: ' . $aBadge['color']; + else + $sClass .= ' bg-' . $aBadge['color']; + } + + return BxDolTemplate::getInstance()->parseHtmlByName('badge.html', array( + 'bx_if:content' => array( + 'condition' => $aBadge['is_icon_only'] != '1', + 'content' => array('content' => _t($aBadge['text'])), + ), + 'bx_if:icon' => array( + 'condition' => $aBadge['icon'] != '', + 'content' => array('content' => BxDolTemplate::getInstance()->getIcon($aBadge['icon'], array('class' => 'bx-badge-icon sys-colored', 'style' => $sStyleFont))), + ), + 'title' => $aBadge['text'], + 'style_font' => $sStyleFont, + 'style_bg' => $sStyleBg, + 'class' => $sClass, + ) + ); + } + + public function serviceGetFooter() + { + return BxDolTemplate::getInstance()->parseHtmlByName('footer.html', []); + } + + private function _getSearchObject() + { + $sClass = 'BxTemplSearch'; + $sElsName = 'bx_elasticsearch'; + $sElsMethod = 'is_configured'; + if(BxDolRequest::serviceExists($sElsName, $sElsMethod) && BxDolService::call($sElsName, $sElsMethod) && !bx_get('cat') && !bx_get('type')) { + $oModule = BxDolModule::getInstance($sElsName); + bx_import('Search', $oModule->_aModule); + $sClass = 'BxElsSearch'; + } + /** + * @hooks + * @hookdef hook-system-search_keyword 'system', 'search_keyword' - hook to override sClass for search + * - $unit_name - equals `system` + * - $action - equals `search_keyword` + * - $object_id - not used + * - $sender_id - not used + * - $extra_params - array of additional params with the following array keys: + * - `override_result` - [string] by ref, class name for search, can be overridden in hook processing + * @hook @ref hook-system-search_keyword + */ + bx_alert('system', 'search_keyword', 0, 0, array('class' => &$sClass)); + + $oSearch = new $sClass(bx_get('section')); + $oSearch->setLiveSearch(bx_get('live_search') ? 1 : 0); + $oSearch->setMetaType(bx_process_input(bx_get('type'))); + $oSearch->setCategoryObject(bx_process_input(bx_get('cat'))); + + return $oSearch; + } +} + +/** @} */ diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/search_extended_results.html b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/search_extended_results.html new file mode 100644 index 0000000000..b22cb85e12 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/search_extended_results.html @@ -0,0 +1,7 @@ + + __sort__ + __code__ + + __paginate__ + + \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/uploader_button_html5_js.html b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/uploader_button_html5_js.html new file mode 100644 index 0000000000..60fd4b0a8e --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/uploader_button_html5_js.html @@ -0,0 +1,23 @@ +__uploader_instance_name__ = new BxDolUploaderHTML5('__engine__', '__storage_object__', '__uniq_id__', { + 'multiple': __multiple__, + 'latest': __latest__, + 'content_id': '__content_id__', + 'images_transcoder' : '__images_transcoder__', + 'storage_private' : '__storage_private__', + 'template_error_msg': '{error}', + 'template_ghost': __template_ghost__, + 'reordering': __is_init_reordering__, + 'maxFilesize': __max_file_size__/1024.0/1024.0, + 'acceptedFiles': __accepted_files__, + 'resizeWidth': __resize_width__, + 'resizeHeight': __resize_height__, + 'resizeMethod': __resize_method__, + 'dictDefaultMessage': '', + 'dictFileTooBig': '', + 'dictMaxFilesExceeded': '', + 'dictInvalidFileType': '', + 'on_upload_before': __on_upload_before__, + 'on_upload': __on_upload__, + 'on_restore_ghosts': __on_restore_ghosts__ +}); +__uploader_instance_name__.restoreGhosts(__is_init_reordering__); \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/vote_counter_label_likes.html b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/vote_counter_label_likes.html new file mode 100644 index 0000000000..7353b21035 --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/vote_counter_label_likes.html @@ -0,0 +1,8 @@ + + + __icon__ + + + __text__ + + \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/vote_counter_label_reactions.html b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/vote_counter_label_reactions.html new file mode 100644 index 0000000000..c54f718d4f --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/vote_counter_label_reactions.html @@ -0,0 +1,16 @@ + + + + + + + + __emoji__ + + __image__ + + + + __text__ + + \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/vote_counter_wrapper_reactions.html b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/vote_counter_wrapper_reactions.html new file mode 100644 index 0000000000..86d25031fb --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/template/vote_counter_wrapper_reactions.html @@ -0,0 +1,9 @@ + + + __counter__ + + __counter__ + + __script__ + + \ No newline at end of file diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/script.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/script.php index 5987147399..20b8665a97 100644 --- a/upgrade/files/14.0.0.B2-14.0.0.RC1/script.php +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/script.php @@ -3,6 +3,9 @@ if (!$this->oDb->isFieldExists('sys_options', 'info')) $this->oDb->query("ALTER TABLE `sys_options` ADD `info` varchar(255) NOT NULL default '' AFTER `caption`"); + $aPathInfo = pathinfo(__FILE__); + $this->oDb->executeSQL($aPathInfo['dirname'] . '/sql_update_info.sql'); + if (!$this->oDb->isFieldExists('sys_agents_models', 'for_asst')) $this->oDb->query("ALTER TABLE `sys_agents_models` ADD `for_asst` tinyint(4) NOT NULL DEFAULT '0' AFTER `params`"); diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/sql.sql b/upgrade/files/14.0.0.B2-14.0.0.RC1/sql.sql index 732b57f7bc..adbc12e50b 100644 --- a/upgrade/files/14.0.0.B2-14.0.0.RC1/sql.sql +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/sql.sql @@ -10,27 +10,6 @@ INSERT INTO `sys_objects_cmts` (`Name`, `Module`, `Table`, `CharsPostMin`, `Char -- Options -SET @iCategoryId = (SELECT `id` FROM `sys_options_categories` WHERE `name` = 'hidden'); - -INSERT IGNORE INTO `sys_options`(`category_id`, `name`, `caption`, `value`, `type`, `extra`, `check`, `check_params`, `check_error`, `order`) VALUES -(@iCategoryId, 'sys_embed_microlink_key', '_adm_stg_cpt_option_sys_embed_microlink_key', '', 'digit', '', '', '', '', 300); - -UPDATE `sys_options` SET `info` = '_adm_stg_inf_option_site_title' WHERE `name` = 'site_title'; -UPDATE `sys_options` SET `info` = '_adm_stg_inf_option_site_email' WHERE `name` = 'site_email'; -UPDATE `sys_options` SET `info` = '_adm_stg_inf_option_site_email_notify' WHERE `name` = 'site_email_notify'; -UPDATE `sys_options` SET `info` = '_adm_stg_inf_option_site_tour_home' WHERE `name` = 'site_tour_home'; -UPDATE `sys_options` SET `info` = '_adm_stg_inf_option_site_tour_studio' WHERE `name` = 'site_tour_studio'; -UPDATE `sys_options` SET `info` = '_adm_stg_inf_option_sys_autoupdate' WHERE `name` = 'sys_autoupdate'; -UPDATE `sys_options` SET `info` = '_adm_stg_inf_option_sys_autoupdate_force_modified_files' WHERE `name` = 'sys_autoupdate_force_modified_files'; -UPDATE `sys_options` SET `info` = '_adm_stg_inf_option_smart_app_banner' WHERE `name` = 'smart_app_banner'; -UPDATE `sys_options` SET `info` = '_adm_stg_inf_option_smart_app_banner_ios_app_id' WHERE `name` = 'smart_app_banner_ios_app_id'; -UPDATE `sys_options` SET `info` = '_adm_stg_inf_option_sys_per_page_search_keyword_single' WHERE `name` = 'sys_per_page_search_keyword_single'; -UPDATE `sys_options` SET `info` = '_adm_stg_inf_option_sys_per_page_search_keyword_plural' WHERE `name` = 'sys_per_page_search_keyword_plural'; -UPDATE `sys_options` SET `info` = '_adm_stg_inf_option_sys_live_search_limit' WHERE `name` = 'sys_live_search_limit'; -UPDATE `sys_options` SET `info` = '_adm_stg_inf_option_sys_profiles_search_limit' WHERE `name` = 'sys_profiles_search_limit'; -UPDATE `sys_options` SET `info` = '_adm_stg_inf_option_sys_profile_bot' WHERE `name` = 'sys_profile_bot'; -UPDATE `sys_options` SET `info` = '_adm_stg_inf_option_sys_create_post_form_preloading_list' WHERE `name` = 'sys_create_post_form_preloading_list'; - SET @iCategoryId = (SELECT `id` FROM `sys_options_categories` WHERE `name` = 'storage'); INSERT IGNORE INTO `sys_options`(`category_id`, `name`, `caption`, `value`, `type`, `extra`, `check`, `check_error`, `order`) VALUES diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/sql_update_info.sql b/upgrade/files/14.0.0.B2-14.0.0.RC1/sql_update_info.sql new file mode 100644 index 0000000000..ba5f5b118a --- /dev/null +++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/sql_update_info.sql @@ -0,0 +1,22 @@ + +SET @iCategoryId = (SELECT `id` FROM `sys_options_categories` WHERE `name` = 'hidden'); + +INSERT IGNORE INTO `sys_options`(`category_id`, `name`, `caption`, `value`, `type`, `extra`, `check`, `check_params`, `check_error`, `order`) VALUES +(@iCategoryId, 'sys_embed_microlink_key', '_adm_stg_cpt_option_sys_embed_microlink_key', '', 'digit', '', '', '', '', 300); + +UPDATE `sys_options` SET `info` = '_adm_stg_inf_option_site_title' WHERE `name` = 'site_title'; +UPDATE `sys_options` SET `info` = '_adm_stg_inf_option_site_email' WHERE `name` = 'site_email'; +UPDATE `sys_options` SET `info` = '_adm_stg_inf_option_site_email_notify' WHERE `name` = 'site_email_notify'; +UPDATE `sys_options` SET `info` = '_adm_stg_inf_option_site_tour_home' WHERE `name` = 'site_tour_home'; +UPDATE `sys_options` SET `info` = '_adm_stg_inf_option_site_tour_studio' WHERE `name` = 'site_tour_studio'; +UPDATE `sys_options` SET `info` = '_adm_stg_inf_option_sys_autoupdate' WHERE `name` = 'sys_autoupdate'; +UPDATE `sys_options` SET `info` = '_adm_stg_inf_option_sys_autoupdate_force_modified_files' WHERE `name` = 'sys_autoupdate_force_modified_files'; +UPDATE `sys_options` SET `info` = '_adm_stg_inf_option_smart_app_banner' WHERE `name` = 'smart_app_banner'; +UPDATE `sys_options` SET `info` = '_adm_stg_inf_option_smart_app_banner_ios_app_id' WHERE `name` = 'smart_app_banner_ios_app_id'; +UPDATE `sys_options` SET `info` = '_adm_stg_inf_option_sys_per_page_search_keyword_single' WHERE `name` = 'sys_per_page_search_keyword_single'; +UPDATE `sys_options` SET `info` = '_adm_stg_inf_option_sys_per_page_search_keyword_plural' WHERE `name` = 'sys_per_page_search_keyword_plural'; +UPDATE `sys_options` SET `info` = '_adm_stg_inf_option_sys_live_search_limit' WHERE `name` = 'sys_live_search_limit'; +UPDATE `sys_options` SET `info` = '_adm_stg_inf_option_sys_profiles_search_limit' WHERE `name` = 'sys_profiles_search_limit'; +UPDATE `sys_options` SET `info` = '_adm_stg_inf_option_sys_profile_bot' WHERE `name` = 'sys_profile_bot'; +UPDATE `sys_options` SET `info` = '_adm_stg_inf_option_sys_create_post_form_preloading_list' WHERE `name` = 'sys_create_post_form_preloading_list'; +
"; + print_r( $what ); + echo "
__code_onclick__
__code_button__
->getIconUrl('user.png') . ')
', $s);
+ * }
+ * @endcode
+ *
+ * The above example replaces column header text with the image.
+ *
+ *
+ *
+ * @section grid_display_custom_action Displaying custom action
+ *
+ * All actions are displayed as buttons. Bulk and independent actions are displaed as big buttons and single actions are displayed as small buttons.
+ *
+ * It is possible to completely customize it by adding the following method to your custom class:
+ * _getAction[action name]
+ * where [action name] is the action name with the capital first letter.
+ *
+ * For example:
+ *
+ * @code
+ * protected function _getActionCustom1 ($sType, $sKey, $a, $isSmall = false) {
+ * $sAttr = $this->_convertAttrs(
+ * $a, 'attr',
+ * 'bx-btn bx-def-margin-sec-left' . ($isSmall ? ' bx-btn-small' : '') // add default classes
+ * );
+ * return '';
+ * }
+ * @endcode
+ *
+ * The above example disables default onclick event and just displays an alert. Please note that you need to convert attributes by adding some default classes or styles if you need.
+ *
+ *
+ *
+ * @section grid_add_action_handler Add action handler
+ *
+ * As it was mentioned earlier only several actions can be handled automatically, all other actions must be processed manually.
+ * To add action handler you need to add method to your custom class with the following format:
+ * performAction[action name]
+ * where [action name] is the action name with the capital first letter.
+ *
+ * For example:
+ *
+ * @code
+ * public function performActionApprove() {
+ *
+ * $iAffected = 0;
+ * $aIds = bx_get('ids');
+ * if (!$aIds || !is_array($aIds)) {
+ * echoJson(array());
+ * exit;
+ * }
+ *
+ * $aIdsAffected = array ();
+ * foreach ($aIds as $mixedId) {
+ * if (!$this->_approve($mixedId))
+ * continue;
+ * $aIdsAffected[] = (int)$mixedId;
+ * $iAffected++;
+ * }
+ *
+ * echoJson(array(
+ * 'msg' => $iAffected > 0 ? sprintf("%d profiles successfully activated", $iAffected) : "Profile(s) activation failed",
+ * 'grid' => $this->getCode(false),
+ * 'blink' => $aIdsAffected,
+ * ));
+ * }
+ *
+ * protected function _approve ($mixedId) {
+ * $oDb = BxDolDb::getInstance();
+ * $sTable = $this->_aOptions['table'];
+ * $sFieldId = $this->_aOptions['field_id'];
+ * $sQuery = $oDb->prepare("UPDATE `{$sTable}` SET `Status` = 'Active' WHERE `{$sFieldId}` = ?", $mixedId);
+ * return $oDb->query($sQuery);
+ * }
+ * @endcode
+ *
+ * The action can be used as 'single' or 'bulk', in the case of 'single' action 'ids' array always has one element.
+ *
+ * As the result, action must outputs JSON array, which is done by echoJson function.
+ * The defined indexes in the array determines behavior after action is performed, the following behaviors are supported:
+ *
+ * - msg: display javascript alert message.
+ * - grid: reload grid data with the provided HTML code.
+ * - popup: display popup with the provided HTML code.
+ * - blink: highlight(blink effect) the specified rows, by the ids.
+ *
+ */
+
+class BxDolGrid extends BxDolFactory implements iBxDolFactoryObject, iBxDolReplaceable
+{
+ protected $_bIsApi;
+
+ protected $_aMarkers = array ();
+
+ protected $_sObject;
+ protected $_aOptions;
+
+ protected $_aBrowseParams;
+ protected $_sDefaultSortingOrder = 'ASC';
+ protected $_iTotalCount = 0;
+
+ protected $_bActionCsrfChecking;
+
+ /**
+ * Constructor
+ * @param $aOptions array of grid options
+ */
+ protected function __construct($aOptions)
+ {
+ parent::__construct();
+
+ $this->_bIsApi = bx_is_api();
+
+ $this->_bActionCsrfChecking = true;
+
+ $this->_sObject = $aOptions['object'];
+ $this->_aOptions = $aOptions;
+
+ $sBrowseParams = bx_get('bp');
+ if(!empty($sBrowseParams)) {
+ $aBrowseParams = bx_process_input(json_decode(urldecode($sBrowseParams), true));
+ if(!empty($aBrowseParams) && is_array($aBrowseParams))
+ $this->setBrowseParams($aBrowseParams);
+ }
+ }
+
+ /**
+ * Get grid object instance by object name
+ * @param $sObject object name
+ * @return object instance or false on error
+ */
+ public static function getObjectInstance($sObject, $oTemplate = false)
+ {
+ if (isset($GLOBALS['bxDolClasses']['BxDolGrid!'.$sObject]))
+ return $GLOBALS['bxDolClasses']['BxDolGrid!'.$sObject];
+
+ $aObject = BxDolGridQuery::getGridObject($sObject);
+ if (!$aObject || !is_array($aObject))
+ return false;
+
+ $sClass = 'BxTemplGrid';
+ if (!empty($aObject['override_class_name'])) {
+ $sClass = $aObject['override_class_name'];
+ if (!empty($aObject['override_class_file']))
+ require_once(BX_DIRECTORY_PATH_ROOT . $aObject['override_class_file']);
+ }
+
+ $o = new $sClass($aObject, $oTemplate);
+
+ if (!$o->_isVisibleGrid($aObject))
+ return false;
+
+ return ($GLOBALS['bxDolClasses']['BxDolGrid!'.$sObject] = $o);
+ }
+
+ public function getObject()
+ {
+ return $this->_sObject;
+ }
+
+ /**
+ * Add replace markers. Curently markers are replaced in 'source' field
+ * @param $a array of markers as key => value
+ * @return true on success or false on error
+ */
+ public function addMarkers ($a)
+ {
+ if (empty($a) || !is_array($a))
+ return false;
+ $this->_aMarkers = array_merge ($this->_aMarkers, $a);
+ return true;
+ }
+
+ public function setBrowseParams($aBrowseParams)
+ {
+ $this->_aBrowseParams = $aBrowseParams;
+ $this->_aQueryAppend['bp'] = urlencode(json_encode($this->_aBrowseParams));
+ }
+
+ /**
+ * Replace provided markers in form array
+ * @param $a form description array
+ * @return array where markes are replaced with real values
+ */
+ protected function _replaceMarkers ()
+ {
+ $this->_aOptions['source'] = bx_replace_markers($this->_aOptions['source'], $this->_aMarkers);
+ }
+
+ protected function _getData ($sFilter, $sOrderField, $sOrderDir, $iStart, $iPerPage)
+ {
+ $sFunc = '_getData' . $this->_aOptions['source_type'];
+ return $this->$sFunc($sFilter, $sOrderField, $sOrderDir, $iStart, $iPerPage);
+ }
+
+ protected function _getDataArray ($sFilter, $sOrderField, $sOrderDir, $iStart, $iPerPage)
+ {
+ if ($this->_aOptions['source'] && !is_array($this->_aOptions['source'])) {
+ $this->_aOptions['source'] = unserialize($this->_aOptions['source']);
+ }
+
+ // apply filter
+ if ($sFilter && (!empty($this->_aOptions['filter_fields']) || !empty($this->_aOptions['filter_fields_translatable']))) {
+ $aSource = array();
+ foreach ($this->_aOptions['source'] as $aRow) {
+ $bFound = false;
+ if (!empty($this->_aOptions['filter_fields'])) {
+ foreach ($this->_aOptions['filter_fields'] as $sField) {
+ if (empty($aRow[$sField]) || false === stripos($aRow[$sField], $sFilter))
+ continue;
+ $aSource[] = $aRow;
+ $bFound = true;
+ break;
+ }
+ }
+ if (!$bFound && !empty($this->_aOptions['filter_fields_translatable'])) {
+ foreach ($this->_aOptions['filter_fields_translatable'] as $sField) {
+ if (empty($aRow[$sField]) || false === stripos(_t($aRow[$sField]), $sFilter))
+ continue;
+ $aSource[] = $aRow;
+ $bFound = true;
+ break;
+ }
+ }
+ }
+ } else {
+ $aSource = &$this->_aOptions['source'];
+ }
+
+ // sort
+ $sSortField = false;
+ $iSortDir = 1;
+ if ($sOrderField && !empty($this->_aOptions['sorting_fields']) && is_array($this->_aOptions['sorting_fields']) && in_array($sOrderField, $this->_aOptions['sorting_fields'])) { // explicit order
+ $sSortField = $sOrderField;
+ $iSortDir = 0 === strcasecmp($sOrderDir, 'desc') ? -1 : 1;
+ } elseif (!empty($this->_aOptions['field_order'])) { // order by "order" field
+ $sSortField = $this->_aOptions['field_order'];
+ }
+
+ if ($sSortField) {
+ $aSourceOrdered = $aSource;
+ $this->_tmpOrderField = $sSortField;
+ $this->_tmpOrderDir = $iSortDir;
+ usort($aSourceOrdered, array($this, '_cmp'));
+ } else {
+ $aSourceOrdered = &$aSource;
+ }
+
+ // calculate total records count
+ if ($this->_aOptions['show_total_count'] == 1){
+ $this->_iTotalCount = count($aSourceOrdered);
+ }
+ return array_slice($aSourceOrdered, $iStart, $iPerPage, true);
+ }
+
+ protected function _getDataSql ($sFilter, $sOrderField, $sOrderDir, $iStart, $iPerPage)
+ {
+ $oDb = BxDolDb::getInstance();
+ $sQuery = $this->_aOptions['source'];
+ if (false === stripos($sQuery, ' WHERE '))
+ $sQuery .= " WHERE 1 ";
+
+ $aResults = false;
+ /**
+ * @hooks
+ * @hookdef hook-grid-get_data 'grid', 'get_data' - hook to override the data to be shown in the grid
+ * - $unit_name - equals `grid`
+ * - $action - equals `get_data`
+ * - $object_id - not used
+ * - $sender_id - not used
+ * - $extra_params - array of additional params with the following array keys:
+ * - `object` - [string] grid object name
+ * - `options` - [array] grid options array as key&value pairs
+ * - `markers` - [array] markers array as key&value pairs
+ * - `filter` - [string] filter value
+ * - `browse_params` - [array] additional browse params array as key&value pairs
+ * - `results` - [array] by ref, array of grid rows, where each row is an array of fields values, can be overridden in hook processing
+ * @hook @ref hook-grid-get_data
+ */
+ bx_alert('grid', 'get_data', 0, false, [
+ 'object' => $this->_sObject,
+ 'options' => $this->_aOptions,
+ 'markers' => $this->_aMarkers,
+ 'filter' => $sFilter,
+ 'browse_params' => $this->_aBrowseParams,
+ 'results' => &$aResults
+ ]);
+ if($aResults !== false)
+ return $aResults;
+
+ // add filter condition
+ $sOrderByFilter = '';
+ $sQuery .= $this->_getDataSqlWhereClause($sFilter, $sOrderByFilter);
+
+ // calculate total records count
+ if ($this->_aOptions['show_total_count'] == 1){
+ $this->_iTotalCount = $this->_getDataSqlCounter($sQuery, $sFilter);
+ }
+
+ // add order
+ $sQuery .= $this->_getDataSqlOrderClause ($sOrderByFilter, $sOrderField, $sOrderDir);
+
+ $sQuery = $sQuery . $oDb->prepareAsString(' LIMIT ?, ?', $iStart, $iPerPage);
+ return $oDb->getAll($sQuery);
+ }
+
+ protected function _getDataSqlCounter($sQuery, $sFilter)
+ {
+ $oDb = BxDolDb::getInstance();
+
+ $sQuery = preg_replace("/^SELECT.*FROM/mU", "SELECT COUNT(*) FROM ", $sQuery);
+ if(strpos($sQuery, 'GROUP BY') === false)
+ return $oDb->getOne($sQuery);
+ else
+ return array_sum($oDb->getColumn($sQuery));
+ }
+
+ protected function _getDataSqlWhereClause($sFilter, &$sOrderByFilter)
+ {
+ if(!$sFilter || (empty($this->_aOptions['filter_fields']) && empty($this->_aOptions['filter_fields_translatable'])))
+ return '';
+
+ $oDb = BxDolDb::getInstance();
+
+ $sMode = $this->_aOptions['filter_mode'];
+ if($sMode != 'like' && $sMode != 'fulltext')
+ $sMode = getParam('useLikeOperator') ? 'like' : 'fulltext';
+
+ $sCond = '';
+ if('like' == $sMode) { // LIKE search
+
+ // condition for regular fields
+ if (!empty($this->_aOptions['filter_fields']))
+ foreach ($this->_aOptions['filter_fields'] as $sField)
+ $sCond .= $oDb->prepareAsString("`{$sField}` LIKE ? OR ", '%' . $sFilter . '%');
+
+ // condition for translatable fields
+ if (!empty($this->_aOptions['filter_fields_translatable'])) {
+ $sCondFields = '';
+ foreach ($this->_aOptions['filter_fields_translatable'] as $sField)
+ $sCondFields .= "`k`.`Key` = `{$sField}` OR ";
+
+ $sCondFields = rtrim($sCondFields, ' OR ');
+
+ if ($sCondFields)
+ $sCond .= $oDb->prepareAsString("(SELECT 1 FROM `sys_localization_strings` AS `s` INNER JOIN `sys_localization_keys` AS `k` ON (`k`.`ID` = `s`.`IDKey`) WHERE `s`.`string` LIKE ? AND ($sCondFields) LIMIT 1) OR ", '%' . $sFilter . '%');
+ }
+
+ $sCond = rtrim($sCond, ' OR ');
+
+ }
+ else { // FULLTEXT search
+
+ // condition for regular fields
+ if (!empty($this->_aOptions['filter_fields'])) {
+
+ $sCondFields = '';
+ foreach ($this->_aOptions['filter_fields'] as $sField)
+ $sCondFields .= "`{$sField}`,";
+
+ $sCondFields = rtrim($sCondFields, ',');
+
+ if ($sCondFields) {
+ $sCond = $oDb->prepareAsString(" MATCH ($sCondFields) AGAINST (?) ", $sFilter);
+ $sOrderByFilter = $sCond;
+ $sCond .= ' > 1 OR ';
+ }
+ }
+
+ // condition for translatable fields
+ if (!empty($this->_aOptions['filter_fields_translatable'])) {
+
+ $sCondFields = '';
+ foreach ($this->_aOptions['filter_fields_translatable'] as $sField)
+ $sCondFields .= "`k`.`Key` = `{$sField}` OR ";
+
+ $sCondFields = rtrim($sCondFields, ' OR ');
+
+ if ($sCondFields)
+ $sCond .= $oDb->prepareAsString("(SELECT 1 FROM `sys_localization_strings` AS `s` INNER JOIN `sys_localization_keys` AS `k` ON (`k`.`ID` = `s`.`IDKey`) WHERE MATCH (`s`.`string`) AGAINST (?) AND ($sCondFields) LIMIT 1) OR ", $sFilter);
+ }
+
+ $sCond = rtrim($sCond, ' OR ');
+ }
+
+ /**
+ * @hooks
+ * @hookdef hook-grid-get_data_by_filter 'grid', 'get_data_by_filter' - hook to override the data to be shown in the grid
+ * - $unit_name - equals `grid`
+ * - $action - equals `get_data_by_filter`
+ * - $object_id - not used
+ * - $sender_id - not used
+ * - $extra_params - array of additional params with the following array keys:
+ * - `object` - [string] grid object name
+ * - `options` - [array] grid options array as key&value pairs
+ * - `markers` - [array] markers array as key&value pairs
+ * - `filter` - [string] filter value
+ * - `browse_params` - [array] additional browse params array as key&value pairs
+ * - `conditions` - [string] by ref, 'where' part of SQL query in accordance with provided filter(s), can be overridden in hook processing
+ * @hook @ref hook-grid-get_data_by_filter
+ */
+ bx_alert('grid', 'get_data_by_filter', 0, false, [
+ 'object' => $this->_sObject,
+ 'options' => $this->_aOptions,
+ 'markers' => $this->_aMarkers,
+ 'filter' => $sFilter,
+ 'browse_params' => $this->_aBrowseParams,
+ 'conditions' => &$sCond
+ ]);
+
+ return $sCond ? ' AND (' . $sCond . ')' : $sCond;
+ }
+
+ protected function _getDataSqlOrderClause ($sOrderByFilter, $sOrderField, $sOrderDir, $bFieldsOnly = false)
+ {
+ $sOrderClause = '';
+
+ if ($sOrderField && is_array($this->_aOptions['sorting_fields']) && in_array($sOrderField, $this->_aOptions['sorting_fields'])) { // explicit order
+
+ $sDir = (0 === strcasecmp($sOrderDir, 'desc') ? 'DESC' : 'ASC');
+
+ if (is_array($this->_aOptions['sorting_fields_translatable']) && in_array($sOrderField, $this->_aOptions['sorting_fields_translatable'])) {
+
+ // translatable fields
+ $iLang = BxDolLanguages::getInstance()->getCurrentLangId();
+ $oDb = BxDolDb::getInstance();
+ $sOrderClause = $oDb->prepareAsString("(SELECT `s`.`string` FROM `sys_localization_strings` AS `s` INNER JOIN `sys_localization_keys` AS `k` ON (`k`.`ID` = `s`.`IDKey`) WHERE `k`.`KEY` = `$sOrderField` AND `s`.`IDLanguage` = ? LIMIT 1) ", $iLang) . $sDir;
+
+ } else {
+
+ // regular fields
+ $sOrderClause = "`" . $sOrderField . "` $sDir";
+
+ }
+
+ } elseif ($sOrderByFilter) { // order by filter
+
+ $sOrderClause = $sOrderByFilter . " DESC";
+
+ } elseif (!empty($this->_aOptions['field_order'])) { // order by "order" field
+
+ if (false == strpos($this->_aOptions['field_order'], ',')) {
+ $sOrderClause = "`" . $this->_aOptions['field_order'] . "` " . $this->_sDefaultSortingOrder;
+ } else {
+ $a = explode(',', $this->_aOptions['field_order']);
+ foreach ($a as $sField)
+ $sOrderClause .= "`" . trim($sField) . "` " . $this->_sDefaultSortingOrder . ", ";
+
+ if ($sOrderClause)
+ $sOrderClause = trim($sOrderClause, ', ');
+ }
+
+ }
+
+ return $bFieldsOnly || empty($sOrderClause) ? $sOrderClause : " ORDER BY " . $sOrderClause;
+ }
+
+ protected function _getCellData($sKey, $aField, $aRow)
+ {
+ if (isset($aRow[$sKey])) {
+ if (!empty($aField['display'])) {
+ bx_import('BxDolForm');
+ $sDisplayFunc = 'display' . $aField['display'];
+ $oDisplay = new BxDolFormCheckerHelper();
+ return $oDisplay->$sDisplayFunc($aRow[$sKey]);
+ } else {
+ return bx_process_output($aRow[$sKey]);
+ }
+ } else {
+ return _t('_undefined');
+ }
+ }
+
+ protected function _cmp ($r1, $r2)
+ {
+ $iRet = strcasecmp($r1[$this->_tmpOrderField], $r2[$this->_tmpOrderField]);
+ return $iRet ? $this->_tmpOrderDir * $iRet : 0;
+ }
+
+ protected function _genMethodName ($s)
+ {
+ return bx_gen_method_name($s);
+ }
+
+ protected function _isVisibleGrid ($a)
+ {
+ if (isAdmin() || !isset($a['visible_for_levels']))
+ return true;
+ return BxDolAcl::getInstance()->isMemberLevelInSet($a['visible_for_levels']);
+ }
+
+ protected function _getFilterValue()
+ {
+ return bx_unicode_urldecode(bx_process_input(bx_get($this->_aOptions['filter_get'])));
+ }
+
+ protected function _getOrderValue()
+ {
+ return bx_unicode_urldecode(bx_process_input(bx_get($this->_aOptions['order_get_field'])));
+ }
+
+ public function setActionCsrfChecking($bCsrfChecking)
+ {
+ $this->_bActionCsrfChecking = $bCsrfChecking;
+ }
+
+ public function isActionCsrfCheckingDisabled() {
+ return !$this->_bActionCsrfChecking;
+ }
+}
+
+/** @} */
diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/inc/classes/BxDolMenu.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/inc/classes/BxDolMenu.php
new file mode 100644
index 0000000000..5c89bba6fe
--- /dev/null
+++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/inc/classes/BxDolMenu.php
@@ -0,0 +1,540 @@
+ 2^(1-1) = 1
+ * - user level id = 2 -> 2^(2-1) = 2
+ * - user level id = 3 -> 2^(3-1) = 4
+ * - user level id = 4 -> 2^(4-1) = 8
+ * - active: it is possible to disable particular menu item, then it will not be displayed.
+ * - order: menu item order in the particular set.
+ *
+ *
+ * 4. Display Menu.
+ * Use the following sample code to display menu:
+ * @code
+ * $oMenu = BxTemplMenu::getObjectInstance('sample_menu'); // 'sample_menu' is 'object' field from 'sys_objects_menu' table.
+ * if ($oMenu)
+ * echo $oMenu->getCode; // display menu
+ * @endcode
+ *
+ * But in most cases you don't need to use above code to display menu,
+ * menu objects are integrated into pages - there is special 'menu' page block type for it.
+ *
+ */
+class BxDolMenu extends BxDolFactory implements iBxDolFactoryObject, iBxDolReplaceable
+{
+ protected static $SEL_MODULE = '';
+ protected static $SEL_NAME = '';
+
+ protected $_bIsApi;
+
+ protected $_bHx;
+ protected $_bHxHead;
+ protected $_mHxPreload;
+ protected $_aHx;
+
+ protected $_bDynamicMode;
+ protected $_bAddNoFollow;
+
+ protected $_bSelModuleCheck;
+ protected $_sSelModule;
+ protected $_sSelName;
+
+ protected $_sObject;
+ protected $_aObject;
+ protected $_oQuery;
+ protected $_oPermalinks;
+ protected $_aMarkers = array();
+ protected $_bMultilevel = false;
+
+ protected $_sSessionKeyCollapsed;
+
+ protected $_aContentParams;
+
+ /**
+ * Constructor
+ * @param $aObject array of menu options
+ */
+ protected function __construct($aObject)
+ {
+ parent::__construct();
+
+ $this->_bIsApi = bx_is_api();
+
+ $this->_bHx = false;
+ $this->_aHx = [];
+
+ $this->_bDynamicMode = false;
+ $this->_bAddNoFollow = getParam('sys_add_nofollow') == 'on';
+
+ $this->_bSelModuleCheck = false;
+
+ $this->_sObject = isset($aObject['object']) ? $aObject['object'] : 'bx-menu-obj-' . time() . rand(0, PHP_INT_MAX);
+ $this->_aObject = $aObject;
+ $this->_oQuery = new BxDolMenuQuery($this->_aObject);
+ $this->_oPermalinks = BxDolPermalinks::getInstance();
+
+ $this->_bMultilevel = !empty($this->_aObject['set_name']) && $this->_oQuery->isSetMultilevel($this->_aObject['set_name']);
+
+ $this->_sSessionKeyCollapsed = 'bx_menu_collapsed_';
+
+ $this->_aContentParams = [];
+
+ $this->addMarkers([
+ 'object' => $this->_sObject
+ ]);
+
+ if(isLogged() && ($oProfile = BxDolProfile::getInstance()) !== false) {
+ $sUrl = $oProfile->getUrl();
+ if($this->_bIsApi)
+ $sUrl = bx_api_get_relative_url($sUrl);
+
+ $this->addMarkers([
+ 'member_id' => $oProfile->id(),
+ 'member_display_name' => $oProfile->getDisplayName(),
+ 'member_url' => $sUrl,
+ 'content_id' => $oProfile->getContentId()
+ ]);
+ }
+ }
+
+ /**
+ * Get menu object instance by object name
+ * @param $sObject object name
+ * @return object instance or false on error
+ */
+ static public function getObjectInstance($sObject, $oTemplate = false)
+ {
+ $oMenu = false;
+ if (!isset($GLOBALS['bxDolClasses']['BxDolMenu!'.$sObject])) {
+ $aObject = BxDolMenuQuery::getMenuObject($sObject);
+ if (!$aObject || !is_array($aObject) || (int)$aObject['active'] == 0)
+ return false;
+
+ $sClass = 'BxTemplMenu';
+ if (!empty($aObject['override_class_name'])) {
+ $sClass = $aObject['override_class_name'];
+ if (!empty($aObject['override_class_file']))
+ require_once(BX_DIRECTORY_PATH_ROOT . $aObject['override_class_file']);
+ }
+
+ $oMenu = new $sClass($aObject, $oTemplate);
+ $GLOBALS['bxDolClasses']['BxDolMenu!'.$sObject] = $oMenu;
+ }
+ else
+ $oMenu = $GLOBALS['bxDolClasses']['BxDolMenu!'.$sObject];
+
+ /**
+ * @hooks
+ * @hookdef hook-system-get_object 'system', 'get_object' - hook to override menu object
+ * - $unit_name - equals `system`
+ * - $action - equals `get_object`
+ * - $object_id - not used
+ * - $sender_id - not used
+ * - $extra_params - array of additional params with the following array keys:
+ * - `type` - [string] object type, equals to 'menu'
+ * - `name` - [string] menu object name
+ * - `object` - [object] by ref, an instance of menu, @see BxDolMenu, can be overridden in hook processing
+ * @hook @ref hook-system-get_object
+ */
+ bx_alert('system', 'get_object', 0, false, [
+ 'type' => 'menu',
+ 'name' => $sObject,
+ 'object' => &$oMenu,
+ ]);
+
+ return $oMenu;
+ }
+
+ /**
+ * Set selected menu item globally.
+ * @param $sModule menu item module to set as selected
+ * @param $sName menu item name to set as selected
+ */
+ static public function setSelectedGlobal ($sModule, $sName)
+ {
+ self::$SEL_MODULE = $sModule;
+ self::$SEL_NAME = $sName;
+ }
+
+ /**
+ * Process menu triggers.
+ * Menu triggers allow to automatically add menu items to modules with no different if dependant module was install before or after the module menu item belongs to.
+ * For example module "Notes" adds menu items to all profiles modules (Persons, Organizations, etc)
+ * with no difference if persons module was installed before or after "Notes" module was installed.
+ * @param $sMenuTriggerName trigger name to process, usually specified in module installer class - @see BxBaseModGeneralInstaller
+ * @return always true, always success
+ */
+ static public function processMenuTrigger ($sMenuTriggerName)
+ {
+ // get list of active modules
+ $aModules = BxDolModuleQuery::getInstance()->getModulesBy(array(
+ 'type' => 'modules',
+ 'active' => 1,
+ ));
+
+ // get list of menu triggers
+ $aMenuItems = BxDolMenuQuery::getMenuTriggers($sMenuTriggerName);
+
+ // check each menu item trigger for all modules
+ foreach ($aMenuItems as $aMenuItem) {
+ foreach ($aModules as $aModule) {
+ if (!BxDolRequest::serviceExists($aModule['name'], 'get_menu_set_name_for_menu_trigger'))
+ continue;
+
+ $mixedMenuSet = BxDolService::call($aModule['name'], 'get_menu_set_name_for_menu_trigger', array($sMenuTriggerName));
+ if(empty($mixedMenuSet))
+ continue;
+
+ if(is_string($mixedMenuSet))
+ $mixedMenuSet = array($mixedMenuSet);
+
+ foreach($mixedMenuSet as $sMenuSet) {
+ if(empty($sMenuSet))
+ continue;
+
+ $aMenuItem['set_name'] = $sMenuSet;
+ BxDolMenuQuery::addMenuItemToSet($aMenuItem);
+ }
+ }
+ }
+
+ return true;
+ }
+
+ public function isHtmx()
+ {
+ return $this->_bHx;
+ }
+
+ /**
+ * Check if the menu is visible. The menu is visible if at least one menu item is visible.
+ * @return boolean
+ */
+ public function isVisible()
+ {
+ if((int)$this->_aObject['active'] == 0)
+ return false;
+
+ if(!isset($this->_aObject['menu_items']))
+ $this->_aObject['menu_items'] = $this->_oQuery->getMenuItems();
+
+ $bVisible = false;
+ foreach ($this->_aObject['menu_items'] as $a) {
+ if(!$this->_isActive($a) || !$this->_isVisible($a))
+ continue;
+
+ $bVisible = true;
+ break;
+ }
+
+ return $bVisible;
+ }
+
+ public function getTemplateId()
+ {
+ return $this->_aObject['template_id'];
+ }
+
+ /**
+ * Get template name with checking for custom template related to exactly this menu object.
+ * @return string with template name.
+ */
+ public function getTemplateName($sName = '')
+ {
+ if(empty($sName))
+ $sName = $this->_aObject['template'];
+
+ $sNameCustom = str_replace('.html', '_' . $this->_sObject . '.html', $sName);
+ return $this->_oTemplate->isHtml($sNameCustom) ? $sNameCustom : $sName;
+ }
+
+ public function setTemplateById ($iTemplateId)
+ {
+ $aTemplate = $this->_oQuery->getMenuTemplateById($iTemplateId);
+ if(empty($aTemplate) || !is_array($aTemplate))
+ return;
+
+ $this->_aObject['template'] = $aTemplate['template'];
+ }
+
+ /**
+ * Set selected menu item for current menu object only.
+ * @param $sModule menu item module to set as selected
+ * @param $sName menu item name to set as selected
+ */
+ public function setSelected ($sModule, $sName)
+ {
+ $this->_sSelModule = $sModule;
+ $this->_sSelName = $sName;
+ }
+
+ public function setDynamicMode ($bDynamicMode)
+ {
+ $this->_bDynamicMode = $bDynamicMode;
+ }
+
+ public function setHtmx($bHx)
+ {
+ $this->_bHx = $bHx;
+ }
+
+ /**
+ * Get an arrey of replacable markers.
+ * @return an array with markers
+ */
+ public function getMarkers()
+ {
+ return $this->_aMarkers;
+ }
+
+ /**
+ * Add replace markers.
+ * @param $a array of markers as key => value
+ * @return true on success or false on error
+ */
+ public function addMarkers ($a)
+ {
+ if (empty($a) || !is_array($a))
+ return false;
+ $this->_aMarkers = array_merge ($this->_aMarkers, $a);
+ return true;
+ }
+
+ /**
+ * Remove marker
+ * @param $s marker key
+ */
+ public function removeMarker ($s)
+ {
+ unset($this->_aMarkers[$s]);
+ }
+
+ public function initContentParams()
+ {
+ $this->_aContentParams = [];
+ }
+
+ public function setContentParams($aParams)
+ {
+ $this->_aContentParams = $aParams;
+
+ return true;
+ }
+
+ public function getContentParams()
+ {
+ if(!$this->_aContentParams)
+ $this->initContentParams();
+
+ return $this->_aContentParams;
+ }
+
+ public function performActionSetCollapsed($mixedValue)
+ {
+ $this->_setCollapsed($this->_sObject, (int)$mixedValue);
+ }
+
+ public function performActionSetCollapsedSubmenu($sMenuItem, $mixedValue)
+ {
+ $this->_setCollapsed($this->_sObject . '_' . $sMenuItem, (int)$mixedValue);
+ }
+
+ public function getUserChoiceCollapsed($sObject = '')
+ {
+ $iProfile = bx_get_logged_profile_id();
+ if(!$iProfile)
+ return false;
+
+ if(!$sObject)
+ $sObject = $this->_sObject;
+
+ $sSessionKey = $this->_sSessionKeyCollapsed . $iProfile;
+ $aCollapsed = BxDolSession::getInstance()->getValue($sSessionKey);
+ if(!isset($aCollapsed[$sObject]))
+ return false;
+
+ return (int)$aCollapsed[$sObject];
+ }
+
+ public function getUserChoiceCollapsedSubmenu($mixedItem, $sObject = '')
+ {
+ if(!$sObject)
+ $sObject = $this->_sObject;
+
+ if(is_array($mixedItem) && isset($mixedItem['name']))
+ $sObject .= '_' . $mixedItem['name'];
+ else if(is_string($mixedItem))
+ $sObject .= '_' . $mixedItem;
+
+ return $this->getUserChoiceCollapsed($sObject);
+ }
+
+ protected function _setCollapsed($sName, $mixedValue)
+ {
+ $iProfile = bx_get_logged_profile_id();
+ if(!$iProfile)
+ return;
+
+ $oSession = BxDolSession::getInstance();
+ $sSessionKey = $this->_sSessionKeyCollapsed . $iProfile;
+
+ $aCollapsed = $oSession->getValue($sSessionKey);
+ if(!is_array($aCollapsed))
+ $aCollapsed = [];
+
+ $aCollapsed[$sName] = $mixedValue;
+ $oSession->setValue($sSessionKey, $aCollapsed);
+ }
+
+ /**
+ * Check if menu items is selected.
+ * @param $a menu item array
+ * @return boolean
+ */
+ protected function _isSelected ($a)
+ {
+ if($this->_sSelModule || $this->_sSelName)
+ return (!$this->_bSelModuleCheck || !isset($a['module']) || $a['module'] == $this->_sSelModule) && (isset($a['name']) && $a['name'] == $this->_sSelName) ? true : false;
+
+ return (!$this->_bSelModuleCheck || !isset($a['module']) || $a['module'] == self::$SEL_MODULE) && (isset($a['name']) && $a['name'] == self::$SEL_NAME) ? true : false;
+ }
+
+ /**
+ * Check if menu items is active.
+ * @param $a menu item array
+ * @return boolean
+ */
+ protected function _isActive ($a)
+ {
+ if($this->_bIsApi)
+ return !isset($a['active_api']) || (int)$a['active_api'] !=0;
+ else
+ return !isset($a['active']) || (int)$a['active'] != 0;
+ }
+
+ /**
+ * Check if menu items is visible.
+ * @param $a menu item array
+ * @return boolean
+ */
+ protected function _isVisible ($a)
+ {
+ if(isset($a['visible_for_levels']) && !BxDolAcl::getInstance()->isMemberLevelInSet($a['visible_for_levels']))
+ return false;
+
+ if(!empty($a['visibility_custom']) && !BxDolService::callSerialized($a['visibility_custom'], $this->_aMarkers))
+ return false;
+
+ if($this->_iPageType && !empty($a['hidden_on_pt']) && ((1 << ($this->_iPageType - 2)) & (int)$a['hidden_on_pt']))
+ return false;
+
+ return true;
+ }
+
+ protected function _getVisibilityClass($a)
+ {
+ $aHiddenOn = array(
+ pow(2, BX_DB_HIDDEN_PHONE - 1) => 'bx-def-media-phone-hide',
+ pow(2, BX_DB_HIDDEN_TABLET - 1) => 'bx-def-media-tablet-hide',
+ pow(2, BX_DB_HIDDEN_DESKTOP - 1) => 'bx-def-media-desktop-hide',
+ pow(2, BX_DB_HIDDEN_MOBILE - 1) => 'bx-def-mobile-app-hide'
+ );
+
+ $aHiddenOnCol = array(
+ pow(2, 1) => 'bx-def-thin-col-hide',
+ pow(2, 2) => 'bx-def-half-col-hide',
+ pow(2, 3) => 'bx-def-wide-col-hide',
+ pow(2, 4) => 'bx-def-full-col-hide'
+ );
+
+ $sHiddenOnCssClasses = '';
+ if(!empty($a['hidden_on']))
+ foreach($aHiddenOn as $iHiddenOn => $sClass)
+ if((int)$a['hidden_on'] & $iHiddenOn)
+ $sHiddenOnCssClasses .= ' ' . $sClass;
+
+
+ if(!empty($a['hidden_on_col'])){
+ foreach($aHiddenOnCol as $iHiddenOn => $sClass)
+ if((int)$a['hidden_on_col'] & $iHiddenOn)
+ $sHiddenOnCssClasses .= ' ' . $sClass;
+ }
+
+ return $sHiddenOnCssClasses;
+ }
+
+ /**
+ * Replace provided markers in menu item array, curently markers are replaced in title, link and onclick fields.
+ * @param $a menu item array
+ * @return array where markes are replaced with real values
+ */
+ protected function _replaceMarkers ($a)
+ {
+ if (empty($this->_aMarkers))
+ return $a;
+ $aReplacebleFields = array ('title', 'link', 'onclick');
+ foreach ($aReplacebleFields as $sField)
+ if (isset($a[$sField]))
+ $a[$sField] = bx_replace_markers($a[$sField], $this->_aMarkers);
+ return $a;
+ }
+
+}
+
+/** @} */
diff --git a/upgrade/files/14.0.0.B2-14.0.0.RC1/files/inc/classes/BxDolMetatags.php b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/inc/classes/BxDolMetatags.php
new file mode 100644
index 0000000000..5fcd7a148c
--- /dev/null
+++ b/upgrade/files/14.0.0.B2-14.0.0.RC1/files/inc/classes/BxDolMetatags.php
@@ -0,0 +1,1212 @@
+locationsAddFromForm($iContentId);
+ * @endcode
+ *
+ * Upon 'edit' form display call BxDolMetatags::locationGet to fill-in location form input, for example:
+ * @code
+ * $oMetatags = BxDolMetatags::getObjectInstance('object_name');
+ * $aSpecificValues = $oMetatags->locationGet($iContentId);
+ * $oForm->initChecker($aContentInfo, $aSpecificValues);
+ * @endcode
+ *
+ * To display location call BxDolMetatags::locationsString:
+ * @code
+ * $oMetatags = BxDolMetatags::getObjectInstance('object_name');
+ * echo $oMetatags->locationsString($iContentId)
+ * @endcode
+ *
+ * Upon page display call BxDolMetatags::addPageMetaInfo to add location (and all other, including content image) meta information to the page header:
+ * @code
+ * $o = BxDolMetatags::getObjectInstance('object_name');
+ * $o->addPageMetaInfo($iContentId, array('id' => $iFileId, 'object' => 'storage_object_name'));
+ * @endcode
+ *
+ * Form object must have location field, usual name for this field is 'location' (this name is used as $sPrefix in some functions), type is 'custom',
+ * also form object must be derived from BxBaseModGeneralFormEntry class, which has custom field declaration.
+ *
+ *
+ *
+ * @section metatags_keywords \#keyword
+ *
+ * Upon content 'add' and 'edit' form submit, call BxDolMetatags::keywordsAdd
+ * @code
+ * $oMetatags = BxDolMetatags::getObjectInstance('object_name');
+ * $oMetatags->keywordsAdd($iContentId, $aContentInfo['text_field_with_hash_tags']);
+ * @endcode
+ *
+ * Before displaying the text with hashtags call BxDolMetatags::keywordsParse to highlight keywords:
+ * @code
+ * $oMetatags = BxDolMetatags::getObjectInstance('object_name');
+ * $sText = $oMetatags->keywordsParse($iContentId, $sText);
+ * @endcode
+ *
+ * Upon page display call BxDolMetatags::addPageMetaInfo to add keywords (and all other, including content image) meta information to the page header.
+ *
+ * To be able to search by tags metatgs object must be specified in *SearchResult class as 'object_metatags' in 'aCurrent' array.
+ *
+ *
+ *
+ * @section metatags_mention \@mention
+ *
+ * Upon content 'add' and 'edit' form submit, call BxDolMetatags::mentionsAdd
+ * @code
+ * $oMetatags = BxDolMetatags::getObjectInstance('object_name');
+ * $oMetatags->mentionsAdd($iContentId, $aContentInfo['text_field_with_mentions']);
+ * @endcode
+ *
+ * Before displaying the text with mentions call BxDolMetatags::mentionsParse:
+ * @code
+ * $oMetatags = BxDolMetatags::getObjectInstance('object_name');
+ * $sText = $oMetatags->mentionsParse($iContentId, $sText);
+ * @endcode
+ *
+ * Upon page display call BxDolMetatags::addPageMetaInfo to add all available meta info to the page meta into where possible, however it doesn't adding anyting for mentions for now.
+ *
+ * To be able to search by mentions object must be specified in *SearchResult class as 'object_metatags' in 'aCurrent' array.
+ *
+ *
+ *
+ * @section metatags_auto Add \@mention, \#keyword using one call
+ *
+ * Upon content 'add' and 'edit' form submit, call BxDolMetatags::metaAdd
+ * @code
+ * $oMetatags = BxDolMetatags::getObjectInstance('object_name');
+ * $oMetatags->metaAdd($iContentId, $aContentInfo['text_field']);
+ * @endcode
+ * or call BxDolMetatags::metaAddAuto, it autodetects fields with metainfo:
+ * @code
+ * $oMetatags = BxDolMetatags::getObjectInstance('object_name');
+ * $oMetatags->metaAddAuto($iContentId, $aContentInfo, $CNF, $CNF['OBJECT_FORM_ENTRY_DISPLAY_ADD']);
+ * @endcode
+ *
+ * Before displaying the text with different metainfo call BxDolMetatags::metaParse:
+ * @code
+ * $oMetatags = BxDolMetatags::getObjectInstance('object_name');
+ * $sText = $oMetatags->metaParse($iContentId, $sText);
+ * @endcode
+ *
+ * Upon page display call BxDolMetatags::addPageMetaInfo to add all available meta info to the page meta into where possible.
+ *
+ *
+ *
+ * @section metatags_delete_content Content deletion
+ *
+ * When content is deleted associated meta data can be deleted by calling BxDolMetatags::onDeleteContent:
+ * @code
+ * $oMetatags = BxDolMetatags::getObjectInstance('object_name');
+ * $oMetatags->onDeleteContent($iContentId);
+ * @endcode
+ *
+ */
+class BxDolMetatags extends BxDolFactory implements iBxDolFactoryObject
+{
+ protected static $_aLocationKeys = ['lat', 'lng', 'country', 'state', 'city', 'zip', 'street', 'street_number'];
+ protected static $_sKeywordPattern = '/[\pCc\pZ\p{Ps}\p{Pe}\p{Pi}\p{Pf}]\#(\pL[\pL\pN_]+)/u';
+
+ protected $_sObject;
+ protected $_aObject;
+ protected $_oQuery;
+ protected $_aMetas = [];
+
+ /**
+ * Constructor
+ * @param $aObject array of metags object options
+ */
+ protected function __construct($aObject)
+ {
+ parent::__construct();
+
+ $this->_sObject = $aObject['object'];
+ $this->_aObject = $aObject;
+
+ $a = array ('keywords', 'locations', 'mentions', 'pictures');
+ foreach ($a as $sMeta) {
+ if (empty($this->_aObject['table_' . $sMeta]))
+ continue;
+ $this->_aMetas[] = $sMeta;
+ }
+
+ $this->_oQuery = new BxDolMetatagsQuery($this->_aObject);
+ }
+
+ /**
+ * Get metatags object instance by object name
+ * @param $sObject object name
+ * @return object instance or false on error
+ */
+ static public function getObjectInstance($sObject)
+ {
+ if (isset($GLOBALS['bxDolClasses']['BxDolMetatags!'.$sObject]))
+ return $GLOBALS['bxDolClasses']['BxDolMetatags!'.$sObject];
+
+ $aObject = BxDolMetatagsQuery::getMetatagsObject($sObject);
+ if (!$aObject || !is_array($aObject))
+ return false;
+
+ $sClass = 'BxTemplMetatags';
+ if (!empty($aObject['override_class_name']))
+ $sClass = $aObject['override_class_name'];
+ if (!empty($aObject['override_class_file']))
+ require_once(BX_DIRECTORY_PATH_ROOT . $aObject['override_class_file']);
+
+ $o = new $sClass($aObject);
+
+ return ($GLOBALS['bxDolClasses']['BxDolMetatags!'.$sObject] = $o);
+ }
+
+ /**
+ * Get metatags by term
+ * @param string $sMeta - 'keywords' is only supported meta for now
+ * @param type $sMetaItem
+ * @param type $sTerm
+ * @return type
+ */
+ static public function getMetatagsDataByTerm($sMeta, $sMetaItem, $sTerm)
+ {
+ $bHashtagsOnly = getParam('sys_metatags_hashtags_only') == 'on';
+ $aLabels = [];
+ if($bHashtagsOnly)
+ $aLabels = array_map(function($sValue) {return mb_strtolower($sValue);}, BxDolLabel::getInstance()->getLabels(['type' => 'values']));
+
+ $aValues = [];
+ $aObjects = BxDolMetatagsQuery::getMetatagsObjects();
+ foreach($aObjects as $aObject) {
+ $oObject = BxDolMetatags::getObjectInstance($aObject['object']);
+ if(!$oObject || !$oObject->{$sMeta . 'IsEnabled'}())
+ continue;
+
+ $sMethod = $sMeta . 'GetByTerm';
+ if(!method_exists($oObject->_oQuery, $sMethod))
+ continue;
+
+ $aData = $oObject->_oQuery->$sMethod($sTerm);
+ foreach($aData as $aMeta) {
+ if($bHashtagsOnly && in_array(strtolower($aMeta[$sMetaItem]), $aLabels))
+ continue;
+
+ $aMatch = [];
+ if(!preg_match(self::$_sKeywordPattern, ' #' . $aMeta[$sMetaItem], $aMatch) || !isset($aMatch[1]) || strcasecmp($aMeta[$sMetaItem], $aMatch[1]) != 0)
+ continue;
+
+ $aValues[$aMeta[$sMetaItem]] = [
+ 'id' => $aMeta['object_id'],
+ 'meta' => $aMeta[$sMetaItem],
+ 'url' => $oObject->keywordsGetHashTagUrl($aMeta[$sMetaItem], $aMeta['object_id'])
+ ];
+ }
+ }
+
+ $aValues = array_slice($aValues, 0, (int)getParam('sys_profiles_search_limit'));
+
+ return $aValues;
+ }
+
+ public function getModule()
+ {
+ return $this->_aObject['module'];
+ }
+
+ /**
+ * Add all available meta tags to the head section
+ * @return number of successfully added metas
+ */
+ public function addPageMetaInfo($iId, $mixedImage = false)
+ {
+ $i = 0;
+ foreach ($this->_aMetas as $sMeta) {
+ $sFunc = $sMeta . 'AddMeta';
+ $i += $this->$sFunc($iId);
+ }
+
+ if ($mixedImage && is_array($mixedImage)) {
+
+ if (!empty($mixedImage['object']))
+ $o = BxDolStorage::getObjectInstance($mixedImage['object']);
+ elseif (!empty($mixedImage['transcoder']))
+ $o = BxDolTranscoder::getObjectInstance($mixedImage['transcoder']);
+
+ $mixedImage = $o ? $o->getFileUrlById($mixedImage['id']) : false;
+ }
+
+ if ($mixedImage)
+ BxDolTemplate::getInstance()->addPageMetaImage($mixedImage);
+
+ return $i;
+ }
+
+ /**
+ * Perform @see keywordsParse @see mentionsParse and maybe other
+ * @param $iId content id
+ * @param $s string
+ * @return modified string
+ */
+ public function metaParse($iId, $s)
+ {
+ foreach ($this->_aMetas as $sMeta) {
+ $sFunc = $sMeta . 'Parse';
+ if (method_exists($this, $sFunc))
+ $s = $this->$sFunc($iId, $s);
+ }
+ return $s;
+ }
+
+ /**
+ * Perform @see keywordsAddAuto @see mentionsAddAuto and maybe other
+ * @param $iId content id
+ * @param $aContentInfo content info array
+ * @param $CNF module config array
+ * @param $sFormDisplay form display object
+ * @return number of founded keywords, mentions, etc
+ */
+ public function metaAddAuto($iId, $aContentInfo, $CNF, $sFormDisplay)
+ {
+ $i = 0;
+ foreach ($this->_aMetas as $sMeta) {
+ $sFunc = $sMeta . 'AddAuto';
+ if (method_exists($this, $sFunc))
+ $i += $this->$sFunc($iId, $aContentInfo, $CNF, $sFormDisplay);
+ }
+ return $i;
+ }
+
+ /**
+ * Perform @see keywordsAdd @see mentionsAdd and maybe other
+ * @param $iId content id
+ * @param $s string
+ * @return number of added keywords, mentions, etc
+ */
+ public function metaAdd($iId, $s)
+ {
+ $i = 0;
+ foreach ($this->_aMetas as $sMeta) {
+ if ('locations' == $sMeta)
+ continue;
+ $sFunc = $sMeta . 'Add';
+ if (method_exists($this, $sFunc))
+ $i += $this->$sFunc($iId, $s);
+ }
+ return $i;
+ }
+
+ /**
+ * Checks if keywords enabled for current metatags object
+ */
+ public function keywordsIsEnabled()
+ {
+ return empty($this->_aObject['table_keywords']) ? false : true;
+ }
+
+ /**
+ * This function is specifically for formatting "Photo Camera" string, when "Photo Camera" is used as image hashtag
+ */
+ static public function keywordsCameraModel($aExif)
+ {
+ if (!isset($aExif['Make']))
+ return '';
+
+ $sMake = trim($aExif['Make']);
+ if ($sMake && isset($aExif['Model'])) {
+ $sModel = trim($aExif['Model']);
+ if (0 === mb_strpos($sModel, $sMake))
+ $sModel = mb_substr($sModel, mb_strlen($sMake));
+ }
+
+ return $sMake . (empty($sModel) ? '' : ' ' . trim($sModel));
+ }
+
+ /**
+ * Add \#keywords from the string
+ * @param $iId content id
+ * @param $s string with \#keywords
+ * @return number of found keywords
+ */
+ public function keywordsAdd($iId, $s)
+ {
+ //--- Remove tags WITH their content first.
+ $s = preg_replace("/