cmdbabstract.class.inc.php 126 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521
  1. <?php
  2. // Copyright (C) 2010-2012 Combodo SARL
  3. //
  4. // This file is part of iTop.
  5. //
  6. // iTop is free software; you can redistribute it and/or modify
  7. // it under the terms of the GNU Affero General Public License as published by
  8. // the Free Software Foundation, either version 3 of the License, or
  9. // (at your option) any later version.
  10. //
  11. // iTop is distributed in the hope that it will be useful,
  12. // but WITHOUT ANY WARRANTY; without even the implied warranty of
  13. // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14. // GNU Affero General Public License for more details.
  15. //
  16. // You should have received a copy of the GNU Affero General Public License
  17. // along with iTop. If not, see <http://www.gnu.org/licenses/>
  18. /**
  19. * Abstract class that implements some common and useful methods for displaying
  20. * the objects
  21. *
  22. * @copyright Copyright (C) 2010-2012 Combodo SARL
  23. * @license http://opensource.org/licenses/AGPL-3.0
  24. */
  25. define('OBJECT_PROPERTIES_TAB', 'ObjectProperties');
  26. define('HILIGHT_CLASS_CRITICAL', 'red');
  27. define('HILIGHT_CLASS_WARNING', 'orange');
  28. define('HILIGHT_CLASS_OK', 'green');
  29. define('HILIGHT_CLASS_NONE', '');
  30. require_once(APPROOT.'/core/cmdbobject.class.inc.php');
  31. require_once(APPROOT.'/application/applicationextension.inc.php');
  32. require_once(APPROOT.'/application/utils.inc.php');
  33. require_once(APPROOT.'/application/applicationcontext.class.inc.php');
  34. require_once(APPROOT.'/application/ui.linkswidget.class.inc.php');
  35. require_once(APPROOT.'/application/ui.linksdirectwidget.class.inc.php');
  36. require_once(APPROOT.'/application/ui.passwordwidget.class.inc.php');
  37. require_once(APPROOT.'/application/ui.extkeywidget.class.inc.php');
  38. require_once(APPROOT.'/application/ui.htmleditorwidget.class.inc.php');
  39. require_once(APPROOT.'/application/datatable.class.inc.php');
  40. /**
  41. * All objects to be displayed in the application (either as a list or as details)
  42. * must implement this interface.
  43. */
  44. interface iDisplay
  45. {
  46. /**
  47. * Maps the given context parameter name to the appropriate filter/search code for this class
  48. * @param string $sContextParam Name of the context parameter, i.e. 'org_id'
  49. * @return string Filter code, i.e. 'customer_id'
  50. */
  51. public static function MapContextParam($sContextParam);
  52. /**
  53. * This function returns a 'hilight' CSS class, used to hilight a given row in a table
  54. * There are currently (i.e defined in the CSS) 4 possible values HILIGHT_CLASS_CRITICAL,
  55. * HILIGHT_CLASS_WARNING, HILIGHT_CLASS_OK, HILIGHT_CLASS_NONE
  56. * To Be overridden by derived classes
  57. * @param void
  58. * @return String The desired higlight class for the object/row
  59. */
  60. public function GetHilightClass();
  61. /**
  62. * Returns the relative path to the page that handles the display of the object
  63. * @return string
  64. */
  65. public static function GetUIPage();
  66. /**
  67. * Displays the details of the object
  68. */
  69. public function DisplayDetails(WebPage $oPage, $bEditMode = false);
  70. }
  71. abstract class cmdbAbstractObject extends CMDBObject implements iDisplay
  72. {
  73. protected $m_iFormId; // The ID of the form used to edit the object (when in edition mode !)
  74. static $iGlobalFormId = 1;
  75. protected $aFieldsMap;
  76. /**
  77. * returns what will be the next ID for the forms
  78. */
  79. public static function GetNextFormId()
  80. {
  81. return 1 + self::$iGlobalFormId;
  82. }
  83. public static function GetUIPage()
  84. {
  85. return 'UI.php';
  86. }
  87. /**
  88. * Set a message diplayed to the end-user next time this object will be displayed
  89. * Messages are uniquely identified so that plugins can override standard messages (the final work is given to the last plugin to set the message for a given message id)
  90. * In practice, standard messages are recorded at the end but they will not overwrite existing messages
  91. *
  92. * @param string $sClass The class of the object (must be the final class)
  93. * @param int $iKey The identifier of the object
  94. * @param string $sMessageId Your id or one of the well-known ids: 'create', 'update' and 'apply_stimulus'
  95. * @param string $sMessage The HTML message (must be correctly escaped)
  96. * @param string $sSeverity Any of the following: ok, info, error.
  97. * @param float $fRank Ordering of the message: smallest displayed first (can be negative)
  98. * @param bool $bMustNotExist Do not alter any existing message (considering the id)
  99. *
  100. */
  101. public static function SetSessionMessage($sClass, $iKey, $sMessageId, $sMessage, $sSeverity, $fRank, $bMustNotExist = false)
  102. {
  103. $sMessageKey = $sClass.'::'.$iKey;
  104. if (!isset($_SESSION['obj_messages'][$sMessageKey]))
  105. {
  106. $_SESSION['obj_messages'][$sMessageKey] = array();
  107. }
  108. if (!$bMustNotExist || !array_key_exists($sMessageId, $_SESSION['obj_messages'][$sMessageKey]))
  109. {
  110. $_SESSION['obj_messages'][$sMessageKey][$sMessageId] = array(
  111. 'rank' => $fRank,
  112. 'severity' => $sSeverity,
  113. 'message' => $sMessage
  114. );
  115. }
  116. }
  117. function DisplayBareHeader(WebPage $oPage, $bEditMode = false)
  118. {
  119. // Standard Header with name, actions menu and history block
  120. //
  121. // Is there a message for this object ??
  122. $sMessageKey = get_class($this).'::'.$this->GetKey();
  123. if (array_key_exists('obj_messages', $_SESSION) && array_key_exists($sMessageKey, $_SESSION['obj_messages']))
  124. {
  125. $aMessages = array();
  126. $aRanks = array();
  127. foreach ($_SESSION['obj_messages'][$sMessageKey] as $sMessageId => $aMessageData)
  128. {
  129. $sMsgClass = 'message_'.$aMessageData['severity'];
  130. $aMessages[] = "<div class=\"header_message $sMsgClass\">".$aMessageData['message']."</div>";
  131. $aRanks[] = $aMessageData['rank'];
  132. }
  133. array_multisort($aRanks, $aMessages);
  134. foreach ($aMessages as $sMessage)
  135. {
  136. $oPage->add($sMessage);
  137. }
  138. unset($_SESSION['obj_messages'][$sMessageKey]);
  139. }
  140. // action menu
  141. $oSingletonFilter = new DBObjectSearch(get_class($this));
  142. $oSingletonFilter->AddCondition('id', $this->GetKey(), '=');
  143. $oBlock = new MenuBlock($oSingletonFilter, 'details', false);
  144. $oBlock->Display($oPage, -1);
  145. // Master data sources
  146. $sSynchroIcon = '';
  147. $oReplicaSet = $this->GetMasterReplica();
  148. $bSynchronized = false;
  149. $oCreatorTask = null;
  150. $bCanBeDeletedByTask = false;
  151. $bCanBeDeletedByUser = true;
  152. $aMasterSources = array();
  153. if ($oReplicaSet->Count() > 0)
  154. {
  155. $bSynchronized = true;
  156. while($aData = $oReplicaSet->FetchAssoc())
  157. {
  158. // Assumption: $aData['datasource'] will not be null because the data source id is always set...
  159. $sApplicationURL = $aData['datasource']->GetApplicationUrl($this, $aData['replica']);
  160. $sLink = $aData['datasource']->GetName();
  161. if (!empty($sApplicationURL))
  162. {
  163. $sLink = "<a href=\"$sApplicationURL\" target=\"_blank\">".$aData['datasource']->GetName()."</a>";
  164. }
  165. if ($aData['replica']->Get('status_dest_creator') == 1)
  166. {
  167. $oCreatorTask = $aData['datasource'];
  168. $bCreatedByTask = true;
  169. }
  170. else
  171. {
  172. $bCreatedByTask = false;
  173. }
  174. if ($bCreatedByTask)
  175. {
  176. $sDeletePolicy = $aData['datasource']->Get('delete_policy');
  177. if (($sDeletePolicy == 'delete') || ($sDeletePolicy == 'update_then_delete'))
  178. {
  179. $bCanBeDeletedByTask = true;
  180. }
  181. $sUserDeletePolicy = $aData['datasource']->Get('user_delete_policy');
  182. if ($sUserDeletePolicy == 'nobody')
  183. {
  184. $bCanBeDeletedByUser = false;
  185. }
  186. elseif (($sUserDeletePolicy == 'administrators') && !UserRights::IsAdministrator())
  187. {
  188. $bCanBeDeletedByUser = false;
  189. }
  190. else // everybody...
  191. {
  192. }
  193. }
  194. $aMasterSources[$aData['datasource']->GetKey()]['datasource'] = $aData['datasource'];
  195. $aMasterSources[$aData['datasource']->GetKey()]['url'] = $sLink;
  196. $aMasterSources[$aData['datasource']->GetKey()]['last_synchro'] = $aData['replica']->Get('status_last_seen');
  197. }
  198. if (is_object($oCreatorTask))
  199. {
  200. $sTaskUrl = $aMasterSources[$oCreatorTask->GetKey()]['url'];
  201. if (!$bCanBeDeletedByUser)
  202. {
  203. $sTip = "<p>".Dict::Format('Core:Synchro:TheObjectCannotBeDeletedByUser_Source', $sTaskUrl)."</p>";
  204. }
  205. else
  206. {
  207. $sTip = "<p>".Dict::Format('Core:Synchro:TheObjectWasCreatedBy_Source', $sTaskUrl)."</p>";
  208. }
  209. if ($bCanBeDeletedByTask)
  210. {
  211. $sTip .= "<p>".Dict::Format('Core:Synchro:TheObjectCanBeDeletedBy_Source', $sTaskUrl)."</p>";
  212. }
  213. }
  214. else
  215. {
  216. $sTip = "<p>".Dict::S('Core:Synchro:ThisObjectIsSynchronized')."</p>";
  217. }
  218. $sTip .= "<p><b>".Dict::S('Core:Synchro:ListOfDataSources')."</b></p>";
  219. foreach($aMasterSources as $aStruct)
  220. {
  221. $oDataSource = $aStruct['datasource'];
  222. $sLink = $aStruct['url'];
  223. $sTip .= "<p style=\"white-space:nowrap\">".$oDataSource->GetIcon(true, 'style="vertical-align:middle"')."&nbsp;$sLink<br/>";
  224. $sTip .= Dict::S('Core:Synchro:LastSynchro').'<br/>'.$aStruct['last_synchro']."</p>";
  225. }
  226. $sSynchroIcon = '&nbsp;<img style="vertical-align:middle;" id="synchro_icon" src="../images/locked.png"/>';
  227. $oPage->add_ready_script("$('#synchro_icon').qtip( { content: '$sTip', show: 'mouseover', hide: { fixed: true }, style: { name: 'dark', tip: 'leftTop' }, position: { corner: { target: 'rightMiddle', tooltip: 'leftTop' }} } );");
  228. }
  229. $oPage->add("<div class=\"page_header\"><h1>".$this->GetIcon()."&nbsp;\n");
  230. $sRefreshIcon = '';
  231. if ($_SERVER['REQUEST_METHOD'] == 'GET')
  232. {
  233. $sRefreshIcon = '<img src="../images/reload.png" style="cursor:pointer;vertical-align:middle;margin-left:1em;" onclick="window.location.reload();" title="'.htmlentities(Dict::S('UI:Button:Refresh'), ENT_QUOTES, 'UTF-8').'"/>';
  234. }
  235. $oPage->add(MetaModel::GetName(get_class($this)).": <span class=\"hilite\">".$this->GetName()."</span>$sRefreshIcon $sSynchroIcon</h1>\n");
  236. $oPage->add("</div>\n");
  237. }
  238. function DisplayBareHistory(WebPage $oPage, $bEditMode = false)
  239. {
  240. // history block (with as a tab)
  241. $oHistoryFilter = new DBObjectSearch('CMDBChangeOp');
  242. $oHistoryFilter->AddCondition('objkey', $this->GetKey(), '=');
  243. $oHistoryFilter->AddCondition('objclass', get_class($this), '=');
  244. $oBlock = new HistoryBlock($oHistoryFilter, 'table', false);
  245. $oBlock->Display($oPage, -1);
  246. }
  247. function DisplayBareProperties(WebPage $oPage, $bEditMode = false, $sPrefix = '', $aExtraParams = array())
  248. {
  249. $aFieldsMap = $this->GetBareProperties($oPage, $bEditMode, $sPrefix, $aExtraParams);
  250. if (!isset($aExtraParams['disable_plugins']) || !$aExtraParams['disable_plugins'])
  251. {
  252. foreach (MetaModel::EnumPlugins('iApplicationUIExtension') as $oExtensionInstance)
  253. {
  254. $oExtensionInstance->OnDisplayProperties($this, $oPage, $bEditMode);
  255. }
  256. }
  257. // Special case to display the case log, if any...
  258. // WARNING: if you modify the loop below, also check the corresponding code in UpdateObject and DisplayModifyForm
  259. foreach(MetaModel::ListAttributeDefs(get_class($this)) as $sAttCode => $oAttDef)
  260. {
  261. if ($oAttDef instanceof AttributeCaseLog)
  262. {
  263. $sComment = (isset($aExtraParams['fieldsComments'][$sAttCode])) ? $aExtraParams['fieldsComments'][$sAttCode] : '';
  264. $this->DisplayCaseLog($oPage, $sAttCode, $sComment, $sPrefix, $bEditMode);
  265. }
  266. }
  267. return $aFieldsMap;
  268. }
  269. /**
  270. * Add a field to the map: attcode => id used when building a form
  271. * @param string $sAttCode The attribute code of the field being edited
  272. * @param string $sInputId The unique ID of the control/widget in the page
  273. */
  274. protected function AddToFieldsMap($sAttCode, $sInputId)
  275. {
  276. $this->aFieldsMap[$sAttCode] = $sInputId;
  277. }
  278. function DisplayBareRelations(WebPage $oPage, $bEditMode = false)
  279. {
  280. // Related objects: display all the linkset attributes, each as a separate tab
  281. // In the order described by the 'display' ZList
  282. $aList = $this->FlattenZList(MetaModel::GetZListItems(get_class($this), 'details'));
  283. if (count($aList) == 0)
  284. {
  285. // Empty ZList defined, display all the linkedset attributes defined
  286. $aList = array_keys(MetaModel::ListAttributeDefs(get_class($this)));
  287. }
  288. $sClass = get_class($this);
  289. foreach($aList as $sAttCode)
  290. {
  291. $oAttDef = MetaModel::GetAttributeDef(get_class($this), $sAttCode);
  292. // Display mode
  293. if (!$oAttDef->IsLinkset()) continue; // Process only linkset attributes...
  294. // $oSet = new DBObjectSet($this->Get($sAttCode)->GetFilter()); // Why do something so useless ?
  295. $oSet = $this->Get($sAttCode);
  296. $iCount = $oSet->Count();
  297. $sCount = '';
  298. if ($iCount != 0)
  299. {
  300. $sCount = " ($iCount)";
  301. }
  302. $oPage->SetCurrentTab($oAttDef->GetLabel().$sCount);
  303. if ($this->IsNew())
  304. {
  305. $iFlags = $this->GetInitialStateAttributeFlags($sAttCode);
  306. }
  307. else
  308. {
  309. $iFlags = $this->GetAttributeFlags($sAttCode);
  310. }
  311. $bReadOnly = ($iFlags & (OPT_ATT_READONLY|OPT_ATT_SLAVE));
  312. if ($bEditMode && (!$bReadOnly))
  313. {
  314. $sInputId = $this->m_iFormId.'_'.$sAttCode;
  315. $sLinkedClass = $oAttDef->GetLinkedClass();
  316. if ($oAttDef->IsIndirect())
  317. {
  318. $oLinkingAttDef = MetaModel::GetAttributeDef($sLinkedClass, $oAttDef->GetExtKeyToRemote());
  319. $sTargetClass = $oLinkingAttDef->GetTargetClass();
  320. }
  321. else
  322. {
  323. $sTargetClass = $sLinkedClass;
  324. }
  325. $oPage->p(MetaModel::GetClassIcon($sTargetClass)."&nbsp;".$oAttDef->GetDescription().'<span id="busy_'.$sInputId.'"></span>');
  326. $oValue = $this->Get($sAttCode);
  327. $sDisplayValue = ''; // not used
  328. $aArgs = array('this' => $this);
  329. $sHTMLValue = "<span id=\"field_{$sInputId}\">".self::GetFormElementForField($oPage, $sClass, $sAttCode, $oAttDef, $oValue, $sDisplayValue, $sInputId, '', $iFlags, $aArgs).'</span>';
  330. $this->AddToFieldsMap($sAttCode, $sInputId);
  331. $oPage->add($sHTMLValue);
  332. }
  333. else
  334. {
  335. // Display mode
  336. if (!$oAttDef->IsIndirect())
  337. {
  338. // 1:n links
  339. $sTargetClass = $oAttDef->GetLinkedClass();
  340. $aDefaults = array($oAttDef->GetExtKeyToMe() => $this->GetKey());
  341. $oAppContext = new ApplicationContext();
  342. foreach($oAppContext->GetNames() as $sKey)
  343. {
  344. // The linked object inherits the parent's value for the context
  345. if (MetaModel::IsValidAttCode($sClass, $sKey))
  346. {
  347. $aDefaults[$sKey] = $this->Get($sKey);
  348. }
  349. }
  350. $aParams = array(
  351. 'target_attr' => $oAttDef->GetExtKeyToMe(),
  352. 'object_id' => $this->GetKey(),
  353. 'menu' => false,
  354. 'default' => $aDefaults,
  355. 'table_id' => $sClass.'_'.$sAttCode,
  356. );
  357. }
  358. else
  359. {
  360. // n:n links
  361. $sLinkedClass = $oAttDef->GetLinkedClass();
  362. $oLinkingAttDef = MetaModel::GetAttributeDef($sLinkedClass, $oAttDef->GetExtKeyToRemote());
  363. $sTargetClass = $oLinkingAttDef->GetTargetClass();
  364. $bMenu = ($this->Get($sAttCode)->Count() > 0); // The menu is enabled only if there are already some elements...
  365. $aParams = array(
  366. 'link_attr' => $oAttDef->GetExtKeyToMe(),
  367. 'object_id' => $this->GetKey(),
  368. 'target_attr' => $oAttDef->GetExtKeyToRemote(),
  369. 'view_link' => false,
  370. 'menu' => false,
  371. 'display_limit' => true, // By default limit the list to speed up the initial load & display
  372. 'table_id' => $sClass.'_'.$sAttCode,
  373. );
  374. }
  375. $oPage->p(MetaModel::GetClassIcon($sTargetClass)."&nbsp;".$oAttDef->GetDescription());
  376. $oBlock = new DisplayBlock($this->Get($sAttCode)->GetFilter(), 'list', false);
  377. $oBlock->Display($oPage, 'rel_'.$sAttCode, $aParams);
  378. }
  379. }
  380. $oPage->SetCurrentTab('');
  381. foreach (MetaModel::EnumPlugins('iApplicationUIExtension') as $oExtensionInstance)
  382. {
  383. $oExtensionInstance->OnDisplayRelations($this, $oPage, $bEditMode);
  384. }
  385. // Display Notifications after the other tabs since this tab disappears in edition
  386. if (!$bEditMode)
  387. {
  388. // Look for any trigger that considers this object as "In Scope"
  389. // If any trigger has been found then display a tab with notifications
  390. //
  391. $oTriggerSet = new CMDBObjectSet(new DBObjectSearch('Trigger'));
  392. $aTriggers = array();
  393. while($oTrigger = $oTriggerSet->Fetch())
  394. {
  395. if($oTrigger->IsInScope($this))
  396. {
  397. $aTriggers[] = $oTrigger->GetKey();
  398. }
  399. }
  400. if (count($aTriggers) > 0)
  401. {
  402. // Display notifications regarding the object
  403. $iId = $this->GetKey();
  404. $sTriggersList = implode(',', $aTriggers);
  405. $oNotifSearch = DBObjectSearch::FromOQL("SELECT EventNotificationEmail AS Ev JOIN Trigger AS T ON Ev.trigger_id = T.id WHERE T.id IN ($sTriggersList) AND Ev.object_id = $iId");
  406. $oNotifSet = new DBObjectSet($oNotifSearch);
  407. $sCount = ($oNotifSet->Count() > 0) ? ' ('.$oNotifSet->Count().')' : '';
  408. $oPage->SetCurrentTab(Dict::S('UI:NotificationsTab').$sCount);
  409. $oBlock = new DisplayBlock($oNotifSearch, 'list', false);
  410. $oBlock->Display($oPage, 'notifications', array('menu' => false));
  411. }
  412. }
  413. }
  414. function GetBareProperties(WebPage $oPage, $bEditMode = false, $sPrefix, $aExtraParams = array())
  415. {
  416. $sHtml = '';
  417. $oAppContext = new ApplicationContext();
  418. $sStateAttCode = MetaModel::GetStateAttributeCode(get_class($this));
  419. $aDetails = array();
  420. $sClass = get_class($this);
  421. $aDetailsList = MetaModel::GetZListItems($sClass, 'details');
  422. $aDetailsStruct = self::ProcessZlist($aDetailsList, array('UI:PropertiesTab' => array()), 'UI:PropertiesTab', 'col1', '');
  423. // Compute the list of properties to display, first the attributes in the 'details' list, then
  424. // all the remaining attributes that are not external fields
  425. $sHtml = '';
  426. $aDetails = array();
  427. $iInputId = 0;
  428. $aFieldsMap = array();
  429. $aFieldsComments = (isset($aExtraParams['fieldsComments'])) ? $aExtraParams['fieldsComments'] : array();
  430. $aExtraFlags = (isset($aExtraParams['fieldsFlags'])) ? $aExtraParams['fieldsFlags'] : array();
  431. $bFieldComments = (count($aFieldsComments) > 0);
  432. foreach($aDetailsStruct as $sTab => $aCols )
  433. {
  434. $aDetails[$sTab] = array();
  435. ksort($aCols);
  436. $oPage->SetCurrentTab(Dict::S($sTab));
  437. $oPage->add('<table style="vertical-align:top"><tr>');
  438. foreach($aCols as $sColIndex => $aFieldsets)
  439. {
  440. $oPage->add('<td style="vertical-align:top">');
  441. //$aDetails[$sTab][$sColIndex] = array();
  442. $sLabel = '';
  443. $sPreviousLabel = '';
  444. $aDetails[$sTab][$sColIndex] = array();
  445. foreach($aFieldsets as $sFieldsetName => $aFields)
  446. {
  447. if (!empty($sFieldsetName) && ($sFieldsetName[0] != '_'))
  448. {
  449. $sLabel = $sFieldsetName;
  450. }
  451. else
  452. {
  453. $sLabel = '';
  454. }
  455. if ($sLabel != $sPreviousLabel)
  456. {
  457. if (!empty($sPreviousLabel))
  458. {
  459. $oPage->add('<fieldset>');
  460. $oPage->add('<legend>'.Dict::S($sPreviousLabel).'</legend>');
  461. }
  462. $oPage->Details($aDetails[$sTab][$sColIndex]);
  463. if (!empty($sPreviousLabel))
  464. {
  465. $oPage->add('</fieldset>');
  466. }
  467. $aDetails[$sTab][$sColIndex] = array();
  468. $sPreviousLabel = $sLabel;
  469. }
  470. foreach($aFields as $sAttCode)
  471. {
  472. if ($bEditMode)
  473. {
  474. $sComments = isset($aFieldsComments[$sAttCode]) ? $aFieldsComments[$sAttCode] : '&nbsp;';
  475. $sInfos = '&nbsp;';
  476. if ($this->IsNew())
  477. {
  478. $iFlags = $this->GetInitialStateAttributeFlags($sAttCode);
  479. }
  480. else
  481. {
  482. $iFlags = $this->GetAttributeFlags($sAttCode);
  483. }
  484. if (($iFlags & OPT_ATT_MANDATORY) && $this->IsNew())
  485. {
  486. $iFlags = $iFlags & ~OPT_ATT_READONLY; // Mandatory fields cannot be read-only when creating an object
  487. }
  488. if (array_key_exists($sAttCode, $aExtraFlags))
  489. {
  490. // the caller may override some flags if needed
  491. $iFlags = $iFlags | $aExtraFlags[$sAttCode];
  492. }
  493. $oAttDef = MetaModel::GetAttributeDef($sClass, $sAttCode);
  494. if ( (!$oAttDef->IsLinkSet()) && (($iFlags & OPT_ATT_HIDDEN) == 0))
  495. {
  496. if ($oAttDef->IsWritable())
  497. {
  498. if ($sStateAttCode == $sAttCode)
  499. {
  500. // State attribute is always read-only from the UI
  501. $sHTMLValue = $this->GetStateLabel();
  502. $val = array('label' => '<span>'.$oAttDef->GetLabel().'</span>', 'value' => $sHTMLValue, 'comments' => $sComments, 'infos' => $sInfos);
  503. }
  504. else
  505. {
  506. $sInputId = $this->m_iFormId.'_'.$sAttCode;
  507. if ($iFlags & OPT_ATT_HIDDEN)
  508. {
  509. // Attribute is hidden, add a hidden input
  510. $oPage->add('<input type="hidden" id="'.$sInputId.'" name="attr_'.$sPrefix.$sAttCode.'" value="'.htmlentities($this->Get($sAttCode), ENT_QUOTES, 'UTF-8').'"/>');
  511. $aFieldsMap[$sAttCode] = $sInputId;
  512. }
  513. else
  514. {
  515. if ($iFlags & (OPT_ATT_READONLY|OPT_ATT_SLAVE))
  516. {
  517. // Check if the attribute is not read-only because of a synchro...
  518. $aReasons = array();
  519. $sSynchroIcon = '';
  520. if ($iFlags & OPT_ATT_SLAVE)
  521. {
  522. $iSynchroFlags = $this->GetSynchroReplicaFlags($sAttCode, $aReasons);
  523. $sSynchroIcon = "&nbsp;<img id=\"synchro_$sInputId\" src=\"../images/transp-lock.png\" style=\"vertical-align:middle\"/>";
  524. $sTip = '';
  525. foreach($aReasons as $aRow)
  526. {
  527. $sTip .= "<p>Synchronized with {$aRow['name']} - {$aRow['description']}</p>";
  528. }
  529. $sTip = addslashes($sTip);
  530. $oPage->add_ready_script("$('#synchro_$sInputId').qtip( { content: '$sTip', show: 'mouseover', hide: 'mouseout', style: { name: 'dark', tip: 'leftTop' }, position: { corner: { target: 'rightMiddle', tooltip: 'leftTop' }} } );");
  531. }
  532. // Attribute is read-only
  533. $sHTMLValue = "<span id=\"field_{$sInputId}\">".$this->GetAsHTML($sAttCode);
  534. $sHTMLValue .= '<input type="hidden" id="'.$sInputId.'" name="attr_'.$sPrefix.$sAttCode.'" value="'.htmlentities($this->Get($sAttCode), ENT_QUOTES, 'UTF-8').'"/></span>';
  535. $aFieldsMap[$sAttCode] = $sInputId;
  536. $sComments = $sSynchroIcon;
  537. }
  538. else
  539. {
  540. $sValue = $this->Get($sAttCode);
  541. $sDisplayValue = $this->GetEditValue($sAttCode);
  542. $aArgs = array('this' => $this, 'formPrefix' => $sPrefix);
  543. $sHTMLValue = "<span id=\"field_{$sInputId}\">".self::GetFormElementForField($oPage, $sClass, $sAttCode, $oAttDef, $sValue, $sDisplayValue, $sInputId, '', $iFlags, $aArgs).'</span>';
  544. $aFieldsMap[$sAttCode] = $sInputId;
  545. }
  546. $val = array('label' => '<span title="'.$oAttDef->GetDescription().'">'.$oAttDef->GetLabel().'</span>', 'value' => $sHTMLValue, 'comments' => $sComments, 'infos' => $sInfos);
  547. }
  548. }
  549. }
  550. else
  551. {
  552. $val = array('label' => '<span title="'.$oAttDef->GetDescription().'">'.$oAttDef->GetLabel().'</span>', 'value' => $this->GetAsHTML($sAttCode), 'comments' => $sComments, 'infos' => $sInfos);
  553. }
  554. }
  555. else
  556. {
  557. $val = null; // Skip this field
  558. }
  559. }
  560. else
  561. {
  562. // !bEditMode
  563. $val = $this->GetFieldAsHtml($sClass, $sAttCode, $sStateAttCode);
  564. }
  565. if ($val != null)
  566. {
  567. // The field is visible, add it to the current column
  568. $aDetails[$sTab][$sColIndex][] = $val;
  569. $iInputId++;
  570. }
  571. }
  572. }
  573. if (!empty($sPreviousLabel))
  574. {
  575. $oPage->add('<fieldset>');
  576. $oPage->add('<legend>'.Dict::S($sFieldsetName).'</legend>');
  577. }
  578. $oPage->Details($aDetails[$sTab][$sColIndex]);
  579. if (!empty($sPreviousLabel))
  580. {
  581. $oPage->add('</fieldset>');
  582. }
  583. $oPage->add('</td>');
  584. }
  585. $oPage->add('</tr></table>');
  586. }
  587. return $aFieldsMap;
  588. }
  589. function DisplayDetails(WebPage $oPage, $bEditMode = false)
  590. {
  591. $sTemplate = Utils::ReadFromFile(MetaModel::GetDisplayTemplate(get_class($this)));
  592. if (!empty($sTemplate))
  593. {
  594. $oTemplate = new DisplayTemplate($sTemplate);
  595. // Note: to preserve backward compatibility with home-made templates, the placeholder '$pkey$' has been preserved
  596. // but the preferred method is to use '$id$'
  597. $oTemplate->Render($oPage, array('class_name'=> MetaModel::GetName(get_class($this)),'class'=> get_class($this), 'pkey'=> $this->GetKey(), 'id'=> $this->GetKey(), 'name' => $this->GetName()));
  598. }
  599. else
  600. {
  601. // Object's details
  602. // template not found display the object using the *old style*
  603. $this->DisplayBareHeader($oPage, $bEditMode);
  604. $oPage->AddTabContainer(OBJECT_PROPERTIES_TAB);
  605. $oPage->SetCurrentTabContainer(OBJECT_PROPERTIES_TAB);
  606. $oPage->SetCurrentTab(Dict::S('UI:PropertiesTab'));
  607. $this->DisplayBareProperties($oPage, $bEditMode);
  608. $this->DisplayBareRelations($oPage, $bEditMode);
  609. $oPage->SetCurrentTab(Dict::S('UI:HistoryTab'));
  610. $this->DisplayBareHistory($oPage, $bEditMode);
  611. }
  612. }
  613. function DisplayPreview(WebPage $oPage)
  614. {
  615. $aDetails = array();
  616. $sClass = get_class($this);
  617. $aList = MetaModel::GetZListItems($sClass, 'preview');
  618. foreach($aList as $sAttCode)
  619. {
  620. $aDetails[] = array('label' => MetaModel::GetLabel($sClass, $sAttCode), 'value' =>$this->GetAsHTML($sAttCode));
  621. }
  622. $oPage->details($aDetails);
  623. }
  624. public static function DisplaySet(WebPage $oPage, CMDBObjectSet $oSet, $aExtraParams = array())
  625. {
  626. $oPage->add(self::GetDisplaySet($oPage, $oSet, $aExtraParams));
  627. }
  628. /**
  629. * Get the HTML fragment corresponding to the display of a table representing a set of objects
  630. * @param WebPage $oPage The page object is used for out-of-band information (mostly scripts) output
  631. * @param CMDBObjectSet The set of objects to display
  632. * @param Hash $aExtraParams Some extra configuration parameters to tweak the behavior of the display
  633. * @return String The HTML fragment representing the table of objects
  634. */
  635. public static function GetDisplaySet(WebPage $oPage, CMDBObjectSet $oSet, $aExtraParams = array())
  636. {
  637. if (empty($aExtraParams['currentId']))
  638. {
  639. $iListId = $oPage->GetUniqueId(); // Works only if not in an Ajax page !!
  640. }
  641. else
  642. {
  643. $iListId = $aExtraParams['currentId'];
  644. }
  645. // Initialize and check the parameters
  646. $bViewLink = isset($aExtraParams['view_link']) ? $aExtraParams['view_link'] : true;
  647. $sLinkageAttribute = isset($aExtraParams['link_attr']) ? $aExtraParams['link_attr'] : '';
  648. $iLinkedObjectId = isset($aExtraParams['object_id']) ? $aExtraParams['object_id'] : 0;
  649. $sTargetAttr = isset($aExtraParams['target_attr']) ? $aExtraParams['target_attr'] : '';
  650. if (!empty($sLinkageAttribute))
  651. {
  652. if($iLinkedObjectId == 0)
  653. {
  654. // if 'links' mode is requested the id of the object to link to must be specified
  655. throw new ApplicationException(Dict::S('UI:Error:MandatoryTemplateParameter_object_id'));
  656. }
  657. if($sTargetAttr == '')
  658. {
  659. // if 'links' mode is requested the d of the object to link to must be specified
  660. throw new ApplicationException(Dict::S('UI:Error:MandatoryTemplateParameter_target_attr'));
  661. }
  662. }
  663. $bDisplayMenu = isset($aExtraParams['menu']) ? $aExtraParams['menu'] == true : true;
  664. $bTruncated = isset($aExtraParams['truncated']) ? $aExtraParams['truncated'] == true : true;
  665. $bSelectMode = isset($aExtraParams['selection_mode']) ? $aExtraParams['selection_mode'] == true : false;
  666. $bSingleSelectMode = isset($aExtraParams['selection_type']) ? ($aExtraParams['selection_type'] == 'single') : false;
  667. $aExtraFieldsRaw = isset($aExtraParams['extra_fields']) ? explode(',', trim($aExtraParams['extra_fields'])) : array();
  668. $aExtraFields = array();
  669. foreach ($aExtraFieldsRaw as $sFieldName)
  670. {
  671. // Ignore attributes not of the main queried class
  672. if (preg_match('/^(.*)\.(.*)$/', $sFieldName, $aMatches))
  673. {
  674. $sClassAlias = $aMatches[1];
  675. $sAttCode = $aMatches[2];
  676. if ($sClassAlias == $oSet->GetFilter()->GetClassAlias())
  677. {
  678. $aExtraFields[] = $sAttCode;
  679. }
  680. }
  681. else
  682. {
  683. $aExtraFields[] = $sFieldName;
  684. }
  685. }
  686. $sHtml = '';
  687. $oAppContext = new ApplicationContext();
  688. $sClassName = $oSet->GetFilter()->GetClass();
  689. $sZListName = isset($aExtraParams['zlist']) ? ($aExtraParams['zlist']) : 'list';
  690. if ($sZListName !== false)
  691. {
  692. $aList = self::FlattenZList(MetaModel::GetZListItems($sClassName, $sZListName));
  693. $aList = array_merge($aList, $aExtraFields);
  694. }
  695. else
  696. {
  697. $aList = $aExtraFields;
  698. }
  699. // Filter the list to removed linked set since we are not able to display them here
  700. foreach($aList as $index => $sAttCode)
  701. {
  702. $oAttDef = MetaModel::GetAttributeDef($sClassName, $sAttCode);
  703. if ($oAttDef instanceof AttributeLinkedSet)
  704. {
  705. // Removed from the display list
  706. unset($aList[$index]);
  707. }
  708. }
  709. if (!empty($sLinkageAttribute))
  710. {
  711. // The set to display is in fact a set of links between the object specified in the $sLinkageAttribute
  712. // and other objects...
  713. // The display will then group all the attributes related to the link itself:
  714. // | Link_attr1 | link_attr2 | ... || Object_attr1 | Object_attr2 | Object_attr3 | .. | Object_attr_n |
  715. $aDisplayList = array();
  716. $aAttDefs = MetaModel::ListAttributeDefs($sClassName);
  717. assert(isset($aAttDefs[$sLinkageAttribute]));
  718. $oAttDef = $aAttDefs[$sLinkageAttribute];
  719. assert($oAttDef->IsExternalKey());
  720. // First display all the attributes specific to the link record
  721. foreach($aList as $sLinkAttCode)
  722. {
  723. $oLinkAttDef = $aAttDefs[$sLinkAttCode];
  724. if ( (!$oLinkAttDef->IsExternalKey()) && (!$oLinkAttDef->IsExternalField()) )
  725. {
  726. $aDisplayList[] = $sLinkAttCode;
  727. }
  728. }
  729. // Then display all the attributes neither specific to the link record nor to the 'linkage' object (because the latter are constant)
  730. foreach($aList as $sLinkAttCode)
  731. {
  732. $oLinkAttDef = $aAttDefs[$sLinkAttCode];
  733. if (($oLinkAttDef->IsExternalKey() && ($sLinkAttCode != $sLinkageAttribute))
  734. || ($oLinkAttDef->IsExternalField() && ($oLinkAttDef->GetKeyAttCode()!=$sLinkageAttribute)) )
  735. {
  736. $aDisplayList[] = $sLinkAttCode;
  737. }
  738. }
  739. // First display all the attributes specific to the link
  740. // Then display all the attributes linked to the other end of the relationship
  741. $aList = $aDisplayList;
  742. }
  743. $sSelectMode = 'none';
  744. if ($bSelectMode)
  745. {
  746. $sSelectMode = $bSingleSelectMode ? 'single' : 'multiple';
  747. }
  748. $sClassAlias = $oSet->GetClassAlias();
  749. $bDisplayLimit = isset($aExtraParams['display_limit']) ? $aExtraParams['display_limit'] : true;
  750. // Load only the requested columns
  751. $oSet->OptimizeColumnLoad(array($sClassAlias => $aList));
  752. $sTableId = isset($aExtraParams['table_id']) ? $aExtraParams['table_id'] : null;
  753. $aClassAliases = array( $sClassAlias => $sClassName);
  754. $oDataTable = new DataTable($iListId, $oSet, $aClassAliases, $sTableId);
  755. $oSettings = DataTableSettings::GetDataModelSettings($aClassAliases, $bViewLink, array($sClassAlias => $aList));
  756. if ($bDisplayLimit)
  757. {
  758. $iDefaultPageSize = appUserPreferences::GetPref('default_page_size', MetaModel::GetConfig()->GetMinDisplayLimit());
  759. $oSettings->iDefaultPageSize = $iDefaultPageSize;
  760. }
  761. else
  762. {
  763. $oSettings->iDefaultPageSize = 0;
  764. }
  765. $oSettings->aSortOrder = MetaModel::GetOrderByDefault($sClassName);
  766. return $oDataTable->Display($oPage, $oSettings, $bDisplayMenu, $sSelectMode, $bViewLink, $aExtraParams);
  767. }
  768. public static function GetDisplayExtendedSet(WebPage $oPage, CMDBObjectSet $oSet, $aExtraParams = array())
  769. {
  770. if (empty($aExtraParams['currentId']))
  771. {
  772. $iListId = $oPage->GetUniqueId(); // Works only if not in an Ajax page !!
  773. }
  774. else
  775. {
  776. $iListId = $aExtraParams['currentId'];
  777. }
  778. $aList = array();
  779. // Initialize and check the parameters
  780. $bViewLink = isset($aExtraParams['view_link']) ? $aExtraParams['view_link'] : true;
  781. $bDisplayMenu = isset($aExtraParams['menu']) ? $aExtraParams['menu'] == true : true;
  782. // Check if there is a list of aliases to limit the display to...
  783. $aDisplayAliases = isset($aExtraParams['display_aliases']) ? explode(',', $aExtraParams['display_aliases']) : array();
  784. $sZListName = isset($aExtraParams['zlist']) ? ($aExtraParams['zlist']) : 'list';
  785. $aExtraFieldsRaw = isset($aExtraParams['extra_fields']) ? explode(',', trim($aExtraParams['extra_fields'])) : array();
  786. $aExtraFields = array();
  787. foreach ($aExtraFieldsRaw as $sFieldName)
  788. {
  789. // Ignore attributes not of the main queried class
  790. if (preg_match('/^(.*)\.(.*)$/', $sFieldName, $aMatches))
  791. {
  792. $sClassAlias = $aMatches[1];
  793. $sAttCode = $aMatches[2];
  794. if (array_key_exists($sClassAlias, $oSet->GetSelectedClasses()))
  795. {
  796. $aExtraFields[$sClassAlias][] = $sAttCode;
  797. }
  798. }
  799. else
  800. {
  801. $aExtraFields['*'] = $sAttCode;
  802. }
  803. }
  804. $sHtml = '';
  805. $oAppContext = new ApplicationContext();
  806. $aClasses = $oSet->GetFilter()->GetSelectedClasses();
  807. $aAuthorizedClasses = array();
  808. foreach($aClasses as $sAlias => $sClassName)
  809. {
  810. if ( (UserRights::IsActionAllowed($sClassName, UR_ACTION_READ, $oSet) && (UR_ALLOWED_YES || UR_ALLOWED_DEPENDS)) &&
  811. ( (count($aDisplayAliases) == 0) || (in_array($sAlias, $aDisplayAliases))) )
  812. {
  813. $aAuthorizedClasses[$sAlias] = $sClassName;
  814. }
  815. }
  816. $aAttribs = array();
  817. foreach($aAuthorizedClasses as $sAlias => $sClassName)
  818. {
  819. if (array_key_exists($sAlias, $aExtraFields))
  820. {
  821. $aList[$sAlias] = $aExtraFields[$sAlias];
  822. }
  823. else
  824. {
  825. $aList[$sAlias] = array();
  826. }
  827. if ($sZListName !== false)
  828. {
  829. $aDefaultList = self::FlattenZList(MetaModel::GetZListItems($sClassName, $sZListName));
  830. $aList[$sAlias] = array_merge($aDefaultList, $aList[$sAlias]);
  831. }
  832. // Filter the list to removed linked set since we are not able to display them here
  833. foreach($aList[$sAlias] as $index => $sAttCode)
  834. {
  835. $oAttDef = MetaModel::GetAttributeDef($sClassName, $sAttCode);
  836. if ($oAttDef instanceof AttributeLinkedSet)
  837. {
  838. // Removed from the display list
  839. unset($aList[$sAlias][$index]);
  840. }
  841. }
  842. }
  843. // Load only the requested columns
  844. $aAttToLoad = array(); // attributes to load
  845. foreach($aAuthorizedClasses as $sAlias => $sClassName)
  846. {
  847. foreach($aList[$sAlias] as $sAttCode)
  848. {
  849. $aAttToLoad[$sAlias][] = $sAttCode;
  850. }
  851. }
  852. $oSet->OptimizeColumnLoad($aAttToLoad);
  853. $sSelectMode = 'none';
  854. $sClassAlias = $oSet->GetClassAlias();
  855. $oDataTable = new DataTable($iListId, $oSet, $aAuthorizedClasses);
  856. $oSettings = DataTableSettings::GetDataModelSettings($aAuthorizedClasses, $bViewLink, $aList);
  857. $bDisplayLimit = isset($aExtraParams['display_limit']) ? $aExtraParams['display_limit'] : true;
  858. if ($bDisplayLimit)
  859. {
  860. $iDefaultPageSize = appUserPreferences::GetPref('default_page_size', MetaModel::GetConfig()->GetMinDisplayLimit());
  861. $oSettings->iDefaultPageSize = $iDefaultPageSize;
  862. }
  863. $oSettings->aSortOrder = MetaModel::GetOrderByDefault($sClassName);
  864. return $oDataTable->Display($oPage, $oSettings, $bDisplayMenu, $sSelectMode, $bViewLink, $aExtraParams);
  865. }
  866. static function DisplaySetAsCSV(WebPage $oPage, CMDBObjectSet $oSet, $aParams = array())
  867. {
  868. $oPage->add(self::GetSetAsCSV($oSet, $aParams));
  869. }
  870. static function GetSetAsCSV(DBObjectSet $oSet, $aParams = array())
  871. {
  872. $sSeparator = isset($aParams['separator']) ? $aParams['separator'] : ','; // default separator is comma
  873. $sTextQualifier = isset($aParams['text_qualifier']) ? $aParams['text_qualifier'] : '"'; // default text qualifier is double quote
  874. $aFields = null;
  875. if (isset($aParams['fields']) && (strlen($aParams['fields']) > 0))
  876. {
  877. $aFields = explode(',', $aParams['fields']);
  878. }
  879. $bFieldsAdvanced = false;
  880. if (isset($aParams['fields_advanced']))
  881. {
  882. $bFieldsAdvanced = (bool) $aParams['fields_advanced'];
  883. }
  884. $bLocalize = true;
  885. if (isset($aParams['localize_values']))
  886. {
  887. $bLocalize = (bool) $aParams['localize_values'];
  888. }
  889. $aList = array();
  890. $oAppContext = new ApplicationContext();
  891. $aClasses = $oSet->GetFilter()->GetSelectedClasses();
  892. $aAuthorizedClasses = array();
  893. foreach($aClasses as $sAlias => $sClassName)
  894. {
  895. if (UserRights::IsActionAllowed($sClassName, UR_ACTION_READ, $oSet) && (UR_ALLOWED_YES || UR_ALLOWED_DEPENDS))
  896. {
  897. $aAuthorizedClasses[$sAlias] = $sClassName;
  898. }
  899. }
  900. $aAttribs = array();
  901. $aHeader = array();
  902. foreach($aAuthorizedClasses as $sAlias => $sClassName)
  903. {
  904. $aList[$sAlias] = array();
  905. foreach(MetaModel::ListAttributeDefs($sClassName) as $sAttCode => $oAttDef)
  906. {
  907. if (is_null($aFields) || (count($aFields) == 0))
  908. {
  909. // Standard list of attributes (no link sets)
  910. if ($oAttDef->IsScalar() && ($oAttDef->IsWritable() || $oAttDef->IsExternalField()))
  911. {
  912. $sAttCodeEx = $oAttDef->IsExternalField() ? $oAttDef->GetKeyAttCode().'->'.$oAttDef->GetExtAttCode() : $sAttCode;
  913. if ($oAttDef->IsExternalKey(EXTKEY_ABSOLUTE))
  914. {
  915. if ($bFieldsAdvanced)
  916. {
  917. $aList[$sAlias][$sAttCodeEx] = $oAttDef;
  918. if ($oAttDef->IsExternalKey(EXTKEY_RELATIVE))
  919. {
  920. $sRemoteClass = $oAttDef->GetTargetClass();
  921. foreach(MetaModel::GetReconcKeys($sRemoteClass) as $sRemoteAttCode)
  922. {
  923. $aList[$sAlias][$sAttCode.'->'.$sRemoteAttCode] = MetaModel::GetAttributeDef($sRemoteClass, $sRemoteAttCode);
  924. }
  925. }
  926. }
  927. }
  928. else
  929. {
  930. // Any other attribute
  931. $aList[$sAlias][$sAttCodeEx] = $oAttDef;
  932. }
  933. }
  934. }
  935. else
  936. {
  937. // User defined list of attributes
  938. if (in_array($sAttCode, $aFields) || in_array($sAlias.'.'.$sAttCode, $aFields))
  939. {
  940. $aList[$sAlias][$sAttCode] = $oAttDef;
  941. }
  942. }
  943. }
  944. if ($bFieldsAdvanced)
  945. {
  946. $aHeader[] = 'id';
  947. }
  948. foreach($aList[$sAlias] as $sAttCodeEx => $oAttDef)
  949. {
  950. $sStar = '';
  951. if (!$oAttDef->IsNullAllowed() && isset($aParams['showMandatoryFields']))
  952. {
  953. $sStar = '*';
  954. }
  955. $aHeader[] = ($bLocalize ? MetaModel::GetLabel($sClassName, $sAttCodeEx) : $sAttCodeEx).$sStar;
  956. }
  957. }
  958. $sHtml = implode($sSeparator, $aHeader)."\n";
  959. $oSet->Seek(0);
  960. while ($aObjects = $oSet->FetchAssoc())
  961. {
  962. $aRow = array();
  963. foreach($aAuthorizedClasses as $sAlias => $sClassName)
  964. {
  965. $oObj = $aObjects[$sAlias];
  966. if ($bFieldsAdvanced)
  967. {
  968. if (is_null($oObj))
  969. {
  970. $aRow[] = '';
  971. }
  972. else
  973. {
  974. $aRow[] = $oObj->GetKey();
  975. }
  976. }
  977. foreach($aList[$sAlias] as $sAttCodeEx => $oAttDef)
  978. {
  979. if (is_null($oObj))
  980. {
  981. $aRow[] = '';
  982. }
  983. else
  984. {
  985. $value = $oObj->Get($sAttCodeEx);
  986. $aRow[] = $oAttDef->GetAsCSV($value, $sSeparator, $sTextQualifier, $oObj, $bLocalize);
  987. }
  988. }
  989. }
  990. $sHtml .= implode($sSeparator, $aRow)."\n";
  991. }
  992. return $sHtml;
  993. }
  994. static function DisplaySetAsHTMLSpreadsheet(WebPage $oPage, CMDBObjectSet $oSet, $aParams = array())
  995. {
  996. $oPage->add(self::GetSetAsHTMLSpreadsheet($oSet, $aParams));
  997. }
  998. /**
  999. * Spreadsheet output: designed for end users doing some reporting
  1000. * Then the ids are excluded and replaced by the corresponding friendlyname
  1001. */
  1002. static function GetSetAsHTMLSpreadsheet(DBObjectSet $oSet, $aParams = array())
  1003. {
  1004. $aFields = null;
  1005. if (isset($aParams['fields']) && (strlen($aParams['fields']) > 0))
  1006. {
  1007. $aFields = explode(',', $aParams['fields']);
  1008. }
  1009. $bFieldsAdvanced = false;
  1010. if (isset($aParams['fields_advanced']))
  1011. {
  1012. $bFieldsAdvanced = (bool) $aParams['fields_advanced'];
  1013. }
  1014. $bLocalize = true;
  1015. if (isset($aParams['localize_values']))
  1016. {
  1017. $bLocalize = (bool) $aParams['localize_values'];
  1018. }
  1019. $aList = array();
  1020. $oAppContext = new ApplicationContext();
  1021. $aClasses = $oSet->GetFilter()->GetSelectedClasses();
  1022. $aAuthorizedClasses = array();
  1023. foreach($aClasses as $sAlias => $sClassName)
  1024. {
  1025. if (UserRights::IsActionAllowed($sClassName, UR_ACTION_READ, $oSet) && (UR_ALLOWED_YES || UR_ALLOWED_DEPENDS))
  1026. {
  1027. $aAuthorizedClasses[$sAlias] = $sClassName;
  1028. }
  1029. }
  1030. $aAttribs = array();
  1031. $aHeader = array();
  1032. foreach($aAuthorizedClasses as $sAlias => $sClassName)
  1033. {
  1034. $aList[$sAlias] = array();
  1035. foreach(MetaModel::ListAttributeDefs($sClassName) as $sAttCode => $oAttDef)
  1036. {
  1037. if (is_null($aFields) || (count($aFields) == 0))
  1038. {
  1039. // Standard list of attributes (no link sets)
  1040. if ($oAttDef->IsScalar() && ($oAttDef->IsWritable() || $oAttDef->IsExternalField()))
  1041. {
  1042. $sAttCodeEx = $oAttDef->IsExternalField() ? $oAttDef->GetKeyAttCode().'->'.$oAttDef->GetExtAttCode() : $sAttCode;
  1043. $aList[$sAlias][$sAttCodeEx] = $oAttDef;
  1044. if ($bFieldsAdvanced && $oAttDef->IsExternalKey(EXTKEY_RELATIVE))
  1045. {
  1046. $sRemoteClass = $oAttDef->GetTargetClass();
  1047. foreach(MetaModel::GetReconcKeys($sRemoteClass) as $sRemoteAttCode)
  1048. {
  1049. $aList[$sAlias][$sAttCode.'->'.$sRemoteAttCode] = MetaModel::GetAttributeDef($sRemoteClass, $sRemoteAttCode);
  1050. }
  1051. }
  1052. }
  1053. }
  1054. else
  1055. {
  1056. // User defined list of attributes
  1057. if (in_array($sAttCode, $aFields) || in_array($sAlias.'.'.$sAttCode, $aFields))
  1058. {
  1059. $aList[$sAlias][$sAttCode] = $oAttDef;
  1060. }
  1061. }
  1062. }
  1063. // Replace external key by the corresponding friendly name (if not already in the list)
  1064. foreach($aList[$sAlias] as $sAttCode => $oAttDef)
  1065. {
  1066. if ($oAttDef->IsExternalKey())
  1067. {
  1068. unset($aList[$sAlias][$sAttCode]);
  1069. $sFriendlyNameAttCode = $sAttCode.'_friendlyname';
  1070. if (!array_key_exists($sFriendlyNameAttCode, $aList[$sAlias]) && MetaModel::IsValidAttCode($sClassName, $sFriendlyNameAttCode))
  1071. {
  1072. $oFriendlyNameAtt = MetaModel::GetAttributeDef($sClassName, $sFriendlyNameAttCode);
  1073. $aList[$sAlias][$sFriendlyNameAttCode] = $oFriendlyNameAtt;
  1074. }
  1075. }
  1076. }
  1077. foreach($aList[$sAlias] as $sAttCodeEx => $oAttDef)
  1078. {
  1079. $sColLabel = $bLocalize ? MetaModel::GetLabel($sClassName, $sAttCodeEx) : $sAttCodeEx;
  1080. $oFinalAttDef = $oAttDef->GetFinalAttDef();
  1081. if (get_class($oFinalAttDef) == 'AttributeDateTime')
  1082. {
  1083. $aHeader[] = $sColLabel.' ('.Dict::S('UI:SplitDateTime-Date').')';
  1084. $aHeader[] = $sColLabel.' ('.Dict::S('UI:SplitDateTime-Time').')';
  1085. }
  1086. else
  1087. {
  1088. $aHeader[] = $sColLabel;
  1089. }
  1090. }
  1091. }
  1092. $sHtml = "<table border=\"1\">\n";
  1093. $sHtml .= "<tr>\n";
  1094. $sHtml .= "<td>".implode("</td><td>", $aHeader)."</td>\n";
  1095. $sHtml .= "</tr>\n";
  1096. $oSet->Seek(0);
  1097. while ($aObjects = $oSet->FetchAssoc())
  1098. {
  1099. $aRow = array();
  1100. foreach($aAuthorizedClasses as $sAlias => $sClassName)
  1101. {
  1102. $oObj = $aObjects[$sAlias];
  1103. foreach($aList[$sAlias] as $sAttCodeEx => $oAttDef)
  1104. {
  1105. if (is_null($oObj))
  1106. {
  1107. $aRow[] = '<td></td>';
  1108. }
  1109. else
  1110. {
  1111. $oFinalAttDef = $oAttDef->GetFinalAttDef();
  1112. if (get_class($oFinalAttDef) == 'AttributeDateTime')
  1113. {
  1114. $sDate = $oObj->Get($sAttCodeEx);
  1115. if ($sDate === null)
  1116. {
  1117. $aRow[] = '<td></td>';
  1118. $aRow[] = '<td></td>';
  1119. }
  1120. else
  1121. {
  1122. $iDate = AttributeDateTime::GetAsUnixSeconds($sDate);
  1123. $aRow[] = '<td>'.date('Y-m-d', $iDate).'</td>';
  1124. $aRow[] = '<td>'.date('H:i:s', $iDate).'</td>';
  1125. }
  1126. }
  1127. else
  1128. {
  1129. $rawValue = $oObj->Get($sAttCodeEx);
  1130. if ($oAttDef instanceof AttributeFriendlyName)
  1131. {
  1132. $sKeyAttCode = $oAttDef->GetKeyAttCode();
  1133. if ($oObj->Get($sKeyAttCode) == 0)
  1134. {
  1135. $rawValue = '';
  1136. }
  1137. }
  1138. if ($bLocalize)
  1139. {
  1140. $outputValue = htmlentities($oFinalAttDef->GetEditValue($rawValue), ENT_QUOTES, 'UTF-8');
  1141. }
  1142. else
  1143. {
  1144. $outputValue = htmlentities($rawValue, ENT_QUOTES, 'UTF-8');
  1145. }
  1146. $aRow[] = '<td>'.$outputValue.'</td>';
  1147. }
  1148. }
  1149. }
  1150. }
  1151. $sHtml .= implode("\n", $aRow);
  1152. $sHtml .= "</tr>\n";
  1153. }
  1154. $sHtml .= "</table>\n";
  1155. return $sHtml;
  1156. }
  1157. static function DisplaySetAsXML(WebPage $oPage, CMDBObjectSet $oSet, $aParams = array())
  1158. {
  1159. $bLocalize = true;
  1160. if (isset($aParams['localize_values']))
  1161. {
  1162. $bLocalize = (bool) $aParams['localize_values'];
  1163. }
  1164. $oAppContext = new ApplicationContext();
  1165. $aClasses = $oSet->GetFilter()->GetSelectedClasses();
  1166. $aAuthorizedClasses = array();
  1167. foreach($aClasses as $sAlias => $sClassName)
  1168. {
  1169. if (UserRights::IsActionAllowed($sClassName, UR_ACTION_READ, $oSet) && (UR_ALLOWED_YES || UR_ALLOWED_DEPENDS))
  1170. {
  1171. $aAuthorizedClasses[$sAlias] = $sClassName;
  1172. }
  1173. }
  1174. $aAttribs = array();
  1175. $aList = array();
  1176. $aList[$sAlias] = MetaModel::GetZListItems($sClassName, 'details');
  1177. $oPage->add("<Set>\n");
  1178. $oSet->Seek(0);
  1179. while ($aObjects = $oSet->FetchAssoc())
  1180. {
  1181. if (count($aAuthorizedClasses) > 1)
  1182. {
  1183. $oPage->add("<Row>\n");
  1184. }
  1185. foreach($aAuthorizedClasses as $sAlias => $sClassName)
  1186. {
  1187. $oObj = $aObjects[$sAlias];
  1188. if (is_null($oObj))
  1189. {
  1190. $oPage->add("<$sClassName alias=\"$sAlias\" id=\"null\">\n");
  1191. }
  1192. else
  1193. {
  1194. $sClassName = get_class($oObj);
  1195. $oPage->add("<$sClassName alias=\"$sAlias\" id=\"".$oObj->GetKey()."\">\n");
  1196. }
  1197. foreach(MetaModel::ListAttributeDefs($sClassName) as $sAttCode=>$oAttDef)
  1198. {
  1199. if (is_null($oObj))
  1200. {
  1201. $oPage->add("<$sAttCode>null</$sAttCode>\n");
  1202. }
  1203. else
  1204. {
  1205. if ($oAttDef->IsWritable())
  1206. {
  1207. if (!$oAttDef->IsLinkSet())
  1208. {
  1209. $sValue = $oObj->GetAsXML($sAttCode, $bLocalize);
  1210. $oPage->add("<$sAttCode>$sValue</$sAttCode>\n");
  1211. }
  1212. }
  1213. }
  1214. }
  1215. $oPage->add("</$sClassName>\n");
  1216. }
  1217. if (count($aAuthorizedClasses) > 1)
  1218. {
  1219. $oPage->add("</Row>\n");
  1220. }
  1221. }
  1222. $oPage->add("</Set>\n");
  1223. }
  1224. public static function DisplaySearchForm(WebPage $oPage, CMDBObjectSet $oSet, $aExtraParams = array())
  1225. {
  1226. $oPage->add(self::GetSearchForm($oPage, $oSet, $aExtraParams));
  1227. }
  1228. public static function GetSearchForm(WebPage $oPage, CMDBObjectSet $oSet, $aExtraParams = array())
  1229. {
  1230. static $iSearchFormId = 0;
  1231. $bMultiSelect = false;
  1232. $oAppContext = new ApplicationContext();
  1233. $sHtml = '';
  1234. $numCols=4;
  1235. $sClassName = $oSet->GetFilter()->GetClass();
  1236. // Romain: temporarily removed the tab "OQL query" because it was not finalized
  1237. // (especially when used to add a link)
  1238. /*
  1239. $sHtml .= "<div class=\"mini_tabs\" id=\"mini_tabs{$iSearchFormId}\"><ul>
  1240. <li><a href=\"#\" onClick=\"$('div.mini_tab{$iSearchFormId}').toggle();$('#mini_tabs{$iSearchFormId} ul li a').toggleClass('selected');\">".Dict::S('UI:OQLQueryTab')."</a></li>
  1241. <li><a class=\"selected\" href=\"#\" onClick=\"$('div.mini_tab{$iSearchFormId}').toggle();$('#mini_tabs{$iSearchFormId} ul li a').toggleClass('selected');\">".Dict::S('UI:SimpleSearchTab')."</a></li>
  1242. </ul></div>\n";
  1243. */
  1244. // Simple search form
  1245. if (isset($aExtraParams['currentId']))
  1246. {
  1247. $sSearchFormId = $aExtraParams['currentId'];
  1248. }
  1249. else
  1250. {
  1251. $iSearchFormId = $oPage->GetUniqueId();
  1252. $sSearchFormId = 'SimpleSearchForm'.$iSearchFormId;
  1253. $sHtml .= "<div id=\"ds_$sSearchFormId\" class=\"mini_tab{$iSearchFormId}\">\n";
  1254. }
  1255. // Check if the current class has some sub-classes
  1256. if (isset($aExtraParams['baseClass']))
  1257. {
  1258. $sRootClass = $aExtraParams['baseClass'];
  1259. }
  1260. else
  1261. {
  1262. $sRootClass = $sClassName;
  1263. }
  1264. $aSubClasses = MetaModel::GetSubclasses($sRootClass);
  1265. if (count($aSubClasses) > 0)
  1266. {
  1267. $aOptions = array();
  1268. $aOptions[MetaModel::GetName($sRootClass)] = "<option value=\"$sRootClass\">".MetaModel::GetName($sRootClass)."</options>\n";
  1269. foreach($aSubClasses as $sSubclassName)
  1270. {
  1271. $aOptions[MetaModel::GetName($sSubclassName)] = "<option value=\"$sSubclassName\">".MetaModel::GetName($sSubclassName)."</options>\n";
  1272. }
  1273. $aOptions[MetaModel::GetName($sClassName)] = "<option selected value=\"$sClassName\">".MetaModel::GetName($sClassName)."</options>\n";
  1274. ksort($aOptions);
  1275. $sContext = $oAppContext->GetForLink();
  1276. $sClassesCombo = "<select name=\"class\" onChange=\"ReloadSearchForm('$sSearchFormId', this.value, '$sRootClass', '$sContext')\">\n".implode('', $aOptions)."</select>\n";
  1277. }
  1278. else
  1279. {
  1280. $sClassesCombo = MetaModel::GetName($sClassName);
  1281. }
  1282. $oUnlimitedFilter = new DBObjectSearch($sClassName);
  1283. $sAction = (isset($aExtraParams['action'])) ? $aExtraParams['action'] : utils::GetAbsoluteUrlAppRoot().'pages/UI.php';
  1284. $sHtml .= "<form id=\"fs_{$sSearchFormId}\" action=\"{$sAction}\">\n"; // Don't use $_SERVER['SCRIPT_NAME'] since the form may be called asynchronously (from ajax.php)
  1285. $sHtml .= "<h2>".Dict::Format('UI:SearchFor_Class_Objects', $sClassesCombo)."</h2>\n";
  1286. $index = 0;
  1287. $sHtml .= "<p>\n";
  1288. $aFilterCriteria = $oSet->GetFilter()->GetCriteria();
  1289. $aMapCriteria = array();
  1290. foreach($aFilterCriteria as $aCriteria)
  1291. {
  1292. $aMapCriteria[$aCriteria['filtercode']][] = array('value' => $aCriteria['value'], 'opcode' => $aCriteria['opcode']);
  1293. }
  1294. $aList = MetaModel::GetZListItems($sClassName, 'standard_search');
  1295. $aConsts = $oSet->ListConstantFields(); // Some fields are constants based on the query/context
  1296. $sClassAlias = $oSet->GetFilter()->GetClassAlias();
  1297. foreach($aList as $sFilterCode)
  1298. {
  1299. //$oAppContext->Reset($sFilterCode); // Make sure the same parameter will not be passed twice
  1300. $sHtml .= '<span style="white-space: nowrap;padding:5px;display:inline-block;">';
  1301. $sFilterValue = isset($aConsts[$sClassAlias][$sFilterCode]) ? $aConsts[$sClassAlias][$sFilterCode] : '';
  1302. $sFilterValue = utils::ReadParam($sFilterCode, $sFilterValue, false, 'raw_data');
  1303. $sFilterOpCode = null; // Use the default 'loose' OpCode
  1304. if (empty($sFilterValue))
  1305. {
  1306. if (isset($aMapCriteria[$sFilterCode]))
  1307. {
  1308. if (count($aMapCriteria[$sFilterCode]) > 1)
  1309. {
  1310. $sFilterValue = Dict::S('UI:SearchValue:Mixed');
  1311. }
  1312. else
  1313. {
  1314. $sFilterValue = $aMapCriteria[$sFilterCode][0]['value'];
  1315. $sFilterOpCode = $aMapCriteria[$sFilterCode][0]['opcode'];
  1316. }
  1317. if ($sFilterCode != 'company')
  1318. {
  1319. $oUnlimitedFilter->AddCondition($sFilterCode, $sFilterValue, $sFilterOpCode);
  1320. }
  1321. }
  1322. }
  1323. $oAttDef = MetaModel::GetAttributeDef($sClassName, $sFilterCode);
  1324. if ($oAttDef->IsExternalKey())
  1325. {
  1326. $sTargetClass = $oAttDef->GetTargetClass();
  1327. $oSearch = new DBObjectSearch($sTargetClass);
  1328. $oSearch->SetModifierProperty('UserRightsGetSelectFilter', 'bSearchMode', true);
  1329. $oAllowedValues = new DBObjectSet($oSearch);
  1330. $iFieldSize = $oAttDef->GetMaxSize();
  1331. $iMaxComboLength = $oAttDef->GetMaximumComboLength();
  1332. $sHtml .= "<label>".MetaModel::GetFilterLabel($sClassName, $sFilterCode).":</label>&nbsp;";
  1333. $aExtKeyParams = $aExtraParams;
  1334. $aExtKeyParams['iFieldSize'] = $oAttDef->GetMaxSize();
  1335. $aExtKeyParams['iMinChars'] = $oAttDef->GetMinAutoCompleteChars();
  1336. $sHtml .= UIExtKeyWidget::DisplayFromAttCode($oPage, $sFilterCode, $sClassName, $oAttDef->GetLabel(), $oAllowedValues, $sFilterValue, $sSearchFormId.'search_'.$sFilterCode, false, $sFilterCode, '', $aExtKeyParams, true);
  1337. }
  1338. else
  1339. {
  1340. $aAllowedValues = MetaModel::GetAllowedValues_flt($sClassName, $sFilterCode, $aExtraParams);
  1341. if (is_null($aAllowedValues))
  1342. {
  1343. // Any value is possible, display an input box
  1344. $sHtml .= "<label>".MetaModel::GetFilterLabel($sClassName, $sFilterCode).":</label>&nbsp;<input class=\"textSearch\" name=\"$sFilterCode\" value=\"".htmlentities($sFilterValue, ENT_QUOTES, 'utf-8')."\"/>\n";
  1345. }
  1346. else
  1347. {
  1348. //Enum field, display a multi-select combo
  1349. $sValue = "<select class=\"multiselect\" size=\"1\" name=\"{$sFilterCode}[]\" multiple>\n";
  1350. $bMultiSelect = true;
  1351. //$sValue .= "<option value=\"\">".Dict::S('UI:SearchValue:Any')."</option>\n";
  1352. foreach($aAllowedValues as $key => $value)
  1353. {
  1354. if (is_array($sFilterValue) && in_array($key, $sFilterValue))
  1355. {
  1356. $sSelected = ' selected';
  1357. }
  1358. else if ($sFilterValue == $key)
  1359. {
  1360. $sSelected = ' selected';
  1361. }
  1362. else
  1363. {
  1364. $sSelected = '';
  1365. }
  1366. $sValue .= "<option value=\"$key\"$sSelected>$value</option>\n";
  1367. }
  1368. $sValue .= "</select>\n";
  1369. $sHtml .= "<label>".MetaModel::GetFilterLabel($sClassName, $sFilterCode).":</label>&nbsp;$sValue\n";
  1370. }
  1371. }
  1372. unset($aExtraParams[$sFilterCode]);
  1373. // Finally, add a tooltip if one is defined for this attribute definition
  1374. $sTip = $oAttDef->GetHelpOnSmartSearch();
  1375. if (strlen($sTip) > 0)
  1376. {
  1377. $sTip = addslashes($sTip);
  1378. $sTip = str_replace(array("\n", "\r"), " ", $sTip);
  1379. // :input does represent in form visible input (INPUT, SELECT, TEXTAREA)
  1380. $oPage->add_ready_script("$('form#fs_$sSearchFormId :input[name={$sFilterCode}]').qtip( { content: '$sTip', show: 'mouseover', hide: 'mouseout', style: { name: 'dark', tip: 'leftTop' }, position: { corner: { target: 'rightMiddle', tooltip: 'leftTop' }} } );");
  1381. }
  1382. $index++;
  1383. $sHtml .= '</span> ';
  1384. }
  1385. $sHtml .= "</p>\n";
  1386. $sHtml .= "<p align=\"right\"><input type=\"submit\" value=\"".Dict::S('UI:Button:Search')."\"></p>\n";
  1387. if (isset($aExtraParams['table_id']))
  1388. {
  1389. // Rename to avoid collisions...
  1390. $aExtraParams['_table_id_'] = $aExtraParams['table_id'];
  1391. unset($aExtraParams['table_id']);
  1392. }
  1393. foreach($aExtraParams as $sName => $sValue)
  1394. {
  1395. $sHtml .= "<input type=\"hidden\" name=\"$sName\" value=\"$sValue\" />\n";
  1396. }
  1397. $sHtml .= "<input type=\"hidden\" name=\"class\" value=\"$sClassName\" />\n";
  1398. $sHtml .= "<input type=\"hidden\" name=\"dosearch\" value=\"1\" />\n";
  1399. $sHtml .= "<input type=\"hidden\" name=\"operation\" value=\"search_form\" />\n";
  1400. $sHtml .= $oAppContext->GetForForm();
  1401. $sHtml .= "</form>\n";
  1402. if (!isset($aExtraParams['currentId']))
  1403. {
  1404. $sHtml .= "</div><!-- Simple search form -->\n";
  1405. }
  1406. if ($bMultiSelect)
  1407. {
  1408. $oPage->add_ready_script("$('.multiselect').multiselect({header: false, noneSelectedText: '".addslashes(Dict::S('UI:SearchValue:Any'))."', selectedList: 1, selectedText:'".addslashes(Dict::S('UI:SearchValue:NbSelected'))."'});");
  1409. }
  1410. /*
  1411. // OQL query builder
  1412. $sHtml .= "<div id=\"OQLQuery{$iSearchFormId}\" style=\"display:none\" class=\"mini_tab{$iSearchFormId}\">\n";
  1413. $sHtml .= "<h1>".Dict::S('UI:OQLQueryBuilderTitle')."</h1>\n";
  1414. $sHtml .= "<form id=\"formOQL{$iSearchFormId}\"><table style=\"width:80%;\"><tr style=\"vertical-align:top\">\n";
  1415. $sHtml .= "<td style=\"text-align:right\"><label>SELECT&nbsp;</label><select name=\"oql_class\">";
  1416. $aClasses = MetaModel::EnumChildClasses($sClassName, ENUM_CHILD_CLASSES_ALL);
  1417. $sSelectedClass = utils::ReadParam('oql_class', $sClassName, false, 'class');
  1418. $sOQLClause = utils::ReadParam('oql_clause', '', false, 'raw_data');
  1419. asort($aClasses);
  1420. foreach($aClasses as $sChildClass)
  1421. {
  1422. $sSelected = ($sChildClass == $sSelectedClass) ? 'selected' : '';
  1423. $sHtml.= "<option value=\"$sChildClass\" $sSelected>".MetaModel::GetName($sChildClass)."</option>\n";
  1424. }
  1425. $sHtml .= "</select>&nbsp;</td><td>\n";
  1426. $sHtml .= "<textarea name=\"oql_clause\" style=\"width:100%\">$sOQLClause</textarea></td></tr>\n";
  1427. $sHtml .= "<tr><td colspan=\"2\" style=\"text-align:right\"><input type=\"submit\" value=\"".Dict::S('UI:Button:Query')."\"></td></tr>\n";
  1428. $sHtml .= "<input type=\"hidden\" name=\"dosearch\" value=\"1\" />\n";
  1429. foreach($aExtraParams as $sName => $sValue)
  1430. {
  1431. $sHtml .= "<input type=\"hidden\" name=\"$sName\" value=\"$sValue\" />\n";
  1432. }
  1433. $sHtml .= "<input type=\"hidden\" name=\"operation\" value=\"search_oql\" />\n";
  1434. $sHtml .= $oAppContext->GetForForm();
  1435. $sHtml .= "</table></form>\n";
  1436. $sHtml .= "</div><!-- OQL query form -->\n";
  1437. */
  1438. return $sHtml;
  1439. }
  1440. public static function GetFormElementForField($oPage, $sClass, $sAttCode, $oAttDef, $value = '', $sDisplayValue = '', $iId = '', $sNameSuffix = '', $iFlags = 0, $aArgs = array())
  1441. {
  1442. static $iInputId = 0;
  1443. $sFieldPrefix = '';
  1444. $sFormPrefix = isset($aArgs['formPrefix']) ? $aArgs['formPrefix'] : '';
  1445. $sFieldPrefix = isset($aArgs['prefix']) ? $sFormPrefix.$aArgs['prefix'] : $sFormPrefix;
  1446. if ($sDisplayValue == '')
  1447. {
  1448. $sDisplayValue = $value;
  1449. }
  1450. if (isset($aArgs[$sAttCode]) && empty($value))
  1451. {
  1452. // default value passed by the context (either the app context of the operation)
  1453. $value = $aArgs[$sAttCode];
  1454. }
  1455. if (!empty($iId))
  1456. {
  1457. $iInputId = $iId;
  1458. }
  1459. else
  1460. {
  1461. $iInputId = $oPage->GetUniqueId();
  1462. }
  1463. if (!$oAttDef->IsExternalField())
  1464. {
  1465. $bMandatory = 'false';
  1466. if ( (!$oAttDef->IsNullAllowed()) || ($iFlags & OPT_ATT_MANDATORY))
  1467. {
  1468. $bMandatory = 'true';
  1469. }
  1470. $sValidationField = "<span class=\"form_validation\" id=\"v_{$iId}\"></span>";
  1471. $sHelpText = $oAttDef->GetHelpOnEdition();
  1472. $aEventsList = array();
  1473. switch($oAttDef->GetEditClass())
  1474. {
  1475. case 'Date':
  1476. $aEventsList[] ='validate';
  1477. $aEventsList[] ='keyup';
  1478. $aEventsList[] ='change';
  1479. if (($iFlags & OPT_ATT_MANDATORY) && (empty($sDisplayValue)))
  1480. {
  1481. $sDisplayValue = date($oAttDef->GetDateFormat());
  1482. }
  1483. $sHTMLValue = "<input title=\"$sHelpText\" class=\"date-pick\" type=\"text\" size=\"12\" name=\"attr_{$sFieldPrefix}{$sAttCode}{$sNameSuffix}\" value=\"".htmlentities($sDisplayValue, ENT_QUOTES, 'UTF-8')."\" id=\"$iId\"/>&nbsp;{$sValidationField}";
  1484. break;
  1485. case 'DateTime':
  1486. $aEventsList[] ='validate';
  1487. $aEventsList[] ='keyup';
  1488. $aEventsList[] ='change';
  1489. if (($iFlags & OPT_ATT_MANDATORY) && (empty($sDisplayValue)))
  1490. {
  1491. $sDisplayValue = date($oAttDef->GetDateFormat());
  1492. }
  1493. $sHTMLValue = "<input title=\"$sHelpText\" class=\"datetime-pick\" type=\"text\" size=\"20\" name=\"attr_{$sFieldPrefix}{$sAttCode}{$sNameSuffix}\" value=\"".htmlentities($sDisplayValue, ENT_QUOTES, 'UTF-8')."\" id=\"$iId\"/>&nbsp;{$sValidationField}";
  1494. break;
  1495. case 'Duration':
  1496. $aEventsList[] ='validate';
  1497. $aEventsList[] ='change';
  1498. $oPage->add_ready_script("$('#{$iId}_d').bind('keyup change', function(evt, sFormId) { return UpdateDuration('$iId'); });");
  1499. $oPage->add_ready_script("$('#{$iId}_h').bind('keyup change', function(evt, sFormId) { return UpdateDuration('$iId'); });");
  1500. $oPage->add_ready_script("$('#{$iId}_m').bind('keyup change', function(evt, sFormId) { return UpdateDuration('$iId'); });");
  1501. $oPage->add_ready_script("$('#{$iId}_s').bind('keyup change', function(evt, sFormId) { return UpdateDuration('$iId'); });");
  1502. $aVal = AttributeDuration::SplitDuration($value);
  1503. $sDays = "<input title=\"$sHelpText\" type=\"text\" style=\"text-align:right\" size=\"3\" name=\"attr_{$sFieldPrefix}{$sAttCode}[d]{$sNameSuffix}\" value=\"{$aVal['days']}\" id=\"{$iId}_d\"/>";
  1504. $sHours = "<input title=\"$sHelpText\" type=\"text\" style=\"text-align:right\" size=\"2\" name=\"attr_{$sFieldPrefix}{$sAttCode}[h]{$sNameSuffix}\" value=\"{$aVal['hours']}\" id=\"{$iId}_h\"/>";
  1505. $sMinutes = "<input title=\"$sHelpText\" type=\"text\" style=\"text-align:right\" size=\"2\" name=\"attr_{$sFieldPrefix}{$sAttCode}[m]{$sNameSuffix}\" value=\"{$aVal['minutes']}\" id=\"{$iId}_m\"/>";
  1506. $sSeconds = "<input title=\"$sHelpText\" type=\"text\" style=\"text-align:right\" size=\"2\" name=\"attr_{$sFieldPrefix}{$sAttCode}[s]{$sNameSuffix}\" value=\"{$aVal['seconds']}\" id=\"{$iId}_s\"/>";
  1507. $sHidden = "<input type=\"hidden\" id=\"{$iId}\" value=\"".htmlentities($value, ENT_QUOTES, 'UTF-8')."\"/>";
  1508. $sHTMLValue = Dict::Format('UI:DurationForm_Days_Hours_Minutes_Seconds', $sDays, $sHours, $sMinutes, $sSeconds).$sHidden."&nbsp;".$sValidationField;
  1509. $oPage->add_ready_script("$('#{$iId}').bind('update', function(evt, sFormId) { return ToggleDurationField('$iId'); });");
  1510. break;
  1511. case 'Password':
  1512. $aEventsList[] ='validate';
  1513. $aEventsList[] ='keyup';
  1514. $aEventsList[] ='change';
  1515. $sHTMLValue = "<input title=\"$sHelpText\" type=\"password\" size=\"30\" name=\"attr_{$sFieldPrefix}{$sAttCode}{$sNameSuffix}\" value=\"".htmlentities($value, ENT_QUOTES, 'UTF-8')."\" id=\"$iId\"/>&nbsp;{$sValidationField}";
  1516. break;
  1517. case 'OQLExpression':
  1518. case 'Text':
  1519. $aEventsList[] ='validate';
  1520. $aEventsList[] ='keyup';
  1521. $aEventsList[] ='change';
  1522. $sEditValue = $oAttDef->GetEditValue($value);
  1523. $aStyles = array();
  1524. $sStyle = '';
  1525. $sWidth = $oAttDef->GetWidth('width', '');
  1526. if (!empty($sWidth))
  1527. {
  1528. $aStyles[] = 'width:'.$sWidth;
  1529. }
  1530. $sHeight = $oAttDef->GetHeight('height', '');
  1531. if (!empty($sHeight))
  1532. {
  1533. $aStyles[] = 'height:'.$sHeight;
  1534. }
  1535. if (count($aStyles) > 0)
  1536. {
  1537. $sStyle = 'style="'.implode('; ', $aStyles).'"';
  1538. }
  1539. if ($oAttDef->GetEditClass() == 'OQLExpression')
  1540. {
  1541. $sTestResId = 'query_res_'.$sFieldPrefix.$sAttCode.$sNameSuffix; //$oPage->GetUniqueId();
  1542. $sBaseUrl = utils::GetAbsoluteUrlAppRoot().'pages/run_query.php?expression=';
  1543. $sInitialUrl = $sBaseUrl.urlencode($sEditValue);
  1544. $sAdditionalStuff = "<a id=\"$sTestResId\" target=\"_blank\" href=\"$sInitialUrl\">".Dict::S('UI:Edit:TestQuery')."</a>";
  1545. $oPage->add_ready_script("$('#$iId').bind('change keyup', function(evt, sFormId) { $('#$sTestResId').attr('href', '$sBaseUrl'+encodeURIComponent($(this).val())); } );");
  1546. }
  1547. else
  1548. {
  1549. $sAdditionalStuff = "";
  1550. }
  1551. // Ok, the text area is drawn here
  1552. $sHTMLValue = "<table><tr><td><textarea class=\"resizable\" title=\"$sHelpText\" name=\"attr_{$sFieldPrefix}{$sAttCode}{$sNameSuffix}\" rows=\"8\" cols=\"40\" id=\"$iId\" $sStyle>".htmlentities($sEditValue, ENT_QUOTES, 'UTF-8')."</textarea>$sAdditionalStuff</td><td>{$sValidationField}</td></tr></table>";
  1553. break;
  1554. case 'CaseLog':
  1555. $aStyles = array();
  1556. $sStyle = '';
  1557. $sWidth = $oAttDef->GetWidth('width', '');
  1558. if (!empty($sWidth))
  1559. {
  1560. $aStyles[] = 'width:'.$sWidth;
  1561. }
  1562. $sHeight = $oAttDef->GetHeight('height', '');
  1563. if (!empty($sHeight))
  1564. {
  1565. $aStyles[] = 'height:'.$sHeight;
  1566. }
  1567. if (count($aStyles) > 0)
  1568. {
  1569. $sStyle = 'style="'.implode('; ', $aStyles).'"';
  1570. }
  1571. $sHeader = '<div class="caselog_input_header">&nbsp;'.Dict::S('UI:CaseLogTypeYourTextHere').'</div>';
  1572. $sEditValue = $oAttDef->GetEditValue($value);
  1573. $sPreviousLog = is_object($value) ? $value->GetAsHTML($oPage, true /* bEditMode */, array('AttributeText', 'RenderWikiHtml')) : '';
  1574. $iEntriesCount = is_object($value) ? count($value->GetIndex()) : 0;
  1575. $sHidden = "<input type=\"hidden\" id=\"{$iId}_count\" value=\"$iEntriesCount\"/>"; // To know how many entries the case log already contains
  1576. $sHTMLValue = "<div class=\"caselog\" $sStyle><table style=\"width:100%;\"><tr><td>$sHeader<textarea style=\"border:0;width:100%\" title=\"$sHelpText\" name=\"attr_{$sFieldPrefix}{$sAttCode}{$sNameSuffix}\" rows=\"8\" cols=\"40\" id=\"$iId\">".htmlentities($sEditValue, ENT_QUOTES, 'UTF-8')."</textarea>$sPreviousLog</td><td>{$sValidationField}</td></tr></table>$sHidden</div>";
  1577. $oPage->add_ready_script("$('#$iId').bind('keyup change validate', function(evt, sFormId) { return ValidateCaseLogField('$iId', $bMandatory, sFormId) } );"); // Custom validation function
  1578. break;
  1579. case 'HTML':
  1580. $oWidget = new UIHTMLEditorWidget($iId, $sAttCode, $sNameSuffix, $sFieldPrefix, $sHelpText, $sValidationField, $value, $bMandatory);
  1581. $sHTMLValue = $oWidget->Display($oPage, $aArgs);
  1582. break;
  1583. case 'LinkedSet':
  1584. if ($oAttDef->IsIndirect())
  1585. {
  1586. $oWidget = new UILinksWidget($sClass, $sAttCode, $iId, $sNameSuffix, $oAttDef->DuplicatesAllowed(), $aArgs);
  1587. }
  1588. else
  1589. {
  1590. $oWidget = new UILinksWidgetDirect($sClass, $sAttCode, $iId, $sNameSuffix, $aArgs);
  1591. }
  1592. $aEventsList[] ='validate';
  1593. $aEventsList[] ='change';
  1594. $oObj = isset($aArgs['this']) ? $aArgs['this'] : null;
  1595. $sHTMLValue = $oWidget->Display($oPage, $value, array(), $sFormPrefix, $oObj);
  1596. break;
  1597. case 'Document':
  1598. $aEventsList[] ='validate';
  1599. $aEventsList[] ='change';
  1600. $oDocument = $value; // Value is an ormDocument object
  1601. $sFileName = '';
  1602. if (is_object($oDocument))
  1603. {
  1604. $sFileName = $oDocument->GetFileName();
  1605. }
  1606. $iMaxFileSize = utils::ConvertToBytes(ini_get('upload_max_filesize'));
  1607. $sHTMLValue = "<input type=\"hidden\" name=\"MAX_FILE_SIZE\" value=\"$iMaxFileSize\" />\n";
  1608. $sHTMLValue .= "<input name=\"attr_{$sFieldPrefix}{$sAttCode}{$sNameSuffix}[filename]\" type=\"hidden\" id=\"$iId\" \" value=\"".htmlentities($sFileName, ENT_QUOTES, 'UTF-8')."\"/>\n";
  1609. $sHTMLValue .= "<span id=\"name_$iInputId\">$sFileName</span><br/>\n";
  1610. $sHTMLValue .= "<input title=\"$sHelpText\" name=\"attr_{$sFieldPrefix}{$sAttCode}{$sNameSuffix}[fcontents]\" type=\"file\" id=\"file_$iId\" onChange=\"UpdateFileName('$iId', this.value)\"/>&nbsp;{$sValidationField}\n";
  1611. break;
  1612. case 'StopWatch':
  1613. $sHTMLValue = "The edition of a stopwatch is not allowed!!!";
  1614. break;
  1615. case 'List':
  1616. // Not editable for now...
  1617. $sHTMLValue = '';
  1618. break;
  1619. case 'One Way Password':
  1620. $aEventsList[] ='validate';
  1621. $oWidget = new UIPasswordWidget($sAttCode, $iId, $sNameSuffix);
  1622. $sHTMLValue = $oWidget->Display($oPage, $aArgs);
  1623. // Event list & validation is handled directly by the widget
  1624. break;
  1625. case 'ExtKey':
  1626. $aEventsList[] ='validate';
  1627. $aEventsList[] ='change';
  1628. $oAllowedValues = MetaModel::GetAllowedValuesAsObjectSet($sClass, $sAttCode, $aArgs);
  1629. $sFieldName = $sFieldPrefix.$sAttCode.$sNameSuffix;
  1630. $aExtKeyParams = $aArgs;
  1631. $aExtKeyParams['iFieldSize'] = $oAttDef->GetMaxSize();
  1632. $aExtKeyParams['iMinChars'] = $oAttDef->GetMinAutoCompleteChars();
  1633. $sHTMLValue = UIExtKeyWidget::DisplayFromAttCode($oPage, $sAttCode, $sClass, $oAttDef->GetLabel(), $oAllowedValues, $value, $iId, $bMandatory, $sFieldName, $sFormPrefix, $aExtKeyParams);
  1634. $sHTMLValue .= "<!-- iFlags: $iFlags bMandatory: $bMandatory -->\n";
  1635. break;
  1636. case 'String':
  1637. default:
  1638. $aEventsList[] ='validate';
  1639. // #@# todo - add context information (depending on dimensions)
  1640. $aAllowedValues = MetaModel::GetAllowedValues_att($sClass, $sAttCode, $aArgs);
  1641. $iFieldSize = $oAttDef->GetMaxSize();
  1642. if ($aAllowedValues !== null)
  1643. {
  1644. // Discrete list of values, use a SELECT or RADIO buttons depending on the config
  1645. $sDisplayStyle = $oAttDef->GetDisplayStyle();
  1646. switch($sDisplayStyle)
  1647. {
  1648. case 'radio':
  1649. case 'radio_horizontal':
  1650. case 'radio_vertical':
  1651. $sHTMLValue = '';
  1652. $bVertical = ($sDisplayStyle != 'radio_horizontal');
  1653. $sHTMLValue = $oPage->GetRadioButtons($aAllowedValues, $value, $iId, "attr_{$sFieldPrefix}{$sAttCode}{$sNameSuffix}", $bMandatory, $bVertical, $sValidationField);
  1654. $aEventsList[] ='change';
  1655. break;
  1656. case 'select':
  1657. default:
  1658. $sHTMLValue = "<select title=\"$sHelpText\" name=\"attr_{$sFieldPrefix}{$sAttCode}{$sNameSuffix}\" id=\"$iId\">\n";
  1659. $sHTMLValue .= "<option value=\"\">".Dict::S('UI:SelectOne')."</option>\n";
  1660. foreach($aAllowedValues as $key => $display_value)
  1661. {
  1662. if ((count($aAllowedValues) == 1) && ($bMandatory == 'true') )
  1663. {
  1664. // When there is only once choice, select it by default
  1665. $sSelected = ' selected';
  1666. }
  1667. else
  1668. {
  1669. $sSelected = ($value == $key) ? ' selected' : '';
  1670. }
  1671. $sHTMLValue .= "<option value=\"$key\"$sSelected>$display_value</option>\n";
  1672. }
  1673. $sHTMLValue .= "</select>&nbsp;{$sValidationField}\n";
  1674. $aEventsList[] ='change';
  1675. }
  1676. }
  1677. else
  1678. {
  1679. $sHTMLValue = "<input title=\"$sHelpText\" type=\"text\" size=\"30\" maxlength=\"$iFieldSize\" name=\"attr_{$sFieldPrefix}{$sAttCode}{$sNameSuffix}\" value=\"".htmlentities($sDisplayValue, ENT_QUOTES, 'UTF-8')."\" id=\"$iId\"/>&nbsp;{$sValidationField}";
  1680. $aEventsList[] ='keyup';
  1681. $aEventsList[] ='change';
  1682. }
  1683. break;
  1684. }
  1685. $sPattern = addslashes($oAttDef->GetValidationPattern()); //'^([0-9]+)$';
  1686. if (!empty($aEventsList))
  1687. {
  1688. $sNullValue = $oAttDef->GetNullValue();
  1689. if (!is_numeric($sNullValue))
  1690. {
  1691. $sNullValue = "'$sNullValue'"; // Add quotes to turn this into a JS string if it's not a number
  1692. }
  1693. $oPage->add_ready_script("$('#$iId').bind('".implode(' ', $aEventsList)."', function(evt, sFormId) { return ValidateField('$iId', '$sPattern', $bMandatory, sFormId, $sNullValue) } );\n"); // Bind to a custom event: validate
  1694. }
  1695. $aDependencies = MetaModel::GetDependentAttributes($sClass, $sAttCode); // List of attributes that depend on the current one
  1696. if (count($aDependencies) > 0)
  1697. {
  1698. $oPage->add_ready_script("$('#$iId').bind('change', function(evt, sFormId) { return oWizardHelper{$sFormPrefix}.UpdateDependentFields(['".implode("','", $aDependencies)."']) } );\n"); // Bind to a custom event: validate
  1699. }
  1700. }
  1701. return "<div>{$sHTMLValue}</div>";
  1702. }
  1703. public function DisplayModifyForm(WebPage $oPage, $aExtraParams = array())
  1704. {
  1705. self::$iGlobalFormId++;
  1706. $this->aFieldsMap = array();
  1707. $sPrefix = '';
  1708. if (isset($aExtraParams['formPrefix']))
  1709. {
  1710. $sPrefix = $aExtraParams['formPrefix'];
  1711. }
  1712. $aFieldsComments = (isset($aExtraParams['fieldsComments'])) ? $aExtraParams['fieldsComments'] : array();
  1713. $this->m_iFormId = $sPrefix.self::$iGlobalFormId;
  1714. $sClass = get_class($this);
  1715. $oAppContext = new ApplicationContext();
  1716. $sStateAttCode = MetaModel::GetStateAttributeCode($sClass);
  1717. $iKey = $this->GetKey();
  1718. $aDetails = array();
  1719. $aFieldsMap = array();
  1720. if (!isset($aExtraParams['action']))
  1721. {
  1722. $sFormAction = $_SERVER['SCRIPT_NAME']; // No parameter in the URL, the only parameter will be the ones passed through the form
  1723. }
  1724. else
  1725. {
  1726. $sFormAction = $aExtraParams['action'];
  1727. }
  1728. // Custom label for the apply button ?
  1729. if (isset($aExtraParams['custom_button']))
  1730. {
  1731. $sApplyButton = $aExtraParams['custom_button'];
  1732. }
  1733. else if ($iKey > 0)
  1734. {
  1735. $sApplyButton = Dict::S('UI:Button:Apply');
  1736. }
  1737. else
  1738. {
  1739. $sApplyButton = Dict::S('UI:Button:Create');
  1740. }
  1741. // Custom operation for the form ?
  1742. if (isset($aExtraParams['custom_operation']))
  1743. {
  1744. $sOperation = $aExtraParams['custom_operation'];
  1745. }
  1746. else if ($iKey > 0)
  1747. {
  1748. $sOperation = 'apply_modify';
  1749. }
  1750. else
  1751. {
  1752. $sOperation = 'apply_new';
  1753. }
  1754. if ($iKey > 0)
  1755. {
  1756. // The object already exists in the database, it's a modification
  1757. $sButtons = "<input id=\"{$sPrefix}_id\" type=\"hidden\" name=\"id\" value=\"$iKey\">\n";
  1758. $sButtons .= "<input type=\"hidden\" name=\"operation\" value=\"{$sOperation}\">\n";
  1759. $sButtons .= "<button type=\"button\" class=\"action cancel\"><span>".Dict::S('UI:Button:Cancel')."</span></button>&nbsp;&nbsp;&nbsp;&nbsp;\n";
  1760. $sButtons .= "<button type=\"submit\" class=\"action\"><span>{$sApplyButton}</span></button>\n";
  1761. }
  1762. else
  1763. {
  1764. // The object does not exist in the database it's a creation
  1765. $sButtons = "<input type=\"hidden\" name=\"operation\" value=\"$sOperation\">\n";
  1766. $sButtons .= "<button type=\"button\" class=\"action cancel\">".Dict::S('UI:Button:Cancel')."</button>&nbsp;&nbsp;&nbsp;&nbsp;\n";
  1767. $sButtons .= "<button type=\"submit\" class=\"action\"><span>{$sApplyButton}</span></button>\n";
  1768. }
  1769. $aTransitions = $this->EnumTransitions();
  1770. if (!isset($aExtraParams['custom_operation']) && count($aTransitions))
  1771. {
  1772. // transitions are displayed only for the standard new/modify actions, not for modify_all or any other case...
  1773. $oSetToCheckRights = DBObjectSet::FromObject($this);
  1774. $aStimuli = Metamodel::EnumStimuli($sClass);
  1775. foreach($aTransitions as $sStimulusCode => $aTransitionDef)
  1776. {
  1777. $iActionAllowed = (get_class($aStimuli[$sStimulusCode]) == 'StimulusUserAction') ? UserRights::IsStimulusAllowed($sClass, $sStimulusCode, $oSetToCheckRights) : UR_ALLOWED_NO;
  1778. switch($iActionAllowed)
  1779. {
  1780. case UR_ALLOWED_YES:
  1781. $sButtons .= "<button type=\"submit\" name=\"next_action\" value=\"{$sStimulusCode}\" class=\"action\"><span>".$aStimuli[$sStimulusCode]->GetLabel()."</span></button>\n";
  1782. break;
  1783. default:
  1784. // Do nothing
  1785. }
  1786. }
  1787. }
  1788. $sButtonsPosition = MetaModel::GetConfig()->Get('buttons_position');
  1789. $iTransactionId = isset($aExtraParams['transaction_id']) ? $aExtraParams['transaction_id'] : utils::GetNewTransactionId();
  1790. $oPage->SetTransactionId($iTransactionId);
  1791. $oPage->add("<form action=\"$sFormAction\" id=\"form_{$this->m_iFormId}\" enctype=\"multipart/form-data\" method=\"post\" onSubmit=\"return OnSubmit('form_{$this->m_iFormId}');\">\n");
  1792. $sStatesSelection = '';
  1793. if (!isset($aExtraParams['custom_operation']) && $this->IsNew())
  1794. {
  1795. $aInitialStates = MetaModel::EnumInitialStates($sClass);
  1796. //$aInitialStates = array('new' => 'foo', 'closed' => 'bar');
  1797. if (count($aInitialStates) > 1)
  1798. {
  1799. $sStatesSelection = Dict::Format('UI:Create_Class_InState', MetaModel::GetName($sClass)).'<select name="obj_state" class="state_select_'.$this->m_iFormId.'">';
  1800. foreach($aInitialStates as $sStateCode => $sStateData)
  1801. {
  1802. $sSelected = '';
  1803. if ($sStateCode == $this->GetState())
  1804. {
  1805. $sSelected = ' selected';
  1806. }
  1807. $sStatesSelection .= '<option value="'.$sStateCode.'"'.$sSelected.'>'.MetaModel::GetStateLabel($sClass, $sStateCode).'</option>';
  1808. }
  1809. $sStatesSelection .= '</select>';
  1810. $oPage->add_ready_script("$('.state_select_{$this->m_iFormId}').change( function() { oWizardHelper$sPrefix.ReloadObjectCreationForm('form_{$this->m_iFormId}', $(this).val()); } );");
  1811. }
  1812. }
  1813. $sConfirmationMessage = addslashes(Dict::S('UI:NavigateAwayConfirmationMessage'));
  1814. $oPage->add_ready_script(
  1815. <<<EOF
  1816. $(window).unload(function() { return OnUnload('$iTransactionId') } );
  1817. window.onbeforeunload = function() {
  1818. if (!window.bInSubmit && !window.bInCancel)
  1819. {
  1820. return '$sConfirmationMessage';
  1821. }
  1822. // return nothing ! safer for IE
  1823. };
  1824. EOF
  1825. );
  1826. if ($sButtonsPosition != 'bottom')
  1827. {
  1828. // top or both, display the buttons here
  1829. $oPage->p($sStatesSelection);
  1830. $oPage->add($sButtons);
  1831. }
  1832. $oPage->AddTabContainer(OBJECT_PROPERTIES_TAB, $sPrefix);
  1833. $oPage->SetCurrentTabContainer(OBJECT_PROPERTIES_TAB);
  1834. $oPage->SetCurrentTab(Dict::S('UI:PropertiesTab'));
  1835. $aFieldsMap = $this->DisplayBareProperties($oPage, true, $sPrefix, $aExtraParams);
  1836. if ($iKey > 0)
  1837. {
  1838. $aFieldsMap['id'] = $sPrefix.'_id';
  1839. }
  1840. // Now display the relations, one tab per relation
  1841. if (!isset($aExtraParams['noRelations']))
  1842. {
  1843. $this->DisplayBareRelations($oPage, true); // Edit mode, will fill $this->aFieldsMap
  1844. $aFieldsMap = array_merge($aFieldsMap, $this->aFieldsMap);
  1845. }
  1846. $oPage->SetCurrentTab('');
  1847. $oPage->add("<input type=\"hidden\" name=\"class\" value=\"$sClass\">\n");
  1848. $oPage->add("<input type=\"hidden\" name=\"transaction_id\" value=\"$iTransactionId\">\n");
  1849. foreach($aExtraParams as $sName => $value)
  1850. {
  1851. $oPage->add("<input type=\"hidden\" name=\"$sName\" value=\"$value\">\n");
  1852. }
  1853. $oPage->add($oAppContext->GetForForm());
  1854. if ($sButtonsPosition != 'top')
  1855. {
  1856. // bottom or both: display the buttons here
  1857. $oPage->p($sStatesSelection);
  1858. $oPage->add($sButtons);
  1859. }
  1860. // Hook the cancel button via jQuery so that it can be unhooked easily as well if needed
  1861. $sDefaultUrl = utils::GetAbsoluteUrlAppRoot().'pages/UI.php?operation=cancel&'.$oAppContext->GetForLink();
  1862. $oPage->add_ready_script("$('#form_{$this->m_iFormId} button.cancel').click( function() { BackToDetails('$sClass', $iKey, '$sDefaultUrl')} );");
  1863. $oPage->add("</form>\n");
  1864. $iFieldsCount = count($aFieldsMap);
  1865. $sJsonFieldsMap = json_encode($aFieldsMap);
  1866. $sState = $this->GetState();
  1867. $oPage->add_script(
  1868. <<<EOF
  1869. // Create the object once at the beginning of the page...
  1870. var oWizardHelper$sPrefix = new WizardHelper('$sClass', '$sPrefix', '$sState');
  1871. oWizardHelper$sPrefix.SetFieldsMap($sJsonFieldsMap);
  1872. oWizardHelper$sPrefix.SetFieldsCount($iFieldsCount);
  1873. EOF
  1874. );
  1875. $oPage->add_ready_script(
  1876. <<<EOF
  1877. oWizardHelper$sPrefix.UpdateWizard();
  1878. // Starts the validation when the page is ready
  1879. CheckFields('form_{$this->m_iFormId}', false);
  1880. EOF
  1881. );
  1882. }
  1883. public static function DisplayCreationForm(WebPage $oPage, $sClass, $oObjectToClone = null, $aArgs = array(), $aExtraParams = array())
  1884. {
  1885. $oAppContext = new ApplicationContext();
  1886. $sClass = ($oObjectToClone == null) ? $sClass : get_class($oObjectToClone);
  1887. $sStateAttCode = MetaModel::GetStateAttributeCode($sClass);
  1888. $aStates = MetaModel::EnumStates($sClass);
  1889. $sStatesSelection = '';
  1890. if ($oObjectToClone == null)
  1891. {
  1892. $oObj = MetaModel::NewObject($sClass);
  1893. if (!empty($sStateAttCode))
  1894. {
  1895. $sTargetState = MetaModel::GetDefaultState($sClass);
  1896. $oObj->Set($sStateAttCode, $sTargetState);
  1897. }
  1898. }
  1899. else
  1900. {
  1901. $oObj = clone $oObjectToClone;
  1902. }
  1903. // Pre-fill the object with default values, when there is only on possible choice
  1904. // AND the field is mandatory (otherwise there is always the possiblity to let it empty)
  1905. $aArgs['this'] = $oObj;
  1906. $aDetailsList = self::FLattenZList(MetaModel::GetZListItems($sClass, 'details'));
  1907. // Order the fields based on their dependencies
  1908. $aDeps = array();
  1909. foreach($aDetailsList as $sAttCode)
  1910. {
  1911. $aDeps[$sAttCode] = MetaModel::GetPrequisiteAttributes($sClass, $sAttCode);
  1912. }
  1913. $aList = self::OrderDependentFields($aDeps);
  1914. // Now fill-in the fields with default/supplied values
  1915. foreach($aList as $sAttCode)
  1916. {
  1917. if (isset($aArgs['default'][$sAttCode]))
  1918. {
  1919. $oObj->Set($sAttCode, $aArgs['default'][$sAttCode]);
  1920. }
  1921. else
  1922. {
  1923. $oAttDef = MetaModel::GetAttributeDef($sClass, $sAttCode);
  1924. // If the field is mandatory, set it to the only possible value
  1925. $iFlags = $oObj->GetInitialStateAttributeFlags($sAttCode);
  1926. if ((!$oAttDef->IsNullAllowed()) || ($iFlags & OPT_ATT_MANDATORY))
  1927. {
  1928. if ($oAttDef->IsExternalKey())
  1929. {
  1930. $oAllowedValues = MetaModel::GetAllowedValuesAsObjectSet($sClass, $sAttCode, $aArgs);
  1931. if ($oAllowedValues->Count() == 1)
  1932. {
  1933. $oRemoteObj = $oAllowedValues->Fetch();
  1934. $oObj->Set($sAttCode, $oRemoteObj->GetKey());
  1935. }
  1936. }
  1937. else
  1938. {
  1939. $aAllowedValues = MetaModel::GetAllowedValues_att($sClass, $sAttCode, $aArgs);
  1940. if (count($aAllowedValues) == 1)
  1941. {
  1942. $aValues = array_keys($aAllowedValues);
  1943. $oObj->Set($sAttCode, $aValues[0]);
  1944. }
  1945. }
  1946. }
  1947. }
  1948. }
  1949. return $oObj->DisplayModifyForm( $oPage, $aExtraParams);
  1950. }
  1951. public static function ProcessZlist($aList, $aDetails, $sCurrentTab, $sCurrentCol, $sCurrentSet)
  1952. {
  1953. //echo "<pre>ZList: ";
  1954. //print_r($aList);
  1955. //echo "</pre>\n";
  1956. $index = 0;
  1957. foreach($aList as $sKey => $value)
  1958. {
  1959. if (is_array($value))
  1960. {
  1961. if (preg_match('/^(.*):(.*)$/U', $sKey, $aMatches))
  1962. {
  1963. $sCode = $aMatches[1];
  1964. $sName = $aMatches[2];
  1965. switch($sCode)
  1966. {
  1967. case 'tab':
  1968. //echo "<p>Found a tab: $sName ($sKey)</p>\n";
  1969. if(!isset($aDetails[$sName]))
  1970. {
  1971. $aDetails[$sName] = array('col1' => array());
  1972. }
  1973. $aDetails = self::ProcessZlist($value, $aDetails, $sName, 'col1', '');
  1974. break;
  1975. case 'fieldset':
  1976. //echo "<p>Found a fieldset: $sName ($sKey)</p>\n";
  1977. if(!isset($aDetailsStruct[$sCurrentTab][$sCurrentCol][$sName]))
  1978. {
  1979. $aDetails[$sCurrentTab][$sCurrentCol][$sName] = array();
  1980. }
  1981. $aDetails = self::ProcessZlist($value, $aDetails, $sCurrentTab, $sCurrentCol, $sName);
  1982. break;
  1983. default:
  1984. case 'col':
  1985. //echo "<p>Found a column: $sName ($sKey)</p>\n";
  1986. if(!isset($aDetails[$sCurrentTab][$sName]))
  1987. {
  1988. $aDetails[$sCurrentTab][$sName] = array();
  1989. }
  1990. $aDetails = self::ProcessZlist($value, $aDetails, $sCurrentTab, $sName, '');
  1991. break;
  1992. }
  1993. }
  1994. }
  1995. else
  1996. {
  1997. //echo "<p>Scalar value: $value, in [$sCurrentTab][$sCurrentCol][$sCurrentSet][]</p>\n";
  1998. if (empty($sCurrentSet))
  1999. {
  2000. $aDetails[$sCurrentTab][$sCurrentCol]['_'.$index][] = $value;
  2001. }
  2002. else
  2003. {
  2004. $aDetails[$sCurrentTab][$sCurrentCol][$sCurrentSet][] = $value;
  2005. }
  2006. }
  2007. $index++;
  2008. }
  2009. return $aDetails;
  2010. }
  2011. static function FlattenZList($aList)
  2012. {
  2013. $aResult = array();
  2014. foreach($aList as $value)
  2015. {
  2016. if (!is_array($value))
  2017. {
  2018. $aResult[] = $value;
  2019. }
  2020. else
  2021. {
  2022. $aResult = array_merge($aResult,self::FlattenZList($value));
  2023. }
  2024. }
  2025. return $aResult;
  2026. }
  2027. protected function GetFieldAsHtml($sClass, $sAttCode, $sStateAttCode)
  2028. {
  2029. $retVal = null;
  2030. if ($this->IsNew())
  2031. {
  2032. $iFlags = $this->GetInitialStateAttributeFlags($sAttCode);
  2033. }
  2034. else
  2035. {
  2036. $iFlags = $this->GetAttributeFlags($sAttCode);
  2037. }
  2038. $oAttDef = MetaModel::GetAttributeDef($sClass, $sAttCode);
  2039. if ( (!$oAttDef->IsLinkSet()) && (($iFlags & OPT_ATT_HIDDEN) == 0) )
  2040. {
  2041. // The field is visible in the current state of the object
  2042. if ($sStateAttCode == $sAttCode)
  2043. {
  2044. // Special display for the 'state' attribute itself
  2045. $sDisplayValue = $this->GetStateLabel();
  2046. }
  2047. else if ($oAttDef->GetEditClass() == 'Document')
  2048. {
  2049. $oDocument = $this->Get($sAttCode);
  2050. $sDisplayValue = $this->GetAsHTML($sAttCode);
  2051. $sDisplayValue .= "<br/>".Dict::Format('UI:OpenDocumentInNewWindow_', $oDocument->GetDisplayLink(get_class($this), $this->GetKey(), $sAttCode)).", \n";
  2052. $sDisplayValue .= "<br/>".Dict::Format('UI:DownloadDocument_', $oDocument->GetDownloadLink(get_class($this), $this->GetKey(), $sAttCode)).", \n";
  2053. }
  2054. else
  2055. {
  2056. $sDisplayValue = $this->GetAsHTML($sAttCode);
  2057. }
  2058. $retVal = array('label' => '<span title="'.MetaModel::GetDescription($sClass, $sAttCode).'">'.MetaModel::GetLabel($sClass, $sAttCode).'</span>', 'value' => $sDisplayValue);
  2059. }
  2060. return $retVal;
  2061. }
  2062. /**
  2063. * Displays a blob document *inline* (if possible, depending on the type of the document)
  2064. * @return string
  2065. */
  2066. public function DisplayDocumentInline(WebPage $oPage, $sAttCode)
  2067. {
  2068. $oDoc = $this->Get($sAttCode);
  2069. $sClass = get_class($this);
  2070. $Id = $this->GetKey();
  2071. switch ($oDoc->GetMainMimeType())
  2072. {
  2073. case 'text':
  2074. case 'html':
  2075. $data = $oDoc->GetData();
  2076. switch($oDoc->GetMimeType())
  2077. {
  2078. case 'text/html':
  2079. case 'text/xml':
  2080. $oPage->add("<iframe id='preview_$sAttCode' src=\"".utils::GetAbsoluteUrlAppRoot()."pages/ajax.render.php?operation=display_document&class=$sClass&id=$Id&field=$sAttCode\" width=\"100%\" height=\"400\">Loading...</iframe>\n");
  2081. break;
  2082. default:
  2083. $oPage->add("<pre>".htmlentities(MyHelpers::beautifulstr($data, 1000, true), ENT_QUOTES, 'UTF-8')."</pre>\n");
  2084. }
  2085. break;
  2086. case 'application':
  2087. switch($oDoc->GetMimeType())
  2088. {
  2089. case 'application/pdf':
  2090. $oPage->add("<iframe id='preview_$sAttCode' src=\"".utils::GetAbsoluteUrlAppRoot()."pages/ajax.render.php?operation=display_document&class=$sClass&id=$Id&field=$sAttCode\" width=\"100%\" height=\"400\">Loading...</iframe>\n");
  2091. break;
  2092. default:
  2093. $oPage->add(Dict::S('UI:Document:NoPreview'));
  2094. }
  2095. break;
  2096. case 'image':
  2097. $oPage->add("<img src=\"".utils::GetAbsoluteUrlAppRoot()."pages/ajax.render.php?operation=display_document&class=$sClass&id=$Id&field=$sAttCode\" />\n");
  2098. break;
  2099. default:
  2100. $oPage->add(Dict::S('UI:Document:NoPreview'));
  2101. }
  2102. }
  2103. // $m_highlightComparison[previous][new] => next value
  2104. protected static $m_highlightComparison = array(
  2105. HILIGHT_CLASS_CRITICAL => array(
  2106. HILIGHT_CLASS_CRITICAL => HILIGHT_CLASS_CRITICAL,
  2107. HILIGHT_CLASS_WARNING => HILIGHT_CLASS_CRITICAL,
  2108. HILIGHT_CLASS_OK => HILIGHT_CLASS_CRITICAL,
  2109. HILIGHT_CLASS_NONE => HILIGHT_CLASS_CRITICAL,
  2110. ),
  2111. HILIGHT_CLASS_WARNING => array(
  2112. HILIGHT_CLASS_CRITICAL => HILIGHT_CLASS_CRITICAL,
  2113. HILIGHT_CLASS_WARNING => HILIGHT_CLASS_WARNING,
  2114. HILIGHT_CLASS_OK => HILIGHT_CLASS_WARNING,
  2115. HILIGHT_CLASS_NONE => HILIGHT_CLASS_WARNING,
  2116. ),
  2117. HILIGHT_CLASS_OK => array(
  2118. HILIGHT_CLASS_CRITICAL => HILIGHT_CLASS_CRITICAL,
  2119. HILIGHT_CLASS_WARNING => HILIGHT_CLASS_WARNING,
  2120. HILIGHT_CLASS_OK => HILIGHT_CLASS_OK,
  2121. HILIGHT_CLASS_NONE => HILIGHT_CLASS_OK,
  2122. ),
  2123. HILIGHT_CLASS_NONE => array(
  2124. HILIGHT_CLASS_CRITICAL => HILIGHT_CLASS_CRITICAL,
  2125. HILIGHT_CLASS_WARNING => HILIGHT_CLASS_WARNING,
  2126. HILIGHT_CLASS_OK => HILIGHT_CLASS_OK,
  2127. HILIGHT_CLASS_NONE => HILIGHT_CLASS_NONE,
  2128. ),
  2129. );
  2130. /**
  2131. * This function returns a 'hilight' CSS class, used to hilight a given row in a table
  2132. * There are currently (i.e defined in the CSS) 4 possible values HILIGHT_CLASS_CRITICAL,
  2133. * HILIGHT_CLASS_WARNING, HILIGHT_CLASS_OK, HILIGHT_CLASS_NONE
  2134. * To Be overridden by derived classes
  2135. * @param void
  2136. * @return String The desired higlight class for the object/row
  2137. */
  2138. public function GetHilightClass()
  2139. {
  2140. // Possible return values are:
  2141. // HILIGHT_CLASS_CRITICAL, HILIGHT_CLASS_WARNING, HILIGHT_CLASS_OK, HILIGHT_CLASS_NONE
  2142. $current = HILIGHT_CLASS_NONE; // Not hilighted by default
  2143. // Invoke extensions before the deletion (the deletion will do some cleanup and we might loose some information
  2144. foreach (MetaModel::EnumPlugins('iApplicationUIExtension') as $oExtensionInstance)
  2145. {
  2146. $new = $oExtensionInstance->GetHilightClass($this);
  2147. @$current = self::$m_highlightComparison[$current][$new];
  2148. }
  2149. return $current;
  2150. }
  2151. /**
  2152. * Re-order the fields based on their inter-dependencies
  2153. * @params hash @aFields field_code => array_of_depencies
  2154. * @return array Ordered array of fields or throws an exception
  2155. */
  2156. public static function OrderDependentFields($aFields)
  2157. {
  2158. $bCircular = false;
  2159. $aResult = array();
  2160. $iCount = 0;
  2161. do
  2162. {
  2163. $bSet = false;
  2164. $iCount++;
  2165. foreach($aFields as $sFieldCode => $aDeps)
  2166. {
  2167. foreach($aDeps as $key => $sDependency)
  2168. {
  2169. if (in_array($sDependency, $aResult))
  2170. {
  2171. // Dependency is resolved, remove it
  2172. unset($aFields[$sFieldCode][$key]);
  2173. }
  2174. }
  2175. if (count($aFields[$sFieldCode]) == 0)
  2176. {
  2177. // No more pending depencies for this field, add it to the list
  2178. $aResult[] = $sFieldCode;
  2179. unset($aFields[$sFieldCode]);
  2180. $bSet = true;
  2181. }
  2182. }
  2183. }
  2184. while($bSet && (count($aFields) > 0));
  2185. if (count($aFields) > 0)
  2186. {
  2187. $sMessage = "Error: Circular dependencies between the fields (or field missing in ZList) ! <pre>".print_r($aFields, true)."</pre>";
  2188. throw(new Exception($sMessage));
  2189. }
  2190. return $aResult;
  2191. }
  2192. /**
  2193. * Get the list of actions to be displayed as 'shortcuts' (i.e buttons) instead of inside the Actions popup menu
  2194. * @param $sFinalClass string The actual class of the objects for which to display the menu
  2195. * @return Array the list of menu codes (i.e dictionary entries) that can be displayed as shortcuts next to the actions menu
  2196. */
  2197. public static function GetShortcutActions($sFinalClass)
  2198. {
  2199. $sShortcutActions = MetaModel::GetConfig()->Get('shortcut_actions');
  2200. $aShortcutActions = explode(',', $sShortcutActions);
  2201. return $aShortcutActions;
  2202. }
  2203. /**
  2204. * Maps the given context parameter name to the appropriate filter/search code for this class
  2205. * @param string $sContextParam Name of the context parameter, i.e. 'org_id'
  2206. * @return string Filter code, i.e. 'customer_id'
  2207. */
  2208. public static function MapContextParam($sContextParam)
  2209. {
  2210. if ($sContextParam == 'menu')
  2211. {
  2212. return null;
  2213. }
  2214. else
  2215. {
  2216. return $sContextParam;
  2217. }
  2218. }
  2219. /**
  2220. * Updates the object from a flat array of values
  2221. * @param $aAttList array $aAttList array of attcode
  2222. * @param $aErrors array Returns information about slave attributes
  2223. * @param $sTargetState string Target state for which to evaluate the writeable attributes (=current state is empty)
  2224. * @return array of attcodes that can be used for writing on the current object
  2225. */
  2226. public function GetWriteableAttList($aAttList, &$aErrors, $sTargetState = '')
  2227. {
  2228. if (!is_array($aAttList))
  2229. {
  2230. $aAttList = $this->FlattenZList(MetaModel::GetZListItems(get_class($this), 'details'));
  2231. // Special case to process the case log, if any...
  2232. // WARNING: if you change this also check the functions DisplayModifyForm and DisplayCaseLog
  2233. foreach(MetaModel::ListAttributeDefs(get_class($this)) as $sAttCode => $oAttDef)
  2234. {
  2235. if ($this->IsNew())
  2236. {
  2237. $iFlags = $this->GetInitialStateAttributeFlags($sAttCode);
  2238. }
  2239. else
  2240. {
  2241. $aVoid = array();
  2242. $iFlags = $this->GetAttributeFlags($sAttCode, $aVoid, $sTargetState);
  2243. }
  2244. if ($oAttDef instanceof AttributeCaseLog)
  2245. {
  2246. if (!($iFlags & (OPT_ATT_HIDDEN|OPT_ATT_SLAVE|OPT_ATT_READONLY)))
  2247. {
  2248. // The case log is editable, append it to the list of fields to retrieve
  2249. $aAttList[] = $sAttCode;
  2250. }
  2251. }
  2252. }
  2253. }
  2254. $aWriteableAttList = array();
  2255. foreach($aAttList as $sAttCode)
  2256. {
  2257. $oAttDef = MetaModel::GetAttributeDef(get_class($this), $sAttCode);
  2258. if ($this->IsNew())
  2259. {
  2260. $iFlags = $this->GetInitialStateAttributeFlags($sAttCode);
  2261. }
  2262. else
  2263. {
  2264. $aVoid = array();
  2265. $iFlags = $this->GetAttributeFlags($sAttCode, $aVoid, $sTargetState);
  2266. }
  2267. if ($oAttDef->IsWritable())
  2268. {
  2269. if ( $iFlags & (OPT_ATT_HIDDEN | OPT_ATT_READONLY))
  2270. {
  2271. // Non-visible, or read-only attribute, do nothing
  2272. }
  2273. elseif($iFlags & OPT_ATT_SLAVE)
  2274. {
  2275. $aErrors[$sAttCode] = Dict::Format('UI:AttemptingToSetASlaveAttribute_Name', $oAttDef->GetLabel());
  2276. }
  2277. else
  2278. {
  2279. $aWriteableAttList[$sAttCode] = $oAttDef;
  2280. }
  2281. }
  2282. }
  2283. return $aWriteableAttList;
  2284. }
  2285. /**
  2286. * Updates the object from a flat array of values
  2287. * @param string $aValues array of attcode => scalar or array (N-N links)
  2288. * @return void
  2289. */
  2290. public function UpdateObjectFromArray($aValues)
  2291. {
  2292. foreach($aValues as $sAttCode => $value)
  2293. {
  2294. $oAttDef = MetaModel::GetAttributeDef(get_class($this), $sAttCode);
  2295. if ($oAttDef->IsLinkSet() && $oAttDef->IsIndirect())
  2296. {
  2297. $aLinks = $value;
  2298. $sLinkedClass = $oAttDef->GetLinkedClass();
  2299. $sExtKeyToRemote = $oAttDef->GetExtKeyToRemote();
  2300. $sExtKeyToMe = $oAttDef->GetExtKeyToMe();
  2301. $oLinkedSet = DBObjectSet::FromScratch($sLinkedClass);
  2302. if (is_array($aLinks))
  2303. {
  2304. foreach($aLinks as $id => $aData)
  2305. {
  2306. if (is_numeric($id))
  2307. {
  2308. if ($id < 0)
  2309. {
  2310. // New link to be created, the opposite of the id (-$id) is the ID of the remote object
  2311. $oLink = MetaModel::NewObject($sLinkedClass);
  2312. $oLink->Set($sExtKeyToRemote, -$id);
  2313. $oLink->Set($sExtKeyToMe, $this->GetKey());
  2314. }
  2315. else
  2316. {
  2317. // Existing link, potentially to be updated...
  2318. $oLink = MetaModel::GetObject($sLinkedClass, $id);
  2319. }
  2320. // Now populate the attributes
  2321. foreach($aData as $sName => $value)
  2322. {
  2323. if (MetaModel::IsValidAttCode($sLinkedClass, $sName))
  2324. {
  2325. $oLinkAttDef = MetaModel::GetAttributeDef($sLinkedClass, $sName);
  2326. if ($oLinkAttDef->IsWritable())
  2327. {
  2328. $oLink->Set($sName, $value);
  2329. }
  2330. }
  2331. }
  2332. $oLinkedSet->AddObject($oLink);
  2333. }
  2334. }
  2335. }
  2336. $this->Set($sAttCode, $oLinkedSet);
  2337. }
  2338. elseif ($oAttDef->GetEditClass() == 'Document')
  2339. {
  2340. // There should be an uploaded file with the named attr_<attCode>
  2341. $oDocument = $value['fcontents'];
  2342. if (!$oDocument->IsEmpty())
  2343. {
  2344. // A new file has been uploaded
  2345. $this->Set($sAttCode, $oDocument);
  2346. }
  2347. }
  2348. elseif ($oAttDef->GetEditClass() == 'One Way Password')
  2349. {
  2350. // Check if the password was typed/changed
  2351. $aPwdData = $value;
  2352. if (!is_null($aPwdData) && $aPwdData['changed'])
  2353. {
  2354. // The password has been changed or set
  2355. $this->Set($sAttCode, $aPwdData['value']);
  2356. }
  2357. }
  2358. elseif ($oAttDef->GetEditClass() == 'Duration')
  2359. {
  2360. $aDurationData = $value;
  2361. if (!is_array($aDurationData)) continue;
  2362. $iValue = (((24*$aDurationData['d'])+$aDurationData['h'])*60 +$aDurationData['m'])*60 + $aDurationData['s'];
  2363. $this->Set($sAttCode, $iValue);
  2364. $previousValue = $this->Get($sAttCode);
  2365. if ($previousValue !== $iValue)
  2366. {
  2367. $this->Set($sAttCode, $iValue);
  2368. }
  2369. }
  2370. else if (($oAttDef->GetEditClass() == 'LinkedSet') && !$oAttDef->IsIndirect() && ($oAttDef->GetEditMode() == LINKSET_EDITMODE_INPLACE))
  2371. {
  2372. $oLinkset = $this->Get($sAttCode);
  2373. $sLinkedClass = $oLinkset->GetClass();
  2374. $aObjSet = array();
  2375. $oLinkset->Rewind();
  2376. $bModified = false;
  2377. while($oLink = $oLinkset->Fetch())
  2378. {
  2379. if (in_array($oLink->GetKey(), $value['to_be_deleted']))
  2380. {
  2381. // The link is to be deleted, don't copy it in the array
  2382. $bModified = true;
  2383. }
  2384. else
  2385. {
  2386. $aObjSet[] = $oLink;
  2387. }
  2388. }
  2389. if (array_key_exists('to_be_created', $value) && (count($value['to_be_created']) > 0))
  2390. {
  2391. // Now handle the lniks to be created
  2392. foreach($value['to_be_created'] as $aData)
  2393. {
  2394. $sSubClass = $aData['class'];
  2395. if ( ($sLinkedClass == $sSubClass) || (is_subclass_of($sSubClass, $sLinkedClass)) )
  2396. {
  2397. $aObjData = $aData['data'];
  2398. $oLink = new $sSubClass;
  2399. $oLink->UpdateObjectFromArray($aObjData);
  2400. $aObjSet[] = $oLink;
  2401. $bModified = true;
  2402. }
  2403. }
  2404. }
  2405. if ($bModified)
  2406. {
  2407. $oNewSet = DBObjectSet::FromArray($oLinkset->GetClass(), $aObjSet);
  2408. $this->Set($sAttCode, $oNewSet);
  2409. }
  2410. }
  2411. else
  2412. {
  2413. if (!is_null($value))
  2414. {
  2415. $aAttributes[$sAttCode] = trim($value);
  2416. $previousValue = $this->Get($sAttCode);
  2417. if ($previousValue !== $aAttributes[$sAttCode])
  2418. {
  2419. $this->Set($sAttCode, $aAttributes[$sAttCode]);
  2420. }
  2421. }
  2422. }
  2423. }
  2424. }
  2425. /**
  2426. * Updates the object from the POSTed parameters (form)
  2427. */
  2428. public function UpdateObjectFromPostedForm($sFormPrefix = '', $aAttList = null, $sTargetState = '')
  2429. {
  2430. if (is_null($aAttList))
  2431. {
  2432. $aAttList = array_keys(MetaModel::ListAttributeDefs(get_class($this)));
  2433. }
  2434. $aValues = array();
  2435. foreach($aAttList as $sAttCode)
  2436. {
  2437. $oAttDef = MetaModel::GetAttributeDef(get_class($this), $sAttCode);
  2438. if ($oAttDef->GetEditClass() == 'Document')
  2439. {
  2440. $value = array('fcontents' => utils::ReadPostedDocument("attr_{$sFormPrefix}{$sAttCode}", 'fcontents'));
  2441. }
  2442. else if (($oAttDef->GetEditClass() == 'LinkedSet') && !$oAttDef->IsIndirect() && ($oAttDef->GetEditMode() == LINKSET_EDITMODE_INPLACE))
  2443. {
  2444. $aRawToBeCreated = json_decode(utils::ReadPostedParam("attr_{$sFormPrefix}{$sAttCode}_tbc", '{}', 'raw_data'), true);
  2445. $aToBeCreated = array();
  2446. foreach($aRawToBeCreated as $aData)
  2447. {
  2448. $sSubFormPrefix = $aData['formPrefix'];
  2449. $sObjClass = $aData['class'];
  2450. $aObjData = array();
  2451. foreach($aData as $sKey => $value)
  2452. {
  2453. if (preg_match("/^attr_$sSubFormPrefix(.*)$/", $sKey, $aMatches))
  2454. {
  2455. $aObjData[$aMatches[1]] = $value;
  2456. }
  2457. }
  2458. $aToBeCreated[] = array('class' => $sObjClass, 'data' => $aObjData);
  2459. }
  2460. $value = array('to_be_created' => $aToBeCreated,
  2461. 'to_be_deleted' => json_decode(utils::ReadPostedParam("attr_{$sFormPrefix}{$sAttCode}_tbd", '[]', 'raw_data'), true) );
  2462. }
  2463. else
  2464. {
  2465. $value = utils::ReadPostedParam("attr_{$sFormPrefix}{$sAttCode}", null, 'raw_data');
  2466. }
  2467. if (!is_null($value))
  2468. {
  2469. $aValues[$sAttCode] = $value;
  2470. }
  2471. }
  2472. $aErrors = array();
  2473. $aFinalValues = array();
  2474. foreach($this->GetWriteableAttList(array_keys($aValues), $aErrors, $sTargetState) as $sAttCode => $oAttDef)
  2475. {
  2476. $aFinalValues[$sAttCode] = $aValues[$sAttCode];
  2477. }
  2478. $this->UpdateObjectFromArray($aFinalValues);
  2479. // Invoke extensions after the update of the object from the form
  2480. foreach (MetaModel::EnumPlugins('iApplicationUIExtension') as $oExtensionInstance)
  2481. {
  2482. $oExtensionInstance->OnFormSubmit($this, $sFormPrefix);
  2483. }
  2484. return $aErrors;
  2485. }
  2486. /**
  2487. * Updates the object from a given page argument
  2488. */
  2489. public function UpdateObjectFromArg($sArgName, $aAttList = null, $sTargetState = '')
  2490. {
  2491. if (is_null($aAttList))
  2492. {
  2493. $aAttList = array_keys(MetaModel::ListAttributeDefs(get_class($this)));
  2494. }
  2495. $aRawValues = utils::ReadParam($sArgName, array(), '', 'raw_data');
  2496. $aValues = array();
  2497. foreach($aAttList as $sAttCode)
  2498. {
  2499. if (isset($aRawValues[$sAttCode]))
  2500. {
  2501. $aValues[$sAttCode] = $aRawValues[$sAttCode];
  2502. }
  2503. }
  2504. $aErrors = array();
  2505. $aFinalValues = array();
  2506. foreach($this->GetWriteableAttList(array_keys($aValues), $aErrors, $sTargetState) as $sAttCode => $oAttDef)
  2507. {
  2508. $aFinalValues[$sAttCode] = $aValues[$sAttCode];
  2509. }
  2510. $this->UpdateObjectFromArray($aFinalValues);
  2511. return $aErrors;
  2512. }
  2513. public function DBInsertNoReload()
  2514. {
  2515. $res = parent::DBInsertNoReload();
  2516. // Invoke extensions after insertion (the object must exist, have an id, etc.)
  2517. foreach (MetaModel::EnumPlugins('iApplicationObjectExtension') as $oExtensionInstance)
  2518. {
  2519. $oExtensionInstance->OnDBInsert($this, self::GetCurrentChange());
  2520. }
  2521. return $res;
  2522. }
  2523. protected function DBCloneTracked_Internal($newKey = null)
  2524. {
  2525. $oNewObj = parent::DBCloneTracked_Internal($newKey);
  2526. // Invoke extensions after insertion (the object must exist, have an id, etc.)
  2527. foreach (MetaModel::EnumPlugins('iApplicationObjectExtension') as $oExtensionInstance)
  2528. {
  2529. $oExtensionInstance->OnDBInsert($oNewObj, self::GetCurrentChange());
  2530. }
  2531. return $oNewObj;
  2532. }
  2533. public function DBUpdate()
  2534. {
  2535. $res = parent::DBUpdate();
  2536. // Invoke extensions after the update (could be before)
  2537. foreach (MetaModel::EnumPlugins('iApplicationObjectExtension') as $oExtensionInstance)
  2538. {
  2539. $oExtensionInstance->OnDBUpdate($this, self::GetCurrentChange());
  2540. }
  2541. return $res;
  2542. }
  2543. protected static function BulkUpdateTracked_Internal(DBObjectSearch $oFilter, array $aValues)
  2544. {
  2545. // Todo - invoke the extension
  2546. return parent::BulkUpdateTracked_Internal($oFilter, $aValues);
  2547. }
  2548. protected function DBDeleteTracked_Internal(&$oDeletionPlan = null)
  2549. {
  2550. // Invoke extensions before the deletion (the deletion will do some cleanup and we might loose some information
  2551. foreach (MetaModel::EnumPlugins('iApplicationObjectExtension') as $oExtensionInstance)
  2552. {
  2553. $oExtensionInstance->OnDBDelete($this, self::GetCurrentChange());
  2554. }
  2555. return parent::DBDeleteTracked_Internal($oDeletionPlan);
  2556. }
  2557. public function IsModified()
  2558. {
  2559. if (parent::IsModified())
  2560. {
  2561. return true;
  2562. }
  2563. // Plugins
  2564. //
  2565. foreach (MetaModel::EnumPlugins('iApplicationObjectExtension') as $oExtensionInstance)
  2566. {
  2567. if ($oExtensionInstance->OnIsModified($this))
  2568. {
  2569. return true;
  2570. }
  2571. }
  2572. return false;
  2573. }
  2574. public function DoCheckToWrite()
  2575. {
  2576. parent::DoCheckToWrite();
  2577. // Plugins
  2578. //
  2579. foreach (MetaModel::EnumPlugins('iApplicationObjectExtension') as $oExtensionInstance)
  2580. {
  2581. $aNewIssues = $oExtensionInstance->OnCheckToWrite($this);
  2582. if (count($aNewIssues) > 0)
  2583. {
  2584. $this->m_aCheckIssues = array_merge($this->m_aCheckIssues, $aNewIssues);
  2585. }
  2586. }
  2587. // User rights
  2588. //
  2589. $aChanges = $this->ListChanges();
  2590. if (count($aChanges) > 0)
  2591. {
  2592. $aForbiddenFields = array();
  2593. foreach ($this->ListChanges() as $sAttCode => $value)
  2594. {
  2595. $bUpdateAllowed = UserRights::IsActionAllowedOnAttribute(get_class($this), $sAttCode, UR_ACTION_MODIFY, DBObjectSet::FromObject($this));
  2596. if (!$bUpdateAllowed)
  2597. {
  2598. $oAttCode = MetaModel::GetAttributeDef(get_class($this), $sAttCode);
  2599. $aForbiddenFields[] = $oAttCode->GetLabel();
  2600. }
  2601. }
  2602. if (count($aForbiddenFields) > 0)
  2603. {
  2604. // Security issue
  2605. $this->m_bSecurityIssue = true;
  2606. $this->m_aCheckIssues[] = Dict::Format('UI:Delete:NotAllowedToUpdate_Fields',implode(', ', $aForbiddenFields));
  2607. }
  2608. }
  2609. }
  2610. protected function DoCheckToDelete(&$oDeletionPlan)
  2611. {
  2612. parent::DoCheckToDelete($oDeletionPlan);
  2613. // Plugins
  2614. //
  2615. foreach (MetaModel::EnumPlugins('iApplicationObjectExtension') as $oExtensionInstance)
  2616. {
  2617. $aNewIssues = $oExtensionInstance->OnCheckToDelete($this);
  2618. if (count($aNewIssues) > 0)
  2619. {
  2620. $this->m_aDeleteIssues = array_merge($this->m_aDeleteIssues, $aNewIssues);
  2621. }
  2622. }
  2623. // User rights
  2624. //
  2625. $bDeleteAllowed = UserRights::IsActionAllowed(get_class($this), UR_ACTION_DELETE, DBObjectSet::FromObject($this));
  2626. if (!$bDeleteAllowed)
  2627. {
  2628. // Security issue
  2629. $this->m_bSecurityIssue = true;
  2630. $this->m_aDeleteIssues[] = Dict::S('UI:Delete:NotAllowedToDelete');
  2631. }
  2632. }
  2633. /**
  2634. * Special display where the case log uses the whole "screen" at the bottom of the "Properties" tab
  2635. */
  2636. public function DisplayCaseLog(WebPage $oPage, $sAttCode, $sComment = '', $sPrefix = '', $bEditMode = false)
  2637. {
  2638. $oPage->SetCurrentTab(Dict::S('UI:PropertiesTab'));
  2639. $sClass = get_class($this);
  2640. if ($this->IsNew())
  2641. {
  2642. $iFlags = $this->GetInitialStateAttributeFlags($sAttCode);
  2643. }
  2644. else
  2645. {
  2646. $iFlags = $this->GetAttributeFlags($sAttCode);
  2647. }
  2648. if ( $iFlags & OPT_ATT_HIDDEN)
  2649. {
  2650. // The case log is hidden do nothing
  2651. }
  2652. else
  2653. {
  2654. $oAttDef = MetaModel::GetAttributeDef(get_class($this), $sAttCode);
  2655. $sInputId = $this->m_iFormId.'_'.$sAttCode;
  2656. if ((!$bEditMode) || ($iFlags & (OPT_ATT_READONLY|OPT_ATT_SLAVE)))
  2657. {
  2658. // Check if the attribute is not read-only because of a synchro...
  2659. $aReasons = array();
  2660. $sSynchroIcon = '';
  2661. if ($iFlags & OPT_ATT_SLAVE)
  2662. {
  2663. $iSynchroFlags = $this->GetSynchroReplicaFlags($sAttCode, $aReasons);
  2664. $sSynchroIcon = "&nbsp;<img id=\"synchro_$sInputId\" src=\"../images/transp-lock.png\" style=\"vertical-align:middle\"/>";
  2665. $sTip = '';
  2666. foreach($aReasons as $aRow)
  2667. {
  2668. $sTip .= "<p>Synchronized with {$aRow['name']} - {$aRow['description']}</p>";
  2669. }
  2670. $sTip = addslashes($sTip);
  2671. $oPage->add_ready_script("$('#synchro_$sInputId').qtip( { content: '$sTip', show: 'mouseover', hide: 'mouseout', style: { name: 'dark', tip: 'leftTop' }, position: { corner: { target: 'rightMiddle', tooltip: 'leftTop' }} } );");
  2672. }
  2673. // Attribute is read-only
  2674. $sHTMLValue = $this->GetAsHTML($sAttCode);
  2675. $sHTMLValue .= '<input type="hidden" id="'.$sInputId.'" name="attr_'.$sPrefix.$sAttCode.'" value="'.htmlentities($this->Get($sAttCode), ENT_QUOTES, 'UTF-8').'"/>';
  2676. $aFieldsMap[$sAttCode] = $sInputId;
  2677. $sComment .= $sSynchroIcon;
  2678. }
  2679. else
  2680. {
  2681. $sValue = $this->Get($sAttCode);
  2682. $sDisplayValue = $this->GetEditValue($sAttCode);
  2683. $aArgs = array('this' => $this, 'formPrefix' => $sPrefix);
  2684. $sHTMLValue = '';
  2685. if ($sComment != '')
  2686. {
  2687. $sHTMLValue = '<span>'.$sComment.'</span><br/>';
  2688. }
  2689. $sHTMLValue .= "<span id=\"field_{$sInputId}\">".self::GetFormElementForField($oPage, $sClass, $sAttCode, $oAttDef, $sValue, $sDisplayValue, $sInputId, '', $iFlags, $aArgs).'</span>';
  2690. $aFieldsMap[$sAttCode] = $sInputId;
  2691. }
  2692. //$aVal = array('label' => '<span title="'.$oAttDef->GetDescription().'">'.$oAttDef->GetLabel().'</span>', 'value' => $sHTMLValue, 'comments' => $sComments, 'infos' => $sInfos);
  2693. $oPage->add('<fieldset><legend>'.$oAttDef->GetLabel().'</legend>');
  2694. $oPage->add($sHTMLValue);
  2695. $oPage->add('</fieldset>');
  2696. }
  2697. }
  2698. public function GetExpectedAttributes($sCurrentState, $sStimulus, $bOnlyNewOnes)
  2699. {
  2700. $aTransitions = $this->EnumTransitions();
  2701. $aStimuli = MetaModel::EnumStimuli(get_class($this));
  2702. if (!isset($aTransitions[$sStimulus]))
  2703. {
  2704. // Invalid stimulus
  2705. throw new ApplicationException(Dict::Format('UI:Error:Invalid_Stimulus_On_Object_In_State', $sStimulus, $oObj->GetName(), $oObj->GetStateLabel()));
  2706. }
  2707. $aTransition = $aTransitions[$sStimulus];
  2708. $sTargetState = $aTransition['target_state'];
  2709. $aTargetStates = MetaModel::EnumStates(get_class($this));
  2710. $aTargetState = $aTargetStates[$sTargetState];
  2711. $aCurrentState = $aTargetStates[$this->GetState()];
  2712. $aExpectedAttributes = $aTargetState['attribute_list'];
  2713. $aCurrentAttributes = $aCurrentState['attribute_list'];
  2714. $aComputedAttributes = array();
  2715. foreach($aExpectedAttributes as $sAttCode => $iExpectCode)
  2716. {
  2717. if (!array_key_exists($sAttCode, $aCurrentAttributes))
  2718. {
  2719. $aComputedAttributes[$sAttCode] = $iExpectCode;
  2720. }
  2721. else
  2722. {
  2723. if ( !($aCurrentAttributes[$sAttCode] & (OPT_ATT_HIDDEN|OPT_ATT_READONLY)) )
  2724. {
  2725. $iExpectCode = $iExpectCode & ~(OPT_ATT_MUSTPROMPT|OPT_ATT_MUSTCHANGE); // Already prompted/changed, reset the flags
  2726. }
  2727. //TODO: better check if the attribute is not *null*
  2728. if ( ($iExpectCode & OPT_ATT_MANDATORY) && ($this->Get($sAttCode) != ''))
  2729. {
  2730. $iExpectCode = $iExpectCode & ~(OPT_ATT_MANDATORY); // If the attribute is present, then no need to request its presence
  2731. }
  2732. $aComputedAttributes[$sAttCode] = $iExpectCode;
  2733. }
  2734. $aComputedAttributes[$sAttCode] = $aComputedAttributes[$sAttCode] & ~(OPT_ATT_READONLY|OPT_ATT_HIDDEN); // Don't care about this form now
  2735. if ($aComputedAttributes[$sAttCode] == 0)
  2736. {
  2737. unset($aComputedAttributes[$sAttCode]);
  2738. }
  2739. }
  2740. return $aComputedAttributes;
  2741. }
  2742. /**
  2743. * Display a form for modifying several objects at once
  2744. * The form will be submitted to the current page, with the specified additional values
  2745. */
  2746. public static function DisplayBulkModifyForm($oP, $sClass, $aSelectedObj, $sCustomOperation, $sCancelUrl, $aExcludeAttributes = array(), $aContextData = array())
  2747. {
  2748. if (count($aSelectedObj) > 0)
  2749. {
  2750. $iAllowedCount = count($aSelectedObj);
  2751. $sSelectedObj = implode(',', $aSelectedObj);
  2752. $sOQL = "SELECT $sClass WHERE id IN (".$sSelectedObj.")";
  2753. $oSet = new CMDBObjectSet(DBObjectSearch::FromOQL($sOQL));
  2754. // Compute the distribution of the values for each field to determine which of the "scalar" fields are homogenous
  2755. $aList = MetaModel::ListAttributeDefs($sClass);
  2756. $aValues = array();
  2757. foreach($aList as $sAttCode => $oAttDef)
  2758. {
  2759. if ($oAttDef->IsScalar())
  2760. {
  2761. $aValues[$sAttCode] = array();
  2762. }
  2763. }
  2764. while($oObj = $oSet->Fetch())
  2765. {
  2766. foreach($aList as $sAttCode => $oAttDef)
  2767. {
  2768. if ($oAttDef->IsScalar() && $oAttDef->IsWritable())
  2769. {
  2770. $currValue = $oObj->Get($sAttCode);
  2771. if ($oAttDef instanceof AttributeCaseLog)
  2772. {
  2773. $currValue = ' '; // Don't put an empty string, in case the field would be considered as mandatory...
  2774. }
  2775. if (is_object($currValue)) continue; // Skip non scalar values...
  2776. if(!array_key_exists($currValue, $aValues[$sAttCode]))
  2777. {
  2778. $aValues[$sAttCode][$currValue] = array('count' => 1, 'display' => $oObj->GetAsHTML($sAttCode));
  2779. }
  2780. else
  2781. {
  2782. $aValues[$sAttCode][$currValue]['count']++;
  2783. }
  2784. }
  2785. }
  2786. }
  2787. // Now create an object that has values for the homogenous values only
  2788. $oDummyObj = new $sClass(); // @@ What if the class is abstract ?
  2789. $aComments = array();
  2790. function MyComparison($a, $b) // Sort descending
  2791. {
  2792. if ($a['count'] == $b['count'])
  2793. {
  2794. return 0;
  2795. }
  2796. return ($a['count'] > $b['count']) ? -1 : 1;
  2797. }
  2798. $iFormId = cmdbAbstractObject::GetNextFormId(); // Identifier that prefixes all the form fields
  2799. $sReadyScript = '';
  2800. $aDependsOn = array();
  2801. $sFormPrefix = '2_';
  2802. foreach($aList as $sAttCode => $oAttDef)
  2803. {
  2804. $aPrerequisites = MetaModel::GetPrequisiteAttributes($sClass, $sAttCode); // List of attributes that are needed for the current one
  2805. if (count($aPrerequisites) > 0)
  2806. {
  2807. // When 'enabling' a field, all its prerequisites must be enabled too
  2808. $sFieldList = "['{$sFormPrefix}".implode("','{$sFormPrefix}", $aPrerequisites)."']";
  2809. $oP->add_ready_script("$('#enable_{$sFormPrefix}{$sAttCode}').bind('change', function(evt, sFormId) { return PropagateCheckBox( this.checked, $sFieldList, true); } );\n");
  2810. }
  2811. $aDependents = MetaModel::GetDependentAttributes($sClass, $sAttCode); // List of attributes that are needed for the current one
  2812. if (count($aDependents) > 0)
  2813. {
  2814. // When 'disabling' a field, all its dependent fields must be disabled too
  2815. $sFieldList = "['{$sFormPrefix}".implode("','{$sFormPrefix}", $aDependents)."']";
  2816. $oP->add_ready_script("$('#enable_{$sFormPrefix}{$sAttCode}').bind('change', function(evt, sFormId) { return PropagateCheckBox( this.checked, $sFieldList, false); } );\n");
  2817. }
  2818. if ($oAttDef->IsScalar() && $oAttDef->IsWritable())
  2819. {
  2820. if ($oAttDef->GetEditClass() == 'One Way Password')
  2821. {
  2822. $sTip = "Unknown values";
  2823. $sReadyScript .= "$('#multi_values_$sAttCode').qtip( { content: '$sTip', show: 'mouseover', hide: 'mouseout', style: { name: 'dark', tip: 'leftTop' }, position: { corner: { target: 'rightMiddle', tooltip: 'leftTop' }} } );";
  2824. $oDummyObj->Set($sAttCode, null);
  2825. $aComments[$sAttCode] = '<input type="checkbox" id="enable_'.$iFormId.'_'.$sAttCode.'" onClick="ToogleField(this.checked, \''.$iFormId.'_'.$sAttCode.'\')"/>';
  2826. $aComments[$sAttCode] .= '<div class="multi_values" id="multi_values_'.$sAttCode.'"> ? </div>';
  2827. $sReadyScript .= 'ToogleField(false, \''.$iFormId.'_'.$sAttCode.'\');'."\n";
  2828. }
  2829. else
  2830. {
  2831. $iCount = count($aValues[$sAttCode]);
  2832. if ($iCount == 1)
  2833. {
  2834. // Homogenous value
  2835. reset($aValues[$sAttCode]);
  2836. $aKeys = array_keys($aValues[$sAttCode]);
  2837. $currValue = $aKeys[0]; // The only value is the first key
  2838. //echo "<p>current value for $sAttCode : $currValue</p>";
  2839. $oDummyObj->Set($sAttCode, $currValue);
  2840. $aComments[$sAttCode] = '<input type="checkbox" checked id="enable_'.$iFormId.'_'.$sAttCode.'" onClick="ToogleField(this.checked, \''.$iFormId.'_'.$sAttCode.'\')"/>';
  2841. $aComments[$sAttCode] .= '<div class="mono_value">1</div>';
  2842. }
  2843. else
  2844. {
  2845. // Non-homogenous value
  2846. $aMultiValues = $aValues[$sAttCode];
  2847. uasort($aMultiValues, 'MyComparison');
  2848. $iMaxCount = 5;
  2849. $sTip = "<p><b>".Dict::Format('UI:BulkModify_Count_DistinctValues', $iCount)."</b><ul>";
  2850. $index = 0;
  2851. foreach($aMultiValues as $sCurrValue => $aVal)
  2852. {
  2853. $sDisplayValue = empty($aVal['display']) ? '<i>'.Dict::S('Enum:Undefined').'</i>' : str_replace(array("\n", "\r"), " ", $aVal['display']);
  2854. $sTip .= "<li>".Dict::Format('UI:BulkModify:Value_Exists_N_Times', $sDisplayValue, $aVal['count'])."</li>";
  2855. $index++;
  2856. if ($iMaxCount == $index)
  2857. {
  2858. $sTip .= "<li>".Dict::Format('UI:BulkModify:N_MoreValues', count($aMultiValues) - $iMaxCount)."</li>";
  2859. break;
  2860. }
  2861. }
  2862. $sTip .= "</ul></p>";
  2863. $sTip = addslashes($sTip);
  2864. $sReadyScript .= "$('#multi_values_$sAttCode').qtip( { content: '$sTip', show: 'mouseover', hide: 'mouseout', style: { name: 'dark', tip: 'leftTop' }, position: { corner: { target: 'rightMiddle', tooltip: 'leftTop' }} } );";
  2865. $oDummyObj->Set($sAttCode, null);
  2866. $aComments[$sAttCode] = '<input type="checkbox" id="enable_'.$iFormId.'_'.$sAttCode.'" onClick="ToogleField(this.checked, \''.$iFormId.'_'.$sAttCode.'\')"/>';
  2867. $aComments[$sAttCode] .= '<div class="multi_values" id="multi_values_'.$sAttCode.'">'.$iCount.'</div>';
  2868. }
  2869. $sReadyScript .= 'ToogleField('.(($iCount == 1) ? 'true': 'false').', \''.$iFormId.'_'.$sAttCode.'\');'."\n";
  2870. }
  2871. }
  2872. }
  2873. $sStateAttCode = MetaModel::GetStateAttributeCode($sClass);
  2874. if (($sStateAttCode != '') && ($oDummyObj->GetState() == ''))
  2875. {
  2876. // Hmmm, it's not gonna work like this ! Set a default value for the "state"
  2877. // Maybe we should use the "state" that is the most common among the objects...
  2878. $aMultiValues = $aValues[$sStateAttCode];
  2879. uasort($aMultiValues, 'MyComparison');
  2880. foreach($aMultiValues as $sCurrValue => $aVal)
  2881. {
  2882. $oDummyObj->Set($sStateAttCode, $sCurrValue);
  2883. break;
  2884. }
  2885. //$oStateAtt = MetaModel::GetAttributeDef($sClass, $sStateAttCode);
  2886. //$oDummyObj->Set($sStateAttCode, $oStateAtt->GetDefaultValue());
  2887. }
  2888. $oP->add("<div class=\"page_header\">\n");
  2889. $oP->add("<h1>".$oDummyObj->GetIcon()."&nbsp;".Dict::Format('UI:Modify_M_ObjectsOf_Class_OutOf_N', $iAllowedCount, $sClass, $iAllowedCount)."</h1>\n");
  2890. $oP->add("</div>\n");
  2891. $oP->add("<div class=\"wizContainer\">\n");
  2892. $sDisableFields = json_encode($aExcludeAttributes);
  2893. $aParams = array
  2894. (
  2895. 'fieldsComments' => $aComments,
  2896. 'noRelations' => true,
  2897. 'custom_operation' => $sCustomOperation,
  2898. 'custom_button' => Dict::S('UI:Button:PreviewModifications'),
  2899. 'selectObj' => $sSelectedObj,
  2900. 'preview_mode' => true,
  2901. 'disabled_fields' => $sDisableFields,
  2902. 'disable_plugins' => true
  2903. );
  2904. $aParams = $aParams + $aContextData; // merge keeping associations
  2905. $oDummyObj->DisplayModifyForm($oP, $aParams);
  2906. $oP->add("</div>\n");
  2907. $oP->add_ready_script($sReadyScript);
  2908. $oP->add_ready_script(
  2909. <<<EOF
  2910. $('.wizContainer button.cancel').unbind('click');
  2911. $('.wizContainer button.cancel').click( function() { window.location.href = '$sCancelUrl'; } );
  2912. EOF
  2913. );
  2914. } // Else no object selected ???
  2915. else
  2916. {
  2917. $oP->p("No object selected !, nothing to do");
  2918. }
  2919. }
  2920. /**
  2921. * Process the reply made from a form built with DisplayBulkModifyForm
  2922. */
  2923. public static function DoBulkModify($oP, $sClass, $aSelectedObj, $sCustomOperation, $bPreview, $sCancelUrl, $aContextData = array())
  2924. {
  2925. $aHeaders = array(
  2926. 'form::select' => array('label' => "<input type=\"checkbox\" onClick=\"CheckAll('.selectList:not(:disabled)', this.checked);\"></input>", 'description' => Dict::S('UI:SelectAllToggle+')),
  2927. 'object' => array('label' => MetaModel::GetName($sClass), 'description' => Dict::S('UI:ModifiedObject')),
  2928. 'status' => array('label' => Dict::S('UI:BulkModifyStatus'), 'description' => Dict::S('UI:BulkModifyStatus+')),
  2929. 'errors' => array('label' => Dict::S('UI:BulkModifyErrors'), 'description' => Dict::S('UI:BulkModifyErrors+')),
  2930. );
  2931. $aRows = array();
  2932. $oP->add("<div class=\"page_header\">\n");
  2933. $oP->add("<h1>".MetaModel::GetClassIcon($sClass)."&nbsp;".Dict::Format('UI:Modify_N_ObjectsOf_Class', count($aSelectedObj), $sClass)."</h1>\n");
  2934. $oP->add("</div>\n");
  2935. $oP->set_title(Dict::Format('UI:Modify_N_ObjectsOf_Class', count($aSelectedObj), $sClass));
  2936. if (!$bPreview)
  2937. {
  2938. // Not in preview mode, do the update for real
  2939. $sTransactionId = utils::ReadPostedParam('transaction_id', '');
  2940. if (!utils::IsTransactionValid($sTransactionId, false))
  2941. {
  2942. throw new Exception(Dict::S('UI:Error:ObjectAlreadyUpdated'));
  2943. }
  2944. utils::RemoveTransaction($sTransactionId);
  2945. }
  2946. foreach($aSelectedObj as $iId)
  2947. {
  2948. $oObj = MetaModel::GetObject($sClass, $iId);
  2949. $aErrors = $oObj->UpdateObjectFromPostedForm('');
  2950. $bResult = (count($aErrors) == 0);
  2951. if ($bResult)
  2952. {
  2953. list($bResult, $aErrors) = $oObj->CheckToWrite(true /* Enforce Read-only fields */);
  2954. }
  2955. if ($bPreview)
  2956. {
  2957. $sStatus = $bResult ? Dict::S('UI:BulkModifyStatusOk') : Dict::S('UI:BulkModifyStatusError');
  2958. }
  2959. else
  2960. {
  2961. $sStatus = $bResult ? Dict::S('UI:BulkModifyStatusModified') : Dict::S('UI:BulkModifyStatusSkipped');
  2962. }
  2963. $sCSSClass = $bResult ? HILIGHT_CLASS_NONE : HILIGHT_CLASS_CRITICAL;
  2964. $sChecked = $bResult ? 'checked' : '';
  2965. $sDisabled = $bResult ? '' : 'disabled';
  2966. $aRows[] = array(
  2967. 'form::select' => "<input type=\"checkbox\" class=\"selectList\" $sChecked $sDisabled\"></input>",
  2968. 'object' => $oObj->GetHyperlink(),
  2969. 'status' => $sStatus,
  2970. 'errors' => '<p>'.($bResult ? '': implode('</p><p>', $aErrors)).'</p>',
  2971. '@class' => $sCSSClass,
  2972. );
  2973. if ($bResult && (!$bPreview))
  2974. {
  2975. $oObj->DBUpdate();
  2976. }
  2977. }
  2978. $oP->Table($aHeaders, $aRows);
  2979. if ($bPreview)
  2980. {
  2981. $sFormAction = $_SERVER['SCRIPT_NAME']; // No parameter in the URL, the only parameter will be the ones passed through the form
  2982. // Form to submit:
  2983. $oP->add("<form method=\"post\" action=\"$sFormAction\" enctype=\"multipart/form-data\">\n");
  2984. $aDefaults = utils::ReadParam('default', array());
  2985. $oAppContext = new ApplicationContext();
  2986. $oP->add($oAppContext->GetForForm());
  2987. foreach ($aContextData as $sKey => $value)
  2988. {
  2989. $oP->add("<input type=\"hidden\" name=\"{$sKey}\" value=\"$value\">\n");
  2990. }
  2991. $oP->add("<input type=\"hidden\" name=\"operation\" value=\"$sCustomOperation\">\n");
  2992. $oP->add("<input type=\"hidden\" name=\"class\" value=\"$sClass\">\n");
  2993. $oP->add("<input type=\"hidden\" name=\"preview_mode\" value=\"0\">\n");
  2994. $oP->add("<input type=\"hidden\" name=\"transaction_id\" value=\"".utils::GetNewTransactionId()."\">\n");
  2995. $oP->add("<button type=\"button\" class=\"action cancel\" onClick=\"window.location.href='$sCancelUrl'\">".Dict::S('UI:Button:Cancel')."</button>&nbsp;&nbsp;&nbsp;&nbsp;\n");
  2996. $oP->add("<button type=\"submit\" class=\"action\"><span>".Dict::S('UI:Button:ModifyAll')."</span></button>\n");
  2997. foreach($_POST as $sKey => $value)
  2998. {
  2999. if (preg_match('/attr_(.+)/', $sKey, $aMatches))
  3000. {
  3001. // Beware: some values (like durations) are passed as arrays
  3002. if (is_array($value))
  3003. {
  3004. foreach($value as $vKey => $vValue)
  3005. {
  3006. $oP->add("<input type=\"hidden\" name=\"{$sKey}[$vKey]\" value=\"$vValue\">\n");
  3007. }
  3008. }
  3009. else
  3010. {
  3011. $oP->add("<input type=\"hidden\" name=\"$sKey\" value=\"$value\">\n");
  3012. }
  3013. }
  3014. }
  3015. $oP->add("</form>\n");
  3016. }
  3017. else
  3018. {
  3019. $oP->add("<button type=\"button\" onClick=\"window.location.href='$sCancelUrl'\" class=\"action\"><span>".Dict::S('UI:Button:Done')."</span></button>\n");
  3020. }
  3021. }
  3022. /**
  3023. * Perform all the needed checks to delete one (or more) objects
  3024. */
  3025. public static function DeleteObjects(WebPage $oP, $sClass, $aObjects, $bPreview, $sCustomOperation, $aContextData = array())
  3026. {
  3027. $oDeletionPlan = new DeletionPlan();
  3028. foreach($aObjects as $oObj)
  3029. {
  3030. if ($bPreview)
  3031. {
  3032. $oObj->CheckToDelete($oDeletionPlan);
  3033. }
  3034. else
  3035. {
  3036. $oObj->DBDeleteTracked(CMDBObject::GetCurrentChange(), null, $oDeletionPlan);
  3037. }
  3038. }
  3039. if ($bPreview)
  3040. {
  3041. if (count($aObjects) == 1)
  3042. {
  3043. $oObj = $aObjects[0];
  3044. $oP->add("<h1>".Dict::Format('UI:Delete:ConfirmDeletionOf_Name', $oObj->GetName())."</h1>\n");
  3045. }
  3046. else
  3047. {
  3048. $oP->add("<h1>".Dict::Format('UI:Delete:ConfirmDeletionOf_Count_ObjectsOf_Class', count($aObjects), MetaModel::GetName($sClass))."</h1>\n");
  3049. }
  3050. // Explain what should be done
  3051. //
  3052. $aDisplayData = array();
  3053. foreach ($oDeletionPlan->ListDeletes() as $sTargetClass => $aDeletes)
  3054. {
  3055. foreach ($aDeletes as $iId => $aData)
  3056. {
  3057. $oToDelete = $aData['to_delete'];
  3058. $bAutoDel = (($aData['mode'] == DEL_SILENT) || ($aData['mode'] == DEL_AUTO));
  3059. if (array_key_exists('issue', $aData))
  3060. {
  3061. if ($bAutoDel)
  3062. {
  3063. if (isset($aData['requested_explicitely']))
  3064. {
  3065. $sConsequence = Dict::Format('UI:Delete:CannotDeleteBecause', $aData['issue']);
  3066. }
  3067. else
  3068. {
  3069. $sConsequence = Dict::Format('UI:Delete:ShouldBeDeletedAtomaticallyButNotPossible', $aData['issue']);
  3070. }
  3071. }
  3072. else
  3073. {
  3074. $sConsequence = Dict::Format('UI:Delete:MustBeDeletedManuallyButNotPossible', $aData['issue']);
  3075. }
  3076. }
  3077. else
  3078. {
  3079. if ($bAutoDel)
  3080. {
  3081. if (isset($aData['requested_explicitely']))
  3082. {
  3083. $sConsequence = ''; // not applicable
  3084. }
  3085. else
  3086. {
  3087. $sConsequence = Dict::S('UI:Delete:WillBeDeletedAutomatically');
  3088. }
  3089. }
  3090. else
  3091. {
  3092. $sConsequence = Dict::S('UI:Delete:MustBeDeletedManually');
  3093. }
  3094. }
  3095. $aDisplayData[] = array(
  3096. 'class' => MetaModel::GetName(get_class($oToDelete)),
  3097. 'object' => $oToDelete->GetHyperLink(),
  3098. 'consequence' => $sConsequence,
  3099. );
  3100. }
  3101. }
  3102. foreach ($oDeletionPlan->ListUpdates() as $sRemoteClass => $aToUpdate)
  3103. {
  3104. foreach ($aToUpdate as $iId => $aData)
  3105. {
  3106. $oToUpdate = $aData['to_reset'];
  3107. if (array_key_exists('issue', $aData))
  3108. {
  3109. $sConsequence = Dict::Format('UI:Delete:CannotUpdateBecause_Issue', $aData['issue']);
  3110. }
  3111. else
  3112. {
  3113. $sConsequence = Dict::Format('UI:Delete:WillAutomaticallyUpdate_Fields', $aData['attributes_list']);
  3114. }
  3115. $aDisplayData[] = array(
  3116. 'class' => MetaModel::GetName(get_class($oToUpdate)),
  3117. 'object' => $oToUpdate->GetHyperLink(),
  3118. 'consequence' => $sConsequence,
  3119. );
  3120. }
  3121. }
  3122. $iImpactedIndirectly = $oDeletionPlan->GetTargetCount() - count($aObjects);
  3123. if ($iImpactedIndirectly > 0)
  3124. {
  3125. if (count($aObjects) == 1)
  3126. {
  3127. $oObj = $aObjects[0];
  3128. $oP->p(Dict::Format('UI:Delete:Count_Objects/LinksReferencing_Object', $iImpactedIndirectly, $oObj->GetName()));
  3129. }
  3130. else
  3131. {
  3132. $oP->p(Dict::Format('UI:Delete:Count_Objects/LinksReferencingTheObjects', $iImpactedIndirectly));
  3133. }
  3134. $oP->p(Dict::S('UI:Delete:ReferencesMustBeDeletedToEnsureIntegrity'));
  3135. }
  3136. if (($iImpactedIndirectly > 0) || $oDeletionPlan->FoundStopper())
  3137. {
  3138. $aDisplayConfig = array();
  3139. $aDisplayConfig['class'] = array('label' => 'Class', 'description' => '');
  3140. $aDisplayConfig['object'] = array('label' => 'Object', 'description' => '');
  3141. $aDisplayConfig['consequence'] = array('label' => 'Consequence', 'description' => Dict::S('UI:Delete:Consequence+'));
  3142. $oP->table($aDisplayConfig, $aDisplayData);
  3143. }
  3144. if ($oDeletionPlan->FoundStopper())
  3145. {
  3146. if ($oDeletionPlan->FoundSecurityIssue())
  3147. {
  3148. $oP->p(Dict::S('UI:Delete:SorryDeletionNotAllowed'));
  3149. }
  3150. elseif ($oDeletionPlan->FoundManualOperation())
  3151. {
  3152. $oP->p(Dict::S('UI:Delete:PleaseDoTheManualOperations'));
  3153. }
  3154. else // $bFoundManualOp
  3155. {
  3156. $oP->p(Dict::S('UI:Delete:PleaseDoTheManualOperations'));
  3157. }
  3158. $oAppContext = new ApplicationContext();
  3159. $oP->add("<form method=\"post\">\n");
  3160. $oP->add("<input type=\"hidden\" name=\"transaction_id\" value=\"".utils::ReadParam('transaction_id')."\">\n");
  3161. $oP->add("<input type=\"button\" onclick=\"window.history.back();\" value=\"".Dict::S('UI:Button:Back')."\">\n");
  3162. $oP->add("<input DISABLED type=\"submit\" name=\"\" value=\"".Dict::S('UI:Button:Delete')."\">\n");
  3163. $oP->add($oAppContext->GetForForm());
  3164. $oP->add("</form>\n");
  3165. }
  3166. else
  3167. {
  3168. if (count($aObjects) == 1)
  3169. {
  3170. $oObj = $aObjects[0];
  3171. $id = $oObj->GetKey();
  3172. $oP->p('<h1>'.Dict::Format('UI:Delect:Confirm_Object', $oObj->GetHyperLink()).'</h1>');
  3173. }
  3174. else
  3175. {
  3176. $oP->p('<h1>'.Dict::Format('UI:Delect:Confirm_Count_ObjectsOf_Class', count($aObjects), MetaModel::GetName($sClass)).'</h1>');
  3177. }
  3178. foreach($aObjects as $oObj)
  3179. {
  3180. $aKeys[] = $oObj->GetKey();
  3181. }
  3182. $oFilter = new DBObjectSearch($sClass);
  3183. $oFilter->AddCondition('id', $aKeys, 'IN');
  3184. $oSet = new CMDBobjectSet($oFilter);
  3185. $oP->add('<div id="0">');
  3186. CMDBAbstractObject::DisplaySet($oP, $oSet, array('display_limit' => false, 'menu' => false));
  3187. $oP->add("</div>\n");
  3188. $oP->add("<form method=\"post\">\n");
  3189. foreach ($aContextData as $sKey => $value)
  3190. {
  3191. $oP->add("<input type=\"hidden\" name=\"{$sKey}\" value=\"$value\">\n");
  3192. }
  3193. $oP->add("<input type=\"hidden\" name=\"transaction_id\" value=\"".utils::GetNewTransactionId()."\">\n");
  3194. $oP->add("<input type=\"hidden\" name=\"operation\" value=\"$sCustomOperation\">\n");
  3195. $oP->add("<input type=\"hidden\" name=\"filter\" value=\"".$oFilter->Serialize()."\">\n");
  3196. $oP->add("<input type=\"hidden\" name=\"class\" value=\"$sClass\">\n");
  3197. foreach($aObjects as $oObj)
  3198. {
  3199. $oP->add("<input type=\"hidden\" name=\"selectObject[]\" value=\"".$oObj->GetKey()."\">\n");
  3200. }
  3201. $oP->add("<input type=\"button\" onclick=\"window.history.back();\" value=\"".Dict::S('UI:Button:Back')."\">\n");
  3202. $oP->add("<input type=\"submit\" name=\"\" value=\"".Dict::S('UI:Button:Delete')."\">\n");
  3203. $oAppContext = new ApplicationContext();
  3204. $oP->add($oAppContext->GetForForm());
  3205. $oP->add("</form>\n");
  3206. }
  3207. }
  3208. else // if ($bPreview)...
  3209. {
  3210. // Execute the deletion
  3211. //
  3212. if (count($aObjects) == 1)
  3213. {
  3214. $oObj = $aObjects[0];
  3215. $oP->add("<h1>".Dict::Format('UI:Title:DeletionOf_Object', $oObj->GetName())."</h1>\n");
  3216. }
  3217. else
  3218. {
  3219. $oP->add("<h1>".Dict::Format('UI:Title:BulkDeletionOf_Count_ObjectsOf_Class', count($aObjects), MetaModel::GetName($sClass))."</h1>\n");
  3220. }
  3221. // Security - do not allow the user to force a forbidden delete by the mean of page arguments...
  3222. if ($oDeletionPlan->FoundSecurityIssue())
  3223. {
  3224. throw new CoreException(Dict::S('UI:Error:NotEnoughRightsToDelete'));
  3225. }
  3226. if ($oDeletionPlan->FoundManualOperation())
  3227. {
  3228. throw new CoreException(Dict::S('UI:Error:CannotDeleteBecauseManualOpNeeded'));
  3229. }
  3230. if ($oDeletionPlan->FoundManualDelete())
  3231. {
  3232. throw new CoreException(Dict::S('UI:Error:CannotDeleteBecauseOfDepencies'));
  3233. }
  3234. // Report deletions
  3235. //
  3236. $aDisplayData = array();
  3237. foreach ($oDeletionPlan->ListDeletes() as $sTargetClass => $aDeletes)
  3238. {
  3239. foreach ($aDeletes as $iId => $aData)
  3240. {
  3241. $oToDelete = $aData['to_delete'];
  3242. if (isset($aData['requested_explicitely']))
  3243. {
  3244. $sMessage = Dict::S('UI:Delete:Deleted');
  3245. }
  3246. else
  3247. {
  3248. $sMessage = Dict::S('UI:Delete:AutomaticallyDeleted');
  3249. }
  3250. $aDisplayData[] = array(
  3251. 'class' => MetaModel::GetName(get_class($oToDelete)),
  3252. 'object' => $oToDelete->GetName(),
  3253. 'consequence' => $sMessage,
  3254. );
  3255. }
  3256. }
  3257. // Report updates
  3258. //
  3259. foreach ($oDeletionPlan->ListUpdates() as $sTargetClass => $aToUpdate)
  3260. {
  3261. foreach ($aToUpdate as $iId => $aData)
  3262. {
  3263. $oToUpdate = $aData['to_reset'];
  3264. $aDisplayData[] = array(
  3265. 'class' => MetaModel::GetName(get_class($oToUpdate)),
  3266. 'object' => $oToUpdate->GetHyperLink(),
  3267. 'consequence' => Dict::Format('UI:Delete:AutomaticResetOf_Fields', $aData['attributes_list']),
  3268. );
  3269. }
  3270. }
  3271. // Report automatic jobs
  3272. //
  3273. if ($oDeletionPlan->GetTargetCount() > 0)
  3274. {
  3275. if (count($aObjects) == 1)
  3276. {
  3277. $oObj = $aObjects[0];
  3278. $oP->p(Dict::Format('UI:Delete:CleaningUpRefencesTo_Object', $oObj->GetName()));
  3279. }
  3280. else
  3281. {
  3282. $oP->p(Dict::Format('UI:Delete:CleaningUpRefencesTo_Several_ObjectsOf_Class', count($aObjects), MetaModel::GetName($sClass)));
  3283. }
  3284. $aDisplayConfig = array();
  3285. $aDisplayConfig['class'] = array('label' => 'Class', 'description' => '');
  3286. $aDisplayConfig['object'] = array('label' => 'Object', 'description' => '');
  3287. $aDisplayConfig['consequence'] = array('label' => 'Done', 'description' => Dict::S('UI:Delete:Done+'));
  3288. $oP->table($aDisplayConfig, $aDisplayData);
  3289. }
  3290. }
  3291. }
  3292. }
  3293. ?>