BxBaseModGeneralModule.php 189 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925
  1. <?php defined('BX_DOL') or die('hack attempt');
  2. /**
  3. * Copyright (c) UNA, Inc - https://una.io
  4. * MIT License - https://opensource.org/licenses/MIT
  5. *
  6. * @defgroup BaseGeneral Base classes for modules
  7. * @ingroup UnaModules
  8. *
  9. * @{
  10. */
  11. define('BX_BASE_MOD_GENERAL_STATUS_ACTIVE', 'active');
  12. define('BX_BASE_MOD_GENERAL_STATUS_HIDDEN', 'hidden');
  13. define('BX_BASE_MOD_GENERAL_STATUS_PENDING', 'pending');
  14. bx_import('BxDolAcl');
  15. /**
  16. * Base module class.
  17. */
  18. class BxBaseModGeneralModule extends BxDolModule
  19. {
  20. protected $_bIsApi;
  21. protected $_iProfileId;
  22. protected $_aSearchableNamesExcept;
  23. protected $_aFormParams;
  24. protected $_aBrowsingFiltersKeys;
  25. function __construct(&$aModule)
  26. {
  27. parent::__construct($aModule);
  28. $this->_bIsApi = bx_is_api();
  29. $this->_iProfileId = bx_get_logged_profile_id();
  30. $this->_aSearchableNamesExcept = [];
  31. $this->_aFormParams = array(
  32. 'display' => false,
  33. 'dynamic_mode' => false,
  34. 'ajax_mode' => false,
  35. 'absolute_action_url' => false,
  36. 'visibility_autoselect' => false,
  37. 'context_id' => 0,
  38. 'custom' => array()
  39. );
  40. $this->_aBrowsingFiltersKeys = ['mode'];
  41. }
  42. // ====== ACTIONS METHODS
  43. public function isEntryActive($aContentInfo)
  44. {
  45. $CNF = &$this->_oConfig->CNF;
  46. $iProfileId = bx_get_logged_profile_id();
  47. $bModerator = $this->_isModerator();
  48. $mixedResult = null;
  49. /**
  50. * @hooks
  51. * @hookdef hook-bx_base_general-is_entry_active '{module_name}', 'is_entry_active' - hook to override whether an entry (content) active or not
  52. * - $unit_name - module name
  53. * - $action - equals `is_entry_active`
  54. * - $object_id - not used
  55. * - $sender_id - not used
  56. * - $extra_params - array of additional params with the following array keys:
  57. * - `viewer_id` - [int] viewer profile id
  58. * - `is_moderator` - [boolean] is viewer has moderator status or not
  59. * - `content_info` - [array] content info array as key&value pairs
  60. * - `override_result` - [boolean] by ref, boolean value which determines whether entry (content) active or not, can be overridden in hook processing
  61. * @hook @ref hook-bx_base_general-is_entry_active
  62. */
  63. bx_alert($this->getName(), 'is_entry_active', 0, 0, [
  64. 'viewer_id' => $iProfileId,
  65. 'is_moderator' => $bModerator,
  66. 'content_info' => $aContentInfo,
  67. 'override_result' => &$mixedResult
  68. ]);
  69. if($mixedResult !== null)
  70. return $mixedResult;
  71. if($this->isEntryAuthor($aContentInfo, $iProfileId) || $bModerator)
  72. return true;
  73. if(!empty($CNF['FIELD_ALLOW_VIEW_TO']) && (int)$aContentInfo[$CNF['FIELD_ALLOW_VIEW_TO']] < 0) {
  74. $iContextProfileId = abs((int)$aContentInfo[$CNF['FIELD_ALLOW_VIEW_TO']]);
  75. $oContextProfile = BxDolProfile::getInstance($iContextProfileId);
  76. $aAdmins = bx_srv($oContextProfile->getModule(), 'get_admins_to_manage_content', [$iContextProfileId]);
  77. if(!empty($aAdmins) && in_array($iProfileId, $aAdmins))
  78. return true;
  79. }
  80. if(isset($CNF['FIELD_STATUS']) && $aContentInfo[$CNF['FIELD_STATUS']] != 'active')
  81. return false;
  82. if(isset($CNF['FIELD_STATUS_ADMIN']) && isset($aContentInfo[$CNF['FIELD_STATUS_ADMIN']]) && $aContentInfo[$CNF['FIELD_STATUS_ADMIN']] != 'active')
  83. return false;
  84. return true;
  85. }
  86. public function isEntryAuthor($aContentInfo, $iProfileId = 0)
  87. {
  88. $CNF = &$this->_oConfig->CNF;
  89. if(!$iProfileId)
  90. $iProfileId = bx_get_logged_profile_id();
  91. $mixedResult = null;
  92. /**
  93. * @hooks
  94. * @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
  95. * - $unit_name - module name
  96. * - $action - equals `is_entry_author`
  97. * - $object_id - not used
  98. * - $sender_id - not used
  99. * - $extra_params - array of additional params with the following array keys:
  100. * - `viewer_id` - [int] viewer profile id
  101. * - `content_info` - [array] content info array as key&value pairs
  102. * - `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
  103. * @hook @ref hook-bx_base_general-is_entry_author
  104. */
  105. bx_alert($this->getName(), 'is_entry_author', 0, 0, [
  106. 'viewer_id' => $iProfileId,
  107. 'content_info' => $aContentInfo,
  108. 'override_result' => &$mixedResult
  109. ]);
  110. if($mixedResult !== null)
  111. return $mixedResult;
  112. return abs($aContentInfo[$CNF['FIELD_AUTHOR']]) == $iProfileId;
  113. }
  114. public function actionUpdateImage($sFiledName, $iContentId, $sValue)
  115. {
  116. $mixedResult = $this->serviceUpdateImage($sFiledName, $iContentId, $sValue);
  117. if($mixedResult !== false)
  118. echo $mixedResult;
  119. }
  120. public function actionUpdateImagePosition($iContentId, $sFiledName, $sH, $sV)
  121. {
  122. // TODO: check permissions
  123. $this->serviceUpdateImagePosition($iContentId, $sFiledName, $sH, $sV);
  124. }
  125. public function actionApprove()
  126. {
  127. $CNF = &$this->_oConfig->CNF;
  128. if(!isset($CNF['FIELD_STATUS_ADMIN']))
  129. return echoJson([]);
  130. $iContentId = (int)bx_get('content_id');
  131. $aContentInfo = $this->_oDb->getContentInfoById($iContentId);
  132. if(empty($aContentInfo) || !is_array($aContentInfo) || $aContentInfo[$CNF['FIELD_STATUS_ADMIN']] != BX_BASE_MOD_GENERAL_STATUS_PENDING)
  133. return echoJson([]);
  134. if(($mixedCheckResult = $this->checkAllowedApprove($aContentInfo)) !== CHECK_ACTION_RESULT_ALLOWED)
  135. return echoJson(['msg' => $mixedCheckResult]);
  136. $oForm = $this->_getApproveForm($iContentId, $aContentInfo);
  137. $oForm->initChecker();
  138. if(!$oForm->isSubmitted() || !$oForm->isValid()) {
  139. $sPopupId = $this->getName() . '_approve_' . $iContentId;
  140. $sPopupTitle = '_sys_manage_popup_approve_title';
  141. if(!empty($CNF['T']['txt_approve_popup_title']))
  142. $sPopupTitle = $CNF['T']['txt_approve_popup_title'];
  143. return echoJson(['popup' => BxTemplFunctions::getInstance()->popupBox($sPopupId, _t($sPopupTitle), $oForm->getCode(true))]);
  144. }
  145. if($oForm->getCleanValue('do_send')) {
  146. $aResult = [];
  147. if($this->_sendApproveMessage($iContentId, $aContentInfo, $oForm))
  148. $aResult = ['msg' => _t('_sys_manage_txt_sent')];
  149. else
  150. $aResult = ['msg' => _t('_sys_manage_err_cannot_perform_action')];
  151. return echoJson($aResult);
  152. }
  153. if($oForm->getCleanValue('do_submit')) {
  154. $aResult = [];
  155. if($this->_oDb->updateEntriesBy([$CNF['FIELD_STATUS_ADMIN'] => BX_BASE_MOD_GENERAL_STATUS_ACTIVE], [$CNF['FIELD_ID'] => $iContentId])) {
  156. $this->checkAllowedApprove($aContentInfo, true);
  157. $this->onApprove($aContentInfo);
  158. /*
  159. * Process metas.
  160. * Note. It's essential to process metas a the very end,
  161. * because all data related to an entry should be already
  162. * processed and are ready to be passed to alert.
  163. */
  164. $this->processMetasAdd($iContentId);
  165. $aResult = ['msg' => _t('_sys_manage_txt_approved'), 'reload' => 1];
  166. }
  167. else
  168. $aResult = ['msg' => _t('_sys_manage_err_cannot_perform_action')];
  169. return echoJson($aResult);
  170. }
  171. }
  172. public function serviceSetStatus($iId, $sValue, $sStatus = '')
  173. {
  174. $CNF = &$this->_oConfig->CNF;
  175. if(!$sStatus && !empty($CNF['FIELD_STATUS_ADMIN']))
  176. $sStatus = $CNF['FIELD_STATUS_ADMIN'];
  177. $aStatuses = [];
  178. if(!empty($CNF['FIELD_STATUS_ADMIN']))
  179. $aStatuses[] = $CNF['FIELD_STATUS_ADMIN'];
  180. if(!empty($CNF['FIELD_STATUS']))
  181. $aStatuses[] = $CNF['FIELD_STATUS'];
  182. if(!in_array($sStatus, $aStatuses))
  183. return false;
  184. if((int)$this->_oDb->updateEntriesBy([$sStatus => $sValue], [$CNF['FIELD_ID'] => $iId]) == 0)
  185. return false;
  186. if($sValue == BX_BASE_MOD_GENERAL_STATUS_ACTIVE)
  187. $this->onPublished($iId);
  188. }
  189. public function actionRss ()
  190. {
  191. $aArgs = func_get_args();
  192. $this->_rss($aArgs);
  193. }
  194. /**
  195. * Attach link
  196. */
  197. public function actionGetAttachLinkForm()
  198. {
  199. $CNF = &$this->_oConfig->CNF;
  200. $iContentId = ($iContentId = bx_get($CNF['FIELD_ATTACH_LINK_CONTENT_ID'])) !== false ? (int)$iContentId : 0;
  201. echo $this->_oTemplate->getAttachLinkForm($iContentId);
  202. }
  203. public function actionSubmitAttachLinkForm()
  204. {
  205. echoJson($this->getFormAttachLink());
  206. }
  207. public function actionAddAttachLink()
  208. {
  209. $CNF = &$this->_oConfig->CNF;
  210. $sUrl = bx_process_input(bx_get($CNF['FIELD_ATTACH_LINK_URL']));
  211. if(empty($sUrl))
  212. return echoJson([]);
  213. $sUrl = htmlspecialchars_decode($sUrl);
  214. $oStreamContext = stream_context_create([
  215. 'http' => [
  216. 'timeout' => getParam('sys_default_socket_timeout'),
  217. ]
  218. ]);
  219. $sHeader = 'Content-Type';
  220. $aHeaders = @get_headers($sUrl, 1, $oStreamContext);
  221. if(!empty($aHeaders) && is_array($aHeaders) && !empty($aHeaders[$sHeader])) {
  222. $mixedContentType = $aHeaders[$sHeader];
  223. if(!is_array($mixedContentType))
  224. $mixedContentType = [$mixedContentType];
  225. foreach($mixedContentType as $sContentType)
  226. if(strpos($sContentType, 'image') !== false)
  227. return echoJson([]);
  228. }
  229. echoJson($this->addAttachLink([
  230. $CNF['FIELD_ATTACH_LINK_CONTENT_ID'] => ($iContentId = bx_get($CNF['FIELD_ATTACH_LINK_CONTENT_ID'])) !== false ? (int)$iContentId : 0,
  231. $CNF['FIELD_ATTACH_LINK_URL'] => $sUrl
  232. ]));
  233. }
  234. public function actionDeleteAttachLink()
  235. {
  236. $CNF = &$this->_oConfig->CNF;
  237. $iUserId = $this->getUserId();
  238. $iLinkId = bx_process_input(bx_get('id'), BX_DATA_INT);
  239. if(empty($iLinkId))
  240. return echoJson([]);
  241. $aLink = $this->_oDb->getLinksBy(['type' => 'id', 'id' => $iLinkId, 'profile_id' => $iUserId]);
  242. if(empty($aLink) || !is_array($aLink))
  243. return echoJson([]);
  244. if(!empty($aLink['media_id']))
  245. BxDolStorage::getObjectInstance($CNF['OBJECT_STORAGE_PHOTOS'])->deleteFile($aLink['media_id']);
  246. $aResult = [];
  247. if($this->_oDb->deleteLink($iLinkId))
  248. $aResult = ['code' => 0, 'url' => $aLink['url']];
  249. else
  250. $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')];
  251. echoJson($aResult);
  252. }
  253. /**
  254. * Attach poll
  255. */
  256. public function actionEmbedPoll($iPollId = 0)
  257. {
  258. if(empty($iPollId) && bx_get('poll_id') !== false)
  259. $iPollId = (int)bx_get('poll_id');
  260. $aParams = bx_get_with_prefix('param');
  261. array_walk($aParams, function(&$sValue) {
  262. $sValue = bx_process_input($sValue);
  263. });
  264. $this->_oTemplate->embedPollItem($iPollId, $aParams);
  265. }
  266. public function actionEmbedPolls($iId = 0)
  267. {
  268. list($iContentId, $aContentInfo) = $this->_getContent($iId);
  269. if($iContentId === false)
  270. return;
  271. $aParams = bx_get_with_prefix('param');
  272. array_walk($aParams, function(&$sValue) {
  273. $sValue = bx_process_input($sValue);
  274. });
  275. $this->_oTemplate->embedPollItems($aContentInfo, $aParams);
  276. }
  277. public function actionGetPoll()
  278. {
  279. $iPollId = (int)bx_get('poll_id');
  280. $sView = bx_process_input(bx_get('view'));
  281. $sMethod = 'serviceGetBlockPoll' . bx_gen_method_name($sView);
  282. if(!method_exists($this, $sMethod))
  283. return echoJson(array());
  284. $aBlock = $this->$sMethod($iPollId, true);
  285. if(empty($aBlock) || !is_array($aBlock))
  286. return echoJson(array());
  287. return echoJson(array(
  288. 'content' => $aBlock['content']
  289. ));
  290. }
  291. public function actionDeletePoll()
  292. {
  293. $CNF = &$this->_oConfig->CNF;
  294. $iId = bx_process_input(bx_get('id'), BX_DATA_INT);
  295. if(empty($iId))
  296. return echoJson([]);
  297. $aResult = [];
  298. if($this->serviceDeletePoll($iId))
  299. $aResult = ['code' => 0];
  300. else
  301. $aResult = ['code' => 1, 'message' => _t($CNF['txt_err_cannot_perform_action'])];
  302. echoJson($aResult);
  303. }
  304. public function actionGetPollForm()
  305. {
  306. echo $this->_oTemplate->getPollForm((int)bx_get('parent_cid'));
  307. }
  308. public function actionSubmitPollForm()
  309. {
  310. echoJson($this->getPollForm((int)bx_get('parent_cid')));
  311. }
  312. public function serviceGetPollForm()
  313. {
  314. if(!$this->_bIsApi)
  315. return false;
  316. $aResult = $this->getPollForm();
  317. if(isset($aResult['code'])) {
  318. if((int)$aResult['code'] == 0) {
  319. return [
  320. 'id' => $aResult['id'],
  321. 'item' => $aResult['item']
  322. ];
  323. }
  324. else
  325. return isset($aResult['message']) ? [bx_api_get_msg($aResult['message'])] : [];
  326. }
  327. else if(isset($aResult['form'])) {
  328. $sModule = $this->getName();
  329. return [bx_api_get_block('form', $aResult['form'], [
  330. 'ext' => [
  331. 'name' => $sModule,
  332. 'request' => ['url' => '/api.php?r=' . $sModule . '/submit_poll_form', 'immutable' => true]
  333. ]
  334. ])];
  335. }
  336. }
  337. public function serviceSubmitPollForm()
  338. {
  339. if(!$this->_bIsApi)
  340. return false;
  341. return $this->serviceGetPollForm();
  342. }
  343. public function serviceDeletePoll($iId)
  344. {
  345. return $this->_oDb->deletePolls([$this->_oConfig->CNF['FIELD_POLL_ID'] => $iId]);
  346. }
  347. public function getPollForm($iParentCid = 0)
  348. {
  349. $CNF = &$this->_oConfig->CNF;
  350. if(empty($CNF['OBJECT_FORM_POLL']))
  351. return ['code' => 1, 'message' => '_sys_txt_error_occured'];
  352. $iProfileId = bx_get_logged_profile_id();
  353. $oForm = BxDolForm::getObjectInstance($CNF['OBJECT_FORM_POLL'], $CNF['OBJECT_FORM_POLL_DISPLAY_ADD'], $this->_oTemplate);
  354. $oForm->setParentContentId($iParentCid);
  355. $oForm->initChecker();
  356. if($oForm->isSubmittedAndValid()) {
  357. $iId = $oForm->insert();
  358. if($iId)
  359. return ['code' => 0, 'id' => $iId, 'item' => $this->_oTemplate->getPollItem($iId, $iProfileId, [
  360. 'parent_cid' => $iParentCid,
  361. 'manage' => true
  362. ])];
  363. else
  364. return ['code' => 2, 'message' => '_sys_txt_error_entry_creation'];
  365. }
  366. return [
  367. 'form' => $oForm->{'getCode' . ($this->_bIsApi ? 'API' : '')}(),
  368. 'form_id' => $oForm->id
  369. ];
  370. }
  371. public function actionGetCreatePostForm()
  372. {
  373. $sName = $this->_oConfig->getName();
  374. $aParams = bx_process_input(array_intersect_key($_GET, $this->_aFormParams));
  375. $aParams = array_merge($this->_aFormParams, $aParams);
  376. $aParams['context_id'] = (bool)$aParams['context_id'] ? (int)$aParams['context_id'] : false;
  377. $mixedResponse = $this->serviceGetCreatePostForm($aParams);
  378. if(empty($mixedResponse))
  379. return echoJson(array());
  380. else if(is_array($mixedResponse)) {
  381. $mixedResponse['module'] = $sName;
  382. return echoJson($mixedResponse);
  383. }
  384. return echoJson(array(
  385. 'module' => $sName,
  386. 'content' => $mixedResponse
  387. ));
  388. }
  389. public function actionGetNotes()
  390. {
  391. $CNF = &$this->_oConfig->CNF;
  392. if(empty($CNF['OBJECT_NOTES']))
  393. return echoJson([]);
  394. $iContentId = (int)bx_get('content_id');
  395. $oCmtsNotes = BxDolCmts::getObjectInstance($CNF['OBJECT_NOTES'], $iContentId, true, $this->_oTemplate);
  396. $aCmtsNotes = $oCmtsNotes->getCommentsBlock([], ['in_designbox' => false]);
  397. if(empty($aCmtsNotes) || !is_array($aCmtsNotes))
  398. return echoJson([]);
  399. $sPostfix = $iContentId < 0 ? '_rc' : '';
  400. $sPopupId = $this->getName() . '_notes_' . $iContentId;
  401. $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;
  402. echoJson(['popup' => BxTemplFunctions::getInstance()->popupBox($sPopupId, _t($sPopupTitle), $aCmtsNotes['content'])]);
  403. }
  404. public function actionNested()
  405. {
  406. $sAction = bx_get('a');
  407. $sMethodName = 'subaction' . ucfirst($sAction);
  408. if (!method_exists($this, $sMethodName)) {
  409. return;
  410. }
  411. $this->$sMethodName();
  412. }
  413. public function actionEmbed($iContentId, $sUnitTemplate = '', $sAddCode = '')
  414. {
  415. $oTemplate = BxDolTemplate::getInstance();
  416. $aContentInfo = $this->_oDb->getContentInfoById($iContentId);
  417. if(empty($aContentInfo))
  418. $oTemplate->getEmbed(false);
  419. if(empty($sUnitTemplate))
  420. $sUnitTemplate = 'unit_gallery.html';
  421. $CNF = &$this->_oConfig->CNF;
  422. if(!empty($CNF['OBJECT_VIEWS'])) {
  423. $oView = BxDolView::getObjectInstance($CNF['OBJECT_VIEWS'], $iContentId);
  424. if($oView && $oView->isEnabled())
  425. $oView->doView();
  426. }
  427. $oTemplate->getEmbed($this->_oTemplate->unit($aContentInfo, true, $sUnitTemplate, ['embed' => true]) . $sAddCode);
  428. }
  429. public function subactionDelete()
  430. {
  431. header('Content-type: text/html; charset=utf-8');
  432. $iNestedId = (int)bx_get('id');
  433. $sNestedForm = bx_get('s');
  434. $oForm = BxDolForm::getObjectInstance($sNestedForm, $sNestedForm);
  435. if (!$oForm){
  436. echo _t('_sys_request_page_not_found_cpt');
  437. return;
  438. }
  439. $aNested = $this->_oDb->getNestedBy(array('type' => 'id', 'id' => $iNestedId, 'key_name' => $oForm->aParams['db']['key']), $oForm->aParams['db']['table']);
  440. if (empty($aNested)){
  441. echo _t('_sys_request_page_not_found_cpt');
  442. return;
  443. }
  444. $aContentInfo = $this->_oDb->getContentInfoById ($aNested['content_id']);
  445. if (!$aContentInfo){
  446. echo _t('_sys_request_page_not_found_cpt');
  447. return;
  448. }
  449. elseif (CHECK_ACTION_RESULT_ALLOWED !== ($sMsg = $this->checkAllowedEdit ($aContentInfo))) {
  450. echo $sMsg;
  451. }
  452. elseif (!$this->_oDb->deleteNestedById($iNestedId, $oForm->aParams['db']['key'], $oForm->aParams['db']['table'])) {
  453. echo _t('_sys_txt_error_occured');
  454. }
  455. else {
  456. echo 'ok';
  457. }
  458. }
  459. /**
  460. * Get possible recipients for start conversation form
  461. */
  462. public function actionAjaxGetProfiles ()
  463. {
  464. $sTerm = bx_get('term');
  465. $a = BxDolService::call('system', 'profiles_search', array($sTerm), 'TemplServiceProfiles');
  466. header('Content-Type:text/javascript; charset=utf-8');
  467. echo(json_encode($a));
  468. }
  469. public function serviceGetProfiles ($sParams)
  470. {
  471. $aOptions = json_decode($sParams, true);
  472. if (!$sParams || !isset($aOptions['term']))
  473. return [];
  474. return BxDolService::call('system', 'profiles_search', array($aOptions['term']), 'TemplServiceProfiles');
  475. }
  476. public function actionGetBrowsingFilters()
  477. {
  478. $aParams = $this->_prepareBrowsingFiltersParamsGet();
  479. $sContent = $this->_oTemplate->getBrowsingFilters($aParams);
  480. if(empty($sContent))
  481. return echoJson([]);
  482. echoJson([
  483. 'code' => 0,
  484. 'popup' => [
  485. 'html' => $sContent,
  486. 'options' => [
  487. 'closeOnOuterClick' => false,
  488. 'removeOnClose' => false,
  489. ]
  490. ],
  491. ]);
  492. }
  493. public function actionApplyBrowsingFilters()
  494. {
  495. $aParams = $this->_prepareBrowsingFiltersParamsGet();
  496. $aBrowseParams = ['mode' => $aParams['mode'], 'empty_message' => true];
  497. unset($aParams['mode']);
  498. $aBrowseParams['params'] = $aParams;
  499. $mixedResult = $this->serviceBrowse($aBrowseParams);
  500. if(empty($mixedResult))
  501. return echoJson([]);
  502. if(is_array($mixedResult) && isset($mixedResult['content']))
  503. $mixedResult = $mixedResult['content'];
  504. return echoJson([
  505. 'code' => 0,
  506. 'content' => $mixedResult,
  507. 'eval' => $this->_oConfig->getJsObject('main') . '.onApplyBrowsingFilter(oData)'
  508. ]);
  509. }
  510. protected function _prepareBrowsingFiltersParamsGet($mParams = false)
  511. {
  512. $aParams = [];
  513. $bParams = !empty($mParams) && is_array($mParams);
  514. foreach($this->_aBrowsingFiltersKeys as $sKey)
  515. if($bParams) {
  516. if(isset($mParams[$sKey]))
  517. $aParams[$sKey] = $mParams[$sKey];
  518. }
  519. else {
  520. if(($sValue = bx_get($sKey)) !== false)
  521. $aParams[$sKey] = $sValue;
  522. }
  523. return $aParams;
  524. }
  525. // ====== SERVICE METHODS
  526. /**
  527. * Checkes whether a content is active by status (status_admin).
  528. *
  529. * @param type $iContentId
  530. * @return boolean
  531. */
  532. public function serviceIsActive($iContentId)
  533. {
  534. $CNF = &$this->_oConfig->CNF;
  535. $aContentInfo = $this->_oDb->getContentInfoById($iContentId);
  536. if(empty($aContentInfo))
  537. return false;
  538. if(($sKey = 'FIELD_STATUS') && isset($CNF[$sKey]) && $aContentInfo[$CNF[$sKey]] != 'active')
  539. return false;
  540. if(($sKey = 'FIELD_STATUS_ADMIN') && isset($CNF[$sKey]) && isset($aContentInfo[$CNF[$sKey]]) && $aContentInfo[$CNF[$sKey]] != 'active')
  541. return false;
  542. return true;
  543. }
  544. public function serviceIsAllowedAddContentToContext($iContextPid)
  545. {
  546. $oContext = false;
  547. if(!$iContextPid || !($oContext = BxDolProfile::getInstance((int)$iContextPid)))
  548. return false;
  549. if($iContextPid == bx_get_logged_profile_id())
  550. return true;
  551. return bx_srv($oContext->getModule(), 'check_allowed_post_in_profile', [$oContext->getContentId(), $this->getName()]) === CHECK_ACTION_RESULT_ALLOWED;
  552. }
  553. public function serviceIsBadgesAvaliable()
  554. {
  555. if(!isAdmin() && !$this->_isAdministrator())
  556. return false;
  557. $aBadges = BxDolBadges::getInstance()->getData([
  558. 'type' => 'by_module&object',
  559. 'object_id' => 0,
  560. 'module' => $this->getName()
  561. ]);
  562. return count($aBadges) > 0 ? true : false;
  563. }
  564. public function serviceGetSafeServices()
  565. {
  566. return array(
  567. // other
  568. 'ModuleIcon' => '',
  569. 'GetLink' => '',
  570. // browse
  571. 'GetSearchResultUnit' => '',
  572. 'Browse' => '',
  573. 'BrowseFeatured' => '',
  574. 'BrowseFavorite' => '',
  575. // forms
  576. 'GetCreatePostForm' => '',
  577. 'EntityCreate' => '',
  578. 'EntityEdit' => '',
  579. 'EntityDelete' => '',
  580. 'UpdateImage' => '',
  581. //manage
  582. 'GetInfo' => '',
  583. 'EditEntity' => '',
  584. // polls
  585. 'GetPollForm' => '',
  586. 'SubmitPollForm' => '',
  587. 'DeletePoll' => '',
  588. 'GetBlockPollAnswers' => '',
  589. 'GetBlockPollResults' => '',
  590. // page blocks
  591. 'EntityTextBlock' => '',
  592. 'EntityInfo' => '',
  593. 'EntityInfoFull' => '',
  594. 'EntityInfoExtended' => '',
  595. 'EntityLocation' => '',
  596. 'EntityComments' => '',
  597. 'EntityAttachments' => '',
  598. 'CategoriesMultiList' => '',
  599. // menu
  600. 'EntityAllActions' => '',
  601. 'EntityActions' => '',
  602. 'EntitySocialSharing' => '',
  603. 'MyEntriesActions' => '',
  604. 'GetProfiles' => '',
  605. );
  606. }
  607. /**
  608. * @page service Service Calls
  609. * @section bx_base_general Base General
  610. * @subsection bx_base_general-other Other
  611. * @subsubsection bx_base_general-module_icon module_icon
  612. *
  613. * @code bx_srv('bx_posts', 'module_icon', [...]); @endcode
  614. *
  615. * Get module icon as CSS class name with FontAwesome icon name class and color class
  616. *
  617. * @see BxBaseModGeneralModule::serviceModuleIcon
  618. */
  619. /**
  620. * @ref bx_base_general-module_icon "module_icon"
  621. */
  622. public function serviceModuleIcon ()
  623. {
  624. return isset($this->_oConfig->CNF['ICON']) ? $this->_oConfig->CNF['ICON'] : '';
  625. }
  626. public function serviceGetModerators($iContentId)
  627. {
  628. return $this->getModerators($iContentId);
  629. }
  630. public function serviceGetAuthor ($iContentId)
  631. {
  632. $mixedResult = $this->_getFieldValue('FIELD_AUTHOR', $iContentId);
  633. return $mixedResult !== false ? (int)$mixedResult : 0;
  634. }
  635. public function serviceGetPrivacyView ($iContentId)
  636. {
  637. return $this->_getFieldValue('FIELD_ALLOW_VIEW_TO', $iContentId);
  638. }
  639. public function serviceGetDateAdded ($iContentId)
  640. {
  641. $mixedResult = $this->_getFieldValue('FIELD_ADDED', $iContentId);
  642. return $mixedResult !== false ? (int)$mixedResult : 0;
  643. }
  644. public function serviceGetDateChanged ($iContentId)
  645. {
  646. $mixedResult = $this->_getFieldValue('FIELD_CHANGED', $iContentId);
  647. return $mixedResult !== false ? (int)$mixedResult : 0;
  648. }
  649. /**
  650. * @page service Service Calls
  651. * @section bx_base_general Base General
  652. * @subsection bx_base_general-other Other
  653. * @subsubsection bx_base_general-get_link_add get_link_add
  654. *
  655. * @code bx_srv('bx_posts', 'get_link_add', [...]); @endcode
  656. *
  657. * Get add entry URL.
  658. *
  659. * @see BxBaseModGeneralModule::serviceGetLinkAdd
  660. */
  661. /**
  662. * @ref bx_base_general-get_link_add "get_link_add"
  663. */
  664. public function serviceGetLinkAdd ()
  665. {
  666. $sUri = $this->_oConfig->getEntryUri('add');
  667. if(!$sUri)
  668. return '';
  669. return bx_absolute_url(BxDolPermalinks::getInstance()->permalink('page.php?i=' . $sUri));
  670. }
  671. /**
  672. * @page service Service Calls
  673. * @section bx_base_general Base General
  674. * @subsection bx_base_general-other Other
  675. * @subsubsection bx_base_general-get_link_edit get_link_edit
  676. *
  677. * @code bx_srv('bx_posts', 'get_link_edit', [...]); @endcode
  678. *
  679. * Get edit entry URL for the specified content.
  680. * @param $iContentId content id
  681. *
  682. * @see BxBaseModGeneralModule::serviceGetLinkEdit
  683. */
  684. /**
  685. * @ref bx_base_general-get_link_edit "get_link_edit"
  686. */
  687. public function serviceGetLinkEdit ($iContentId)
  688. {
  689. $CNF = &$this->_oConfig->CNF;
  690. $sUri = $this->_oConfig->getEntryUri('edit');
  691. if(!$sUri)
  692. return '';
  693. $aContentInfo = $this->_oDb->getContentInfoById($iContentId);
  694. if(empty($aContentInfo))
  695. return '';
  696. return bx_absolute_url(BxDolPermalinks::getInstance()->permalink('page.php?i=' . $sUri . '&id=' . $aContentInfo[$CNF['FIELD_ID']]));
  697. }
  698. /**
  699. * @page service Service Calls
  700. * @section bx_base_general Base General
  701. * @subsection bx_base_general-other Other
  702. * @subsubsection bx_base_general-get_link get_link
  703. *
  704. * @code bx_srv('bx_posts', 'get_link', [...]); @endcode
  705. *
  706. * Get URL for the specified content.
  707. * @param $iContentId content id
  708. *
  709. * @see BxBaseModGeneralModule::serviceGetLink
  710. */
  711. /**
  712. * @ref bx_base_general-get_link "get_link"
  713. */
  714. public function serviceGetLink ($iContentId)
  715. {
  716. $CNF = &$this->_oConfig->CNF;
  717. $sUri = $this->_oConfig->getEntryUri('view');
  718. if(!$sUri)
  719. return '';
  720. $aContentInfo = $this->_oDb->getContentInfoById($iContentId);
  721. if(empty($aContentInfo))
  722. return '';
  723. return bx_absolute_url(BxDolPermalinks::getInstance()->permalink('page.php?i=' . $sUri . '&id=' . $aContentInfo[$CNF['FIELD_ID']]));
  724. }
  725. public function serviceGetTitle ($iContentId)
  726. {
  727. $mixedResult = $this->_getFieldValue('FIELD_TITLE', $iContentId);
  728. return $mixedResult !== false ? $mixedResult : '';
  729. }
  730. public function serviceGetText ($iContentId)
  731. {
  732. $mixedResult = $this->_getFieldValue('FIELD_TEXT', $iContentId);
  733. if (false === $mixedResult)
  734. return '';
  735. $CNF = &$this->_oConfig->CNF;
  736. if (!empty($CNF['OBJECT_METATAGS']) && is_string($mixedResult)) {
  737. $oMetatags = BxDolMetatags::getObjectInstance($CNF['OBJECT_METATAGS']);
  738. $mixedResult = $oMetatags->metaParse($iContentId, $mixedResult);
  739. }
  740. return $mixedResult;
  741. }
  742. public function serviceGetLocation ($iContentId)
  743. {
  744. $CNF = &$this->_oConfig->CNF;
  745. if(empty($CNF['OBJECT_METATAGS']))
  746. return [];
  747. $mixedResult = $this->_getFieldValue('FIELD_LOCATION', $iContentId);
  748. if(false === $mixedResult)
  749. return [];
  750. $oMeta = false;
  751. if(!($oMeta = BxDolMetatags::getObjectInstance($CNF['OBJECT_METATAGS'])) || !$oMeta->locationsIsEnabled())
  752. return false;
  753. $aLocation = $oMeta->locationGet($iContentId);
  754. if(empty($aLocation) || !is_array($aLocation))
  755. return false;
  756. return array_values(array_slice($aLocation, 1));
  757. }
  758. public function serviceGetEmbed ($iContentId)
  759. {
  760. $sTitle = $this->_getFieldValue('FIELD_TITLE', $iContentId);
  761. return $this->_oTemplate->parseHtmlByName('embed.html', [
  762. 'title' => $sTitle,
  763. 'url' => BX_DOL_URL_ROOT . $this->_oConfig->getBaseUri() . 'embed/' . $iContentId . '/'
  764. ]);
  765. }
  766. public function serviceGetInfo ($iContentId, $bSearchableFieldsOnly = true)
  767. {
  768. $CNF = &$this->_oConfig->CNF;
  769. $aContentInfo = $this->_getFields($iContentId);
  770. if(empty($aContentInfo))
  771. return [];
  772. if($bSearchableFieldsOnly === false)
  773. return $aContentInfo;
  774. else if(is_string($bSearchableFieldsOnly) && isset($aContentInfo[$bSearchableFieldsOnly]))
  775. return $aContentInfo[$bSearchableFieldsOnly];
  776. if(($sSf = $CNF['PARAM_SEARCHABLE_FIELDS'] ?? false) && ($aFields = explode(',', getParam($sSf))))
  777. return array_intersect_key($aContentInfo, array_flip($aFields));
  778. return [];
  779. }
  780. public function serviceGetInfoApi ($iContentId, $bExtendedUnits = false)
  781. {
  782. $aData = $this->serviceGetInfo($iContentId, false);
  783. if($aData)
  784. $aData = $this->getDataAPI($aData, ['extended' => $bExtendedUnits]);
  785. return $aData;
  786. }
  787. /**
  788. * @page service Service Calls
  789. * @section bx_base_general Base General
  790. * @subsection bx_base_general-browsing Browsing
  791. * @subsubsection bx_base_general-get_search_result_unit get_search_result_unit
  792. *
  793. * @code bx_srv('bx_posts', 'get_search_result_unit', [3,"unit_gallery.html"]); @endcode
  794. *
  795. * Get browsing unit for the specified content
  796. * @param $iContentId content id
  797. * @param $sUnitTemplate unit template, such as: unit_full.html, unit_gallery.html, unit_live_search.html
  798. *
  799. * @see BxBaseModGeneralModule::serviceGetSearchResultUnit
  800. */
  801. /**
  802. * @ref bx_base_general-get_search_result_unit "get_search_result_unit"
  803. */
  804. public function serviceGetSearchResultUnit ($iContentId, $sUnitTemplate = '')
  805. {
  806. $aContentInfo = $this->_oDb->getContentInfoById($iContentId);
  807. if($this->_bIsApi)
  808. return $this->getDataAPI($aContentInfo);
  809. if(empty($aContentInfo))
  810. return '';
  811. if(empty($sUnitTemplate))
  812. $sUnitTemplate = 'unit.html';
  813. return $this->_oTemplate->unit($aContentInfo, true, $sUnitTemplate);
  814. }
  815. /**
  816. * @page service Service Calls
  817. * @section bx_base_general Base General
  818. * @subsection bx_base_general-browsing Browsing
  819. * @subsubsection bx_base_general-get_view get_view
  820. *
  821. * @code bx_srv('bx_posts', 'get_view', [3]); @endcode
  822. *
  823. * Get view for the specified content
  824. * @param $iContentId content id
  825. *
  826. * @see BxBaseModGeneralModule::serviceGetView
  827. */
  828. /**
  829. * @ref bx_base_general-get_view "get_view"
  830. */
  831. public function serviceGetView ($iContentId)
  832. {
  833. return $this->serviceEntityTextBlock($iContentId);
  834. }
  835. public function serviceGetAll ($aParams = array())
  836. {
  837. if(empty($aParams) || !is_array($aParams))
  838. $aParams = array('type' => 'all');
  839. return $this->_oDb->getEntriesBy($aParams);
  840. }
  841. public function serviceGetAllByAuthor ($iProfileId)
  842. {
  843. return $this->_oDb->getEntriesByAuthor((int)$iProfileId);
  844. }
  845. public function serviceGetSortableFieldsExtended($aInputsAdd = array())
  846. {
  847. $CNF = &$this->_oConfig->CNF;
  848. if(empty($CNF['OBJECT_FORM_ENTRY']))
  849. return array();
  850. $aResult = array();
  851. $aSortableFields = [];
  852. $aDisplays = [];
  853. if(!empty($CNF['OBJECT_FORM_ENTRY_DISPLAY_ADD'])) {
  854. $aDisplays[] = $CNF['OBJECT_FORM_ENTRY_DISPLAY_ADD'];
  855. }
  856. if(!empty($CNF['OBJECT_FORM_ENTRY_DISPLAY_EDIT'])) {
  857. $aDisplays[] = $CNF['OBJECT_FORM_ENTRY_DISPLAY_EDIT'];
  858. }
  859. $aInputsAll = BxDolFormQuery::getFormInputs($CNF['OBJECT_FORM_ENTRY']);
  860. foreach($aInputsAll as $aInput){
  861. $aInputsAll[$aInput['name']] = $aInput;
  862. }
  863. $aInputs = BxDolFormQuery::getFormInputs($CNF['OBJECT_FORM_ENTRY'], $aDisplays);
  864. foreach($aInputs as $aInput){
  865. $aInputs[$aInput['name']] = $aInput;
  866. if ($aInput['type'] == 'text'){
  867. $aSortableFields[] = $aInput['name'];
  868. }
  869. }
  870. if(!empty($CNF['FIELD_ADDED']) && isset($aInputsAll[$CNF['FIELD_ADDED']])){
  871. $aSortableFields[] = $CNF['FIELD_ADDED'];
  872. }
  873. if(!empty($CNF['FIELD_CHANGED']) && isset($aInputsAll[$CNF['FIELD_CHANGED']])){
  874. $aSortableFields[] = $CNF['FIELD_CHANGED'];
  875. }
  876. foreach($aSortableFields as $sSortableField){
  877. $aResult[$sSortableField . '_asc'] = [
  878. 'name' => $sSortableField,
  879. 'caption' => $aInputsAll[$sSortableField]['caption'],
  880. 'direction' => 'asc'
  881. ];
  882. $aResult[$sSortableField . '_desc'] = [
  883. 'name' => $sSortableField,
  884. 'caption' => $aInputsAll[$sSortableField]['caption'],
  885. 'direction' => 'desc'
  886. ];
  887. }
  888. /**
  889. * @hooks
  890. * @hookdef hook-bx_base_general-get_sortable_fields '{module_name}', 'get_sortable_fields' - hook to override a list of sortable fields
  891. * - $unit_name - module name
  892. * - $action - equals `get_sortable_fields`
  893. * - $object_id - not used
  894. * - $sender_id - not used
  895. * - $extra_params - array of additional params with the following array keys:
  896. * - `override_result` - [array] a list of searchable fields, can be overridden in hook processing
  897. * @hook @ref hook-bx_base_general-get_sortable_fields
  898. */
  899. bx_alert($this->getName(), 'get_sortable_fields', 0, 0, [
  900. 'extended' => true,
  901. 'override_result' => &$aResult
  902. ]);
  903. return $aResult;
  904. }
  905. public function serviceGetSearchableFieldsExtended($aInputsAdd = array())
  906. {
  907. $CNF = &$this->_oConfig->CNF;
  908. if(empty($CNF['OBJECT_FORM_ENTRY']))
  909. return array();
  910. $aResult = array();
  911. if(!empty($CNF['FIELD_AUTHOR']) && !in_array($CNF['FIELD_AUTHOR'], $this->_aSearchableNamesExcept))
  912. $aResult[$CNF['FIELD_AUTHOR']] = array(
  913. 'type' => 'text_auto',
  914. 'caption' => $CNF['T']['form_field_author'],
  915. 'info' => '',
  916. 'value' => '',
  917. 'values' => '',
  918. 'pass' => ''
  919. );
  920. $aInputs = array();
  921. if(!empty($CNF['OBJECT_FORM_ENTRY_DISPLAY_ADD'])) {
  922. $oForm = BxDolForm::getObjectInstance($CNF['OBJECT_FORM_ENTRY'], $CNF['OBJECT_FORM_ENTRY_DISPLAY_ADD'], $this->_oTemplate);
  923. $aInputs = array_merge($aInputs, $oForm->aInputs);
  924. }
  925. if(!empty($CNF['OBJECT_FORM_ENTRY_DISPLAY_EDIT'])) {
  926. $oForm = BxDolForm::getObjectInstance($CNF['OBJECT_FORM_ENTRY'], $CNF['OBJECT_FORM_ENTRY_DISPLAY_EDIT'], $this->_oTemplate);
  927. $aInputs = array_merge($aInputs, $oForm->aInputs);
  928. }
  929. if(!empty($aInputsAdd) && is_array($aInputsAdd))
  930. $aInputs = array_merge($aInputs, $aInputsAdd);
  931. if(!empty($CNF['FIELD_LABELS']) && array_key_exists($CNF['FIELD_LABELS'], $aInputs) && !in_array($CNF['FIELD_LABELS'], $this->_aSearchableNamesExcept))
  932. $aResult[$CNF['FIELD_LABELS']] = [
  933. 'type' => 'checkbox_set',
  934. 'caption' => $CNF['T']['form_field_labels'] ?? '_sys_form_input_labels',
  935. 'info' => '',
  936. 'value' => '',
  937. 'values' => '',
  938. 'pass' => '',
  939. 'search_operator' => 'like'
  940. ];
  941. if(($sField = $CNF['FIELD_ALLOW_VIEW_TO'] ?? '') != '' && array_key_exists($sField, $aInputs) && !in_array($sField, $this->_aSearchableNamesExcept))
  942. $aInputs[$sField] = array_merge($aInputs[$sField], [
  943. 'search_type' => 'select',
  944. 'search_operator' => '='
  945. ]);
  946. foreach($aInputs as $aInput){
  947. if(in_array($aInput['type'], BxDolSearchExtended::$SEARCHABLE_TYPES) && !in_array($aInput['name'], $this->_aSearchableNamesExcept)) {
  948. $aField = array(
  949. 'type' => $aInput['type'],
  950. 'caption_system' => $aInput['caption_system_src'],
  951. 'caption' => $aInput['caption_src'],
  952. 'info' => $aInput['info_src'],
  953. 'value' => !empty($aInput['value']) ? $aInput['value'] : '',
  954. 'values' => !empty($aInput['values_src']) ? $aInput['values_src'] : '',
  955. 'pass' => !empty($aInput['db']['pass']) ? $aInput['db']['pass'] : '',
  956. );
  957. if(isset($aInput['search_type']))
  958. $aField['search_type'] = $aInput['search_type'];
  959. if(isset($aInput['search_operator']))
  960. $aField['search_operator'] = $aInput['search_operator'];
  961. $aResult[$aInput['name']] = $aField;
  962. }
  963. }
  964. /**
  965. * @hooks
  966. * @hookdef hook-bx_base_general-get_searchable_fields '{module_name}', 'get_searchable_fields' - hook to override a list of searchable fields
  967. * - $unit_name - module name
  968. * - $action - equals `get_searchable_fields`
  969. * - $object_id - not used
  970. * - $sender_id - not used
  971. * - $extra_params - array of additional params with the following array keys:
  972. * - `override_result` - [array] a list of searchable fields, can be overridden in hook processing
  973. * @hook @ref hook-bx_base_general-get_searchable_fields
  974. */
  975. bx_alert($this->getName(), 'get_searchable_fields', 0, 0, [
  976. 'extended' => true,
  977. 'override_result' => &$aResult
  978. ]);
  979. return $aResult;
  980. }
  981. public function serviceGetSearchResultExtended($aParams, $iStart = 0, $iPerPage = 0, $bFilterMode = false)
  982. {
  983. if((empty($aParams) || !is_array($aParams)) && !$bFilterMode)
  984. return array();
  985. return $this->_oDb->getEntriesBy(array('type' => 'search_ids', 'search_params' => $aParams, 'start' => $iStart, 'per_page' => $iPerPage));
  986. }
  987. public function serviceGetSearchableFields ($aInputsAdd = array())
  988. {
  989. $CNF = $this->_oConfig->CNF;
  990. if(!isset($CNF['PARAM_SEARCHABLE_FIELDS']) || !isset($CNF['OBJECT_FORM_ENTRY']) || !isset($CNF['OBJECT_FORM_ENTRY_DISPLAY_ADD']))
  991. return array();
  992. $oForm = BxDolForm::getObjectInstance($CNF['OBJECT_FORM_ENTRY'], $CNF['OBJECT_FORM_ENTRY_DISPLAY_ADD'], $this->_oTemplate);
  993. if(!$oForm)
  994. return array();
  995. $aInputs = $oForm->aInputs;
  996. if(!empty($aInputsAdd) && is_array($aInputsAdd))
  997. $aInputs = array_merge($aInputs, $aInputsAdd);
  998. $aTextTypes = array('text', 'textarea');
  999. $aTextFields = array();
  1000. foreach($aInputs as $r)
  1001. if(in_array($r['type'], $aTextTypes))
  1002. $aTextFields[$r['name']] = $r['caption'];
  1003. return $aTextFields;
  1004. }
  1005. public function serviceUpdateImage($sFiledName, $iContentId, $sValue)
  1006. {
  1007. $CNF = &$this->_oConfig->CNF;
  1008. $aData = $this->_oDb->getContentInfoById($iContentId);
  1009. if(empty($aData) || !is_array($aData))
  1010. return false;
  1011. if($this->checkAllowedEdit($aData) !== CHECK_ACTION_RESULT_ALLOWED)
  1012. return false;
  1013. //TODO add transcoder settings
  1014. $oImgStorage = BxDolStorage::getObjectInstance($CNF['OBJECT_STORAGE']);
  1015. if(!$oImgStorage)
  1016. return false;
  1017. $this->_oDb->updateEntriesBy([$sFiledName => $sValue], [$CNF['FIELD_ID'] => $iContentId]);
  1018. $this->serviceUpdateImagePosition($iContentId, $sFiledName, '', '');
  1019. $this->onUpdateImage($iContentId, $sFiledName, $sValue);
  1020. return $oImgStorage->getFileUrlById($sValue);
  1021. }
  1022. public function serviceUpdateImagePosition($iContentId, $sFiledName, $sH, $sV)
  1023. {
  1024. $CNF = &$this->_oConfig->CNF;
  1025. $sFieldNamePos = 'FIELD_' . strtoupper($sFiledName) . '_POSITION';
  1026. if(!isset($CNF[$sFieldNamePos]))
  1027. return false;
  1028. $sValue = '';
  1029. if($sH != '' || $sV != '')
  1030. $sValue = json_encode(['x' => $sH, 'y' => $sV]);
  1031. $this->_oDb->updateEntriesBy([$CNF[$sFieldNamePos] => $sValue], [$CNF['FIELD_ID'] => $iContentId]);
  1032. if($this instanceof BxBaseModProfileModule) {
  1033. $aContentInfo = $this->_oDb->getContentInfoById($iContentId);
  1034. bx_content_cache_del_by_prefix('sprofile_unit_vars:' . $aContentInfo['profile_id'] . ':');
  1035. }
  1036. return true;
  1037. }
  1038. public function serviceManageTools($sType = 'common')
  1039. {
  1040. if(!isLogged())
  1041. return '';
  1042. $oGrid = BxDolGrid::getObjectInstance($this->_oConfig->getGridObject($sType));
  1043. if(!$oGrid)
  1044. return '';
  1045. if($this->_bIsApi)
  1046. return [
  1047. bx_api_get_block('grid', $oGrid->getCodeAPI())
  1048. ];
  1049. $CNF = &$this->_oConfig->CNF;
  1050. $mixedMenu = '';
  1051. if(BxDolAcl::getInstance()->isMemberLevelInSet(192)) {
  1052. $oPermalink = BxDolPermalinks::getInstance();
  1053. $aMenuItems = array();
  1054. if(!empty($CNF['OBJECT_GRID_COMMON']) && !empty($CNF['T']['menu_item_manage_my']))
  1055. $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);
  1056. if(!empty($CNF['OBJECT_GRID_ADMINISTRATION']) && !empty($CNF['T']['menu_item_manage_all']))
  1057. $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);
  1058. if(count($aMenuItems) > 1) {
  1059. $mixedMenu = new BxTemplMenu(array(
  1060. 'template' => 'menu_block_submenu_ver.html',
  1061. 'menu_items' => $aMenuItems
  1062. ), $this->_oTemplate);
  1063. $mixedMenu->setSelected($this->_aModule['name'], 'manage-' . $sType);
  1064. }
  1065. }
  1066. if(!empty($CNF['OBJECT_MENU_SUBMENU']) && isset($CNF['URI_MANAGE_COMMON']) && ($oSubmenu = BxDolMenu::getObjectInstance($CNF['OBJECT_MENU_SUBMENU'])) !== false)
  1067. $oSubmenu->setSelected($this->_aModule['name'], $CNF['URI_MANAGE_COMMON']);
  1068. $this->_oTemplate->addCss(array('manage_tools.css'));
  1069. $this->_oTemplate->addJs(array('manage_tools.js'));
  1070. $this->_oTemplate->addJsTranslation(array('_sys_grid_search'));
  1071. return array(
  1072. 'content' => $this->_oTemplate->getJsCode('manage_tools', array('sObjNameGrid' => $this->_oConfig->getGridObject($sType))) . $oGrid->getCode(),
  1073. 'menu' => $mixedMenu
  1074. );
  1075. }
  1076. public function serviceGetMenuAddonManageTools()
  1077. {
  1078. return 0;
  1079. }
  1080. public function serviceGetMenuAddonManageToolsProfileStats($iProfileId = 0)
  1081. {
  1082. return 0;
  1083. }
  1084. public function serviceGetObjectBrowse($sMode, $aParams = false, $sClassSearchResult = 'SearchResult')
  1085. {
  1086. if(empty($aParams) || !is_array($aParams))
  1087. $aParams = [];
  1088. return $this->getObjectBrowse($sMode, array_merge(['mode' => $sMode], $aParams), $sClassSearchResult);
  1089. }
  1090. /**
  1091. * @page service Service Calls
  1092. * @section bx_base_general Base General
  1093. * @subsection bx_base_general-browsing Browsing
  1094. * @subsubsection bx_base_general-browse browse
  1095. *
  1096. * @code bx_srv('bx_posts', 'browse', [...]); @endcode
  1097. * @code {{~bx_posts:browse[{"mode":"author", "params":{"author":"10"}}]~}} @endcode
  1098. *
  1099. * Universal browse method.
  1100. * @param $aParams custom browse params, possible params are the following:
  1101. * - mode - browse mode, such as 'recent', 'featured', etc
  1102. * - params - custom params to browse method, for example 'unit_view' can be passed here
  1103. * - design_box - design box style, @see BxBaseFunctions::DesignBoxContent
  1104. * - empty_message - display or not "empty" message when there is no content
  1105. * - ajax_paginate - use AJAX paginate or not
  1106. *
  1107. * @see BxBaseModGeneralModule::serviceBrowse
  1108. */
  1109. /**
  1110. * @ref bx_base_general-browse "browse"
  1111. */
  1112. public function serviceBrowse ($aParams = array())
  1113. {
  1114. if($this->_bIsApi && is_string($aParams)){
  1115. $aParams = json_decode($aParams, true);
  1116. if (isset($aParams['params'])) {
  1117. if(($sK = 'type') && isset($aParams['params'][$sK]))
  1118. $aParams['mode'] = $aParams['params'][$sK];
  1119. if(($sK = 'class_search_result') && isset($aParams['params'][$sK]))
  1120. $aParams[$sK] = $aParams['params'][$sK];
  1121. if(isset($aParams['params']['filters'])) {
  1122. foreach($aParams['params']['filters'] as $sKey => $sValue)
  1123. $aParams['params'][$sKey] = $sValue;
  1124. $aParams['params']['filters'] = [
  1125. 'values' => $aParams['params']['filters']
  1126. ];
  1127. }
  1128. }
  1129. }
  1130. if (isset($aParams['params']['condition']))
  1131. unset($aParams['params']['condition']);
  1132. return $this->serviceBrowseWithCondition ($aParams);
  1133. }
  1134. public function serviceBrowseWithCondition ($aParams = array())
  1135. {
  1136. $aDefaults = array (
  1137. 'mode' => 'recent',
  1138. 'params' => false,
  1139. 'design_box' => BX_DB_PADDING_DEF,
  1140. 'empty_message' => false,
  1141. 'ajax_paginate' => true,
  1142. 'class_search_result' => 'SearchResult'
  1143. );
  1144. $aParams = array_merge($aDefaults, $aParams);
  1145. return $this->_serviceBrowse ($aParams['mode'], $aParams['params'], $aParams['design_box'], $aParams['empty_message'], $aParams['ajax_paginate'], $aParams['class_search_result']);
  1146. }
  1147. /**
  1148. * @page service Service Calls
  1149. * @section bx_base_general Base General
  1150. * @subsection bx_base_general-browsing Browsing
  1151. * @subsubsection bx_base_general-browse_featured browse_featured
  1152. *
  1153. * @code bx_srv('bx_posts', 'browse_featured', [...]); @endcode
  1154. *
  1155. * Display featured entries
  1156. * @param $sUnitView browsing unity view,
  1157. * such as: full, extended, gallery, showcase
  1158. * @param $bEmptyMessage display or not "empty" message when there is no content
  1159. * @param $bAjaxPaginate use AJAX paginate or not
  1160. *
  1161. * @see BxBaseModGeneralModule::serviceBrowseFeatured
  1162. */
  1163. /**
  1164. * @ref bx_base_general-browse_featured "browse_featured"
  1165. */
  1166. public function serviceBrowseFeatured ($sUnitView = false, $bEmptyMessage = false, $bAjaxPaginate = true)
  1167. {
  1168. return $this->_serviceBrowse ('featured', $sUnitView ? array('unit_view' => $sUnitView) : false, BX_DB_PADDING_DEF, $bEmptyMessage, $bAjaxPaginate);
  1169. }
  1170. /**
  1171. * @page service Service Calls
  1172. * @section bx_base_general Base General
  1173. * @subsection bx_base_general-browsing Browsing
  1174. * @subsubsection bx_base_general-browse_favorite browse_favorite
  1175. *
  1176. * @code bx_srv('bx_posts', 'browse_favorite', [...]); @endcode
  1177. *
  1178. * Display entries which were added to favorite list by some member
  1179. * @param $iProfileId profile ID
  1180. * @param $aParams additional browse params, see BxBaseModGeneralModule::serviceBrowse
  1181. *
  1182. * @see BxBaseModGeneralModule::serviceBrowseFavorite BxBaseModGeneralModule::serviceBrowse
  1183. */
  1184. /**
  1185. * @ref bx_base_general-browse_favorite "browse_favorite"
  1186. */
  1187. public function serviceBrowseFavorite ($iProfileId = 0, $aParams = array())
  1188. {
  1189. $CNF = &$this->_oConfig->CNF;
  1190. $oProfile = null;
  1191. if((int)$iProfileId)
  1192. $oProfile = BxDolProfile::getInstance($iProfileId);
  1193. if(!$oProfile && bx_get('profile_id') !== false)
  1194. $oProfile = BxDolProfile:: getInstance(bx_process_input(bx_get('profile_id'), BX_DATA_INT));
  1195. if(!$oProfile)
  1196. $oProfile = BxDolProfile::getInstance();
  1197. if(!$oProfile)
  1198. return '';
  1199. $bEmptyMessage = true;
  1200. if(isset($aParams['empty_message'])) {
  1201. $bEmptyMessage = (bool)$aParams['empty_message'];
  1202. unset($aParams['empty_message']);
  1203. }
  1204. if(bx_get('list_id') !== false && !isset($aParams['list_id']))
  1205. $aParams['list_id'] = (int) bx_get('list_id');
  1206. $aBlock = $this->_serviceBrowse ('favorite', array_merge(array('user' => $oProfile->id()), $aParams), BX_DB_PADDING_DEF, $bEmptyMessage);
  1207. if(!$aBlock)
  1208. return $aBlock;
  1209. $sTitle = _t('_sys_txt_default_favorite_list');
  1210. if(!empty($aParams['list_id']) && ($oFavorite = BxDolFavorite::getObjectInstance($CNF['OBJECT_FAVORITES'], 0, true))) {
  1211. $aList = $oFavorite->getQueryObject()->getList(['type' => 'id', 'list_id' => $aParams['list_id']]);
  1212. if(!empty($aList) && is_array($aList))
  1213. $sTitle = $aList['title'];
  1214. }
  1215. return array_merge($aBlock, ['markers' => [
  1216. 'title' => $sTitle
  1217. ]]);
  1218. }
  1219. /**
  1220. * @page service Service Calls
  1221. * @section bx_base_general Base General
  1222. * @subsection bx_base_general-browsing Browsing
  1223. * @subsubsection bx_base_general-browse_favorite_lists browse_favorite_lists
  1224. *
  1225. * @code bx_srv('bx_posts', 'browse_favorite_lists', [...]); @endcode
  1226. *
  1227. * Display entries which were added to favorite lists grouped by lists by some member
  1228. * @param $iProfileId profile ID
  1229. * @param $aParams additional browse params, see BxBaseModGeneralModule::serviceBrowse
  1230. *
  1231. * @see BxBaseModGeneralModule::serviceBrowseFavoriteLists BxBaseModGeneralModule::serviceBrowse
  1232. */
  1233. /**
  1234. * @ref bx_base_general-browse_favorite_lists "browse_favorite_lists"
  1235. */
  1236. public function serviceBrowseFavoriteLists ($iProfileId = 0, $aParams = array())
  1237. {
  1238. $CNF = &$this->_oConfig->CNF;
  1239. $oProfile = null;
  1240. if((int)$iProfileId)
  1241. $oProfile = BxDolProfile::getInstance($iProfileId);
  1242. if(!$oProfile && bx_get('profile_id') !== false)
  1243. $oProfile = BxDolProfile:: getInstance(bx_process_input(bx_get('profile_id'), BX_DATA_INT));
  1244. if(!$oProfile)
  1245. $oProfile = BxDolProfile::getInstance();
  1246. if(!$oProfile)
  1247. return '';
  1248. $iStart = (bx_get('list_start') !== false ? (int)bx_get('list_start') : 0);
  1249. $iPerPage = (int)getParam($CNF['PARAM_PER_PAGE_FOR_FAVORITES_LISTS']);
  1250. return $this->_oTemplate->getFavoriteList($oProfile, $iStart, $iPerPage, $aParams);
  1251. }
  1252. /**
  1253. * @page service Service Calls
  1254. * @section bx_base_general Base General
  1255. * @subsection bx_base_general-browsing Browsing
  1256. * @subsubsection bx_base_general-browse_by_category category
  1257. *
  1258. * @code bx_srv('bx_posts', 'browse_by_category', [...]); @endcode
  1259. *
  1260. * Display entries in category
  1261. * @param $sUnitView browsing unity view,
  1262. * such as: full, extended, gallery, showcase
  1263. * @param $bEmptyMessage display or not "empty" message when there is no content
  1264. * @param $bAjaxPaginate use AJAX paginate or not
  1265. *
  1266. * @see BxBaseModGeneralModule::serviceBrowseByCategory BxBaseModGeneralModule::serviceBrowse
  1267. */
  1268. /**
  1269. * @ref bx_base_general-browse_by_category "browse_by_category"
  1270. */
  1271. public function serviceBrowseCategory($sUnitView = false, $bEmptyMessage = true, $bAjaxPaginate = true, $aParams = [])
  1272. {
  1273. $sType = 'category';
  1274. $aParams = array_merge(['category' => bx_process_input(bx_get('category'), BX_DATA_INT)], $aParams);
  1275. if($sUnitView)
  1276. $aParams['unit_view'] = $sUnitView;
  1277. return $this->_serviceBrowse($sType, $aParams, BX_DB_PADDING_DEF, $bEmptyMessage, $bAjaxPaginate);
  1278. }
  1279. /**
  1280. * @page service Service Calls
  1281. * @section bx_base_general Base General
  1282. * @subsection bx_base_general-browsing Browsing
  1283. * @subsubsection bx_base_general-browse_multi_category category
  1284. *
  1285. * @code bx_srv('bx_posts', 'browse_multi_category', [...]); @endcode
  1286. *
  1287. * Display entries in multi category
  1288. * @param $sUnitView browsing unity view,
  1289. * such as: full, extended, gallery, showcase
  1290. * @param $bEmptyMessage display or not "empty" message when there is no content
  1291. * @param $bAjaxPaginate use AJAX paginate or not
  1292. *
  1293. * @see BxBaseModGeneralModule::serviceBrowseMultiCategory BxBaseModGeneralModule::serviceBrowse
  1294. */
  1295. /**
  1296. * @ref bx_base_general-browse_multi_category "browse_multi_category"
  1297. */
  1298. public function serviceBrowseMultiCategory($sUnitView = false, $bEmptyMessage = true, $bAjaxPaginate = true, $aParams = [])
  1299. {
  1300. $sType = 'multi_category';
  1301. $aParams = array_merge(['category' => bx_process_input(bx_get('category'))], $aParams);
  1302. if($sUnitView)
  1303. $aParams['unit_view'] = $sUnitView;
  1304. return $this->_serviceBrowse($sType, $aParams, BX_DB_PADDING_DEF, $bEmptyMessage, $bAjaxPaginate);
  1305. }
  1306. /**
  1307. * @page service Service Calls
  1308. * @section bx_base_general Base General
  1309. * @subsection bx_base_general-browsing Browsing
  1310. * @subsubsection bx_base_general-browse_favorite_list_actions browse_favorite_list_actions
  1311. *
  1312. * @code bx_srv('bx_posts', 'browse_favorite_list_actions', [...]); @endcode
  1313. *
  1314. * Display menu actions for favorite lists
  1315. *
  1316. * @see BxBaseModGeneralModule::serviceFavoritesListActions
  1317. */
  1318. /**
  1319. * @ref bx_base_general-browse_favorite_list_actions "browse_favorite_list_actions"
  1320. */
  1321. public function serviceFavoritesListActions()
  1322. {
  1323. $iListId = 0;
  1324. if(bx_get('list_id') !== false)
  1325. $iListId = (int) bx_get('list_id');
  1326. $oProfile = null;
  1327. if(bx_get('profile_id') !== false)
  1328. $oProfile = BxDolProfile:: getInstance(bx_process_input(bx_get('profile_id'), BX_DATA_INT));
  1329. if(!$oProfile)
  1330. return false;
  1331. $CNF = &$this->_oConfig->CNF;
  1332. $oFavorite = BxDolFavorite::getObjectInstance($CNF['OBJECT_FAVORITES'], 0, true);
  1333. $aList = $oFavorite->getQueryObject()->getList(array('type' => 'id', 'list_id' => $iListId));
  1334. if($iListId != 0 && (empty($aList) || !is_array($aList)))
  1335. return false;
  1336. $sRv = '';
  1337. if (!empty($aList) && $oFavorite->isAllowedEditList($aList['author_id'])){
  1338. $aMarkers = array(
  1339. 'js_object' => $oFavorite->getJsObjectName(),
  1340. 'list_id' => $iListId,
  1341. );
  1342. $oMenu = BxDolMenu::getObjectInstance('sys_favorite_list');
  1343. $oMenu->addMarkers($aMarkers);
  1344. $sMenu = $oMenu->getCode();
  1345. $sRv .= $sMenu . $oFavorite->getJsScript();
  1346. }
  1347. $aMarkers = array(
  1348. 'id' => $iListId,
  1349. 'module' => $this->_aModule['name'],
  1350. 'url' => $this->_getFavoriteListUrl($iListId, $oProfile->id()),
  1351. 'title' => $iListId > 0 ? $aList['title'] : _t('_sys_txt_default_favorite_list')
  1352. );
  1353. $oMenu = BxDolMenu::getObjectInstance('sys_social_sharing');
  1354. $oMenu->addMarkers($aMarkers);
  1355. $sRv .= $sMenu = $oMenu->getCode();
  1356. return $sRv;
  1357. }
  1358. /**
  1359. * @page service Service Calls
  1360. * @section bx_base_general Base General
  1361. * @subsection bx_base_general-menu Menu
  1362. * @subsubsection bx_base_general-favorites_list_info favorites_list_info
  1363. *
  1364. * @code bx_srv('bx_posts', 'favorites_list_info', [...]); @endcode
  1365. *
  1366. * Favorites list info
  1367. * @param $aParams array with additional custom params
  1368. * which may overwrite some default values
  1369. *
  1370. * @see BxBaseModGeneralModule::serviceFavoritesListInfo
  1371. */
  1372. /**
  1373. * @ref bx_base_general-favorites_list_info "favorites_list_info"
  1374. */
  1375. public function serviceFavoritesListInfo($aParams = array())
  1376. {
  1377. $CNF = &$this->_oConfig->CNF;
  1378. $iListId = 0;
  1379. if(bx_get('list_id') !== false)
  1380. $iListId = (int) bx_get('list_id');
  1381. $oFavorite = BxDolFavorite::getObjectInstance($CNF['OBJECT_FAVORITES'], 0, true);
  1382. $aList = $oFavorite->getQueryObject()->getList(array('type' => 'id', 'list_id' => $iListId));
  1383. if($iListId != 0 && (empty($aList) || !is_array($aList)))
  1384. return false;
  1385. $oProfile = null;
  1386. if(bx_get('profile_id') !== false)
  1387. $oProfile = BxDolProfile:: getInstance(bx_process_input(bx_get('profile_id'), BX_DATA_INT));
  1388. if(!$oProfile)
  1389. return false;
  1390. return $this->_oTemplate->getFavoritesListInfo($aList, $oProfile);
  1391. }
  1392. /**
  1393. * Display entries posted into particular context
  1394. * @return HTML string
  1395. */
  1396. public function serviceBrowseContext ($iProfileId = 0, $aParams = array())
  1397. {
  1398. return $this->_serviceBrowseWithParam ('context', 'profile_id', $iProfileId, $aParams);
  1399. }
  1400. public function serviceBrowseFollowedContexts ($iProfileId = 0, $aParams = [])
  1401. {
  1402. return $this->_serviceBrowseWithParam ('followed_contexts', 'profile_id', $iProfileId, $aParams);
  1403. }
  1404. public function _serviceBrowseWithParam ($sParamName, $sParamGet, $sParamVal, $aParams = array())
  1405. {
  1406. if(!$sParamVal)
  1407. $sParamVal = bx_process_input(bx_get($sParamGet), BX_DATA_INT);
  1408. if(!$sParamVal)
  1409. return '';
  1410. $bEmptyMessage = true;
  1411. if(isset($aParams['empty_message'])) {
  1412. $bEmptyMessage = (bool)$aParams['empty_message'];
  1413. unset($aParams['empty_message']);
  1414. }
  1415. $bAjaxPaginate = true;
  1416. if(isset($aParams['ajax_paginate'])) {
  1417. $bAjaxPaginate = (bool)$aParams['ajax_paginate'];
  1418. unset($aParams['ajax_paginate']);
  1419. }
  1420. return $this->_serviceBrowse ($sParamName, array_merge(array($sParamName => $sParamVal), $aParams), BX_DB_PADDING_DEF, $bEmptyMessage, $bAjaxPaginate);
  1421. }
  1422. public function getFormsHelper ()
  1423. {
  1424. $sClass = 'FormsEntryHelper';
  1425. $oObject = null;
  1426. bx_alert('system', 'get_forms_helper', 0, 0, [
  1427. 'module' => $this->getName(),
  1428. 'class' => &$sClass,
  1429. 'class_ref' => &$sClass,
  1430. 'object' => &$oObject
  1431. ]);
  1432. if($oObject !== null)
  1433. return $oObject;
  1434. bx_import($sClass, $this->_aModule);
  1435. $sClass = $this->_aModule['class_prefix'] . $sClass;
  1436. return new $sClass($this);
  1437. }
  1438. public function serviceFormsHelper()
  1439. {
  1440. return $this->getFormsHelper();
  1441. }
  1442. /**
  1443. * Add entry using provided fields' values.
  1444. * @return array with result:
  1445. * 'code' is 0 on success or non-zero on error,
  1446. * 'message' is error message in case of error,
  1447. * 'content' is content info array in case of success
  1448. */
  1449. public function serviceEntityAdd($iProfile, $aValues, $sDisplay = false)
  1450. {
  1451. $oFormsHelper = $this->getFormsHelper();
  1452. return $oFormsHelper->addData($iProfile, $aValues, $sDisplay);
  1453. }
  1454. public function serviceEntityAddForcedly($iProfile, $aValues, $sDisplay = false)
  1455. {
  1456. $oFormsHelper = $this->getFormsHelper();
  1457. $oFormsHelper->setValidMode(true);
  1458. return $oFormsHelper->addData($iProfile, $aValues, $sDisplay);
  1459. }
  1460. /**
  1461. * Perform redirect after content creation
  1462. * @return nothing, rediret header is sent
  1463. */
  1464. public function serviceRedirectAfterAdd($aContentInfo)
  1465. {
  1466. $oFormsHelper = $this->getFormsHelper();
  1467. $oFormsHelper->redirectAfterAdd($aContentInfo);
  1468. }
  1469. /**
  1470. * Get form object for add, edit, view or delete the content
  1471. * @param $sType 'add', 'edit', 'view' or 'delete'
  1472. * @param $aParams optional array with parameters(display name, etc)
  1473. * @return form object or false on error
  1474. */
  1475. public function serviceGetObjectForm ($sType, $aParams = array())
  1476. {
  1477. if(!in_array($sType, array('add', 'edit', 'view', 'delete')))
  1478. return false;
  1479. $iLoggedId = (int)bx_get_logged_profile_id();
  1480. $mixedContextId = isset($aParams['context_id']) ? $aParams['context_id'] : false;
  1481. $oContextProfile = false;
  1482. $bContext = $mixedContextId !== false;
  1483. if($bContext) {
  1484. $oContextProfile = BxDolProfile::getInstance(abs($mixedContextId));
  1485. $bContext = $oContextProfile !== false;
  1486. if($bContext && $oContextProfile->checkAllowedPostInProfile() !== CHECK_ACTION_RESULT_ALLOWED)
  1487. return false;
  1488. }
  1489. $CNF = &$this->_oConfig->CNF;
  1490. $oFormsHelper = $this->getFormsHelper();
  1491. $sParamsKey = 'ajax_mode';
  1492. if(isset($aParams[$sParamsKey]) && (bool)$aParams[$sParamsKey] === true)
  1493. $oFormsHelper->setAjaxMode((bool)$aParams[$sParamsKey]);
  1494. $sParamsKey = 'absolute_action_url';
  1495. if(isset($aParams[$sParamsKey]) && (bool)$aParams[$sParamsKey] === true)
  1496. $oFormsHelper->setAbsoluteActionUrl((bool)$aParams[$sParamsKey]);
  1497. if($bContext)
  1498. $oFormsHelper->setContextId($mixedContextId);
  1499. $sDisplay = !empty($aParams['display']) ? $aParams['display'] : false;
  1500. $sFunc = 'getObjectForm' . ucfirst($sType);
  1501. $oForm = $oFormsHelper->$sFunc($sDisplay);
  1502. $sKey = 'FIELD_ALLOW_VIEW_TO';
  1503. if(!empty($CNF[$sKey]) && !empty($oForm->aInputs[$CNF[$sKey]]) && (!$bContext || $mixedContextId < 0)) {
  1504. $bContextOwner = $bContext && abs($mixedContextId) == $iLoggedId;
  1505. if(!$bContext || $bContextOwner) {
  1506. $iGc = 0;
  1507. $iKeyGh = false;
  1508. foreach($oForm->aInputs[$CNF[$sKey]]['values'] as $iKey => $aValue) {
  1509. if(isset($aValue['type']) && in_array($aValue['type'], array('group_header', 'group_end'))) {
  1510. if($iKeyGh !== false && $iGc == 0) {
  1511. unset($oForm->aInputs[$CNF[$sKey]]['values'][$iKeyGh]);
  1512. $iKeyGh = false;
  1513. if($aValue['type'] == 'group_end')
  1514. unset($oForm->aInputs[$CNF[$sKey]]['values'][$iKey]);
  1515. }
  1516. if($aValue['type'] == 'group_header') {
  1517. $iGc = 0;
  1518. $iKeyGh = $iKey;
  1519. }
  1520. continue;
  1521. }
  1522. //--- Show 'Public' privacy group only in Public post form.
  1523. if(!$bContext && $aValue['key'] == BX_DOL_PG_ALL) {
  1524. $iGc += 1;
  1525. continue;
  1526. }
  1527. //--- Show a default privacy groups in Profile (for Owner) post form.
  1528. if($bContextOwner && ((int)$aValue['key'] >= 0 || $mixedContextId == $aValue['key'])) {
  1529. $iGc += 1;
  1530. continue;
  1531. }
  1532. unset($oForm->aInputs[$CNF[$sKey]]['values'][$iKey]);
  1533. }
  1534. }
  1535. else {
  1536. $oForm->aInputs[$CNF[$sKey]]['value'] = $mixedContextId;
  1537. $oForm->aInputs[$CNF[$sKey]]['type'] = 'hidden';
  1538. }
  1539. }
  1540. $sKey = 'FIELD_LABELS';
  1541. if(!empty($CNF[$sKey]) && !empty($oForm->aInputs[$CNF[$sKey]]) && empty($oForm->aInputs[$CNF[$sKey]]['value']) && $bContext) {
  1542. $iContextProfileId = $oContextProfile->id();
  1543. $sContextModule = $oContextProfile->getModule();
  1544. if(bx_srv($sContextModule, 'is_fan', [$iContextProfileId, $iLoggedId])) {
  1545. $aContextInfo = bx_srv($sContextModule, 'get_content_info_by_profile_id', [$iContextProfileId]);
  1546. if(!empty($aContextInfo['hashtag']))
  1547. $oForm->aInputs[$CNF[$sKey]]['value'] = [$aContextInfo['hashtag']];
  1548. }
  1549. }
  1550. /**
  1551. * @hooks
  1552. * @hookdef hook-system-get_object_form 'system', 'get_object_form' - hook to override an object of create content form, @see BxDolForm
  1553. * - $unit_name - equals `system`
  1554. * - $action - equals `get_object_form`
  1555. * - $object_id - not used
  1556. * - $sender_id - not used
  1557. * - $extra_params - array of additional params with the following array keys:
  1558. * - `module` - [string] module name
  1559. * - `type` - [string] 'add', 'edit', 'view' or 'delete' form display type
  1560. * - `params` - [array] form params array as key&value pairs
  1561. * - `form` - [object] by ref, an object of create content form, @see BxDolForm, can be overridden in hook processing
  1562. * @hook @ref hook-system-get_object_form
  1563. */
  1564. bx_alert('system', 'get_object_form', 0, 0, [
  1565. 'module' => $this->_oConfig->getName(),
  1566. 'type' => $sType,
  1567. 'params' => $aParams,
  1568. 'form' => &$oForm
  1569. ]);
  1570. return $oForm;
  1571. }
  1572. /**
  1573. *
  1574. *
  1575. * Create entry form
  1576. * @return HTML string
  1577. */
  1578. public function serviceEntityCreate ($sParams = false)
  1579. {
  1580. if($this->_bIsApi && ($aParams = bx_api_get_browse_params($sParams))) {
  1581. if(($aKeys = ['context_pid', 'context_nid', 'context_usage']) && ($aParamsContext = array_intersect_key($aParams, array_flip($aKeys)))) {
  1582. $_GET = array_merge($_GET, $aParamsContext);
  1583. $sParams = array_diff_key($aParams, array_flip($aKeys));
  1584. }
  1585. }
  1586. $bParamsArray = is_array($sParams);
  1587. $sDisplay = is_string($sParams) ? $sParams : false;
  1588. if($bParamsArray && !empty($sParams['display']))
  1589. $sDisplay = $sParams['display'];
  1590. $oFormsHelper = $this->getFormsHelper();
  1591. if($bParamsArray && isset($sParams['dynamic_mode']))
  1592. $oFormsHelper->setDynamicMode($sParams['dynamic_mode']);
  1593. $mixedResult = $oFormsHelper->addDataForm($sDisplay);
  1594. if($this->_bIsApi)
  1595. return $mixedResult;
  1596. if(isset($mixedResult['_dt']) && $mixedResult['_dt'] == 'json') {
  1597. echoJson($mixedResult);
  1598. exit;
  1599. }
  1600. return $mixedResult;
  1601. }
  1602. /**
  1603. * @page service Service Calls
  1604. * @section bx_base_general Base General
  1605. * @subsection bx_base_general-forms Forms
  1606. * @subsubsection bx_base_general-get_create_post_form get_create_post_form
  1607. *
  1608. * @code bx_srv('bx_posts', 'get_create_post_form'); @endcode
  1609. *
  1610. * Get content creation form
  1611. * @param $aParams additional parameters array:
  1612. * context_id, ajax_mode, absolute_action_url, displays
  1613. *
  1614. * @see BxBaseModGeneralModule::serviceGetCreatePostForm
  1615. */
  1616. /**
  1617. * @ref bx_base_general-get_create_post_form "get_create_post_form"
  1618. */
  1619. public function serviceGetCreatePostForm($aParams = [])
  1620. {
  1621. $aParams = array_merge($this->_aFormParams, $aParams);
  1622. if($aParams['context_id'] !== false && ($aContextInfo = BxDolProfileQuery::getInstance()->getInfoById(abs($aParams['context_id']))))
  1623. if(bx_srv($aContextInfo['type'], 'check_allowed_post_in_profile', [$aContextInfo['content_id'], $this->getName()]) !== CHECK_ACTION_RESULT_ALLOWED)
  1624. return '';
  1625. $oForm = $this->serviceGetObjectForm('add', $aParams);
  1626. if(!$oForm)
  1627. return '';
  1628. return $this->serviceEntityCreate($aParams);
  1629. }
  1630. /**
  1631. * @page service Service Calls
  1632. * @section bx_base_general Base General
  1633. * @subsection bx_base_general-forms Forms
  1634. * @subsubsection bx_base_general-entity_edit entity_edit
  1635. *
  1636. * @code bx_srv('bx_posts', 'entity_edit', [...]); @endcode
  1637. *
  1638. * Get content edit form
  1639. * @param $iContentId content ID
  1640. * @param $sDisplay optional form display name
  1641. *
  1642. * @see BxBaseModGeneralModule::serviceEntityEdit
  1643. */
  1644. /**
  1645. * @ref bx_base_general-entity_edit "entity_edit"
  1646. */
  1647. public function serviceEntityEdit ($iContentId = 0, $sDisplay = false)
  1648. {
  1649. return $this->_serviceEntityForm ('editDataForm', $iContentId, $sDisplay);
  1650. }
  1651. /**
  1652. * @page service Service Calls
  1653. * @section bx_base_general Base General
  1654. * @subsection bx_base_general-forms Forms
  1655. * @subsubsection bx_base_general-entity_delete entity_delete
  1656. *
  1657. * @code bx_srv('bx_posts', 'entity_delete', [...]); @endcode
  1658. *
  1659. * Get content delete form
  1660. * @param $iContentId content ID
  1661. *
  1662. * @see BxBaseModGeneralModule::serviceEntityDelete
  1663. */
  1664. /**
  1665. * @ref bx_base_general-entity_delete "entity_delete"
  1666. */
  1667. public function serviceEntityDelete ($iContentId = 0)
  1668. {
  1669. $mixedResult = $this->_serviceEntityForm ('deleteDataForm', $iContentId);
  1670. if(!bx_is_api())
  1671. return $mixedResult;
  1672. $aResult = [];
  1673. if(is_a($mixedResult, 'BxTemplFormView')){
  1674. $iContentId = $this->_getContent($iContentId, false);
  1675. $aResult = bx_api_get_block('form', $mixedResult->getCodeAPI(), ['ext' => ['name' => $this->getName(), 'request' => ['url' => '/api.php?r=' . $this->_aModule['name'] . '/entity_delete&params[]=' . $iContentId . '&params[]=' . $mixedResult->aParams['display'], 'immutable' => true]]]);
  1676. }
  1677. else
  1678. $aResult = $mixedResult;
  1679. return [
  1680. $aResult
  1681. ];
  1682. }
  1683. /**
  1684. * @page service Service Calls
  1685. * @section bx_base_general Base General
  1686. * @subsection bx_base_general-page_blocks Page Blocks
  1687. * @subsubsection bx_base_general-entity_text_block entity_text_block
  1688. *
  1689. * @code bx_srv('bx_posts', 'entity_text_block', [...]); @endcode
  1690. *
  1691. * Get content text/description
  1692. * @param $iContentId content ID
  1693. *
  1694. * @see BxBaseModGeneralModule::serviceEntityTextBlock
  1695. */
  1696. /**
  1697. * @ref bx_base_general-entity_text_block "entity_text_block"
  1698. */
  1699. public function serviceEntityTextBlock ($iContentId = 0)
  1700. {
  1701. return $this->_serviceEntityForm ('viewDataEntry', $iContentId);
  1702. }
  1703. /**
  1704. * @page service Service Calls
  1705. * @section bx_base_general Base General
  1706. * @subsection bx_base_general-page_blocks Page Blocks
  1707. * @subsubsection bx_base_general-entity_info entity_info
  1708. *
  1709. * @code bx_srv('bx_posts', 'entity_info', [...]); @endcode
  1710. *
  1711. * Get content info
  1712. * @param $iContentId content ID
  1713. *
  1714. * @see BxBaseModGeneralModule::serviceEntityInfo
  1715. */
  1716. /**
  1717. * @ref bx_base_general-entity_info "entity_info"
  1718. */
  1719. public function serviceEntityInfo ($iContentId = 0, $sDisplay = false)
  1720. {
  1721. return $this->_serviceEntityForm ('viewDataForm', $iContentId, $sDisplay);
  1722. }
  1723. /**
  1724. * @page service Service Calls
  1725. * @section bx_base_general Base General
  1726. * @subsection bx_base_general-page_blocks Page Blocks
  1727. * @subsubsection bx_base_general-entity_info_full entity_info_full
  1728. *
  1729. * @code bx_srv('bx_posts', 'entity_info_full', [...]); @endcode
  1730. *
  1731. * Get full content info
  1732. * @param $iContentId content ID
  1733. *
  1734. * @see BxBaseModGeneralModule::serviceEntityInfoFull
  1735. */
  1736. /**
  1737. * @ref bx_base_general-entity_info_full "entity_info_full"
  1738. */
  1739. public function serviceEntityInfoFull ($iContentId = 0)
  1740. {
  1741. $CNF = &$this->_oConfig->CNF;
  1742. $sDisplayName = 'OBJECT_FORM_ENTRY_DISPLAY_VIEW_FULL';
  1743. return $this->_serviceEntityForm ('viewDataForm', $iContentId, !empty($CNF[$sDisplayName]) ? $CNF[$sDisplayName] : false);
  1744. }
  1745. /**
  1746. * @page service Service Calls
  1747. * @section bx_base_general Base General
  1748. * @subsection bx_base_general-page_blocks Page Blocks
  1749. * @subsubsection bx_base_general-entity_info_extended entity_info_extended
  1750. *
  1751. * @code bx_srv('bx_posts', 'entity_info_extended', [...]); @endcode
  1752. *
  1753. * Get extended content info
  1754. * @param $iContentId content ID
  1755. *
  1756. * @see BxBaseModGeneralModule::serviceEntityInfoExtended
  1757. */
  1758. /**
  1759. * @ref bx_base_general-entity_info_extended "entity_info_extended"
  1760. */
  1761. public function serviceEntityInfoExtended ($iContentId = 0)
  1762. {
  1763. return $this->_serviceTemplateFunc ('entryInfo', $iContentId);
  1764. }
  1765. /**
  1766. * @page service Service Calls
  1767. * @section bx_base_general Base General
  1768. * @subsection bx_base_general-page_blocks Page Blocks
  1769. * @subsubsection bx_base_general-entity_location entity_location
  1770. *
  1771. * @code bx_srv('bx_posts', 'entity_location', [...]); @endcode
  1772. *
  1773. * Get content location
  1774. * @param $iContentId content ID
  1775. *
  1776. * @see BxBaseModGeneralModule::serviceEntityLocation
  1777. */
  1778. /**
  1779. * @ref bx_base_general-entity_location "entity_location"
  1780. */
  1781. public function serviceEntityLocation ($iContentId = 0)
  1782. {
  1783. $CNF = &$this->_oConfig->CNF;
  1784. $mixedContent = $this->_getContent($iContentId);
  1785. if($mixedContent === false)
  1786. return false;
  1787. list($iContentId, $aContentInfo) = $mixedContent;
  1788. $oFormsHelper = $this->getFormsHelper();
  1789. $oFormView = $oFormsHelper->getObjectFormView();
  1790. if(!$oFormView)
  1791. return false;
  1792. $oFormView->initChecker($aContentInfo);
  1793. if(empty($CNF['FIELD_LOCATION']) || !$oFormView->isInputVisible($CNF['FIELD_LOCATION']))
  1794. return false;
  1795. return $this->_oTemplate->entryLocation ($iContentId);
  1796. }
  1797. /**
  1798. * @page service Service Calls
  1799. * @section bx_base_general Base General
  1800. * @subsection bx_base_general-page_blocks Page Blocks
  1801. * @subsubsection bx_base_general-entity_comments entity_comments
  1802. *
  1803. * @code bx_srv('bx_posts', 'entity_comments', [...]); @endcode
  1804. *
  1805. * Get content comments
  1806. * @param $iContentId content ID
  1807. *
  1808. * @see BxBaseModGeneralModule::serviceEntityComments
  1809. */
  1810. /**
  1811. * @ref bx_base_general-entity_comments "entity_comments"
  1812. */
  1813. public function serviceEntityComments ($iContentId = 0)
  1814. {
  1815. $CNF = &$this->_oConfig->CNF;
  1816. if(empty($CNF['OBJECT_COMMENTS']))
  1817. return '';
  1818. return $this->_entityComments($CNF['OBJECT_COMMENTS'], $iContentId);
  1819. }
  1820. /**
  1821. * @page service Service Calls
  1822. * @section bx_base_general Base General
  1823. * @subsection bx_base_general-page_blocks Page Blocks
  1824. * @subsubsection bx_base_general-entity_attachments entity_attachments
  1825. *
  1826. * @code bx_srv('bx_posts', 'entity_attachments', [...]); @endcode
  1827. *
  1828. * Get content attachments
  1829. * @param $iContentId content ID
  1830. *
  1831. * @see BxBaseModGeneralModule::serviceEntityAttachments
  1832. */
  1833. /**
  1834. * @ref bx_base_general-entity_attachments "entity_attachments"
  1835. */
  1836. public function serviceEntityAttachments ($iContentId = 0)
  1837. {
  1838. return $this->_serviceTemplateFunc ('entryAttachments', $iContentId);
  1839. }
  1840. /**
  1841. * @page service Service Calls
  1842. * @section bx_base_general Base General
  1843. * @subsection bx_base_general-page_blocks Page Blocks
  1844. * @subsubsection bx_base_general-entity_polls entity_polls
  1845. *
  1846. * @code bx_srv('bx_posts', 'entity_polls', [...]); @endcode
  1847. *
  1848. * Display polls for the specified post
  1849. * @param $iContentId content ID
  1850. *
  1851. * @see BxBaseModGeneralModule::serviceEntityPolls
  1852. */
  1853. /**
  1854. * @ref bx_base_general-entity_polls "entity_polls"
  1855. */
  1856. public function serviceEntityPolls ($iContentId = 0)
  1857. {
  1858. return $this->_serviceTemplateFunc ('entryPolls', $iContentId);
  1859. }
  1860. /**
  1861. * Delete content entry
  1862. * @param $iContentId content id
  1863. * @return error message or empty string on success
  1864. */
  1865. public function serviceDeleteEntity ($iContentId, $sFuncDelete = 'deleteData')
  1866. {
  1867. $oFormsHelper = $this->getFormsHelper();
  1868. return $oFormsHelper->$sFuncDelete($iContentId);
  1869. }
  1870. /**
  1871. * Edit content entry
  1872. * @param $iContentId content id
  1873. * @param $aValues key value pairs to update
  1874. * @return error message or empty string on success
  1875. */
  1876. public function serviceEditEntity ($iContentId, $aValues, $sDisplay = false)
  1877. {
  1878. if($this->_bIsApi && is_string($aValues))
  1879. $aValues = bx_api_get_browse_params($aValues);
  1880. $oFormsHelper = $this->getFormsHelper();
  1881. return $oFormsHelper->editData($iContentId, $aValues, $sDisplay);
  1882. }
  1883. /**
  1884. * @page service Service Calls
  1885. * @section bx_base_general Base General
  1886. * @subsection bx_base_general-menu Menu
  1887. * @subsubsection bx_base_general-my_entries_actions my_entries_actions
  1888. *
  1889. * @code bx_srv('bx_posts', 'my_entries_actions', [...]); @endcode
  1890. *
  1891. * My entries actions menu
  1892. * @param $iProfileId profiles ID,
  1893. * if omitted it try to get it from 'profile_id' GET param
  1894. *
  1895. * @see BxBaseModGeneralModule::serviceMyEntriesActions
  1896. */
  1897. /**
  1898. * @ref bx_base_general-my_entries_actions "my_entries_actions"
  1899. */
  1900. public function serviceMyEntriesActions ($iProfileId = 0)
  1901. {
  1902. $CNF = &$this->_oConfig->CNF;
  1903. if(empty($CNF['OBJECT_MENU_ACTIONS_MY_ENTRIES']))
  1904. return false;
  1905. if (!$iProfileId)
  1906. $iProfileId = bx_process_input(bx_get('profile_id'), BX_DATA_INT);
  1907. if (!$iProfileId || !($oProfile = BxDolProfile::getInstance($iProfileId)))
  1908. return false;
  1909. if ($iProfileId != $this->_iProfileId)
  1910. return false;
  1911. $oMenu = BxTemplMenu::getObjectInstance($CNF['OBJECT_MENU_ACTIONS_MY_ENTRIES']);
  1912. return $oMenu ? $oMenu->getCode() : false;
  1913. }
  1914. /**
  1915. * @page service Service Calls
  1916. * @section bx_base_general Base General
  1917. * @subsection bx_base_general-menu Menu
  1918. * @subsubsection bx_base_general-entity_all_actions entity_all_actions
  1919. *
  1920. * @code bx_srv('bx_posts', 'entity_all_actions', [...]); @endcode
  1921. *
  1922. * Entry actions and social sharing actions
  1923. * @param $mixedContent content ID
  1924. * @param $aParams additional params
  1925. *
  1926. * @see BxBaseModGeneralModule::serviceEntityAllActions
  1927. */
  1928. /**
  1929. * @ref bx_base_general-entity_all_actions "entity_all_actions"
  1930. */
  1931. public function serviceEntityAllActions ($mixedContent = false, $aParams = array())
  1932. {
  1933. $mixedResult = $this->getEntryAllActions($mixedContent, $aParams);
  1934. if(bx_is_api())
  1935. return [bx_api_get_block('entity_actions', $mixedResult)];
  1936. else
  1937. return $this->_oTemplate->entryAllActions($mixedResult);
  1938. }
  1939. /**
  1940. * @page service Service Calls
  1941. * @section bx_base_general Base General
  1942. * @subsection bx_base_general-menu Menu
  1943. * @subsubsection bx_base_general-entity_actions entity_actions
  1944. *
  1945. * @code bx_srv('bx_posts', 'entity_actions', [...]); @endcode
  1946. *
  1947. * Entry actions, without social sharing actions
  1948. * @param $iContentId content ID
  1949. *
  1950. * @see BxBaseModGeneralModule::serviceEntityActions
  1951. */
  1952. /**
  1953. * @ref bx_base_general-entity_actions "entity_actions"
  1954. */
  1955. public function serviceEntityActions ($iContentId = 0)
  1956. {
  1957. $iContentId = $this->_getContent($iContentId, false);
  1958. if($iContentId === false)
  1959. return false;
  1960. $oMenu = BxTemplMenu::getObjectInstance($this->_oConfig->CNF['OBJECT_MENU_ACTIONS_VIEW_ENTRY']);
  1961. return $oMenu ? $oMenu->getCode() : false;
  1962. }
  1963. /**
  1964. * @page service Service Calls
  1965. * @section bx_base_general Base General
  1966. * @subsection bx_base_general-page_blocks Page Blocks
  1967. * @subsubsection bx_base_general-entity_reports entity_reports
  1968. *
  1969. * @code bx_srv('bx_posts', 'entity_reports', [...]); @endcode
  1970. *
  1971. * Get content reports
  1972. * @param $iContentId content ID
  1973. *
  1974. * @see BxBaseModGeneralModule::serviceEntityReports
  1975. */
  1976. /**
  1977. * @ref bx_base_general-entity_reports "entity_reports"
  1978. */
  1979. public function serviceEntityReports ($iContentId = 0)
  1980. {
  1981. $mixedContent = $this->_getContent($iContentId);
  1982. list($iContentId, $aContentInfo) = $mixedContent;
  1983. if($iContentId === false)
  1984. return false;
  1985. $CNF = &$this->_oConfig->CNF;
  1986. if (!isset($CNF['OBJECT_REPORTS']) || !isset($CNF['OBJECT_NOTES']))
  1987. return false;
  1988. if(!$aContentInfo || !(BxDolAcl::getInstance()->isMemberLevelInSet(192) || (isset($CNF['FIELD_AUTHOR']) && bx_get_logged_profile_id() == $aContentInfo[$CNF['FIELD_AUTHOR']])))
  1989. return false;
  1990. $oReport = BxDolReport::getObjectInstance($CNF['OBJECT_REPORTS'], $iContentId, true);
  1991. if(!$oReport)
  1992. return false;
  1993. return $oReport->getReportedByWithComments($CNF['OBJECT_NOTES']);
  1994. }
  1995. /**
  1996. * @page service Service Calls
  1997. * @section bx_base_general Base General
  1998. * @subsection bx_base_general-page_blocks Page Blocks
  1999. * @subsubsection bx_base_general-reports_count_by_status reports_count_by_status
  2000. *
  2001. * @code bx_srv('bx_posts', 'reports_count_by_status', [...]); @endcode
  2002. *
  2003. * Get number of reports with specified status
  2004. * @param $iStatus status ID
  2005. *
  2006. * @see BxBaseModGeneralModule::serviceReportsCountByStatus
  2007. */
  2008. /**
  2009. * @ref bx_base_general-entity_reports "entity_reports"
  2010. */
  2011. public function serviceReportsCountByStatus ($iStatus)
  2012. {
  2013. $CNF = &$this->_oConfig->CNF;
  2014. if (!isset($CNF['OBJECT_REPORTS']) || !isset($CNF['OBJECT_NOTES']))
  2015. return false;
  2016. $oReport = BxDolReport::getObjectInstance($CNF['OBJECT_REPORTS'], 0, false);
  2017. return $oReport->getCountByStatus($iStatus);
  2018. }
  2019. /**
  2020. * @page service Service Calls
  2021. * @section bx_base_general Base General
  2022. * @subsection bx_base_general-menu Menu
  2023. * @subsubsection bx_base_general-entity_social_sharing entity_social_sharing
  2024. *
  2025. * @code bx_srv('bx_posts', 'entity_social_sharing', [...]); @endcode
  2026. *
  2027. * Entry social sharing actions
  2028. * @param $mixedContent content ID or array with integer content ID and
  2029. * array with content info, or false
  2030. * @param $aParams array with additional custom params
  2031. * which may overwrite some default values
  2032. *
  2033. * @see BxBaseModGeneralModule::serviceEntitySocialSharing
  2034. */
  2035. /**
  2036. * @ref bx_base_general-entity_social_sharing "entity_social_sharing"
  2037. */
  2038. public function serviceEntitySocialSharing($mixedContent = false, $aParams = array())
  2039. {
  2040. if(!empty($mixedContent)) {
  2041. if(!is_array($mixedContent))
  2042. $mixedContent = array((int)$mixedContent, array());
  2043. }
  2044. else {
  2045. $mixedContent = $this->_getContent();
  2046. if($mixedContent === false)
  2047. return false;
  2048. }
  2049. list($iContentId, $aContentInfo) = $mixedContent;
  2050. $CNF = &$this->_oConfig->CNF;
  2051. $sUri = !empty($aParams['uri']) ? $aParams['uri'] : '';
  2052. if(empty($sUri) && !empty($CNF['URI_VIEW_ENTRY']))
  2053. $sUri = $CNF['URI_VIEW_ENTRY'];
  2054. $sUrl = !empty($sUri) ? BxDolPermalinks::getInstance()->permalink('page.php?i=' . $sUri . '&id=' . $iContentId) : '';
  2055. $sTitle = !empty($aParams['title']) ? $aParams['title'] : '';
  2056. if(empty($sTitle) && !empty($aContentInfo[$CNF['FIELD_TITLE']]))
  2057. $sTitle = $aContentInfo[$CNF['FIELD_TITLE']];
  2058. $aMarkers = array(
  2059. 'id' => $iContentId,
  2060. 'module' => $this->_aModule['name'],
  2061. 'url' => bx_absolute_url($sUrl),
  2062. 'title' => $sTitle,
  2063. );
  2064. $iIdThumb = !empty($aParams['id_thumb']) ? (int)$aParams['id_thumb'] : 0;
  2065. if(empty($iIdThumb) && !empty($CNF['FIELD_THUMB']) && !empty($aContentInfo[$CNF['FIELD_THUMB']]))
  2066. $iIdThumb = (int)$aContentInfo[$CNF['FIELD_THUMB']];
  2067. if ($iIdThumb) {
  2068. $sTranscoder = !empty($aParams['object_transcoder']) ? $aParams['object_transcoder'] : '';
  2069. $sStorage = !empty($aParams['object_storage']) ? $aParams['object_storage'] : '';
  2070. if(empty($sStorage) && !empty($CNF['OBJECT_STORAGE']))
  2071. $sStorage = $CNF['OBJECT_STORAGE'];
  2072. if(!empty($sTranscoder))
  2073. $o = BxDolTranscoder::getObjectInstance($sTranscoder);
  2074. else if(!empty($sStorage))
  2075. $o = BxDolStorage::getObjectInstance($sStorage);
  2076. $sImgUrl = $o ? $o->getFileUrlById($iIdThumb) : '';
  2077. if($sImgUrl)
  2078. $aMarkers['img_url'] = $sImgUrl;
  2079. }
  2080. $oMenu = BxDolMenu::getObjectInstance('sys_social_sharing');
  2081. $oMenu->addMarkers($aMarkers);
  2082. $sMenu = $oMenu->getCode();
  2083. if(empty($sMenu))
  2084. return '';
  2085. return $this->_oTemplate->parseHtmlByName('entry-share.html', array(
  2086. 'menu' => $sMenu
  2087. ));
  2088. }
  2089. /**
  2090. * Entry context block
  2091. */
  2092. public function serviceEntityContext ($iContentId = 0)
  2093. {
  2094. return $this->_serviceTemplateFunc ('entryContext', $iContentId);
  2095. }
  2096. /**
  2097. * Blocks for lables tree browsing
  2098. */
  2099. public function serviceGetLablesTree()
  2100. {
  2101. $aBreadcrumbs = array();
  2102. $this->_getLablesBreadcrumbsArray(bx_get('label'), $aBreadcrumbs);
  2103. return $this->_getLablesTreeLevel($aBreadcrumbs);
  2104. }
  2105. public function serviceGetLablesBreadcrumbs()
  2106. {
  2107. if (bx_get('label')){
  2108. $aBreadcrumbs = array();
  2109. $this->_getLablesBreadcrumbsArray(bx_process_input(bx_get('label'), BX_DATA_INT), $aBreadcrumbs);
  2110. $aLabels = array();
  2111. foreach (array_reverse($aBreadcrumbs) as $aLabel){
  2112. $aLabels[] = array(
  2113. 'value' => $aLabel['value'],
  2114. 'url' => $this->_getLablesBrowseUrl($aLabel['id'])
  2115. );
  2116. }
  2117. return $this->_oTemplate->parseHtmlByName('labels_breadcrumbs.html', array('bx_repeat:items' => $aLabels));
  2118. }
  2119. return '';
  2120. }
  2121. public function serviceBrowseByLabel()
  2122. {
  2123. $CNF = &$this->_oConfig->CNF;
  2124. if(empty($CNF['OBJECT_METATAGS']))
  2125. return '';
  2126. $sMode = 'recent';
  2127. if(bx_srv('system', 'is_module_content', [$this->_aModule['name']]))
  2128. $sMode = 'public';
  2129. $o = $this->getObjectBrowse($sMode);
  2130. $o->setDesignBoxTemplateId(BX_DB_PADDING_DEF);
  2131. $o->setDisplayEmptyMsg(true);
  2132. $o->setAjaxPaginate(false);
  2133. $o->setUnitParams(['context' => $sMode]);
  2134. if(($mixedLabel = bx_get('label')) !== false) {
  2135. $sLabel = '';
  2136. if(is_numeric($mixedLabel) && ($aLabel = BxDolLabel::getInstance()->getLabels(['type' => 'id', 'id' => (int)$mixedLabel])) && is_array($aLabel))
  2137. $sLabel = $aLabel['value'];
  2138. else
  2139. $sLabel = bx_process_url_param($mixedLabel, "/^[\d\w\s_-]+$/");
  2140. if($sLabel)
  2141. BxDolMetatags::getObjectInstance($CNF['OBJECT_METATAGS'])->keywordsSetSearchCondition($o, $sLabel);
  2142. }
  2143. if($o->isError)
  2144. return '';
  2145. if($s = $o->processing())
  2146. return $s;
  2147. else
  2148. return '';
  2149. }
  2150. public function serviceBrowseByCategories($sUnitView, $bEmptyMessage, $bAjaxPaginate, $sMode, $iPerPage)
  2151. {
  2152. $o = $this->getObjectBrowse($sMode, ['unit_view' => $sUnitView]);
  2153. $o->setDesignBoxTemplateId(BX_DB_PADDING_DEF);
  2154. $o->setDisplayEmptyMsg($bEmptyMessage);
  2155. $o->setAjaxPaginate($bAjaxPaginate);
  2156. $o->setCategoryObject('multi');
  2157. $aCategories = BxDolCategories::getInstance()->getData([
  2158. 'type' => 'by_module_with_num',
  2159. 'module' => $this->_aModule['name']
  2160. ]);
  2161. $aCategoriesOutput = [];
  2162. foreach($aCategories as $aCategory) {
  2163. if($aCategory['num'] > 0) {
  2164. $o->setCustomSearchCondition(['keyword' => $aCategory['value']]);
  2165. $o->setPaginatePerPage($iPerPage);
  2166. if(!$o->isError){
  2167. $aResult = $o->processing();
  2168. if($aResult && $aResult['content'] != '')
  2169. $aCategoriesOutput[] = [
  2170. 'name' => _t($aCategory['value']),
  2171. 'url' => '',
  2172. 'content' => $aResult['content']
  2173. ];
  2174. }
  2175. }
  2176. }
  2177. return $this->_oTemplate->parseHtmlByName('browse_by_categories.html', [
  2178. 'bx_repeat:categories' => $aCategoriesOutput,
  2179. ]);
  2180. }
  2181. /**
  2182. * @page service Service Calls
  2183. * @section bx_base_general Base General
  2184. * @subsection bx_base_general-polls Polls Blocks
  2185. * @subsubsection bx_base_general-get_block_poll_answers get_block_poll_answers
  2186. *
  2187. * @code bx_srv('bx_posts', 'get_block_poll_answers', [...]); @endcode
  2188. *
  2189. * Get block with poll answers
  2190. * @param $iPollId poll ID
  2191. *
  2192. * @see BxBaseModGeneralModule::serviceGetBlockPollAnswers
  2193. */
  2194. /**
  2195. * @ref bx_base_general-get_block_poll_answers "get_block_poll_answers"
  2196. */
  2197. public function serviceGetBlockPollAnswers($iPollId, $bForceDisplay = false)
  2198. {
  2199. if(!$iPollId)
  2200. return false;
  2201. if(!$bForceDisplay && $this->isPollPerformed($iPollId))
  2202. return $this->serviceGetBlockPollResults($iPollId);
  2203. return $this->_serviceTemplateFunc('entryPollAnswers', $iPollId, 'getPollInfoById');
  2204. }
  2205. /**
  2206. * @page service Service Calls
  2207. * @section bx_base_general Base General
  2208. * @subsection bx_base_general-polls Polls Blocks
  2209. * @subsubsection bx_base_general-get_block_poll_results get_block_poll_results
  2210. *
  2211. * @code bx_srv('bx_posts', 'get_block_poll_results', [...]); @endcode
  2212. *
  2213. * Get block with poll results
  2214. * @param $iPollId poll ID
  2215. *
  2216. * @see BxBaseModGeneralModule::serviceGetBlockPollResults
  2217. */
  2218. /**
  2219. * @ref bx_base_general-get_block_poll_results "get_block_poll_results"
  2220. */
  2221. public function serviceGetBlockPollResults($iPollId)
  2222. {
  2223. return $this->_serviceTemplateFunc('entryPollResults', $iPollId, 'getPollInfoById');
  2224. }
  2225. /**
  2226. * Data for Notifications module
  2227. */
  2228. public function serviceGetNotificationsData()
  2229. {
  2230. $sModule = $this->_aModule['name'];
  2231. $sEventPrivacy = $sModule . '_allow_view_event_to';
  2232. if(BxDolPrivacy::getObjectInstance($sEventPrivacy) === false)
  2233. $sEventPrivacy = '';
  2234. $aResult = [
  2235. 'handlers' => [
  2236. ['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],
  2237. ['group' => $sModule . '_object', 'type' => 'update', 'alert_unit' => $sModule, 'alert_action' => 'edited'],
  2238. ['group' => $sModule . '_object', 'type' => 'delete', 'alert_unit' => $sModule, 'alert_action' => 'deleted'],
  2239. ['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],
  2240. ['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],
  2241. ['group' => $sModule . '_comment', 'type' => 'delete', 'alert_unit' => $sModule, 'alert_action' => 'commentRemoved'],
  2242. ['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],
  2243. ['group' => $sModule . '_reply', 'type' => 'delete', 'alert_unit' => $sModule, 'alert_action' => 'replyRemoved'],
  2244. ['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],
  2245. ['group' => $sModule . '_vote', 'type' => 'delete', 'alert_unit' => $sModule, 'alert_action' => 'undoVote'],
  2246. ['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],
  2247. ['group' => $sModule . '_reaction', 'type' => 'delete', 'alert_unit' => $sModule . '_reactions', 'alert_action' => 'undoVote'],
  2248. ['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],
  2249. ['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],
  2250. //--- Moderation related: For 'admins'.
  2251. ['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],
  2252. ['group' => $sModule . '_object_reported', 'type' => 'insert', 'alert_unit' => $sModule, 'alert_action' => 'reported_content', 'module_name' => $sModule, 'module_method' => 'get_notifications_post_reported', 'module_class' => 'Module', 'module_event_privacy' => $sEventPrivacy],
  2253. ],
  2254. 'settings' => [
  2255. ['group' => 'content', 'unit' => $sModule, 'action' => 'added', 'types' => ['follow_member', 'follow_context']],
  2256. ['group' => 'content_updated', 'unit' => $sModule, 'action' => 'approved', 'types' => ['personal']],
  2257. ['group' => 'comment', 'unit' => $sModule, 'action' => 'commentPost', 'types' => ['personal', 'follow_member', 'follow_context']],
  2258. ['group' => 'reply', 'unit' => $sModule, 'action' => 'replyPost', 'types' => ['personal']],
  2259. ['group' => 'vote', 'unit' => $sModule, 'action' => 'doVote', 'types' => ['personal', 'follow_member', 'follow_context']],
  2260. ['group' => 'vote', 'unit' => $sModule . '_reactions', 'action' => 'doVote', 'types' => ['personal', 'follow_member', 'follow_context']],
  2261. ['group' => 'score_up', 'unit' => $sModule, 'action' => 'doVoteUp', 'types' => ['personal', 'follow_member', 'follow_context']],
  2262. ['group' => 'score_down', 'unit' => $sModule, 'action' => 'doVoteDown', 'types' => ['personal', 'follow_member', 'follow_context']],
  2263. //--- Moderation related: For 'admins'.
  2264. ['group' => 'action_required', 'unit' => $sModule, 'action' => 'pending_approval', 'types' => ['personal']],
  2265. ['group' => 'action_required', 'unit' => $sModule, 'action' => 'reported_content', 'types' => ['personal']],
  2266. ],
  2267. 'alerts' => [
  2268. ['unit' => $sModule, 'action' => 'added'],
  2269. ['unit' => $sModule, 'action' => 'edited'],
  2270. ['unit' => $sModule, 'action' => 'deleted'],
  2271. ['unit' => $sModule, 'action' => 'approved'],
  2272. ['unit' => $sModule, 'action' => 'commentPost'],
  2273. ['unit' => $sModule, 'action' => 'commentRemoved'],
  2274. ['unit' => $sModule, 'action' => 'replyPost'],
  2275. ['unit' => $sModule, 'action' => 'replyRemoved'],
  2276. ['unit' => $sModule, 'action' => 'doVote'],
  2277. ['unit' => $sModule, 'action' => 'undoVote'],
  2278. ['unit' => $sModule . '_reactions', 'action' => 'doVote'],
  2279. ['unit' => $sModule . '_reactions', 'action' => 'undoVote'],
  2280. ['unit' => $sModule, 'action' => 'doVoteUp'],
  2281. ['unit' => $sModule, 'action' => 'doVoteDown'],
  2282. //--- Moderation related: For 'admins'.
  2283. ['unit' => $sModule, 'action' => 'pending_approval'],
  2284. ['unit' => $sModule, 'action' => 'reported_content'],
  2285. ]
  2286. ];
  2287. if(!empty($this->_oConfig->CNF['FIELDS_DELAYED_PROCESSING'])) {
  2288. $aResult['handlers'] = array_merge($aResult['handlers'], [
  2289. ['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' => ''],
  2290. ['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' => ''],
  2291. ]);
  2292. $aResult['settings'] = array_merge($aResult['settings'], [
  2293. ['group' => 'content_updated', 'unit' => $sModule, 'action' => 'publish_failed', 'types' => ['personal']],
  2294. ['group' => 'content_updated', 'unit' => $sModule, 'action' => 'publish_succeeded', 'types' => ['personal']],
  2295. ]);
  2296. $aResult['alerts'] = array_merge($aResult['alerts'], [
  2297. ['unit' => $sModule, 'action' => 'publish_failed'],
  2298. ['unit' => $sModule, 'action' => 'publish_succeeded'],
  2299. ]);
  2300. }
  2301. return $aResult;
  2302. }
  2303. /**
  2304. * Entry post for Notifications module
  2305. */
  2306. public function serviceGetNotificationsPost($aEvent)
  2307. {
  2308. $CNF = &$this->_oConfig->CNF;
  2309. $aContentInfo = $this->_oDb->getContentInfoById($aEvent['object_id']);
  2310. if(empty($aContentInfo) || !is_array($aContentInfo))
  2311. return [];
  2312. $sEntryUrl = bx_absolute_url(BxDolPermalinks::getInstance()->permalink('page.php?i=' . $CNF['URI_VIEW_ENTRY'] . '&id=' . $aContentInfo[$CNF['FIELD_ID']]), '{bx_url_root}');
  2313. $sEntryCaption = isset($aContentInfo[$CNF['FIELD_TITLE']]) ? $aContentInfo[$CNF['FIELD_TITLE']] : strmaxtextlen($aContentInfo[$CNF['FIELD_TEXT']], 20, '...');
  2314. $sEntrySummary = isset($aContentInfo[$CNF['FIELD_TEXT']]) ? $aContentInfo[$CNF['FIELD_TEXT']] : '';
  2315. return [
  2316. 'entry_sample' => $CNF['T']['txt_sample_single'],
  2317. 'entry_url' => $sEntryUrl,
  2318. 'entry_caption' => $sEntryCaption,
  2319. 'entry_summary' => $sEntrySummary,
  2320. 'entry_author' => $aContentInfo[$CNF['FIELD_AUTHOR']],
  2321. 'entry_privacy' => '', //may be empty or not specified. In this case Public privacy will be used.
  2322. '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.
  2323. /*
  2324. * Custom settings for email and/or push notifications can be provided here.
  2325. * Only necessary parts of 'settings' array can be used.
  2326. *
  2327. 'settings' => array(
  2328. 'email' => array(
  2329. 'template' => '', //--- custom email template
  2330. 'markers' => '', //--- markers to parse email parts (subject, body) with
  2331. 'subject' => '' //--- custom email subject
  2332. ),
  2333. 'push' => array(
  2334. 'subject' => '' //--- custom push notification subject
  2335. )
  2336. )
  2337. */
  2338. ];
  2339. }
  2340. public function serviceGetNotificationsPostPendingApproval($aEvent)
  2341. {
  2342. return $this->serviceGetNotificationsPostForModeration($aEvent);
  2343. }
  2344. public function serviceGetNotificationsPostReported($aEvent)
  2345. {
  2346. return $this->serviceGetNotificationsPostForModeration($aEvent);
  2347. }
  2348. public function serviceGetNotificationsPostForModeration($aEvent)
  2349. {
  2350. $aResult = $this->serviceGetNotificationsPost($aEvent);
  2351. /**
  2352. * Unset Entry Author because the notification is addressed to 'admins'.
  2353. */
  2354. if(isset($aResult['entry_author']))
  2355. unset($aResult['entry_author']);
  2356. return $aResult;
  2357. }
  2358. public function serviceGetNotificationsPostApproved($aEvent)
  2359. {
  2360. return $this->serviceGetNotificationsPost($aEvent);
  2361. }
  2362. public function serviceGetNotificationsPostPublishFailed($aEvent)
  2363. {
  2364. return $this->serviceGetNotificationsPost($aEvent);
  2365. }
  2366. public function serviceGetNotificationsPostPublishSucceeded($aEvent)
  2367. {
  2368. return $this->serviceGetNotificationsPost($aEvent);
  2369. }
  2370. /**
  2371. * Entry post comment for Notifications module
  2372. */
  2373. public function serviceGetNotificationsComment($aEvent)
  2374. {
  2375. $CNF = &$this->_oConfig->CNF;
  2376. $iContentId = (int)$aEvent['object_id'];
  2377. $aContentInfo = $this->_oDb->getContentInfoById($iContentId);
  2378. if(empty($aContentInfo) || !is_array($aContentInfo))
  2379. return [];
  2380. $oComment = BxDolCmts::getObjectInstance($CNF['OBJECT_COMMENTS'], $iContentId);
  2381. if(!$oComment || !$oComment->isEnabled())
  2382. return [];
  2383. $sEntryUrl = bx_absolute_url(BxDolPermalinks::getInstance()->permalink('page.php?i=' . $CNF['URI_VIEW_ENTRY'] . '&id=' . $aContentInfo[$CNF['FIELD_ID']]), '{bx_url_root}');
  2384. $sEntryCaption = isset($aContentInfo[$CNF['FIELD_TITLE']]) ? $aContentInfo[$CNF['FIELD_TITLE']] : strmaxtextlen($aContentInfo[$CNF['FIELD_TEXT']], 20, '...');
  2385. $sEntrySummary = isset($aContentInfo[$CNF['FIELD_TEXT']]) ? $aContentInfo[$CNF['FIELD_TEXT']] : '';
  2386. $iCommentId = (int)$aEvent['subobject_id'];
  2387. return [
  2388. 'entry_sample' => $CNF['T']['txt_sample_single'],
  2389. 'entry_url' => $sEntryUrl,
  2390. 'entry_caption' => $sEntryCaption,
  2391. 'entry_summary' => $sEntrySummary,
  2392. 'entry_author' => $aContentInfo[$CNF['FIELD_AUTHOR']],
  2393. 'subentry_sample' => $CNF['T']['txt_sample_comment_single'],
  2394. 'subentry_url' => $oComment->getItemUrl($iCommentId, '{bx_url_root}'),
  2395. 'subentry_url_api' => $oComment->getItemUrlApi($iCommentId, '{bx_url_root}'),
  2396. 'subentry_summary' => $oComment->getViewText($iCommentId),
  2397. 'lang_key' => '', //may be empty or not specified. In this case the default one from Notification module will be used.
  2398. ];
  2399. }
  2400. /**
  2401. * Entry post reply for Notifications module
  2402. */
  2403. public function serviceGetNotificationsReply($aEvent)
  2404. {
  2405. $CNF = &$this->_oConfig->CNF;
  2406. $oComment = BxDolCmts::getObjectInstance($CNF['OBJECT_COMMENTS'], 0, false);
  2407. if(!$oComment || !$oComment->isEnabled())
  2408. return [];
  2409. $iParentId = (int)$aEvent['object_id'];
  2410. $aParentInfo = $oComment->getQueryObject()->getCommentsBy(['type' => 'id', 'id' => $iParentId]);
  2411. if(empty($aParentInfo) || !is_array($aParentInfo))
  2412. return [];
  2413. $iObjectId = (int)$aParentInfo['cmt_object_id'];
  2414. $oComment->init($iObjectId);
  2415. $iCommentId = (int)$aEvent['subobject_id'];
  2416. return [
  2417. 'object_id' => $iObjectId,
  2418. 'entry_sample' => '_cmt_txt_sample_comment_single',
  2419. 'entry_url' => $oComment->getItemUrl($iParentId, '{bx_url_root}'),
  2420. 'entry_url_api' => $oComment->getItemUrlApi($iParentId, '{bx_url_root}'),
  2421. 'entry_caption' => strmaxtextlen($aParentInfo['cmt_text'], 20, '...'),
  2422. 'entry_summary' => $oComment->getViewText($iParentId),
  2423. 'entry_author' => (int)$aParentInfo['cmt_author_id'],
  2424. 'subentry_sample' => '_cmt_txt_sample_reply_to',
  2425. 'subentry_url' => $oComment->getItemUrl($iCommentId, '{bx_url_root}'),
  2426. 'subentry_url_api' => $oComment->getItemUrlApi($iCommentId, '{bx_url_root}'),
  2427. 'subentry_summary' => $oComment->getViewText($iCommentId),
  2428. 'lang_key' => '', //may be empty or not specified. In this case the default one from Notification module will be used.
  2429. ];
  2430. }
  2431. /**
  2432. * Entry post vote for Notifications module
  2433. */
  2434. public function serviceGetNotificationsVote($aEvent)
  2435. {
  2436. $CNF = &$this->_oConfig->CNF;
  2437. $iContentId = (int)$aEvent['object_id'];
  2438. $aContentInfo = $this->_oDb->getContentInfoById($iContentId);
  2439. if(empty($aContentInfo) || !is_array($aContentInfo))
  2440. return [];
  2441. $oVote = BxDolVote::getObjectInstance($CNF['OBJECT_VOTES'], $iContentId);
  2442. if(!$oVote || !$oVote->isEnabled())
  2443. return [];
  2444. $sEntryUrl = bx_absolute_url(BxDolPermalinks::getInstance()->permalink('page.php?i=' . $CNF['URI_VIEW_ENTRY'] . '&id=' . $aContentInfo[$CNF['FIELD_ID']]), '{bx_url_root}');
  2445. $sEntryCaption = isset($aContentInfo[$CNF['FIELD_TITLE']]) ? $aContentInfo[$CNF['FIELD_TITLE']] : strmaxtextlen($aContentInfo[$CNF['FIELD_TEXT']], 20, '...');
  2446. $sEntrySummary = isset($aContentInfo[$CNF['FIELD_TEXT']]) ? $aContentInfo[$CNF['FIELD_TEXT']] : '';
  2447. return [
  2448. 'entry_sample' => $CNF['T']['txt_sample_single'],
  2449. 'entry_url' => $sEntryUrl,
  2450. 'entry_caption' => $sEntryCaption,
  2451. 'entry_summary' => $sEntrySummary,
  2452. 'entry_author' => $aContentInfo[$CNF['FIELD_AUTHOR']],
  2453. 'subentry_sample' => $CNF['T']['txt_sample_vote_single'],
  2454. 'lang_key' => '', //may be empty or not specified. In this case the default one from Notification module will be used.
  2455. ];
  2456. }
  2457. /**
  2458. * Entry post vote for Notifications module
  2459. */
  2460. public function serviceGetNotificationsReaction($aEvent)
  2461. {
  2462. $CNF = &$this->_oConfig->CNF;
  2463. $iContentId = (int)$aEvent['object_id'];
  2464. $aContentInfo = $this->_oDb->getContentInfoById($iContentId);
  2465. if(empty($aContentInfo) || !is_array($aContentInfo))
  2466. return [];
  2467. $oReaction = BxDolVote::getObjectInstance($CNF['OBJECT_REACTIONS'], $iContentId);
  2468. if(!$oReaction || !$oReaction->isEnabled())
  2469. return [];
  2470. $aSubentry = $oReaction->getTrackBy(array('type' => 'id', 'id' => (int)$aEvent['subobject_id']));
  2471. if(empty($aSubentry) || !is_array($aSubentry))
  2472. return [];
  2473. $aSubentrySampleParams = array();
  2474. $aReaction = $oReaction->getReaction($aSubentry['reaction']);
  2475. if(!empty($aReaction['title']))
  2476. $aSubentrySampleParams[] = $aReaction['title'];
  2477. else
  2478. $aSubentrySampleParams[] = '_undefined';
  2479. $sEntryUrl = bx_absolute_url(BxDolPermalinks::getInstance()->permalink('page.php?i=' . $CNF['URI_VIEW_ENTRY'] . '&id=' . $aContentInfo[$CNF['FIELD_ID']]), '{bx_url_root}');
  2480. $sEntryCaption = isset($aContentInfo[$CNF['FIELD_TITLE']]) ? $aContentInfo[$CNF['FIELD_TITLE']] : strmaxtextlen($aContentInfo[$CNF['FIELD_TEXT']], 20, '...');
  2481. $sEntrySummary = isset($aContentInfo[$CNF['FIELD_TEXT']]) ? $aContentInfo[$CNF['FIELD_TEXT']] : '';
  2482. return [
  2483. 'entry_sample' => $CNF['T']['txt_sample_single'],
  2484. 'entry_url' => $sEntryUrl,
  2485. 'entry_caption' => $sEntryCaption,
  2486. 'entry_summary' => $sEntrySummary,
  2487. 'entry_author' => $aContentInfo[$CNF['FIELD_AUTHOR']],
  2488. 'subentry_sample' => $CNF['T']['txt_sample_reaction_single'],
  2489. 'subentry_sample_params' => $aSubentrySampleParams,
  2490. 'lang_key' => '', //may be empty or not specified. In this case the default one from Notification module will be used.
  2491. ];
  2492. }
  2493. /**
  2494. * Entry post score -> vote up for Notifications module
  2495. */
  2496. public function serviceGetNotificationsScoreUp($aEvent)
  2497. {
  2498. return $this->_serviceGetNotificationsScore('up', $aEvent);
  2499. }
  2500. /**
  2501. * Entry post score -> vote up for Notifications module
  2502. */
  2503. public function serviceGetNotificationsScoreDown($aEvent)
  2504. {
  2505. return $this->_serviceGetNotificationsScore('down', $aEvent);
  2506. }
  2507. protected function _serviceGetNotificationsScore($sType, $aEvent)
  2508. {
  2509. $CNF = &$this->_oConfig->CNF;
  2510. $iContentId = (int)$aEvent['object_id'];
  2511. $aContentInfo = $this->_oDb->getContentInfoById($iContentId);
  2512. if(empty($aContentInfo) || !is_array($aContentInfo))
  2513. return array();
  2514. $oScore = BxDolScore::getObjectInstance($CNF['OBJECT_SCORES'], $iContentId);
  2515. if(!$oScore || !$oScore->isEnabled())
  2516. return array();
  2517. $sEntryUrl = bx_absolute_url(BxDolPermalinks::getInstance()->permalink('page.php?i=' . $CNF['URI_VIEW_ENTRY'] . '&id=' . $aContentInfo[$CNF['FIELD_ID']]), '{bx_url_root}');
  2518. $sEntryCaption = isset($aContentInfo[$CNF['FIELD_TITLE']]) ? $aContentInfo[$CNF['FIELD_TITLE']] : strmaxtextlen($aContentInfo[$CNF['FIELD_TEXT']], 20, '...');
  2519. $sEntrySummary = isset($aContentInfo[$CNF['FIELD_TEXT']]) ? $aContentInfo[$CNF['FIELD_TEXT']] : '';
  2520. return [
  2521. 'entry_sample' => $CNF['T']['txt_sample_single'],
  2522. 'entry_url' => $sEntryUrl,
  2523. 'entry_caption' => $sEntryCaption,
  2524. 'entry_summary' => $sEntrySummary,
  2525. 'entry_author' => $aContentInfo[$CNF['FIELD_AUTHOR']],
  2526. 'subentry_sample' => $CNF['T']['txt_sample_score_' . $sType . '_single'],
  2527. 'lang_key' => '', //may be empty or not specified. In this case the default one from Notification module will be used.
  2528. ];
  2529. }
  2530. /**
  2531. * Data for Reputation module
  2532. */
  2533. public function serviceGetReputationData()
  2534. {
  2535. $sModule = $this->_aModule['name'];
  2536. $aResult = [
  2537. 'handlers' => [
  2538. ['group' => $sModule . '_object', 'type' => 'insert', 'alert_unit' => $sModule, 'alert_action' => 'added', 'points_active' => 3, 'points_passive' => 0],
  2539. ['group' => $sModule . '_object', 'type' => 'delete', 'alert_unit' => $sModule, 'alert_action' => 'deleted', 'points_active' => -3, 'points_passive' => 0],
  2540. ['group' => $sModule . '_comment', 'type' => 'insert', 'alert_unit' => $sModule, 'alert_action' => 'commentPost', 'points_active' => 2, 'points_passive' => 1],
  2541. ['group' => $sModule . '_comment', 'type' => 'delete', 'alert_unit' => $sModule, 'alert_action' => 'commentRemoved', 'points_active' => -2, 'points_passive' => -1],
  2542. ['group' => $sModule . '_vote', 'type' => 'insert', 'alert_unit' => $sModule, 'alert_action' => 'doVote', 'points_active' => 1, 'points_passive' => 1],
  2543. ['group' => $sModule . '_vote', 'type' => 'delete', 'alert_unit' => $sModule, 'alert_action' => 'undoVote', 'points_active' => -1, 'points_passive' => -1],
  2544. ['group' => $sModule . '_reaction', 'type' => 'insert', 'alert_unit' => $sModule . '_reactions', 'alert_action' => 'doVote', 'points_active' => 1, 'points_passive' => 1],
  2545. ['group' => $sModule . '_reaction', 'type' => 'delete', 'alert_unit' => $sModule . '_reactions', 'alert_action' => 'undoVote', 'points_active' => -1, 'points_passive' => -1],
  2546. ['group' => $sModule . '_score_up', 'type' => 'insert', 'alert_unit' => $sModule, 'alert_action' => 'doVoteUp', 'points_active' => 1, 'points_passive' => 1],
  2547. ['group' => $sModule . '_score_up', 'type' => 'delete', 'alert_unit' => $sModule, 'alert_action' => 'undoVoteUp', 'points_active' => -1, 'points_passive' => -1],
  2548. ['group' => $sModule . '_score_down', 'type' => 'insert', 'alert_unit' => $sModule, 'alert_action' => 'doVoteDown', 'points_active' => 1, 'points_passive' => -1],
  2549. ['group' => $sModule . '_score_down', 'type' => 'delete', 'alert_unit' => $sModule, 'alert_action' => 'undoVoteDown', 'points_active' => -1, 'points_passive' => 1],
  2550. ],
  2551. 'alerts' => [
  2552. ['unit' => $sModule, 'action' => 'added'],
  2553. ['unit' => $sModule, 'action' => 'deleted'],
  2554. ['unit' => $sModule, 'action' => 'commentPost'],
  2555. ['unit' => $sModule, 'action' => 'commentRemoved'],
  2556. ['unit' => $sModule, 'action' => 'doVote'],
  2557. ['unit' => $sModule, 'action' => 'undoVote'],
  2558. ['unit' => $sModule . '_reactions', 'action' => 'doVote'],
  2559. ['unit' => $sModule . '_reactions', 'action' => 'undoVote'],
  2560. ['unit' => $sModule, 'action' => 'doVoteUp'],
  2561. ['unit' => $sModule, 'action' => 'undoVoteUp'],
  2562. ['unit' => $sModule, 'action' => 'doVoteDown'],
  2563. ['unit' => $sModule, 'action' => 'undoVoteDown'],
  2564. ]
  2565. ];
  2566. return $aResult;
  2567. }
  2568. /**
  2569. * Data for Timeline module
  2570. */
  2571. public function serviceGetTimelineData()
  2572. {
  2573. $sModule = $this->_aModule['name'];
  2574. return array(
  2575. 'handlers' => array(
  2576. 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' => ''),
  2577. array('group' => $sModule . '_object', 'type' => 'update', 'alert_unit' => $sModule, 'alert_action' => 'edited'),
  2578. array('group' => $sModule . '_object', 'type' => 'delete', 'alert_unit' => $sModule, 'alert_action' => 'deleted')
  2579. ),
  2580. 'alerts' => array(
  2581. array('unit' => $sModule, 'action' => 'added'),
  2582. array('unit' => $sModule, 'action' => 'edited'),
  2583. array('unit' => $sModule, 'action' => 'deleted'),
  2584. )
  2585. );
  2586. }
  2587. /**
  2588. * Entry post for Timeline module
  2589. */
  2590. public function serviceGetTimelinePost($aEvent, $aBrowseParams = array())
  2591. {
  2592. $aContentInfo = $this->_oDb->getContentInfoById($aEvent['object_id']);
  2593. if(empty($aContentInfo) || !is_array($aContentInfo))
  2594. return false;
  2595. $CNF = &$this->_oConfig->CNF;
  2596. if((!empty($CNF['FIELD_STATUS']) && $aContentInfo[$CNF['FIELD_STATUS']] != 'active') || (!empty($CNF['FIELD_STATUS_ADMIN']) && $aContentInfo[$CNF['FIELD_STATUS_ADMIN']] != 'active'))
  2597. return false;
  2598. $bCache = true;
  2599. $iUserId = $this->getUserId();
  2600. $iAuthorId = (int)$aContentInfo[$CNF['FIELD_AUTHOR']];
  2601. $iAuthorIdAbs = abs($iAuthorId);
  2602. /**
  2603. * Don't show anonymous posts on the post's owner timeline
  2604. * and don't cache them when they're viewed by their authors.
  2605. */
  2606. if($iAuthorId < 0 && ((is_numeric($aEvent['owner_id']) && $iAuthorIdAbs == (int)$aEvent['owner_id']) || (is_array($aEvent['owner_id']) && in_array($iAuthorIdAbs, $aEvent['owner_id'])))) {
  2607. if($iAuthorIdAbs != $iUserId)
  2608. return false;
  2609. $bCache = false;
  2610. }
  2611. //--- Views
  2612. $oViews = isset($CNF['OBJECT_VIEWS']) ? BxDolView::getObjectInstance($CNF['OBJECT_VIEWS'], $aContentInfo[$CNF['FIELD_ID']]) : null;
  2613. $aViews = array();
  2614. if ($oViews && $oViews->isEnabled())
  2615. $aViews = array(
  2616. 'system' => $CNF['OBJECT_VIEWS'],
  2617. 'object_id' => $aContentInfo[$CNF['FIELD_ID']],
  2618. 'count' => $aContentInfo['views']
  2619. );
  2620. //--- Votes
  2621. $oVotes = isset($CNF['OBJECT_VOTES']) ? BxDolVote::getObjectInstance($CNF['OBJECT_VOTES'], $aContentInfo[$CNF['FIELD_ID']]) : null;
  2622. $aVotes = array();
  2623. if ($oVotes && $oVotes->isEnabled())
  2624. $aVotes = array(
  2625. 'system' => $CNF['OBJECT_VOTES'],
  2626. 'object_id' => $aContentInfo[$CNF['FIELD_ID']],
  2627. 'count' => $aContentInfo['votes']
  2628. );
  2629. //--- Reactions
  2630. $oReactions = isset($CNF['OBJECT_REACTIONS']) ? BxDolVote::getObjectInstance($CNF['OBJECT_REACTIONS'], $aContentInfo[$CNF['FIELD_ID']]) : null;
  2631. $aReactions = array();
  2632. if ($oReactions && $oReactions->isEnabled())
  2633. $aReactions = array(
  2634. 'system' => $CNF['OBJECT_REACTIONS'],
  2635. 'object_id' => $aContentInfo[$CNF['FIELD_ID']],
  2636. 'count' => $aContentInfo['rvotes']
  2637. );
  2638. //--- Scores
  2639. $oScores = isset($CNF['OBJECT_SCORES']) ? BxDolScore::getObjectInstance($CNF['OBJECT_SCORES'], $aContentInfo[$CNF['FIELD_ID']]) : null;
  2640. $aScores = array();
  2641. if ($oScores && $oScores->isEnabled())
  2642. $aScores = array(
  2643. 'system' => $CNF['OBJECT_SCORES'],
  2644. 'object_id' => $aContentInfo[$CNF['FIELD_ID']],
  2645. 'score' => $aContentInfo['score']
  2646. );
  2647. //--- Reports
  2648. $oReports = isset($CNF['OBJECT_REPORTS']) ? BxDolReport::getObjectInstance($CNF['OBJECT_REPORTS'], $aContentInfo[$CNF['FIELD_ID']]) : null;
  2649. $aReports = array();
  2650. if ($oReports && $oReports->isEnabled())
  2651. $aReports = array(
  2652. 'system' => $CNF['OBJECT_REPORTS'],
  2653. 'object_id' => $aContentInfo[$CNF['FIELD_ID']],
  2654. 'count' => $aContentInfo['reports']
  2655. );
  2656. //--- Comments
  2657. $oCmts = isset($CNF['OBJECT_COMMENTS']) ? BxDolCmts::getObjectInstance($CNF['OBJECT_COMMENTS'], $aContentInfo[$CNF['FIELD_ID']]) : null;
  2658. $aComments = array();
  2659. if($oCmts && $oCmts->isEnabled())
  2660. $aComments = array(
  2661. 'system' => $CNF['OBJECT_COMMENTS'],
  2662. 'object_id' => $aContentInfo[$CNF['FIELD_ID']],
  2663. 'count' => $aContentInfo['comments']
  2664. );
  2665. //--- Title & Description
  2666. $sTitle = !empty($aContentInfo[$CNF['FIELD_TITLE']]) ? $aContentInfo[$CNF['FIELD_TITLE']] : '';
  2667. if(empty($sTitle) && !empty($aContentInfo[$CNF['FIELD_TEXT']]))
  2668. $sTitle = $aContentInfo[$CNF['FIELD_TEXT']];
  2669. $iOwnerId = $iAuthorIdAbs;
  2670. if(isset($aEvent['object_privacy_view']) && (int)$aEvent['object_privacy_view'] < 0)
  2671. $iOwnerId = abs($aEvent['object_privacy_view']);
  2672. $aContent = $this->_getContentForTimelinePost($aEvent, $aContentInfo, $aBrowseParams);
  2673. if(isset($aContent['_cache'])) {
  2674. if($bCache)
  2675. $bCache = (bool)$aContent['_cache'];
  2676. unset($aContent['_cache']);
  2677. }
  2678. return [
  2679. '_cache' => $bCache,
  2680. 'owner_id' => $iOwnerId,
  2681. 'object_owner_id' => $iAuthorId,
  2682. 'icon' => !empty($CNF['ICON']) ? $CNF['ICON'] : '',
  2683. 'sample' => isset($CNF['T']['txt_sample_single_with_article']) ? $CNF['T']['txt_sample_single_with_article'] : $CNF['T']['txt_sample_single'],
  2684. 'sample_wo_article' => $CNF['T']['txt_sample_single'],
  2685. 'sample_action' => isset($CNF['T']['txt_sample_action']) ? $CNF['T']['txt_sample_action'] : '',
  2686. 'url' => bx_absolute_url(BxDolPermalinks::getInstance()->permalink('page.php?i=' . $CNF['URI_VIEW_ENTRY'] . '&id=' . $aContentInfo[$CNF['FIELD_ID']])),
  2687. 'content' => $aContent, //a string to display or array to parse default template before displaying.
  2688. 'date' => $aContentInfo[$CNF['FIELD_ADDED']],
  2689. 'views' => $aViews,
  2690. 'votes' => $aVotes,
  2691. 'reactions' => $aReactions,
  2692. 'scores' => $aScores,
  2693. 'reports' => $aReports,
  2694. 'comments' => $aComments,
  2695. 'title' => $sTitle, //may be empty.
  2696. 'description' => '' //may be empty.
  2697. ];
  2698. }
  2699. public function serviceGetTimelinePostAllowedView($aEvent)
  2700. {
  2701. $iContentId = (int)$aEvent['object_id'];
  2702. $aContentInfo = $this->_oDb->getContentInfoById($iContentId);
  2703. if(empty($aContentInfo) || !is_array($aContentInfo))
  2704. return _t('_sys_txt_access_denied');
  2705. return $this->serviceCheckAllowedViewForProfile($aContentInfo);
  2706. }
  2707. /**
  2708. * Check particular action permission without content
  2709. * @param $sAction action to check, for example: Browse, Add
  2710. * @param $iContentId content ID
  2711. * @return message on error, or CHECK_ACTION_RESULT_ALLOWED when allowed
  2712. */
  2713. public function serviceCheckAllowed($sAction, $isPerformAction = false)
  2714. {
  2715. $sMethod = 'checkAllowed' . bx_gen_method_name($sAction);
  2716. if (!method_exists($this, $sMethod))
  2717. return _t('_sys_request_method_not_found_cpt');
  2718. return $this->$sMethod($isPerformAction);
  2719. }
  2720. /**
  2721. * Check particular action permission with content
  2722. * @param $sAction action to check, for example: View, Edit
  2723. * @param $iContentId content ID
  2724. * @return message on error, or CHECK_ACTION_RESULT_ALLOWED when allowed
  2725. */
  2726. public function serviceCheckAllowedWithContent($sAction, $iContentId, $isPerformAction = false)
  2727. {
  2728. if (!$iContentId || !($aContentInfo = $this->_oDb->getContentInfoById($iContentId)))
  2729. return _t('_sys_request_page_not_found_cpt');
  2730. $sMethod = 'checkAllowed' . bx_gen_method_name($sAction);
  2731. if (!method_exists($this, $sMethod))
  2732. return _t('_sys_request_method_not_found_cpt');
  2733. return $this->$sMethod($aContentInfo, $isPerformAction);
  2734. }
  2735. /**
  2736. * Check particular action permission with content for specified profile
  2737. * @param $sAction action to check, for example: View, Edit
  2738. * @param $iContentId content ID
  2739. * @param $iProfileId profile ID which the permissions to be cheked for
  2740. * @return message on error, or CHECK_ACTION_RESULT_ALLOWED when allowed
  2741. */
  2742. public function serviceCheckAllowedWithContentForProfile($sAction, $iContentId, $iProfileId, $isPerformAction = false)
  2743. {
  2744. if (!$iContentId || !($aContentInfo = $this->_oDb->getContentInfoById($iContentId)))
  2745. return _t('_sys_request_page_not_found_cpt');
  2746. $sMethod = 'checkAllowed' . bx_gen_method_name($sAction) . 'ForProfile';
  2747. if (!method_exists($this, $sMethod))
  2748. return _t('_sys_request_method_not_found_cpt');
  2749. return $this->$sMethod($aContentInfo, $iProfileId, $isPerformAction);
  2750. }
  2751. public function serviceCheckAllowedCommentsView($iContentId, $sObjectComments)
  2752. {
  2753. //negative id used in comments for reports
  2754. if ($iContentId < 0)
  2755. return CHECK_ACTION_RESULT_ALLOWED;
  2756. return $this->serviceCheckAllowedWithContent('comments_view', $iContentId);
  2757. }
  2758. public function serviceCheckAllowedCommentsPost($iContentId, $sObjectComments)
  2759. {
  2760. //negative id used in comments for reports
  2761. if ($iContentId < 0)
  2762. return CHECK_ACTION_RESULT_ALLOWED;
  2763. return $this->serviceCheckAllowedWithContent('comments_post', $iContentId);
  2764. }
  2765. public function serviceGetContentOwnerProfileId ($iContentId)
  2766. {
  2767. $CNF = &$this->_oConfig->CNF;
  2768. // file owner must be author of the content or profile itself in case of profile based module
  2769. if ($iContentId) {
  2770. $sModule = $this->getName();
  2771. if ($this instanceof iBxDolProfileService && BxDolService::call($sModule, 'act_as_profile')) {
  2772. $oProfile = BxDolProfile::getInstanceByContentAndType($iContentId, $sModule);
  2773. }
  2774. else {
  2775. $aContentInfo = $this->_oDb->getContentInfoById($iContentId);
  2776. $iContentAuthor = (int)$aContentInfo[$CNF['FIELD_AUTHOR']];
  2777. if($iContentAuthor < 0)
  2778. $iContentAuthor = abs($iContentAuthor);
  2779. $oProfile = $aContentInfo ? BxDolProfile::getInstance($iContentAuthor) : null;
  2780. }
  2781. $iProfileId = $oProfile ? $oProfile->id() : bx_get_logged_profile_id();
  2782. }
  2783. else
  2784. $iProfileId = bx_get_logged_profile_id();
  2785. return $iProfileId;
  2786. }
  2787. public function serviceGetBadges($iContentId, $bIsSingle = false, $bIsCompact = false)
  2788. {
  2789. $sModule = $this->getName();
  2790. $oBadges = BxDolBadges::getInstance();
  2791. $aBadges = $oBadges->getData(array(
  2792. 'type' => ($bIsSingle ? 'by_module&object2_single' : 'by_module&object2'),
  2793. 'module' => $sModule,
  2794. 'object_id' => $iContentId
  2795. ));
  2796. $sResult = false;
  2797. /**
  2798. * @hooks
  2799. * @hookdef hook-system-get_badges 'system', 'get_badges' - hook to override bages assigned to an entry (content)
  2800. * - $unit_name - equals `system`
  2801. * - $action - equals `get_badges`
  2802. * - $object_id - not used
  2803. * - $sender_id - not used
  2804. * - $extra_params - array of additional params with the following array keys:
  2805. * - `module` - [string] module name
  2806. * - `content_id` - [int] content id
  2807. * - `is_single` - [boolean] only one badge can be used or not
  2808. * - `is_compact` - [boolean] badge in compact mode or not
  2809. * - `badges` - [array] a list of all badges assigned to the content
  2810. * - `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
  2811. * @hook @ref hook-system-get_badges
  2812. */
  2813. bx_alert('system', 'get_badges', 0, 0, [
  2814. 'module' => $sModule,
  2815. 'content_id' => $iContentId,
  2816. 'is_single' => $bIsSingle,
  2817. 'is_compact' => $bIsCompact,
  2818. 'badges' => $aBadges,
  2819. 'override_result' => &$sResult
  2820. ]);
  2821. if($sResult !== false)
  2822. return $sResult;
  2823. if(empty($aBadges) || !is_array($aBadges))
  2824. return $this->_bIsApi ? [] : '';
  2825. if($this->_bIsApi) {
  2826. foreach($aBadges as &$aBadge)
  2827. if(($mixedIcon = $aBadge['icon']) && is_numeric($mixedIcon) && (int)$mixedIcon > 0)
  2828. $aBadge['icon_url'] = $this->_oTemplate->getIcon($aBadge['icon'], ['wrap_in_tag' => false]);
  2829. else
  2830. $aBadge['icon'] = $mixedIcon;
  2831. return $aBadges;
  2832. }
  2833. if($bIsSingle)
  2834. return BxDolService::call('system', 'get_badge', array($aBadges[0], $bIsCompact), 'TemplServices');
  2835. $aBadgesOutput = array();
  2836. foreach($aBadges as $aBadge)
  2837. $aBadgesOutput[] = array('badge' => BxDolService::call('system', 'get_badge', array($aBadge, $bIsCompact), 'TemplServices'));
  2838. return $this->_oTemplate->parseHtmlByName('badges.html', array(
  2839. 'bx_repeat:items' => $aBadgesOutput,
  2840. ));
  2841. }
  2842. /**
  2843. * @page service Service Calls
  2844. * @section bx_base_general Base General
  2845. * @subsection bx_base_general-page_blocks Page Blocks
  2846. * @subsubsection bx_base_general-categories_multi_list categories_multi_list
  2847. *
  2848. * @code bx_srv('bx_posts', 'categories_multi_list', [...]); @endcode
  2849. *
  2850. * Display multi-categorories block with number of posts in each category
  2851. * @param $bAsArray boolean reature as array or not.
  2852. *
  2853. * @see BxBaseModGeneralModule::serviceCategoriesMultiList
  2854. */
  2855. /**
  2856. * @ref bx_base_general-categories_multi_list "categories_multi_list"
  2857. */
  2858. public function serviceCategoriesMultiList($bAsArray = false)
  2859. {
  2860. $oCategories = BxDolCategories::getInstance();
  2861. $oCategories->setModule($this->getName());
  2862. $mixedResult = $oCategories->getCategoriesList($bAsArray || $this->_bIsApi);
  2863. return !$this->_bIsApi ? $mixedResult : [bx_api_get_block('categories_list', $mixedResult)];
  2864. }
  2865. /**
  2866. * ======
  2867. * PERMISSION METHODS
  2868. * ======
  2869. */
  2870. public function serviceCheckAllowedViewForProfile ($aDataEntry, $isPerformAction = false, $iProfileId = false)
  2871. {
  2872. $mixedResult = $this->_serviceCheckAllowedViewForProfile ($aDataEntry, $isPerformAction, $iProfileId);
  2873. /**
  2874. * @hooks
  2875. * @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
  2876. * - $unit_name - equals `system`
  2877. * - $action - equals `check_allowed_view`
  2878. * - $object_id - not used
  2879. * - $sender_id - not used
  2880. * - $extra_params - array of additional params with the following array keys:
  2881. * - `module` - [string] module name
  2882. * - `content_info` - [array] content info array as key&value pairs
  2883. * - `profile_id` - [boolean] or [int] profile id to be checked the availability of the action to
  2884. * - `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
  2885. * @hook @ref hook-system-check_allowed_view
  2886. */
  2887. bx_alert('system', 'check_allowed_view', 0, 0, [
  2888. 'module' => $this->getName(),
  2889. 'content_info' => $aDataEntry,
  2890. 'profile_id' => $iProfileId,
  2891. 'override_result' => &$mixedResult
  2892. ]);
  2893. return $mixedResult;
  2894. }
  2895. public function checkAllowedSetThumb ($iContentId = 0)
  2896. {
  2897. return CHECK_ACTION_RESULT_ALLOWED;
  2898. }
  2899. /**
  2900. * @return CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. So make sure to make "true === " checking.
  2901. */
  2902. public function checkAllowedBrowse ()
  2903. {
  2904. $mixedResult = null;
  2905. /**
  2906. * @hooks
  2907. * @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
  2908. * It's equivalent to @ref hook-system-check_allowed_view
  2909. * except `content_info` parameter in $extra_params is missing
  2910. * @hook @ref hook-system-check_allowed_browse
  2911. */
  2912. bx_alert('system', 'check_allowed_browse', 0, 0, [
  2913. 'module' => $this->getName(),
  2914. 'profile_id' => $this->_iProfileId,
  2915. 'override_result' => &$mixedResult
  2916. ]);
  2917. if($mixedResult !== null)
  2918. return $mixedResult;
  2919. return CHECK_ACTION_RESULT_ALLOWED;
  2920. }
  2921. /**
  2922. * @return CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. So make sure to make strict(===) checking.
  2923. */
  2924. public function checkAllowedView ($aDataEntry, $isPerformAction = false)
  2925. {
  2926. return $this->serviceCheckAllowedViewForProfile ($aDataEntry, $isPerformAction);
  2927. }
  2928. /**
  2929. * @return CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. So make sure to make strict(===) checking.
  2930. */
  2931. public function checkAllowedViewForProfile ($aDataEntry, $iProfileId, $isPerformAction = false)
  2932. {
  2933. return $this->serviceCheckAllowedViewForProfile ($aDataEntry, $isPerformAction, $iProfileId);
  2934. }
  2935. /**
  2936. * @return CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. So make sure to make strict(===) checking.
  2937. */
  2938. public function checkAllowedAdd ($isPerformAction = false)
  2939. {
  2940. // check ACL
  2941. $aCheck = checkActionModule($this->_iProfileId, 'create entry', $this->getName(), $isPerformAction);
  2942. if ($aCheck[CHECK_ACTION_RESULT] !== CHECK_ACTION_RESULT_ALLOWED)
  2943. return $aCheck[CHECK_ACTION_MESSAGE];
  2944. return CHECK_ACTION_RESULT_ALLOWED;
  2945. }
  2946. public function serviceCheckAllowedAddInContext($sContextModule)
  2947. {
  2948. $CNF = &$this->_oConfig->CNF;
  2949. if(($sKey = 'OBJECT_PRIVACY_VIEW') && !empty($CNF[$sKey]) && ($oPrivacy = BxDolPrivacy::getObjectInstance($CNF[$sKey])) !== false && !$oPrivacy->isAllowedAddInContext($sContextModule))
  2950. return _t('_sys_txt_access_denied');
  2951. return CHECK_ACTION_RESULT_ALLOWED;
  2952. }
  2953. /**
  2954. * @return CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. So make sure to make strict(===) checking.
  2955. */
  2956. public function checkAllowedApprove ($aDataEntry, $isPerformAction = false)
  2957. {
  2958. $CNF = &$this->_oConfig->CNF;
  2959. $sError = '_sys_txt_access_denied';
  2960. if($this->_oConfig->isAutoApproveEnabled())
  2961. return _t($sError);
  2962. if($aDataEntry[$CNF['FIELD_STATUS_ADMIN']] != BX_BASE_MOD_GENERAL_STATUS_PENDING)
  2963. return _t($sError);
  2964. // moderator always have access
  2965. if ($this->_isModerator($isPerformAction))
  2966. return CHECK_ACTION_RESULT_ALLOWED;
  2967. // check for context's admins
  2968. if (!empty($CNF['FIELD_ALLOW_VIEW_TO']) && (int)$aDataEntry[$CNF['FIELD_ALLOW_VIEW_TO']] < 0) {
  2969. $oProfile = BxDolProfile::getInstance(-(int)$aDataEntry[$CNF['FIELD_ALLOW_VIEW_TO']]);
  2970. if ($oProfile){
  2971. $sModule = $oProfile->getModule();
  2972. $aEntity = BxDolRequest::serviceExists($sModule, 'get_all') ? BxDolService::call($sModule, 'get_all', array(array('type' => 'id', 'id' => $oProfile->getContentId()))) : array();
  2973. $oModule = BxDolModule::getInstance($sModule);
  2974. // check for context's extra roles with rights
  2975. if (method_exists($oModule, 'isAllowedModuleActionByProfile')) {
  2976. $bResult = $oModule->isAllowedModuleActionByProfile($oProfile->getContentId(), $this->getName(), 'edit_any');
  2977. if ($bResult !== NULL) return $bResult;
  2978. }
  2979. // if allowed edit a group then allowed to edit anything inside its context
  2980. if(isset($aEntity) && $oModule->checkAllowedEdit($aEntity) === CHECK_ACTION_RESULT_ALLOWED){
  2981. return CHECK_ACTION_RESULT_ALLOWED;
  2982. }
  2983. }
  2984. }
  2985. return _t($sError);
  2986. }
  2987. /**
  2988. * @return CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. So make sure to make strict(===) checking.
  2989. */
  2990. public function checkAllowedEdit ($aDataEntry, $isPerformAction = false)
  2991. {
  2992. // moderator and owner always have access
  2993. if ($this->isEntryAuthor($aDataEntry, $this->_iProfileId) || $this->_isModerator($isPerformAction))
  2994. return CHECK_ACTION_RESULT_ALLOWED;
  2995. // check for context's admins
  2996. if (!empty($this->_oConfig->CNF['FIELD_ALLOW_VIEW_TO']) && (int)$aDataEntry[$this->_oConfig->CNF['FIELD_ALLOW_VIEW_TO']] < 0) {
  2997. $oProfile = BxDolProfile::getInstance(-(int)$aDataEntry[$this->_oConfig->CNF['FIELD_ALLOW_VIEW_TO']]);
  2998. if ($oProfile){
  2999. $sModule = $oProfile->getModule();
  3000. $aEntity = BxDolRequest::serviceExists($sModule, 'get_all') ? BxDolService::call($sModule, 'get_all', array(array('type' => 'id', 'id' => $oProfile->getContentId()))) : array();
  3001. $oModule = BxDolModule::getInstance($sModule);
  3002. // check for context's extra roles with rights
  3003. if (method_exists($oModule, 'isAllowedModuleActionByProfile')) {
  3004. $bResult = $oModule->isAllowedModuleActionByProfile($oProfile->getContentId(), $this->getName(), 'edit_any');
  3005. if ($bResult !== NULL) return $bResult;
  3006. }
  3007. // if allowed edit a group then allowed to edit anything inside its context
  3008. if(isset($aEntity) && $oModule->checkAllowedEdit($aEntity) === CHECK_ACTION_RESULT_ALLOWED){
  3009. return CHECK_ACTION_RESULT_ALLOWED;
  3010. }
  3011. }
  3012. }
  3013. return _t('_sys_txt_access_denied');
  3014. }
  3015. /**
  3016. * @return CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. So make sure to make strict(===) checking.
  3017. */
  3018. public function checkAllowedDelete (&$aDataEntry, $isPerformAction = false)
  3019. {
  3020. // moderator always has access
  3021. if ($this->_isAdministrator($isPerformAction))
  3022. return CHECK_ACTION_RESULT_ALLOWED;
  3023. // check ACL
  3024. $aCheck = checkActionModule($this->_iProfileId, 'delete entry', $this->getName(), $isPerformAction);
  3025. if ($this->isEntryAuthor($aDataEntry, $this->_iProfileId) && $aCheck[CHECK_ACTION_RESULT] === CHECK_ACTION_RESULT_ALLOWED)
  3026. return CHECK_ACTION_RESULT_ALLOWED;
  3027. // check for context's admins
  3028. if (isset($this->_oConfig->CNF['FIELD_ALLOW_VIEW_TO']) && (int)$aDataEntry[$this->_oConfig->CNF['FIELD_ALLOW_VIEW_TO']] < 0){
  3029. $oProfile = BxDolProfile::getInstance(-(int)$aDataEntry[$this->_oConfig->CNF['FIELD_ALLOW_VIEW_TO']]);
  3030. if ($oProfile){
  3031. $sModule = $oProfile->getModule();
  3032. $aEntity = BxDolRequest::serviceExists($sModule, 'get_all') ? BxDolService::call($sModule, 'get_all', array(array('type' => 'id', 'id' => $oProfile->getContentId()))) : array();
  3033. $oModule = BxDolModule::getInstance($sModule);
  3034. // check for context's extra roles with rights
  3035. if (method_exists($oModule, 'isAllowedModuleActionByProfile')) {
  3036. $bResult = $oModule->isAllowedModuleActionByProfile($oProfile->getContentId(), $this->getName(), 'delete_any');
  3037. if ($bResult !== NULL) return $bResult;
  3038. }
  3039. // if allowed delete a group then allowed to delete anything inside its context
  3040. if(isset($aEntity) && $oModule->checkAllowedDelete($aEntity) === CHECK_ACTION_RESULT_ALLOWED){
  3041. return CHECK_ACTION_RESULT_ALLOWED;
  3042. }
  3043. }
  3044. }
  3045. return _t('_sys_txt_access_denied');
  3046. }
  3047. /**
  3048. * @return CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. So make sure to make strict(===) checking.
  3049. */
  3050. public function checkAllowedSetMembership (&$aDataEntry, $isPerformAction = false)
  3051. {
  3052. // admin always has access
  3053. if (isAdmin())
  3054. return CHECK_ACTION_RESULT_ALLOWED;
  3055. // check ACL
  3056. $aCheck = checkActionModule($this->_iProfileId, 'set acl level', 'system', $isPerformAction);
  3057. if ($aCheck[CHECK_ACTION_RESULT] !== CHECK_ACTION_RESULT_ALLOWED)
  3058. return $aCheck[CHECK_ACTION_MESSAGE];
  3059. return CHECK_ACTION_RESULT_ALLOWED;
  3060. }
  3061. /**
  3062. * @return CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. So make sure to make strict(===) checking.
  3063. */
  3064. public function checkAllowedEditAnyEntry ($isPerformAction = false)
  3065. {
  3066. return $this->checkAllowedEditAnyEntryForProfile($isPerformAction, $this->_iProfileId);
  3067. }
  3068. /**
  3069. * @return CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. So make sure to make strict(===) checking.
  3070. */
  3071. public function checkAllowedDeleteAnyEntry ($isPerformAction = false)
  3072. {
  3073. return $this->checkAllowedDeleteAnyEntryForProfile($isPerformAction, $this->_iProfileId);
  3074. }
  3075. /**
  3076. * @return CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. So make sure to make strict(===) checking.
  3077. */
  3078. public function checkAllowedEditAnyEntryForProfile ($isPerformAction = false, $iProfileId = false)
  3079. {
  3080. if(!$iProfileId)
  3081. $iProfileId = $this->_iProfileId;
  3082. $aCheck = checkActionModule($iProfileId, MEMBERSHIP_ACTION_EDIT_ANY_ENTRY, $this->getName(), $isPerformAction);
  3083. if($aCheck[CHECK_ACTION_RESULT] === CHECK_ACTION_RESULT_ALLOWED)
  3084. return CHECK_ACTION_RESULT_ALLOWED;
  3085. return _t('_sys_txt_access_denied');
  3086. }
  3087. /**
  3088. * @return CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. So make sure to make strict(===) checking.
  3089. */
  3090. public function checkAllowedDeleteAnyEntryForProfile ($isPerformAction = false, $iProfileId = false)
  3091. {
  3092. if(!$iProfileId)
  3093. $iProfileId = $this->_iProfileId;
  3094. $aCheck = checkActionModule($iProfileId, MEMBERSHIP_ACTION_DELETE_ANY_ENTRY, $this->getName(), $isPerformAction);
  3095. if($aCheck[CHECK_ACTION_RESULT] === CHECK_ACTION_RESULT_ALLOWED)
  3096. return CHECK_ACTION_RESULT_ALLOWED;
  3097. return _t('_sys_txt_access_denied');
  3098. }
  3099. /**
  3100. * @return CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. So make sure to make "true === " checking.
  3101. */
  3102. public function checkAllowedCommentsView ($aContentInfo, $isPerformAction = false)
  3103. {
  3104. return $this->checkAllowedView ($aContentInfo, $isPerformAction);
  3105. }
  3106. /**
  3107. * @return CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. So make sure to make "true === " checking.
  3108. */
  3109. public function checkAllowedCommentsPost ($aContentInfo, $isPerformAction = false)
  3110. {
  3111. return $this->checkAllowedView ($aContentInfo, $isPerformAction);
  3112. }
  3113. protected function _serviceCheckAllowedViewForProfile ($aDataEntry, $isPerformAction, $iProfileId)
  3114. {
  3115. $CNF = &$this->_oConfig->CNF;
  3116. if(!$iProfileId)
  3117. $iProfileId = $this->_iProfileId;
  3118. if(empty($aDataEntry) || !is_array($aDataEntry))
  3119. return _t('_sys_txt_not_found');
  3120. if(!empty($iProfileId) && abs($aDataEntry[$CNF['FIELD_AUTHOR']]) == (int)$iProfileId)
  3121. return CHECK_ACTION_RESULT_ALLOWED;
  3122. // below goes mem cached response for current page load
  3123. $sCacheKey = $this->getName() . ':' . __CLASS__ . ':_checkAllowedViewForProfile:' . $aDataEntry[$CNF['FIELD_ID']] . ':' . $iProfileId;
  3124. $mixedRet = bx_mem_cache_get($sCacheKey);
  3125. if (null !== $mixedRet)
  3126. return $mixedRet;
  3127. $mixedRet = CHECK_ACTION_RESULT_ALLOWED;
  3128. if (empty($iProfileId) || !$this->_isModeratorForProfile($isPerformAction, $iProfileId)) { // skip checking if moderator
  3129. $aCheck = checkActionModule($iProfileId, 'view entry', $this->getName(), $isPerformAction);
  3130. if ($aCheck[CHECK_ACTION_RESULT] !== CHECK_ACTION_RESULT_ALLOWED) { // check ACL
  3131. $mixedRet = $aCheck[CHECK_ACTION_MESSAGE];
  3132. } elseif(!empty($CNF['OBJECT_PRIVACY_VIEW'])) { // check privacy
  3133. $oPrivacy = BxDolPrivacy::getObjectInstance($CNF['OBJECT_PRIVACY_VIEW']);
  3134. if ($oPrivacy && !$oPrivacy->check($aDataEntry[$CNF['FIELD_ID']], $iProfileId))
  3135. $mixedRet = _t('_sys_access_denied_to_private_content');
  3136. }
  3137. }
  3138. bx_mem_cache_set($sCacheKey, $mixedRet);
  3139. return $mixedRet;
  3140. }
  3141. public function getObjectBrowse ($sMode, $aParams = false, $sClass = 'SearchResult')
  3142. {
  3143. $oObject = null;
  3144. bx_alert('system', 'get_object_browse', 0, 0, [
  3145. 'module' => $this->getName(),
  3146. 'mode' => &$sMode,
  3147. 'params' => &$aParams,
  3148. 'class' => &$sClass,
  3149. 'object' => &$oObject,
  3150. 'mode_ref' => &$sMode,
  3151. 'params_ref' => &$aParams,
  3152. 'class_ref' => &$sClass,
  3153. 'object_ref' => &$oObject
  3154. ]);
  3155. if($oObject !== null)
  3156. return $oObject;
  3157. if($aParams === false || !is_array($aParams))
  3158. $aParams = [];
  3159. $aParams['class_search_result'] ??= $sClass;
  3160. bx_import($sClass, $this->_aModule);
  3161. $sClass = $this->_aModule['class_prefix'] . $sClass;
  3162. return new $sClass($sMode, $aParams);
  3163. }
  3164. public function _serviceBrowse ($sMode, $aParams = false, $iDesignBox = BX_DB_PADDING_DEF, $bDisplayEmptyMsg = false, $bAjaxPaginate = true, $sClassSearchResult = 'SearchResult')
  3165. {
  3166. if(CHECK_ACTION_RESULT_ALLOWED !== ($sMsg = $this->checkAllowedBrowse()))
  3167. return $this->_bIsApi ? [bx_api_get_msg($sMsg)] : MsgBox($sMsg);
  3168. $o = $this->getObjectBrowse($sMode, $aParams, $sClassSearchResult);
  3169. $o->setDesignBoxTemplateId($iDesignBox);
  3170. $o->setDisplayEmptyMsg($bDisplayEmptyMsg);
  3171. $o->setAjaxPaginate($bAjaxPaginate);
  3172. $o->setUnitParams(array('context' => $sMode));
  3173. if(isset($aParams['condition']) && is_array($aParams['condition']))
  3174. $o->setCustomCurrentCondition($aParams['condition']);
  3175. if($o->isError)
  3176. return '';
  3177. if($this->_bIsApi) {
  3178. $aBlock = BxDolPage::getBlockProcessing();
  3179. $sContentType = 'browse';
  3180. if(($aConfigApi = $aBlock['config_api'] ?? false) && is_array($aConfigApi))
  3181. $sContentType = $aConfigApi['content_type'] ?? $sContentType;
  3182. $bBrowseSimple = $sContentType == 'browse_simple';
  3183. $a = $o->processingAPI($bBrowseSimple);
  3184. if($a && is_array($a))
  3185. $a['hide_empty_msg'] = !(bool)$bDisplayEmptyMsg;
  3186. return !$bBrowseSimple || $a['data'] ? [bx_api_get_block($sContentType, $a)] : [];
  3187. }
  3188. else
  3189. return ($s = $o->processing()) ? $s : '';
  3190. }
  3191. /**
  3192. * Shows a list of profiles.
  3193. */
  3194. protected function _serviceBrowseQuick($aProfiles, $iStart = 0, $iLimit = 4, $aAdditionalParams = [])
  3195. {
  3196. return bx_srv('system', 'browse_quick', [$aProfiles, $iStart, $iLimit, ['additional_params' => $aAdditionalParams]], 'TemplServiceProfiles');
  3197. }
  3198. // ====== COMMON METHODS
  3199. public function isPollPerformed($iObjectId, $iAuthorId = 0, $iAuthorIp = 0)
  3200. {
  3201. if(empty($iAuthorId)) {
  3202. $iAuthorId = bx_get_logged_profile_id();
  3203. $iAuthorIp = bx_get_ip_hash(getVisitorIP());
  3204. }
  3205. return $this->_oDb->isPollPerformed($iObjectId, $iAuthorId, $iAuthorIp);
  3206. }
  3207. public function getPollPerformedValue($iObjectId, $iAuthorId = 0)
  3208. {
  3209. if(empty($iAuthorId))
  3210. $iAuthorId = bx_get_logged_profile_id();
  3211. return $this->_oDb->getPollPerformedValue($iObjectId, $iAuthorId);
  3212. }
  3213. public function onPublished($iContentId)
  3214. {
  3215. $CNF = &$this->_oConfig->CNF;
  3216. $aContentInfo = $this->_oDb->getContentInfoById($iContentId);
  3217. if(!$aContentInfo)
  3218. return;
  3219. /*
  3220. * Process metas.
  3221. * Note. It's essential to process metas a the very end,
  3222. * because all data related to an entry should be already
  3223. * processed and are ready to be passed to alert.
  3224. */
  3225. $this->processMetasAdd($iContentId);
  3226. $this->alertAfterAdd($aContentInfo);
  3227. }
  3228. public function onFailed($iContentId)
  3229. {
  3230. $CNF = &$this->_oConfig->CNF;
  3231. $aContentInfo = $this->_oDb->getContentInfoById($iContentId);
  3232. if(!$aContentInfo)
  3233. return;
  3234. /**
  3235. * @hooks
  3236. * @hookdef hook-bx_base_general-failed '{module_name}', 'failed' - hook after content creation when publishing was failed
  3237. * - $unit_name - module name
  3238. * - $action - equals `failed`
  3239. * - $object_id - content id
  3240. * - $sender_id - content author profile id
  3241. * - $extra_params - array of additional params with the following array keys:
  3242. * - `object_author_id` - [int] content author profile id
  3243. * @hook @ref hook-bx_base_general-failed
  3244. */
  3245. bx_alert($this->getName(), 'failed', $iContentId, $aContentInfo[$CNF['FIELD_AUTHOR']], [
  3246. 'object_author_id' => $aContentInfo[$CNF['FIELD_AUTHOR']]
  3247. ]);
  3248. }
  3249. public function onApprove($mixedContent)
  3250. {
  3251. $CNF = &$this->_oConfig->CNF;
  3252. if(!is_array($mixedContent))
  3253. $mixedContent = $this->_oDb->getContentInfoById((int)$mixedContent);
  3254. $this->alertAfterApprove($mixedContent);
  3255. $this->onPublished($mixedContent[$CNF['FIELD_ID']]);
  3256. }
  3257. public function onUpdateImage($iContentId, $sFiledName, $sFiledValue, $iProfileId = 0) {}
  3258. public function alertAfterAdd($aContentInfo) {}
  3259. public function alertAfterEdit($aContentInfo) {}
  3260. public function alertAfterApprove($aContentInfo)
  3261. {
  3262. $CNF = &$this->_oConfig->CNF;
  3263. $iId = (int)$aContentInfo[$CNF['FIELD_ID']];
  3264. $sModule = $this->getName();
  3265. $aParams = $this->_alertParams($aContentInfo);
  3266. /**
  3267. * @hooks
  3268. * @hookdef hook-bx_base_general-approved '{module_name}', 'approved' - hook when module content has been approved
  3269. * - $unit_name - module name
  3270. * - $action - equals `approved`
  3271. * - $object_id - content id
  3272. * - $sender_id - not used, always `false`
  3273. * - $extra_params - array of additional params with the following array keys:
  3274. * - `source` - [string] uniq string for particular content in the following format `{module}_{content}`
  3275. * - `object_author_id` - [int] content author profile id
  3276. * @hook @ref hook-bx_base_general-approved
  3277. */
  3278. bx_alert($sModule, 'approved', $iId, false, $aParams);
  3279. }
  3280. /**
  3281. * Get array of params to be passed in Add/Edit Alert.
  3282. */
  3283. protected function _alertParams($aContentInfo)
  3284. {
  3285. $CNF = &$this->_oConfig->CNF;
  3286. return [
  3287. 'source' => $this->_oConfig->getName() . '_' . (int)$aContentInfo[$CNF['FIELD_ID']],
  3288. 'object_author_id' => (int)$aContentInfo[$CNF['FIELD_AUTHOR']]
  3289. ];
  3290. }
  3291. public function processMetasAdd($iContentId)
  3292. {
  3293. return $this->processMetas('add', $iContentId);
  3294. }
  3295. public function processMetasEdit($iContentId, $oForm)
  3296. {
  3297. return $this->processMetas('edit', $iContentId, $oForm);
  3298. }
  3299. public function processMetas($aAction, $iContentId, $oForm = false)
  3300. {
  3301. $CNF = &$this->_oConfig->CNF;
  3302. if(empty($CNF['OBJECT_METATAGS']))
  3303. return false;
  3304. $aContentInfo = $this->_oDb->getContentInfoById($iContentId, true);
  3305. $bFldStatus = !empty($CNF['FIELD_STATUS']);
  3306. $bFldStatusAdmin = !empty($CNF['FIELD_STATUS_ADMIN']);
  3307. $bContentInfo = $aContentInfo && (!$bFldStatus || ($bFldStatus && $aContentInfo[$CNF['FIELD_STATUS']] == 'active')) && (!$bFldStatusAdmin || ($bFldStatusAdmin && $aContentInfo[$CNF['FIELD_STATUS_ADMIN']] == 'active'));
  3308. if(!$bContentInfo)
  3309. return false;
  3310. $oMetatags = BxDolMetatags::getObjectInstance($CNF['OBJECT_METATAGS']);
  3311. $oMetatags->metaAddAuto($iContentId, $aContentInfo, $CNF, $CNF['OBJECT_FORM_ENTRY_DISPLAY_' . strtoupper($aAction)]);
  3312. if($oMetatags->locationsIsEnabled() && ($sKey = 'FIELD_LOCATION') && !empty($CNF[$sKey]) && !empty($aContentInfo[$CNF[$sKey]])) {
  3313. $aLocation = unserialize($aContentInfo[$CNF[$sKey]]);
  3314. if(!empty($aLocation) && is_array($aLocation))
  3315. call_user_func_array(array($oMetatags, 'locationsAdd'), array_merge(array($iContentId), array_values($aLocation)));
  3316. }
  3317. if($oMetatags->keywordsIsEnabled() && ($sKey = 'FIELD_LABELS') && !empty($CNF[$sKey]) && !empty($aContentInfo[$CNF[$sKey]])) {
  3318. $aLabels = unserialize($aContentInfo[$CNF[$sKey]]);
  3319. if(!empty($aLabels) && is_array($aLabels))
  3320. foreach ($aLabels as $sLabel) {
  3321. if(!preg_match("/(\pL[\pL\pN_]+)/u", $sLabel))
  3322. continue;
  3323. $oMetatags->keywordsAddOne($iContentId, $sLabel, false);
  3324. }
  3325. }
  3326. return true;
  3327. }
  3328. public function addAttachLink($aValues, $sDisplay = false)
  3329. {
  3330. $CNF = &$this->_oConfig->CNF;
  3331. if(!$sDisplay)
  3332. $sDisplay = $CNF['OBJECT_FORM_ATTACH_LINK_DISPLAY_ADD'];
  3333. $oForm = BxDolForm::getObjectInstance($CNF['OBJECT_FORM_ATTACH_LINK'], $sDisplay, $this->_oTemplate);
  3334. if(!$oForm)
  3335. return array('message' => '_sys_txt_error_occured');
  3336. $oForm->aFormAttrs['method'] = BX_DOL_FORM_METHOD_SPECIFIC;
  3337. $oForm->aParams['csrf']['disable'] = true;
  3338. if(!empty($oForm->aParams['db']['submit_name'])) {
  3339. $sSubmitName = $oForm->aParams['db']['submit_name'];
  3340. if(!isset($oForm->aInputs[$sSubmitName])) {
  3341. if(isset($oForm->aInputs[$CNF['FIELD_ATTACH_LINK_CONTROLS']]))
  3342. foreach($oForm->aInputs[$CNF['FIELD_ATTACH_LINK_CONTROLS']] as $mixedIndex => $aInput) {
  3343. if(!is_numeric($mixedIndex) || empty($aInput['name']) || $aInput['name'] != $sSubmitName)
  3344. continue;
  3345. $aValues[$sSubmitName] = $aInput['value'];
  3346. }
  3347. }
  3348. else
  3349. $aValues[$sSubmitName] = $oForm->aInputs[$sSubmitName]['value'];
  3350. }
  3351. $oForm->aInputs['url']['checker']['params']['preg'] = $this->_oConfig->getPregPattern('url');
  3352. $oForm->initChecker(array(), $aValues);
  3353. if(!$oForm->isSubmittedAndValid())
  3354. return array('message' => '_sys_txt_error_occured');
  3355. return $this->_addLink($oForm);
  3356. }
  3357. public function getFormAttachLink($iContentId = 0)
  3358. {
  3359. $CNF = &$this->_oConfig->CNF;
  3360. $oForm = BxDolForm::getObjectInstance($CNF['OBJECT_FORM_ATTACH_LINK'], $CNF['OBJECT_FORM_ATTACH_LINK_DISPLAY_ADD'], $this->_oTemplate);
  3361. $oForm->aFormAttrs['action'] = BX_DOL_URL_ROOT . $this->_oConfig->getBaseUri() . 'submit_attach_link_form/';
  3362. $oForm->aInputs[$CNF['FIELD_ATTACH_LINK_CONTENT_ID']]['value'] = $iContentId;
  3363. $oForm->aInputs[$CNF['FIELD_ATTACH_LINK_URL']]['checker']['params']['preg'] = $this->_oConfig->getPregPattern('url');
  3364. $oForm->initChecker();
  3365. if($oForm->isSubmittedAndValid())
  3366. return $this->_addLink($oForm);
  3367. return ['form' => $oForm->getCode(), 'form_id' => $oForm->id];
  3368. }
  3369. protected function _addLink(&$oForm)
  3370. {
  3371. $CNF = &$this->_oConfig->CNF;
  3372. $iUserId = $this->getUserId();
  3373. $iContentId = (int)$oForm->getCleanValue($CNF['FIELD_ATTACH_LINK_CONTENT_ID']);
  3374. $sLink = rtrim($oForm->getCleanValue('url'), '/');
  3375. $sHost = parse_url($sLink, PHP_URL_HOST);
  3376. if($sHost && is_private_ip(gethostbyname($sHost)))
  3377. return ['message' => _t('_sys_txt_error_occured')];
  3378. $aMatches = [];
  3379. preg_match($this->_oConfig->getPregPattern('url'), $sLink, $aMatches);
  3380. $sLink = (empty($aMatches[2]) ? 'http://' : '') . $aMatches[0];
  3381. $aSiteInfo = bx_get_site_info($sLink, [
  3382. 'thumbnailUrl' => ['tag' => 'link', 'content_attr' => 'href'],
  3383. 'OGImage' => ['name_attr' => 'property', 'name' => 'og:image'],
  3384. ]);
  3385. $sTitle = !empty($aSiteInfo['title']) ? $aSiteInfo['title'] : $sHost;
  3386. $sDescription = !empty($aSiteInfo['description']) ? $aSiteInfo['description'] : '';
  3387. $sMediaUrl = '';
  3388. if(!empty($aSiteInfo['thumbnailUrl']))
  3389. $sMediaUrl = $aSiteInfo['thumbnailUrl'];
  3390. else if(!empty($aSiteInfo['OGImage']))
  3391. $sMediaUrl = $aSiteInfo['OGImage'];
  3392. $iMediaId = 0;
  3393. $oStorage = null;
  3394. if(!empty($sMediaUrl)) {
  3395. $oStorage = BxDolStorage::getObjectInstance($CNF['OBJECT_STORAGE_PHOTOS']);
  3396. $iMediaId = $oStorage->storeFileFromUrl($sMediaUrl, true, $iUserId);
  3397. }
  3398. $iId = (int)$oForm->insert(['profile_id' => $iUserId, 'media_id' => $iMediaId, 'url' => $sLink, 'title' => $sTitle, 'text' => $sDescription, 'added' => time()]);
  3399. if(!empty($iId)) {
  3400. if(!empty($oStorage) && !empty($iMediaId))
  3401. $oStorage->afterUploadCleanup($iMediaId, $iUserId);
  3402. return [
  3403. 'id' => $iId,
  3404. $CNF['FIELD_ATTACH_LINK_CONTENT_ID'] => $iContentId,
  3405. 'url' => $sLink,
  3406. 'item' => $this->_oTemplate->getAttachLinkItem($iUserId, $iId)
  3407. ];
  3408. }
  3409. return ['message' => _t('_bx_timeline_txt_err_cannot_perform_action')];
  3410. }
  3411. public function getEntryImageData($aContentInfo, $sField = 'FIELD_THUMB', $aTranscoders = array())
  3412. {
  3413. if(empty($aTranscoders))
  3414. $aTranscoders = array('OBJECT_TRANSCODER_COVER', 'OBJECT_IMAGES_TRANSCODER_COVER', 'OBJECT_IMAGES_TRANSCODER_GALLERY');
  3415. $CNF = &$this->_oConfig->CNF;
  3416. if(empty($CNF[$sField]) || empty($aContentInfo[$CNF[$sField]]) || empty($CNF['OBJECT_STORAGE']))
  3417. return false;
  3418. $iId = (int)$aContentInfo[$CNF[$sField]];
  3419. $aFile = BxDolStorage::getObjectInstance($CNF['OBJECT_STORAGE'])->getFile($iId);
  3420. if(!empty($aFile) && is_array($aFile) && strpos($aFile['mime_type'], 'svg') !== false)
  3421. return array('id' => $iId, 'object' => $CNF['OBJECT_STORAGE']);
  3422. foreach($aTranscoders as $sTranscoder)
  3423. if(!empty($CNF[$sTranscoder]))
  3424. return array('id' => $iId, 'transcoder' => $CNF[$sTranscoder]);
  3425. return array('id' => $iId, 'object' => $CNF['OBJECT_STORAGE']);
  3426. }
  3427. public function getEntryAllActions ($mixedContent = false, $aParams = [])
  3428. {
  3429. $CNF = &$this->_oConfig->CNF;
  3430. if(!empty($mixedContent)) {
  3431. if(!is_array($mixedContent))
  3432. $mixedContent = array((int)$mixedContent, (method_exists($this->_oDb, 'getContentInfoById')) ? $this->_oDb->getContentInfoById((int)$mixedContent) : array());
  3433. }
  3434. else {
  3435. $mixedContent = $this->_getContent();
  3436. if($mixedContent === false)
  3437. return false;
  3438. }
  3439. list($iContentId, $aContentInfo) = $mixedContent;
  3440. $sObjectMenu = !empty($aParams['object_menu']) ? $aParams['object_menu'] : '';
  3441. if(empty($sObjectMenu) && !empty($CNF['OBJECT_MENU_ACTIONS_VIEW_ENTRY_ALL']))
  3442. $sObjectMenu = $CNF['OBJECT_MENU_ACTIONS_VIEW_ENTRY_ALL'];
  3443. if(empty($sObjectMenu))
  3444. return false;
  3445. $sEntryTitle = !empty($aParams['entry_title']) ? $aParams['entry_title'] : '';
  3446. if(empty($sEntryTitle) && !empty($CNF['FIELD_TITLE']) && !empty($aContentInfo[$CNF['FIELD_TITLE']]))
  3447. $sEntryTitle = $aContentInfo[$CNF['FIELD_TITLE']];
  3448. $sEntryUrl = !empty($aParams['entry_url']) ? $aParams['entry_url'] : '';
  3449. if(empty($sEntryUrl) && !empty($CNF['URI_VIEW_ENTRY']))
  3450. $sEntryUrl = bx_absolute_url(BxDolPermalinks::getInstance()->permalink('page.php?i=' . $CNF['URI_VIEW_ENTRY'] . '&id=' . $iContentId));
  3451. $iEntryThumb = !empty($aParams['entry_thumb']) ? (int)$aParams['entry_thumb'] : 0;
  3452. if(empty($iEntryThumb) && !empty($CNF['FIELD_THUMB']) && !empty($aContentInfo[$CNF['FIELD_THUMB']]))
  3453. $iEntryThumb = (int)$aContentInfo[$CNF['FIELD_THUMB']];
  3454. $sObjectStorage = !empty($aParams['object_storage']) ? $aParams['object_storage'] : false;
  3455. if(empty($sObjectStorage) && !empty($CNF['OBJECT_STORAGE']))
  3456. $sObjectStorage = $CNF['OBJECT_STORAGE'];
  3457. $sObjectTranscoder = !empty($aParams['object_transcoder']) ? $aParams['object_transcoder'] : false;
  3458. $aMarkers = [
  3459. 'id' => $iContentId,
  3460. 'module' => $this->_oConfig->getName(),
  3461. 'title' => !empty($sEntryTitle) ? $sEntryTitle : '',
  3462. 'url' => !empty($sEntryUrl) ? $sEntryUrl : '',
  3463. 'img_url' => ''
  3464. ];
  3465. if(!empty($iEntryThumb)) {
  3466. if(!empty($sObjectTranscoder))
  3467. $o = BxDolTranscoder::getObjectInstance($sObjectTranscoder);
  3468. else if(!empty($sObjectStorage))
  3469. $o = BxDolStorage::getObjectInstance($sObjectStorage);
  3470. $sImageUrl = $o ? $o->getFileUrlById($iEntryThumb) : '';
  3471. if(!empty($sImageUrl))
  3472. $aMarkers['img_url'] = $sImageUrl;
  3473. }
  3474. $oActions = BxDolMenu::getObjectInstance($sObjectMenu, $this->_oTemplate);
  3475. if(!$oActions)
  3476. return false;
  3477. $oActions->setContentId($iContentId);
  3478. $oActions->addMarkers($aMarkers);
  3479. return $oActions->{bx_is_api() ? 'getCodeAPI' : 'getCode'}();
  3480. }
  3481. public function setProfileId($i)
  3482. {
  3483. $iOldProfileId = $this->_iProfileId;
  3484. $this->_iProfileId = $i;
  3485. return $iOldProfileId;
  3486. }
  3487. public function getProfileId()
  3488. {
  3489. return $this->_iProfileId;
  3490. }
  3491. public function getProfileInfo($iUserId = false)
  3492. {
  3493. $oProfile = $this->getObjectUser($iUserId);
  3494. $oAccount = null;
  3495. if($oProfile && !($oProfile instanceof BxDolProfileUndefined) && !($oProfile instanceof BxDolProfileAnonymous))
  3496. $oAccount = $oProfile->getAccountObject();
  3497. $bAccount = !empty($oAccount);
  3498. if(!$bAccount)
  3499. $oProfile = BxDolProfileUndefined::getInstance();
  3500. return array(
  3501. 'id' => $oProfile->id(),
  3502. 'name' => $oProfile->getDisplayName(),
  3503. 'email' => $bAccount ? $oAccount->getEmail() : '',
  3504. 'link' => $oProfile->getUrl(),
  3505. 'icon' => $oProfile->getIcon(),
  3506. 'thumb' => $oProfile->getThumb(),
  3507. 'avatar' => $oProfile->getAvatar(),
  3508. 'active' => $oProfile->isActive(),
  3509. );
  3510. }
  3511. public function getObjectUser($iUserId = false)
  3512. {
  3513. bx_import('BxDolProfile');
  3514. return BxDolProfile::getInstanceMagic($iUserId);
  3515. }
  3516. public function getObjectFavorite($sSystem = '', $iId = 0)
  3517. {
  3518. $CNF = &$this->_oConfig->CNF;
  3519. if(empty($sSystem) && !empty($CNF['OBJECT_FAVORITES']))
  3520. $sSystem = $CNF['OBJECT_FAVORITES'];
  3521. if(empty($sSystem))
  3522. return false;
  3523. $oFavorite = BxDolFavorite::getObjectInstance($sSystem, $iId, true, $this->_oTemplate);
  3524. if(!$oFavorite || !$oFavorite->isEnabled())
  3525. return false;
  3526. return $oFavorite;
  3527. }
  3528. public function getUserId()
  3529. {
  3530. return isLogged() ? bx_get_logged_profile_id() : 0;
  3531. }
  3532. public function getUserIp()
  3533. {
  3534. return getVisitorIP();
  3535. }
  3536. public function getUserInfo($iUserId = 0)
  3537. {
  3538. $oProfile = BxDolProfile::getInstanceMagic($iUserId);
  3539. return array(
  3540. $oProfile->getDisplayName(),
  3541. $oProfile->getUrl(),
  3542. $oProfile->getThumb(),
  3543. $oProfile->getUnit(),
  3544. $oProfile->getUnit(0, array('template' => 'unit_wo_info'))
  3545. );
  3546. }
  3547. public function getUserInfoWithBadges($iUserId = 0)
  3548. {
  3549. $oProfile = BxDolProfile::getInstanceMagic($iUserId);
  3550. return array(
  3551. $oProfile->getDisplayName(),
  3552. $oProfile->getUrl(),
  3553. $oProfile->getThumb(),
  3554. $oProfile->getUnit(),
  3555. $oProfile->getUnit(0, array('template' => 'unit_wo_info')),
  3556. $oProfile->getBadges()
  3557. );
  3558. }
  3559. public function isMenuItemVisible($sObject, &$aItem, &$aContentInfo)
  3560. {
  3561. $CNF = &$this->_oConfig->CNF;
  3562. // default visible settings
  3563. if(!BxDolAcl::getInstance()->isMemberLevelInSet($aItem['visible_for_levels']))
  3564. return false;
  3565. if (!empty($aItem['visibility_custom'])) {
  3566. $oMenu = BxDolMenu::getObjectInstance($sObject);
  3567. if ($oMenu && !BxDolService::callSerialized($aItem['visibility_custom'], $oMenu->getMarkers()))
  3568. return false;
  3569. }
  3570. // get custom function name to check menu item visibility
  3571. $sFuncCheckAccess = false;
  3572. if(isset($CNF['MENU_ITEM_TO_METHOD'][$sObject][$aItem['name']]))
  3573. $sFuncCheckAccess = $CNF['MENU_ITEM_TO_METHOD'][$sObject][$aItem['name']];
  3574. // check custom visibility settings defined in module config class
  3575. if(!isset($aContentInfo))
  3576. $aContentInfo = array();
  3577. if($sFuncCheckAccess && CHECK_ACTION_RESULT_ALLOWED !== call_user_func_array(array($this, $sFuncCheckAccess), array(&$aContentInfo)))
  3578. return false;
  3579. return true;
  3580. }
  3581. public function getModerators($mixedContentInfo)
  3582. {
  3583. $CNF = &$this->_oConfig->CNF;
  3584. $sModule = $this->_oConfig->getName();
  3585. if(!is_array($mixedContentInfo))
  3586. $mixedContentInfo = $this->_oDb->getContentInfoById((int)$mixedContentInfo);
  3587. $aModerators = [];
  3588. if(getParam('sys_notify_to_approve_by_role') == 'on' && bx_srv('system', 'is_module_content', [$sModule]) && ($sField = 'FIELD_ALLOW_VIEW_TO') && !empty($CNF[$sField]) && (int)$mixedContentInfo[$CNF[$sField]] < 0) {
  3589. $iContextProfileId = abs((int)$mixedContentInfo[$CNF['FIELD_ALLOW_VIEW_TO']]);
  3590. $oContextProfile = BxDolProfile::getInstance($iContextProfileId);
  3591. $aModerators = bx_srv($oContextProfile->getModule(), 'get_admins_to_manage_content', [$iContextProfileId]);
  3592. }
  3593. if(empty($aModerators))
  3594. $aModerators = BxDolAclQuery::getInstance()->getProfilesByAction([
  3595. MEMBERSHIP_ACTION_EDIT_ANY_ENTRY,
  3596. MEMBERSHIP_ACTION_DELETE_ANY_ENTRY
  3597. ], [
  3598. 'module' => $sModule,
  3599. 'ids_only' => true
  3600. ]);
  3601. return $aModerators;
  3602. }
  3603. public function _isModerator ($isPerformAction = false)
  3604. {
  3605. return $this->_isModeratorForProfile($isPerformAction, $this->_iProfileId);
  3606. }
  3607. public function _isModeratorForProfile($isPerformAction = false, $iProfileId = false)
  3608. {
  3609. return CHECK_ACTION_RESULT_ALLOWED === $this->checkAllowedEditAnyEntryForProfile ($isPerformAction, $iProfileId);
  3610. }
  3611. public function _isAdministrator ($isPerformAction = false)
  3612. {
  3613. return $this->_isAdministratorForProfile($isPerformAction, $this->_iProfileId);
  3614. }
  3615. public function _isAdministratorForProfile($isPerformAction = false, $iProfileId = false)
  3616. {
  3617. return CHECK_ACTION_RESULT_ALLOWED === $this->checkAllowedDeleteAnyEntryForProfile ($isPerformAction, $iProfileId);
  3618. }
  3619. public function _prepareAuditParams($aContentInfo, $bIsSaveData = true, $aOverrideAuditParams = array())
  3620. {
  3621. $CNF = &$this->_oConfig->CNF;
  3622. $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;
  3623. $AuditParams = array(
  3624. 'content_title' => (isset($CNF['FIELD_TITLE']) && isset($aContentInfo[$CNF['FIELD_TITLE']])) ? $aContentInfo[$CNF['FIELD_TITLE']] : '',
  3625. 'context_profile_id' => $iContextId,
  3626. 'content_info_object' => isset($CNF['OBJECT_CONTENT_INFO']) ? $CNF['OBJECT_CONTENT_INFO'] : '',
  3627. 'data' => ($bIsSaveData ? $aContentInfo : array())
  3628. );
  3629. if ($iContextId > 0)
  3630. $AuditParams['context_profile_title'] = BxDolProfile::getInstance($iContextId)->getDisplayName();
  3631. $AuditParams = array_merge($AuditParams, $aOverrideAuditParams);
  3632. return $AuditParams;
  3633. }
  3634. public function _getFavoriteListUrl ($iListId, $iProfileId)
  3635. {
  3636. $CNF = &$this->_oConfig->CNF;
  3637. return bx_absolute_url(BxDolPermalinks::getInstance()->permalink('page.php?i=' . $CNF['URI_FAVORITES_LIST'] . '&profile_id=' . $iProfileId . '&list_id=' . $iListId));
  3638. }
  3639. public function getDataAPI($aData, $aParams = [])
  3640. {
  3641. $aDataApi = $this->decodeDataAPI($aData, $aParams);
  3642. $sModule = $this->getName();
  3643. $aExtras = [
  3644. 'module' => $sModule,
  3645. 'data' => $aData,
  3646. 'params' => $aParams,
  3647. 'data_api' => &$aDataApi,
  3648. 'data_api_ref' => &$aDataApi,
  3649. ];
  3650. /**
  3651. * @hooks
  3652. * @hookdef hook-system-decode_data_api 'system', 'decode_data_api' - hook to override content data prepared for sending in API response
  3653. * - $unit_name - equals `system`
  3654. * - $action - equals `decode_data_api`
  3655. * - $object_id - not used
  3656. * - $sender_id - not used
  3657. * - $extra_params - array of additional params with the following array keys:
  3658. * - `module` - [string] module name
  3659. * - `data` - [array] content info array as key&value pairs
  3660. * - `params` - [array] params array as key&value pairs
  3661. * - `data_api` - [array] by ref, content data prepared for sending in API response, can be overridden in hook processing
  3662. * @hook @ref hook-system-decode_data_api
  3663. */
  3664. bx_alert('system', 'decode_data_api', 0, 0, $aExtras);
  3665. /**
  3666. * @hooks
  3667. * @hookdef hook-bx_base_general-decode_data_api '{module_name}', 'decode_data_api' - hook to override content data prepared for sending in API response
  3668. * It's equivalent to @ref hook-system-decode_data_api
  3669. * @hook @ref hook-bx_base_general-decode_data_api
  3670. */
  3671. bx_alert($sModule, 'decode_data_api', 0, 0, $aExtras);
  3672. return $aDataApi;
  3673. }
  3674. public function decodeDataAPI($aData, $aParams = [])
  3675. {
  3676. return $aData;
  3677. }
  3678. protected function decodeDataAPICommonFields(&$aResult, $aData, $aParams)
  3679. {
  3680. $CNF = &$this->_oConfig->CNF;
  3681. if (!empty($CNF['FIELD_LABELS'])) {
  3682. $aResult[$CNF['FIELD_LABELS']] = empty($aData[$CNF['FIELD_LABELS']]) ? [] : unserialize($aData[$CNF['FIELD_LABELS']]);
  3683. }
  3684. if (!empty($CNF['FIELD_LOCATION'])) {
  3685. $aResult[$CNF['FIELD_LOCATION']] = empty($aData[$CNF['FIELD_LOCATION']]) ? [] : unserialize($aData[$CNF['FIELD_LOCATION']]);
  3686. }
  3687. }
  3688. // ====== PROTECTED METHODS
  3689. protected function _serviceEntityForm ($sFormMethod, $iContentId = 0, $sDisplay = false, $sCheckFunction = false, $bErrorMsg = true)
  3690. {
  3691. $iContentId = $this->_getContent($iContentId, false);
  3692. if($iContentId === false)
  3693. return false;
  3694. $oFormsHelper = $this->getFormsHelper();
  3695. return $oFormsHelper->$sFormMethod((int)$iContentId, $sDisplay, $sCheckFunction, $bErrorMsg);
  3696. }
  3697. protected function _serviceTemplateFunc ($sFunc, $iContentId, $sFuncGetContent = 'getContentInfoById')
  3698. {
  3699. return $this->_serviceTemplateFuncEx($sFunc, $iContentId, array('function_get_content' => $sFuncGetContent));
  3700. }
  3701. protected function _serviceTemplateFuncEx ($sFunc, $iContentId, $aParams = array())
  3702. {
  3703. if (!isset($aParams['function_get_content']))
  3704. $aParams['function_get_content'] = 'getContentInfoById';
  3705. $mixedContent = $this->_getContent($iContentId, $aParams['function_get_content']);
  3706. if($mixedContent === false)
  3707. return false;
  3708. list($iContentId, $aContentInfo) = $mixedContent;
  3709. unset($aParams['function_get_content']);
  3710. if (!empty($aParams))
  3711. return $this->_oTemplate->$sFunc($aContentInfo, $aParams);
  3712. else
  3713. return $this->_oTemplate->$sFunc($aContentInfo);
  3714. }
  3715. protected function _getApproveForm($iContentId, $aContentInfo)
  3716. {
  3717. $CNF = &$this->_oConfig->CNF;
  3718. $sForm = 'sys_manage';
  3719. if(!empty($CNF['OBJECT_FORM_MANAGE']))
  3720. $sForm = $CNF['OBJECT_FORM_MANAGE'];
  3721. $sFormDisplay = 'sys_manage_approve';
  3722. if(!empty($CNF['OBJECT_FORM_MANAGE_APPROVE']))
  3723. $sFormDisplay = $CNF['OBJECT_FORM_MANAGE_APPROVE'];
  3724. $oForm = BxTemplFormView::getObjectInstance($sForm, $sFormDisplay);
  3725. $oForm->aFormAttrs['action'] = BX_DOL_URL_ROOT . $this->_oConfig->getBaseUri() . 'approve';
  3726. $oForm->aInputs['content_id']['value'] = $iContentId;
  3727. foreach($oForm->aInputs['controls'] as $iKey => $mixedValue)
  3728. if(is_numeric($iKey) && isset($mixedValue['name']) && $mixedValue['name'] == 'do_submit')
  3729. $oForm->aInputs['controls'][$iKey]['value'] = _t('_sys_form_manage_input_do_submit_approve');
  3730. /**
  3731. * @hooks
  3732. * @hookdef hook-bx_base_general-get_approve_form '{module_name}', 'get_approve_form' - hook to override approve content form
  3733. * - $unit_name - module name
  3734. * - $action - equals `get_approve_form`
  3735. * - $object_id - not used
  3736. * - $sender_id - not used
  3737. * - $extra_params - array of additional params with the following array keys:
  3738. * - `content_id` - [int] content id
  3739. * - `content_info` - [array] content info array as key&value pairs
  3740. * - `override_result` - [object] by ref, an instance of approve content form, @see BxDolForm, can be overridden in hook processing
  3741. * @hook @ref hook-bx_base_general-get_approve_form
  3742. */
  3743. bx_alert($this->_oConfig->getName(), 'get_approve_form', 0, 0, [
  3744. 'content_id' => $iContentId,
  3745. 'content_info' => $aContentInfo,
  3746. 'override_result' => &$oForm
  3747. ]);
  3748. return $oForm;
  3749. }
  3750. protected function _sendApproveMessage($iContentId, $aContentInfo, &$oForm)
  3751. {
  3752. $CNF = &$this->_oConfig->CNF;
  3753. $sETemplate = 't_ManageApprove';
  3754. if(!empty($CNF['ETEMPLATE_MANAGE_APPROVE']))
  3755. $sETemplate = $CNF['ETEMPLATE_MANAGE_APPROVE'];
  3756. $aEParams = array(
  3757. 'content_title' => !empty($CNF['FIELD_TITLE']) && !empty($aContentInfo[$CNF['FIELD_TITLE']]) ? $aContentInfo[$CNF['FIELD_TITLE']] : '',
  3758. 'notes' => $oForm->getCleanValue('notes'),
  3759. );
  3760. /**
  3761. * @hooks
  3762. * @hookdef hook-bx_base_general-get_approve_message '{module_name}', 'get_approve_form' - hook to override approve content message
  3763. * - $unit_name - module name
  3764. * - $action - equals `get_approve_message`
  3765. * - $object_id - not used
  3766. * - $sender_id - not used
  3767. * - $extra_params - array of additional params with the following array keys:
  3768. * - `content_id` - [int] content id
  3769. * - `content_info` - [array] content info array as key&value pairs
  3770. * - `form` - [object] an instance of approve content form
  3771. * - `email_template` - [string] by ref, email template name, @see BxDolEmailTemplates, can be overridden in hook processing
  3772. * - `email_params` - [array] by ref, email template params, can be overridden in hook processing
  3773. * @hook @ref hook-bx_base_general-get_approve_message
  3774. */
  3775. bx_alert($this->_oConfig->getName(), 'get_approve_message', 0, 0, [
  3776. 'content_id' => $iContentId,
  3777. 'content_info' => $aContentInfo,
  3778. 'form' => $oForm,
  3779. 'email_template' => &$sETemplate,
  3780. 'email_params' => &$aEParams,
  3781. 'email_template_ref' => &$sETemplate,
  3782. 'email_params_ref' => &$aEParams
  3783. ]);
  3784. return sendMailTemplate($sETemplate, 0, $aContentInfo[$CNF['FIELD_AUTHOR']], $aEParams);
  3785. }
  3786. protected function _processModerationNotifications($aContentInfo)
  3787. {
  3788. $CNF = &$this->_oConfig->CNF;
  3789. if(empty($CNF['PARAM_AUTO_APPROVE']) || getParam($CNF['PARAM_AUTO_APPROVE']) == 'on')
  3790. return;
  3791. $aRecipients = $this->getModerators($aContentInfo);
  3792. if(empty($aRecipients))
  3793. return;
  3794. $sModule = $this->_oConfig->getName();
  3795. foreach($aRecipients as $iRecipientId)
  3796. /**
  3797. * @hooks
  3798. * @hookdef hook-bx_base_general-pending_approval '{module_name}', 'pending_approval' - hook to notify admins/moderators about new pending approval content
  3799. * - $unit_name - module name
  3800. * - $action - equals `pending_approval`
  3801. * - $object_id - content id
  3802. * - $sender_id - content author profile id
  3803. * - $extra_params - array of additional params with the following array keys:
  3804. * - `object_author_id` - [int] admin/moderator profile id
  3805. * @hook @ref hook-bx_base_general-pending_approval
  3806. */
  3807. bx_alert($sModule, 'pending_approval', $aContentInfo[$CNF['FIELD_ID']], $aContentInfo[$CNF['FIELD_AUTHOR']], [
  3808. 'object_author_id' => (int)$iRecipientId
  3809. ]);
  3810. }
  3811. protected function _rss ($aArgs, $sClass = 'SearchResult')
  3812. {
  3813. if (CHECK_ACTION_RESULT_ALLOWED !== ($sMsg = $this->checkAllowedBrowse())) {
  3814. $this->_oTemplate->displayAccessDenied ($sMsg);
  3815. exit;
  3816. }
  3817. $sMode = array_shift($aArgs);
  3818. $aParams = $this->_buildRssParams($sMode, $aArgs);
  3819. $o = $this->getObjectBrowse($sMode, $aParams, $sClass);
  3820. if ($o->isError)
  3821. $this->_oTemplate->displayPageNotFound ();
  3822. else
  3823. $o->outputRSS();
  3824. exit;
  3825. }
  3826. protected function _getContent($iContentId = 0, $sFuncGetContent = true)
  3827. {
  3828. if(!$iContentId)
  3829. $iContentId = bx_process_input(bx_get('id'), BX_DATA_INT);
  3830. if(!$iContentId)
  3831. return false;
  3832. if($sFuncGetContent === true)
  3833. $sFuncGetContent = 'getContentInfoById';
  3834. if(empty($sFuncGetContent) || !method_exists($this->_oDb, $sFuncGetContent))
  3835. return $iContentId;
  3836. $aContentInfo = $this->_oDb->$sFuncGetContent($iContentId);
  3837. if(!$aContentInfo)
  3838. return false;
  3839. return array($iContentId, $aContentInfo);
  3840. }
  3841. protected function _getContentForTimelinePost($aEvent, $aContentInfo, $aBrowseParams = array())
  3842. {
  3843. $CNF = &$this->_oConfig->CNF;
  3844. $sUrl = bx_absolute_url(BxDolPermalinks::getInstance()->permalink('page.php?i=' . $CNF['URI_VIEW_ENTRY'] . '&id=' . $aContentInfo[$CNF['FIELD_ID']]));
  3845. //--- Image(s)
  3846. $aImages = $this->_getImagesForTimelinePost($aEvent, $aContentInfo, $sUrl, $aBrowseParams);
  3847. $aImagesAttach = $this->_getImagesForTimelinePostAttach($aEvent, $aContentInfo, $sUrl, $aBrowseParams);
  3848. //--- Video(s)
  3849. $aVideos = $this->_getVideosForTimelinePost($aEvent, $aContentInfo, $sUrl, $aBrowseParams);
  3850. $aVideosAttach = $this->_getVideosForTimelinePostAttach($aEvent, $aContentInfo, $sUrl, $aBrowseParams);
  3851. //--- Files(s)
  3852. $aFiles = $this->_getFilesForTimelinePost($aEvent, $aContentInfo, $sUrl, $aBrowseParams);
  3853. $aFilesAttach = $this->_getFilesForTimelinePostAttach($aEvent, $aContentInfo, $sUrl, $aBrowseParams);
  3854. if($this->_bIsApi && getParam('sys_api_extended_units') != 'on') {
  3855. $sTitle = '';
  3856. if(isset($CNF['FIELD_TITLE']) && isset($aContentInfo[$CNF['FIELD_TITLE']]))
  3857. $sTitle = $aContentInfo[$CNF['FIELD_TITLE']];
  3858. else if(isset($CNF['FIELD_TEXT']) && isset($aContentInfo[$CNF['FIELD_TEXT']]))
  3859. $sTitle = strmaxtextlen($aContentInfo[$CNF['FIELD_TEXT']], 20, '...');
  3860. $sAbstract = isset($CNF['FIELD_ABSTRACT']) && isset($aContentInfo[$CNF['FIELD_ABSTRACT']]) ? $aContentInfo[$CNF['FIELD_ABSTRACT']] : '';
  3861. $sText = isset($CNF['FIELD_TEXT']) && isset($aContentInfo[$CNF['FIELD_TEXT']]) ? $aContentInfo[$CNF['FIELD_TEXT']] : '';
  3862. $sText = BxTemplFunctions::getInstance()->getStringWithLimitedLength(strip_tags($sText), 240);
  3863. $aResults = [
  3864. 'url' => $sUrl,
  3865. 'title' => $sTitle,
  3866. 'abstract' => $sAbstract,
  3867. 'text' => $sText
  3868. ];
  3869. if(!empty($aImages) && is_array($aImages))
  3870. $aResults['images'] = $aImages;
  3871. if(!empty($aVideos) && is_array($aVideos))
  3872. $aResults['videos'] = $aVideos;
  3873. if(!empty($aFiles) && is_array($aFiles))
  3874. $aResults['files'] = $aFiles;
  3875. return $aResults;
  3876. }
  3877. //--- Title
  3878. $sTitle = '';
  3879. if(isset($CNF['FIELD_TITLE']) && isset($aContentInfo[$CNF['FIELD_TITLE']]))
  3880. $sTitle = $aContentInfo[$CNF['FIELD_TITLE']];
  3881. else if(isset($CNF['FIELD_TEXT']) && isset($aContentInfo[$CNF['FIELD_TEXT']]))
  3882. $sTitle = strmaxtextlen($aContentInfo[$CNF['FIELD_TEXT']], 20, '...');
  3883. //--- Text
  3884. $sText = '';
  3885. if(isset($CNF['FIELD_ABSTRACT']) && isset($aContentInfo[$CNF['FIELD_ABSTRACT']]))
  3886. $sText = $aContentInfo[$CNF['FIELD_ABSTRACT']];
  3887. if(empty($sText) && isset($CNF['FIELD_TEXT']) && isset($aContentInfo[$CNF['FIELD_TEXT']]))
  3888. $sText = $aContentInfo[$CNF['FIELD_TEXT']];
  3889. if(!empty($CNF['OBJECT_METATAGS']) && is_string($sText)) {
  3890. $oMetatags = BxDolMetatags::getObjectInstance($CNF['OBJECT_METATAGS']);
  3891. $sText = $oMetatags->metaParse($aContentInfo[$CNF['FIELD_ID']], $sText);
  3892. }
  3893. $sCategory = '';
  3894. if (isset($CNF['OBJECT_CATEGORY']) && isset($CNF['OBJECT_CATEGORY']) && isset($aContentInfo[$CNF['FIELD_CATEGORY']])){
  3895. $oCategory = BxDolCategory::getObjectInstance($CNF['OBJECT_CATEGORY']);
  3896. if ($oCategory)
  3897. $sCategory = $oCategory->getCategoryTitle($aContentInfo[$CNF['FIELD_CATEGORY']]);
  3898. }
  3899. $aResult = [
  3900. 'title' => $sTitle,
  3901. 'text' => $sText,
  3902. 'images' => $aImages,
  3903. 'images_attach' => $aImagesAttach,
  3904. 'videos' => $aVideos,
  3905. 'videos_attach' => $aVideosAttach,
  3906. 'files' => $aFiles,
  3907. 'files_attach' => $aFilesAttach
  3908. ];
  3909. return $this->_bIsApi ? $aResult : array_merge($aResult, [
  3910. 'sample' => isset($CNF['T']['txt_sample_single_with_article']) ? $CNF['T']['txt_sample_single_with_article'] : $CNF['T']['txt_sample_single'],
  3911. 'sample_wo_article' => $CNF['T']['txt_sample_single'],
  3912. 'sample_action' => isset($CNF['T']['txt_sample_action']) ? $CNF['T']['txt_sample_action'] : '',
  3913. 'url' => $sUrl,
  3914. 'category' => $sCategory,
  3915. ]);
  3916. }
  3917. protected function _getImagesForTimelinePost($aEvent, $aContentInfo, $sUrl, $aBrowseParams = array())
  3918. {
  3919. $CNF = &$this->_oConfig->CNF;
  3920. if($this->_bIsApi) {
  3921. $aResult = [];
  3922. if(isset($CNF['FIELD_COVER']) && !empty($aContentInfo[$CNF['FIELD_COVER']])) {
  3923. $aResult[] = bx_api_get_image($CNF['OBJECT_STORAGE'], (int)$aContentInfo[$CNF['FIELD_COVER']]);
  3924. }
  3925. if((($sK = $CNF['FIELD_THUMB'] ?? false) && !empty($aContentInfo[$sK])) || (($sK = $CNF['FIELD_PICTURE'] ?? false) && !empty($aContentInfo[$sK]))) {
  3926. $aResult[] = bx_api_get_image($CNF['OBJECT_STORAGE'], (int)$aContentInfo[$sK]);
  3927. }
  3928. return $aResult;
  3929. }
  3930. $iImageId = 0;
  3931. $sImageSm = $sImageMd = $sImageXl = '';
  3932. if(isset($CNF['FIELD_COVER']) && !empty($aContentInfo[$CNF['FIELD_COVER']])) {
  3933. $iImageId = (int)$aContentInfo[$CNF['FIELD_COVER']];
  3934. $sImageSm = $this->_oConfig->getImageUrl($iImageId, ['OBJECT_IMAGES_TRANSCODER_MINIATURE', 'OBJECT_IMAGES_TRANSCODER_THUMB']);
  3935. $sImageMd = $this->_oConfig->getImageUrl($iImageId, ['OBJECT_IMAGES_TRANSCODER_GALLERY', 'OBJECT_IMAGES_TRANSCODER_THUMB']);
  3936. $sImageXl = $this->_oConfig->getImageUrl($iImageId, ['OBJECT_IMAGES_TRANSCODER_COVER']);
  3937. }
  3938. if($sImageMd == '' && (($sK = $CNF['FIELD_THUMB'] ?? false) && !empty($aContentInfo[$sK])) || (($sK = $CNF['FIELD_PICTURE'] ?? false) && !empty($aContentInfo[$sK]))) {
  3939. $iImageId = (int)$aContentInfo[$sK];
  3940. $sImageSm = $this->_oConfig->getImageUrl($iImageId, ['OBJECT_IMAGES_TRANSCODER_MINIATURE', 'OBJECT_IMAGES_TRANSCODER_THUMB']);
  3941. $sImageMd = $this->_oConfig->getImageUrl($iImageId, ['OBJECT_IMAGES_TRANSCODER_GALLERY', 'OBJECT_IMAGES_TRANSCODER_THUMB']);
  3942. $sImageXl = $this->_oConfig->getImageUrl($iImageId, ['OBJECT_IMAGES_TRANSCODER_COVER']);
  3943. }
  3944. if(empty($sImageMd))
  3945. return [];
  3946. if($sImageSm == '')
  3947. $sImageSm = $sImageMd;
  3948. if($sImageXl == '')
  3949. $sImageXl = $sImageMd;
  3950. return [[
  3951. 'id' => $iImageId,
  3952. 'url' => $sUrl,
  3953. 'src' => $sImageMd,
  3954. 'src_small' => $sImageSm,
  3955. 'src_medium' => $sImageMd,
  3956. 'src_orig' => $sImageXl
  3957. ]];
  3958. }
  3959. protected function _getImagesForTimelinePostAttach($aEvent, $aContentInfo, $sUrl, $aBrowseParams = array())
  3960. {
  3961. return array();
  3962. }
  3963. protected function _getVideosForTimelinePost($aEvent, $aContentInfo, $sUrl, $aBrowseParams = array())
  3964. {
  3965. return array();
  3966. }
  3967. protected function _getVideosForTimelinePostAttach($aEvent, $aContentInfo, $sUrl, $aBrowseParams = array())
  3968. {
  3969. return array();
  3970. }
  3971. protected function _getFilesForTimelinePost($aEvent, $aContentInfo, $sUrl, $aBrowseParams = array())
  3972. {
  3973. return array();
  3974. }
  3975. protected function _getFilesForTimelinePostAttach($aEvent, $aContentInfo, $sUrl, $aBrowseParams = array())
  3976. {
  3977. return array();
  3978. }
  3979. protected function _entityComments ($sObject, $iId = 0)
  3980. {
  3981. if (!$iId)
  3982. $iId = bx_process_input(bx_get('id'), BX_DATA_INT);
  3983. if (!$iId)
  3984. return false;
  3985. $oCmts = BxDolCmts::getObjectInstance($sObject, $iId);
  3986. if (!$oCmts || !$oCmts->isEnabled())
  3987. return false;
  3988. if($this->_bIsApi)
  3989. return [
  3990. 'title' => $oCmts->getCommentsBlockTitle(),
  3991. 'content' => [bx_srv('system', 'get_data_api', [['module' => $sObject, 'object_id' => $iId]], 'TemplCmtsServices')]
  3992. ];
  3993. return $oCmts->getCommentsBlock([], ['in_designbox' => false, 'show_empty' => false]);
  3994. }
  3995. protected function _getFields($iContentId)
  3996. {
  3997. $aContentInfo = $this->_oDb->getContentInfoById($iContentId);
  3998. if(empty($aContentInfo))
  3999. return array();
  4000. return BxDolContentInfo::formatFields($aContentInfo);
  4001. }
  4002. protected function _getFieldValue($sField, $iContentId)
  4003. {
  4004. $CNF = &$this->_oConfig->CNF;
  4005. if(empty($CNF[$sField]))
  4006. return false;
  4007. $aContentInfo = $this->_oDb->getContentInfoById($iContentId);
  4008. if(empty($aContentInfo) || empty($aContentInfo[$CNF[$sField]]))
  4009. return false;
  4010. return $aContentInfo[$CNF[$sField]];
  4011. }
  4012. protected function _getFieldValueThumb($sField, $iContentId, $sTranscoder = '')
  4013. {
  4014. $CNF = &$this->_oConfig->CNF;
  4015. if(empty($sTranscoder) || empty($CNF[$sField]))
  4016. return false;
  4017. $aContentInfo = $this->_oDb->getContentInfoById($iContentId);
  4018. if(empty($aContentInfo) || empty($aContentInfo[$CNF[$sField]]))
  4019. return false;
  4020. $oImagesTranscoder = BxDolTranscoderImage::getObjectInstance($sTranscoder);
  4021. if(!$oImagesTranscoder)
  4022. return false;
  4023. return $oImagesTranscoder->getFileUrl($aContentInfo[$CNF[$sField]]);
  4024. }
  4025. protected function _prepareResponse($aResponse, $bAsJson = false, $aAdditional = array())
  4026. {
  4027. if(!$bAsJson)
  4028. return $aResponse;
  4029. if(!empty($aAdditional) && is_array($aAdditional))
  4030. $aResponse = array_merge($aResponse, $aAdditional);
  4031. echoJson($aResponse);
  4032. exit;
  4033. }
  4034. /**
  4035. * Blocks for lables tree browsing private functions
  4036. */
  4037. private function _getLablesBreadcrumbsArray($iLabelId, &$aBreadcrumbs)
  4038. {
  4039. $oLabel = BxDolLabel::getInstance();
  4040. $aLabel = $oLabel->getLabels(array('type' => 'id', 'id' => $iLabelId));
  4041. if ($aLabel){
  4042. $aBreadcrumbs[$aLabel['id']] = array('id' => $aLabel['id'], 'value' => $aLabel['value']);
  4043. $this->_getLablesBreadcrumbsArray($aLabel['parent'], $aBreadcrumbs);
  4044. }
  4045. }
  4046. private function _getLablesBrowseUrl($iLabelId)
  4047. {
  4048. list($sPageLink, $aPageParams) = bx_get_base_url_inline();
  4049. return BxDolPermalinks::getInstance()->permalink(bx_append_url_params($sPageLink, array_merge($aPageParams, array('label' => $iLabelId))));
  4050. }
  4051. private function _getLablesTreeLevel($aBreadcrumbs, $iParent = 0)
  4052. {
  4053. $oLabel = BxDolLabel::getInstance();
  4054. $aLabelsOutput = array();
  4055. $aLabels = $oLabel->getLabels(array('type' => 'parent', 'parent' => $iParent));
  4056. if (count($aLabels) > 0){
  4057. foreach($aLabels as $aLabel) {
  4058. $sChild = $this->_getLablesTreeLevel($aBreadcrumbs, $aLabel['id']);
  4059. $bChildPresent = $sChild != '' ? true : false;
  4060. $bIsOpen = array_key_exists($aLabel['id'], $aBreadcrumbs) ? true : false;
  4061. if (!$bIsOpen){
  4062. $sChild = '';
  4063. }
  4064. $aLabelsOutput[] = array(
  4065. 'value' => $aLabel['value'],
  4066. 'url' => $this->_getLablesBrowseUrl($aLabel['id']),
  4067. 'child' => $sChild,
  4068. 'selected' => bx_process_input(bx_get('label'), BX_DATA_INT) == $aLabel['id'] ? 'selected' : ''.$aLabel['id'],
  4069. 'bx_if:open' => array(
  4070. 'condition' => $bChildPresent && $bIsOpen,
  4071. 'content' => array()
  4072. ),
  4073. 'bx_if:can_open' => array(
  4074. 'condition' => $bChildPresent && !$bIsOpen,
  4075. 'content' => array()
  4076. )
  4077. );
  4078. }
  4079. return $this->_oTemplate->parseHtmlByName('labels_tree.html',
  4080. array(
  4081. 'bx_repeat:items' => $aLabelsOutput,
  4082. 'parent' => $iParent,
  4083. )
  4084. );
  4085. }
  4086. return '';
  4087. }
  4088. }
  4089. /** @} */